Palenca (Vech) link API

The link API from Palenca (Vech) — 1 operation(s) for link.

OpenAPI Specification

palenca-vech-link-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Palenca accounts link API
  description: Palenca API
  version: 2.0.0
tags:
- name: link
paths:
  /v1/link/authorize:
    post:
      tags:
      - link
      summary: Authorize Link
      operationId: authorize_link_v1_link_authorize_post
      parameters:
      - required: false
        schema:
          type: string
          title: X-Api-Key
        name: x-api-key
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthorizeLinkParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse_NoneType_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ErrorDetailResponse:
      properties:
        message:
          type: string
          title: Message
        location:
          type: string
          title: Location
      type: object
      title: ErrorDetailResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AuthorizeLinkParams:
      properties:
        connect_flow_id:
          type: string
          format: uuid
          title: Connect Flow Id
      type: object
      required:
      - connect_flow_id
      title: AuthorizeLinkParams
      example:
        widget_id: b679c2fb-a096-4c26-a902-245f9bce66d9
    ErrorResponse:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetailResponse'
          type: array
          title: Errors
      type: object
      title: ErrorResponse
    BaseResponse_NoneType_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        error:
          $ref: '#/components/schemas/ErrorResponse'
        data:
          type: 'null'
          title: Data
      type: object
      title: BaseResponse[NoneType]
      example:
        success: true
        data: {}
        error: {}
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError