APIs.io Engineering Platform Schema API

The **Schema** endpoints enable you to manage your API definitions. These endpoints also support multi-file schema.

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

OpenAPI Specification

engineering-platform-schema-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Schema API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Schema
  description: The **Schema** endpoints enable you to manage your API definitions. These endpoints also support multi-file schema.
paths:
  /apis/{apiId}/schemas:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/v10Accept'
    post:
      summary: APIs.io Engineering Platform Create a schema
      description: Creates a schema for an API.
      operationId: createApiSchema
      tags:
      - Schema
      requestBody:
        $ref: '#/components/requestBodies/createApiSchema'
      responses:
        '200':
          $ref: '#/components/responses/createApiSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema400ErrorInvalidParams'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Schema Already Exists:
                  $ref: '#/components/examples/apiSchema400ErrorInvalidParams'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorInstanceNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/schemas/{schemaId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiSchemaId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get a schema
      description: 'Gets information about API schema. You can use the `versionId` query parameter to get a schema published in an API version.


        You can use this API to do the following:


        - Get a schema''s metadata.

        - Get all the files in a schema. This only returns the first file in the schema. The endpoint response contains a link to the next set of response results.

        - Get a schema''s contents in multi-file or bundled format.


        **Note:**


        The `versionId` query parameter is a required parameter for API viewers.

        '
      operationId: getApiSchema
      tags:
      - Schema
      responses:
        '200':
          $ref: '#/components/responses/getApiSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema400ErrorNotLinked'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Schema Not Linked to API:
                  $ref: '#/components/examples/apiSchema400ErrorNotLinked'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/api404ErrorInstanceNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiVersionQuery'
      - $ref: '#/components/parameters/apiSchemaOutput'
  /apis/{apiId}/schemas/{schemaId}/files:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiSchemaId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get schema files
      description: 'Gets the files in an API schema. You can use the `versionId` query parameter to get schema files published in an API version.


        **Note:**


        The `versionId` query parameter is a required parameter for API viewers.

        '
      operationId: getApiSchemaFiles
      tags:
      - Schema
      responses:
        '200':
          $ref: '#/components/responses/getApiSchemaFiles'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema400ErrorNotLinked'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Schema Not Linked to API:
                  $ref: '#/components/examples/apiSchema400ErrorNotLinked'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorInstanceNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiVersionQuery'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
  /apis/{apiId}/schemas/{schemaId}/files/{file-path}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiSchemaId'
    - $ref: '#/components/parameters/file-path'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get schema file contents
      description: 'Gets an API schema file contents at the defined path. You can use the `versionId` query parameter to get schema file contents published in an API version.


        **Note:**


        The `versionId` query parameter is a required parameter for API viewers.

        '
      operationId: getApiSchemaFileContents
      tags:
      - Schema
      responses:
        '200':
          $ref: '#/components/responses/getApiSchemaFileContents'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema400ErrorNotLinked'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Schema Not Linked to API:
                  $ref: '#/components/examples/apiSchema400ErrorNotLinked'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorInstanceNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/apiVersionQuery'
    put:
      summary: APIs.io Engineering Platform Create or update a schema file
      description: 'Creates or updates an API schema file.


        **Note:**


        - If the provided file path exists, the file is updated with the new contents.

        - If the provided file path does not exist, then a new schema file is created.

        - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the file path is the `dir/schema.json` value, then a `dir` folder is created with the `schema.json` file inside.

        - You can only update the `root` tag for protobuf specifications.

        '
      operationId: createUpdateApiSchemaFile
      tags:
      - Schema
      requestBody:
        $ref: '#/components/requestBodies/createUpdateApiSchemaFile'
      responses:
        '200':
          $ref: '#/components/responses/createUpdateApiSchemaFile'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema400ErrorNotLinked'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Schema Not Linked to API:
                  $ref: '#/components/examples/apiSchema400ErrorNotLinked'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/apiSchema404ErrorNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a schema file
      description: Deletes a file in an API schema. On success, this returns an HTTP `204 No Content` response.
      operationId: deleteApiSchemaFile
      tags:
      - Schema
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema400ErrorNotLinked'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                Schema Not Linked to API:
                  $ref: '#/components/examples/apiSchema400ErrorNotLinked'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiSchema403ErrorForbidden'
                - $ref: '#/components/schemas/featureUnavailable403Error'
              examples:
                Forbidden:
                  $ref: '#/components/examples/apiSchema403ErrorForbidden'
                Feature Unavailable:
                  $ref: '#/components/examples/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/api404ErrorInstanceNotFound'
        '422':
          $ref: '#/components/responses/gitLinkedApi422Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  responses:
    createApiSchema:
      description: Created
      content:
        application/json:
          schema:
            type: object
            description: Information about the created API schema.
            properties:
              id:
                type: string
                description: The schema's ID.
                example: b4fc1bdc-6587-4f9b-95c9-f768146089b4
              type:
                type: string
                description: The schema's type.
                enum:
                - proto:2
                - proto:3
                - graphql
                - openapi:3_1
                - openapi:3
                - openapi:2
                - openapi:1
                - raml:1
                - raml:0_8
                - wsdl:2
                - wsdl:1
                - asyncapi:2
                example: openapi:3
              files:
                type: array
                description: The list of the schema's files.
                items:
                  type: object
                  title: Schema File Base Data
                  description: Information about the schema file.
                  properties:
                    id:
                      type: string
                      description: The schema file's ID.
                      example: b4fc1bdc-6587-4f9b-95c9-f768146089b4
                    name:
                      type: string
                      description: The schema file's name.
                      example: index.json
                    path:
                      type: string
                      description: The file system path to the schema file.
                      example: index.json
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the file was created.
                      example: '2023-03-29T11:37:15Z'
                    root:
                      type: object
                      description: An object that contains root file information.
                      properties:
                        enabled:
                          type: boolean
                          description: If true, the file is tagged as the schema's root file.
                          example: true
                    createdBy:
                      type: string
                      description: The user ID of the user that created the file.
                      example: '12345678'
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the file was last updated.
                      example: '2023-03-29T11:37:15Z'
                    updatedBy:
                      type: string
                      description: The user ID of the user that last updated the file.
                      example: '12345678'
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the schema was created.
                example: '2023-03-29T11:37:15Z'
              createdBy:
                type: string
                description: The user ID of the user that created the schema.
                example: '12345678'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the schema was last updated.
                example: '2023-03-29T11:37:15Z'
              updatedBy:
                type: string
                description: The user ID of the user that updated the schema.
                example: '12345678'
          example:
            type: openapi:3
            files:
            - createdBy: '12345678'
              path: index.json
              updatedBy: '12345678'
              updatedAt: '2024-07-18T13:17:30.000Z'
              root:
                enabled: true
              id: b4fc1bdc-6587-4f9b-95c9-f768146089b4
              name: index.json
              createdAt: '2024-07-18T13:17:30.000Z'
            updatedAt: '2024-07-18T13:17:30.000Z'
            createdAt: '2024-07-18T13:17:30.000Z'
            createdBy: '12345678'
            updatedBy: '12345678'
            id: b4fc1bdc-6587-4f9b-95c9-f768146089b4
    featureUnavailable403Error:
      description: Feature Unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/featureUnavailable403Error'
          example:
            value:
              type: https://api.postman.com/problems/forbidden
              title: Forbidden
              detail: This feature isn't available in your region.
              status: 403
    api401ErrorUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: An API key must be provided in the request header or query string
              status:
                type: number
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
              instance:
                type: string
                description: The URI reference that identifies the specific occurrence of the problem.
                example: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: An API key must be provided in the request header or query string
            status: 401
            instance: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D
    common500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
    gitLinkedApi422Error:
      description: Git-Linked API Errror
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: actionNotAllowedError
              title:
                type: string
                description: A short summary of the problem.
                example: Action not allowed
              detail:
                type: string
                description: Details about the error.
                example: This action is not allowed for Git linked APIs
          example:
            type: actionNotAllowedError
            title: Action not allowed
            detail: This action is not allowed for Git linked APIs
    createUpdateApiSchemaFile:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            title: Schema File Base Data
            description: Information about the schema file.
            properties:
              createdBy:
                type: string
                description: The user ID of the user that created the file.
                example: '12345678'
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the file was created.
                example: '2024-07-18T13:48:28.000Z'
              root:
                type: object
                description: Information about the schema's root file.
                properties:
                  enabled:
                    type: boolean
                    description: If true, the file is the schema's the root file.
                    example: true
              name:
                type: string
                description: The schema file's name.
                example: index.json
              path:
                type: string
                description: The file system path to the schema file.
                example: index.json
              updatedBy:
                type: string
                description: The user ID of the user that last updated the file.
                example: '12345678'
              id:
                type: string
                description: The schema file's ID.
                example: 2fdc8ea1-d02e-4e50-989e-6fa28f42b995
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the file was last updated.
                example: '2024-07-18T13:48:28.000Z'
          example:
            createdBy: '12345678'
            createdAt: '2024-07-18T13:47:39.000Z'
            root:
              enabled: true
            name: index.json
            path: index.json
            updatedBy: '12345678'
            id: 2fdc8ea1-d02e-4e50-989e-6fa28f42b995
            updatedAt: '2024-07-18T13:48:28.000Z'
    getApiSchema:
      description: Successful Response
      content:
        application/json:
          schema:
            anyOf:
            - type: object
              title: Get Schema
              description: Information about the schema.
              properties:
                id:
                  type: string
                  description: The schema's ID.
                  example: ae2b9ab2-28f2-401d-912f-eca09a78e98b
                type:
                  type: string
                  description: The schema's type.
                  example: openapi:3
                files:
                  type: object
                  description: Information about the schema's files. The response is paginated and limited to one page.
                  properties:
                    data:
                      type: array
                      description: A list of the schema files.
                      items:
                        title: Schema File Base Data
                        description: Information about the schema file.
                        type: object
                        properties:
                          id:
                            type: string
                            description: The schema file's ID.
                            example: cf98c187-17c1-455f-afbf-d4be51f12770
                          name:
                            type: string
                            description: The schema file's name.
                            example: s1.json
                          path:
                            type: string
                            description: The file system path to the schema file.
                            example: dir/s1.json
                          createdAt:
                            type: string
                            format: date-time
                            description: The date and time at which the file was created.
                            example: '2023-03-16T18:38:56.000Z'
                          createdBy:
                            type: string
                            description: The user ID of the user that created the file.
                            example: '5000842'
                          updatedAt:
                            type: string
                            format: date-time
                            description: The date and time at which the file was last updated.
                            example: '2023-03-16T19:11:24.000Z'
                          updatedBy:
                            type: string
                            description: The user ID of the user that last updated the file.
                            example: '5000842'
                    meta:
                      type: object
                      properties:
                        nextPath:
                          type: string
                          description: The URL path to the next file.
                          example: /apis/1fdbff7c-036b-4f8a-91bc-17bf3ae74fd2/schemas/cf98c187-17c1-455f-afbf-d4be51f12770/files?cursor=eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJkaXIvczEuanNvbiJ9
                createdAt:
                  type: string
                  format: date-time
                  description: The date and time at which the schema was created.
                  example: '2022-03-29T11:37:15Z'
                createdBy:
                  type: string
                  description: The user ID of the user that created the schema.
                  example: '12345678'
                updatedAt:
                  type: string
                  format: date-time
                  description: The date and time at which the schema was last updated.
                  example: '2022-03-29T11:37:15Z'
                updatedBy:
                  type: string
                  description: The user ID of the user that last updated the schema.
                  example: '12345678'
            - type: object
              title: Get Bundled Schema
              description: Information about the schema.
              properties:
                id:
                  type: string
                  description: The schema's ID.
                  example: ae2b9ab2-28f2-401d-912f-eca09a78e98b
                type:
                  type: string
                  description: The schema's type.
                  example: openapi:3
                createdBy:
                  type: string
                  description: The user ID of the user that created the schema.
                  example: '12345678'
                updatedBy:
                  type: string
                  description: The user ID of the user that last updated the schema.
                  example: '12345678'
                createdAt:
                  type: string
                  format: date-time
                  example: '2022-03-29T11:37:15Z'
                  description: The date and time at which the schema was created.
                updatedAt:
                  type: string
                  format: date-time
                  description: The date and time at which the schema was last updated.
                  example: '2022-03-29T11:37:15Z'
                content:
                  type: string
                  description: The schema file, in a bundled format.
                  example: "openapi: '3.0.0'\ninfo:\n  version: '1.0.0'\n  title: 'Sample API'\n  description: Buy or rent spacecrafts\n\npaths:\n  /spacecrafts/{spacecraftId}:\n    parameters:\n      - name: spacecraftId\n        description: The unique identifier of the spacecraft\n        in: path\n        required: true\n        schema:\n          $ref: '#/components/schemas/SpacecraftId'\n    get:\n      summary: Read a spacecraft\n      responses:\n        '200':\n          description: The spacecraft corresponding to the provided `spacecraftId`\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Spacecraft'\n        404:\n          description: No spacecraft found for the provided `spacecraftId`\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\n        500:\n          description: Unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\ncomponents:\n  schemas:\n    SpacecraftId:\n      description: The unique identifier of a spacecraft\n      type: string\n    Spacecraft:\n      type: object\n      required:\n        - id\n        - names\n        - type\n      properties:\n        id:\n          $ref: '#/components/schemas/SpacecraftId'\n        name:\n          type: string\n        type:\n          type: string\n          enum:\n            - capsule\n            - probe\n            - satellite\n            - spaceplane\n            - station\n        description:\n          type: string\n    Error:\n      type: object\n      required:\n        - message\n      properties:\n        message:\n          description: A human readable error message\n          type: string\n  securitySchemes:\n    ApiKey:\n      type: apiKey\n      in: header\n      name: X-Api-Key\nsecurity:\n  - ApiKey: []"
          example:
            createdAt: '2022-03-29T11:37:15Z'
            updatedAt: '2022-03-29T11:37:15Z'
            files:
              meta

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-schema-api-openapi.yml