@celigo/api-specs 0.2.1

package/dist/template.yml

@@ -0,0 +1,897 @@
+openapi: 3.2.0
+info:
+  version: 1.0.0
+  title: Templates
+  description: API for managing Celigo integration templates — pre-built configurations Partners publish to the marketplace.
+servers:
+  - url: https://api.integrator.io
+    description: Production (US / default region)
+  - url: https://api.eu.integrator.io
+    description: Production (EU region)
+  - url: https://api.au.integrator.io
+    description: Production (AU region)
+  - url: https://api.ca.integrator.io
+    description: Production (CA region)
+security:
+  - bearerAuth: []
+tags:
+  - name: Templates
+    description: |-
+      Templates are pre-built integration configurations that Partners
+      publish to the Celigo marketplace for other users to install.
+
+      The template lifecycle is: create → upload zip (via `GET /v1/s3SignedURL`) → publish.
+
+      All endpoints require a **Partner account** — non-partner callers
+      receive 403 `access_restricted`.
+
+      ## Template schema
+
+      {% openapi-schemas spec="template" schemas="Template" grouped="true" %}
+paths:
+  /v1/templates:
+    get:
+      x-internal: false
+      operationId: listTemplates
+      tags:
+        - Templates
+      parameters:
+        - name: limit
+          in: query
+          description: Maximum number of records to return per page.
+          schema:
+            type: integer
+            minimum: 1
+            examples:
+              - 100
+        - $ref: '#/components/parameters/After'
+      summary: List templates
+      description: |-
+        Returns all templates owned by the authenticated Partner account.
+        The response is a flat JSON array with no pagination.
+      responses:
+        '200':
+          description: Array of template resources.
+          headers:
+            Link:
+              description: |-
+                RFC-5988 pagination links. When more pages remain, includes a `<...>; rel="next"` entry;
+                absent on the final page.
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Template'
+              examples:
+                default:
+                  value:
+                    - _id: 67ffe71a4432714ded99e81b
+                      name: Salesforce to NetSuite sync
+                      description: Bi-directional sync of contacts between Salesforce and NetSuite.
+                      websiteURL: https://example.com/templates/sf-ns
+                      contactEmail: partner@example.com
+                      published: true
+                      lastModified: '2026-05-05T17:09:48.338Z'
+                      applications:
+                        - salesforce
+                        - netsuite
+                      free: false
+                      numInstalls: 42
+                    - _id: 68a2b3c4d5e6f70089012345
+                      name: Shopify order import
+                      lastModified: '2026-04-20T10:15:00.000Z'
+                      applications:
+                        - shopify
+                      free: false
+                      numInstalls: 0
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+    post:
+      x-internal: false
+      operationId: createTemplate
+      tags:
+        - Templates
+      summary: Create a template
+      description: |-
+        Creates a new integration template. Only `name` is required; all
+        other fields are optional. Upload a zip via `GET /v1/s3SignedURL`
+        before attempting to publish.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TemplateInput'
+            examples:
+              minimal:
+                summary: Minimal create
+                value:
+                  name: Salesforce to NetSuite sync
+              full:
+                summary: All optional fields
+                value:
+                  name: Salesforce to NetSuite sync
+                  description: Bi-directional sync of contacts between Salesforce and NetSuite.
+                  websiteURL: https://example.com/templates/sf-ns
+                  contactEmail: partner@example.com
+                  imageURL: https://example.com/images/sf-ns.png
+                  applications:
+                    - salesforce
+                    - netsuite
+      responses:
+        '201':
+          description: Template created.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Template'
+              examples:
+                default:
+                  value:
+                    _id: 68a2b3c4d5e6f70089012345
+                    name: Salesforce to NetSuite sync
+                    lastModified: '2026-05-16T02:33:22.573Z'
+                    applications: []
+                    free: false
+                    numInstalls: 0
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '422':
+          $ref: '#/components/responses/422-unprocessable-entity'
+  /v1/templates/{_id}:
+    get:
+      x-internal: false
+      operationId: getTemplateById
+      tags:
+        - Templates
+      summary: Get a template
+      description: Returns a single template by ID.
+      parameters:
+        - name: _id
+          in: path
+          required: true
+          schema:
+            type: string
+            format: objectId
+            x-celigo-refModel: templates
+            examples:
+              - 67ffe71a4432714ded99e81b
+      responses:
+        '200':
+          description: The template resource.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Template'
+              examples:
+                published:
+                  summary: Published template
+                  value:
+                    _id: 67ffe71a4432714ded99e81b
+                    name: Salesforce to NetSuite sync
+                    description: Bi-directional sync of contacts between Salesforce and NetSuite.
+                    websiteURL: https://example.com/templates/sf-ns
+                    contactEmail: partner@example.com
+                    published: true
+                    lastModified: '2026-05-05T17:09:48.338Z'
+                    applications:
+                      - salesforce
+                      - netsuite
+                    free: false
+                    numInstalls: 42
+                unpublished:
+                  summary: Unpublished template (published field omitted)
+                  value:
+                    _id: 68a2b3c4d5e6f70089012345
+                    name: Draft template
+                    lastModified: '2026-04-20T10:15:00.000Z'
+                    applications: []
+                    free: false
+                    numInstalls: 0
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '404':
+          $ref: '#/components/responses/404-not-found'
+    put:
+      x-internal: false
+      operationId: updateTemplate
+      tags:
+        - Templates
+      summary: Update a template
+      description: |-
+        Replaces the template's fields with the values in the request body.
+        Omitted optional fields retain their current values. `name` is
+        required on every PUT, even if unchanged.
+      parameters:
+        - name: _id
+          in: path
+          required: true
+          schema:
+            type: string
+            format: objectId
+            x-celigo-refModel: templates
+            examples:
+              - 67ffe71a4432714ded99e81b
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TemplateInput'
+            examples:
+              updateMetadata:
+                summary: Update metadata
+                value:
+                  name: Salesforce to NetSuite sync
+                  description: Updated description for the marketplace listing.
+                  contactEmail: new-contact@example.com
+              publish:
+                summary: Publish to marketplace
+                value:
+                  name: Salesforce to NetSuite sync
+                  published: true
+      responses:
+        '200':
+          description: Updated template.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Template'
+              examples:
+                updated:
+                  summary: Template after a metadata update (Partner account)
+                  value:
+                    _id: 67ffe71a4432714ded99e81b
+                    name: Salesforce to NetSuite sync
+                    description: Updated description for the marketplace listing.
+                    websiteURL: https://example.com/templates/sf-ns
+                    contactEmail: new-contact@example.com
+                    published: true
+                    lastModified: '2026-06-09T18:21:05.114Z'
+                    applications:
+                      - salesforce
+                      - netsuite
+                    free: false
+                    numInstalls: 42
+        '400':
+          $ref: '#/components/responses/400-bad-request'
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '404':
+          $ref: '#/components/responses/404-not-found'
+        '422':
+          description: Template zip has not been uploaded yet.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                template_not_found:
+                  summary: Attempting to publish without a zip
+                  value:
+                    errors:
+                      - code: template_not_found
+                        message: Template zip must be uploaded before publishing.
+    delete:
+      x-internal: false
+      operationId: deleteTemplate
+      tags:
+        - Templates
+      summary: Delete a template
+      description: Permanently deletes a template.
+      parameters:
+        - name: _id
+          in: path
+          required: true
+          schema:
+            type: string
+            format: objectId
+            x-celigo-refModel: templates
+            examples:
+              - 67ffe71a4432714ded99e81b
+      responses:
+        '204':
+          description: Template deleted.
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '404':
+          $ref: '#/components/responses/404-not-found'
+  /v1/integrations/template/{_id}:
+    post:
+      x-internal: false
+      operationId: installTemplate
+      tags:
+        - Templates
+      summary: Install an integration from a template
+      description: |-
+        Installs an integration from a published template. The caller provides a
+        `connectionMap` that maps each template-defined connection ID to an actual
+        connection ID in the caller's account. Every template connection must
+        appear as a key in `connectionMap`.
+      parameters:
+        - name: _id
+          in: path
+          required: true
+          description: The template ID to install from.
+          schema:
+            type: string
+            format: objectId
+            x-celigo-refModel: templates
+            examples:
+              - 67ffe71a4432714ded99e81b
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              description: |-
+                Connection mapping from template connection IDs to the caller's
+                real connection IDs.
+              properties:
+                connectionMap:
+                  type: object
+                  description: |-
+                    Keys are connection `_id` values from the template; values are
+                    the caller's own connection `_id` values that should replace
+                    them during install.
+                  additionalProperties:
+                    type: string
+                  example:
+                    61f92026dd053843b5d72350: 64a1234567890abcdef12345
+                    61f92026dd053843b5d72351: 64a1234567890abcdef12346
+              required:
+                - connectionMap
+            examples:
+              twoConnections:
+                summary: Map two template connections to real ones
+                value:
+                  connectionMap:
+                    61f92026dd053843b5d72350: 64a1234567890abcdef12345
+                    61f92026dd053843b5d72351: 64a1234567890abcdef12346
+      responses:
+        '200':
+          description: Template installed successfully.
+          content:
+            application/json:
+              schema:
+                type: object
+                description: The created integration and related resources.
+                additionalProperties: true
+              examples:
+                installed:
+                  summary: Integration created from the template
+                  value:
+                    _integrationId: 6405b9d73496e05ff253d587
+        '400':
+          description: Missing or empty `connectionMap`.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                missingConnectionMap:
+                  value:
+                    errors:
+                      - code: invalid_connectionMap
+                        message: connectionMap is required.
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '404':
+          description: Template not found.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                invalidRef:
+                  value:
+                    errors:
+                      - code: invalid_ref
+                        message: Template not found.
+        '422':
+          description: |-
+            Connection IDs in `connectionMap` do not match the template's
+            expected connection IDs.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                invalidConnectionId:
+                  value:
+                    errors:
+                      - code: invalid_connectionId
+                        message: Invalid connection ID in connectionMap.
+  /v1/integrations/template/preview:
+    get:
+      x-internal: false
+      operationId: previewTemplateInstall
+      tags:
+        - Templates
+      summary: Preview a template install from an uploaded zip
+      description: |-
+        Previews the resources that would be created by installing a template
+        from an uploaded zip file. The `runKey` query parameter ties this request
+        to a previously uploaded zip (obtained from `GET /v1/s3SignedURL`).
+      parameters:
+        - name: runKey
+          in: query
+          required: true
+          description: |-
+            The `runKey` returned by `GET /v1/s3SignedURL` after uploading the
+            template zip file.
+          schema:
+            type: string
+            examples:
+              - abc123def456
+      responses:
+        '200':
+          description: Preview of resources the template would create.
+          content:
+            application/json:
+              schema:
+                type: object
+                description: Preview envelope with resource docs.
+                additionalProperties: true
+              examples:
+                preview:
+                  summary: Template that creates an integration and one connection
+                  value:
+                    stackRequired: false
+                    objects:
+                      - model: Integration
+                        doc:
+                          _id: 6405b9d73496e05ff253d587
+                          name: Shopify - NetSuite
+                          description: Sync Abandoned Checkouts, Collects, … between Shopify and NetSuite.
+                      - model: Connection
+                        doc:
+                          _id: 61f92026dd053843b5d72350
+                          type: netsuite
+                          name: NetSuite Connection
+                          netsuite:
+                            wsdlVersion: '2020.2'
+                            concurrencyLevel: 1
+        '400':
+          description: Missing required `runKey` query parameter.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                missingRunKey:
+                  value:
+                    errors:
+                      - code: missing_required_field
+                        message: runKey is required.
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '404':
+          description: The `runKey` does not match any uploaded zip.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                invalidKey:
+                  value:
+                    errors:
+                      - code: invalid_key
+                        message: The specified runKey was not found.
+  /v1/integrations/template:
+    post:
+      x-internal: false
+      operationId: installTemplateFromZip
+      tags:
+        - Templates
+      summary: Install a template from an uploaded zip
+      description: |-
+        Installs a template from a previously uploaded zip file. The `runKey`
+        in the request body ties this request to the zip upload (obtained from
+        `GET /v1/s3SignedURL`).
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              description: The `runKey` from the zip upload.
+              properties:
+                runKey:
+                  type: string
+                  description: |-
+                    The `runKey` returned by `GET /v1/s3SignedURL` after uploading
+                    the template zip file.
+                  examples:
+                    - abc123def456
+              required:
+                - runKey
+            examples:
+              default:
+                value:
+                  runKey: abc123def456
+      responses:
+        '200':
+          description: Template installed from uploaded zip.
+          content:
+            application/json:
+              schema:
+                type: object
+                description: The created integration and related resources.
+                additionalProperties: true
+              examples:
+                installed:
+                  summary: Integration created from the uploaded zip
+                  value:
+                    _integrationId: 6405b9d73496e05ff253d587
+        '400':
+          description: Missing required `runKey` in request body.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                missingRunKey:
+                  value:
+                    errors:
+                      - code: missing_required_field
+                        message: runKey is required.
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '403':
+          $ref: '#/components/responses/403-forbidden'
+        '404':
+          description: The `runKey` does not match any uploaded zip.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                invalidKey:
+                  value:
+                    errors:
+                      - code: invalid_key
+                        message: The specified runKey was not found.
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+  parameters:
+    After:
+      name: after
+      in: query
+      required: false
+      description: |-
+        Opaque cursor for forward pagination. Pass the value from the `Link`
+        response header (`rel="next"`) to fetch the next page.
+      schema:
+        type: string
+  schemas:
+    ResourceResponse:
+      type: object
+      description: Response
+      x-celigo-ai-guidance:
+        - Core response fields shared by all Celigo resources
+      properties:
+        _id:
+          type: string
+          format: objectId
+          readOnly: true
+          description: Unique identifier for the resource. Format is a 24-character hexadecimal string.
+          x-celigo-ai-guidance:
+            - |-
+              The _id is used in:
+              - API endpoints that operate on a specific resource (e.g., GET, PUT, DELETE)
+              - References from other resources (e.g., flows that use this resource)
+              - Job history and error tracking
+          examples:
+            - 5f8d43a1b9e5a80011a35f2c
+        createdAt:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Timestamp when the resource was created. Set automatically and cannot be modified.
+          x-celigo-ai-guidance:
+            - Recorded in ISO 8601 with a UTC timezone (Z suffix).
+          examples:
+            - '2023-04-01T09:15:32Z'
+        lastModified:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Timestamp when the resource was last updated. Changes whenever any property is modified.
+          x-celigo-ai-guidance:
+            - Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
+          examples:
+            - '2023-04-15T14:30:15Z'
+        deletedAt:
+          type:
+            - string
+            - 'null'
+          format: date-time
+          readOnly: true
+          description: Timestamp when the resource was soft-deleted. When null or absent, the resource is active.
+          x-celigo-ai-guidance:
+            - Non-null means the resource is soft-deleted (in the recycle bin) — recoverable within the retention period before permanent removal.
+          examples:
+            - '2023-05-20T11:45:32Z'
+      required:
+        - _id
+    Template:
+      type: object
+      required:
+        - _id
+        - name
+        - lastModified
+      description: |-
+        A template resource as returned by the API.
+
+        Fields that are `false` or empty may be omitted from the response
+        (e.g. `published` is omitted when the template is unpublished,
+        `imageURL` is omitted when not set).
+      allOf:
+        - $ref: '#/components/schemas/ResourceResponse'
+        - type: object
+          properties:
+            name:
+              type: string
+              maxLength: 100
+              description: Display name of the template.
+              examples:
+                - Salesforce to NetSuite sync
+            description:
+              type: string
+              description: Longer description shown in the marketplace.
+              examples:
+                - Bi-directional sync of contacts between Salesforce and NetSuite.
+            imageURL:
+              type: string
+              description: |-
+                URL of the template's marketplace image. Omitted when never
+                set; may be an empty string when the field was cleared.
+              examples:
+                - https://example.com/images/sf-ns.png
+            websiteURL:
+              type: string
+              description: |-
+                URL to the partner's website or template landing page. May be
+                an empty string when the field was cleared; legacy values may
+                lack a scheme (e.g. `www.example.com`).
+              examples:
+                - https://example.com/templates/sf-ns
+            contactEmail:
+              type: string
+              description: |-
+                Contact email(s) for template support — a single address or a
+                comma-separated list of addresses.
+              examples:
+                - partner@example.com
+                - support@example.com,ops@example.com
+            published:
+              type: boolean
+              description: |-
+                Whether the template is published to the marketplace. Omitted
+                from the response when `false`. Can only be set to `true` after
+                a template zip file has been uploaded via `GET /v1/s3SignedURL`.
+            applications:
+              type: array
+              items:
+                type: string
+              description: |-
+                Application identifiers associated with this template.
+                Values may be application slugs (e.g. `salesforce`) or
+                Mongo ObjectIds.
+            free:
+              type: boolean
+              description: When true, the template is free to install with no license requirement.
+              readOnly: true
+            numInstalls:
+              type: integer
+              description: Number of times this template has been installed.
+              readOnly: true
+              minimum: 0
+              examples:
+                - 42
+    Error:
+      type: object
+      description: Standard error response envelope returned by integrator.io APIs.
+      properties:
+        errors:
+          type: array
+          description: List of errors that occurred while processing the request.
+          items:
+            type: object
+            properties:
+              code:
+                oneOf:
+                  - type: string
+                  - type: integer
+                description: |-
+                  Machine-readable error code. Usually a string like
+                  `invalid_ref`, `missing_required_field`, or `unauthorized`;
+                  may be an **integer** when the error mirrors an upstream HTTP
+                  status (e.g. `500`) — most commonly returned by connection-ping
+                  and adaptor-proxy responses.
+              message:
+                type: string
+                description: Human-readable description of the error.
+              field:
+                type: string
+                description: |-
+                  Optional pointer to the document field that caused the error.
+                  Used by structural validation errors (`missing_required_field`,
+                  `invalid_ref`) to indicate which field is at fault
+                  (e.g. `_id`, `type`, `http.baseURI`).
+              source:
+                type: string
+                description: |-
+                  Optional origin layer for the error — e.g. `application` when
+                  the error came from the remote system the adaptor called,
+                  `connector` when the adaptor itself rejected the request.
+            required:
+              - message
+      required:
+        - errors
+    TemplateInput:
+      type: object
+      description: |-
+        Request body for creating or updating a template. `name` is always
+        required, even on PUT. `published` can only be set to `true` after
+        uploading a template zip via `GET /v1/s3SignedURL`.
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          maxLength: 100
+          description: Display name of the template.
+          examples:
+            - Salesforce to NetSuite sync
+        description:
+          type: string
+          description: Longer description shown in the marketplace.
+          examples:
+            - Bi-directional sync of contacts between Salesforce and NetSuite.
+        imageURL:
+          type: string
+          description: |-
+            URL of the template's marketplace image. Send an empty string to
+            clear it.
+          examples:
+            - https://example.com/images/sf-ns.png
+        websiteURL:
+          type: string
+          description: |-
+            URL to the partner's website or template landing page. Send an
+            empty string to clear it.
+          examples:
+            - https://example.com/templates/sf-ns
+        contactEmail:
+          type: string
+          description: |-
+            Contact email(s) for template support — a single address or a
+            comma-separated list of addresses.
+          examples:
+            - partner@example.com
+            - support@example.com,ops@example.com
+        published:
+          type: boolean
+          description: |-
+            Set to `true` to publish the template to the marketplace (requires
+            a zip upload first). Set to `false` to unpublish.
+        applications:
+          type: array
+          items:
+            type: string
+          description: |-
+            Application identifiers to associate with this template.
+            Values may be application slugs (e.g. `salesforce`) or
+            Mongo ObjectIds.
+  responses:
+    401-unauthorized:
+      description: |-
+        Unauthorized. The request lacks a valid bearer token, or the provided token
+        failed to authenticate.
+
+        Note: the 401 response is produced by the auth middleware **before** the
+        request reaches the endpoint handler, so it does **not** follow the
+        standard `{errors: [...]}` envelope. Instead the body is a bare
+        `{message: string}` object with no `code`, no `errors` array. Callers
+        handling 401s should key off the HTTP status and the `message` string,
+        not try to destructure an `errors[]`.
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              message:
+                type: string
+                description: |-
+                  Human-readable description of the auth failure. Known values:
+                  - `"Unauthorized"` — no `Authorization` header on the request.
+                  - `"Bearer Authentication Failed"` — header present but token
+                    is invalid, revoked, or expired.
+            required:
+              - message
+          examples:
+            missing_token:
+              summary: No Authorization header sent
+              value:
+                message: Unauthorized
+            invalid_token:
+              summary: Bearer token invalid or revoked
+              value:
+                message: Bearer Authentication Failed
+    403-forbidden:
+      description: |
+        Forbidden. The authenticated caller does not have permission to perform this operation.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            default:
+              value:
+                errors:
+                  - code: forbidden
+                    message: You do not have permission to access this resource.
+    422-unprocessable-entity:
+      description: |
+        Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            default:
+              value:
+                errors:
+                  - code: unprocessable_entity
+                    message: The request could not be processed due to a semantic error.
+    404-not-found:
+      description: |
+        Not found. The requested resource does not exist or is not visible to the caller.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            default:
+              value:
+                errors:
+                  - code: not_found
+                    message: The requested resource was not found.
+    400-bad-request:
+      description: |
+        Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          examples:
+            default:
+              value:
+                errors:
+                  - code: invalid_request
+                    message: The request body failed validation.
+x-enable-proxy: true
+x-internal: false