B3 Connectors API

openapi: 3.1.0
info:
  description: Workflow management API for B3OS
  title: B3OS Workflow Action Connectors API
  version: '1.0'
tags:
- name: Connectors
paths:
  /v1/connectors:
    get:
      description: List all connectors for the current user
      parameters:
      - description: Number of items (default 20, max 100)
        in: query
        name: limit
        schema:
          type: integer
      - description: Offset for pagination (default 0)
        in: query
        name: offset
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorsSuccessResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
      tags:
      - Connectors
    post:
      description: Create a new connector
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - $ref: '#/components/schemas/CreateConnectorParams'
                summary: request
                description: Connector details
        description: Connector details
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorSuccessResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
      tags:
      - Connectors
  /v1/connectors/{id}:
    delete:
      description: Delete a connector
      parameters:
      - description: Connector ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteConnectorSuccessResponse'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Not Found
      tags:
      - Connectors
    get:
      description: Get a connector by ID
      parameters:
      - description: Connector ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectorSuccessResponse'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Not Found
      tags:
      - Connectors
    put:
      description: Update a connector
      parameters:
      - description: Connector ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - $ref: '#/components/schemas/UpdateConnectorParams'
                summary: request
                description: Connector update details
        description: Connector update details
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConnectorSuccessResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Not Found
      tags:
      - Connectors
components:
  schemas:
    UpdateConnectorParams:
      properties:
        data:
          additionalProperties: {}
          type: object
        description:
          type: string
        name:
          type: string
      type: object
    UpdateConnectorSuccessResponse:
      properties:
        code:
          example: 200
          type: integer
        data:
          $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Connector'
        message:
          example: success
          type: string
        requestId:
          example: abc-123
          type: string
      type: object
    DeleteConnectorSuccessResponse:
      properties:
        code:
          example: 200
          type: integer
        message:
          example: success
          type: string
        requestId:
          example: abc-123
          type: string
      type: object
    PaginatedData-github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity_Connector:
      properties:
        hasMore:
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Connector'
          type: array
          uniqueItems: false
        limit:
          type: integer
        offset:
          type: integer
      type: object
    github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Connector:
      properties:
        createdAt:
          type: string
        createdBy:
          type: string
        description:
          type: string
        id:
          type: string
        maskedData:
          additionalProperties: {}
          description: Computed field, not persisted
          type: object
        name:
          type: string
        organizationId:
          type: string
        provider:
          type: string
        type:
          type: string
        updatedAt:
          type: string
        updatedBy:
          type: string
      type: object
    ListConnectorsSuccessResponse:
      properties:
        code:
          example: 200
          type: integer
        data:
          $ref: '#/components/schemas/PaginatedData-github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity_Connector'
        message:
          example: success
          type: string
        requestId:
          example: abc-123
          type: string
      type: object
    CreateConnectorParams:
      properties:
        data:
          additionalProperties: {}
          type: object
        description:
          type: string
        name:
          type: string
        type:
          type: string
      required:
      - data
      - name
      - type
      type: object
    CreateConnectorSuccessResponse:
      properties:
        code:
          example: 200
          type: integer
        data:
          $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Connector'
        message:
          example: success
          type: string
        requestId:
          example: abc-123
          type: string
      type: object
    github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse:
      properties:
        code:
          type: integer
        details:
          items: {}
          type: array
          uniqueItems: false
        message:
          type: string
        requestId:
          type: string
      type: object
    GetConnectorSuccessResponse:
      properties:
        code:
          example: 200
          type: integer
        data:
          $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Connector'
        message:
          example: success
          type: string
        requestId:
          example: abc-123
          type: string
      type: object