APIs.io Engineering Platform API Versions API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman API Versions API
  description: "The Postman API enables you to programmatically access data stored in your Postman account.\n\n> Certain endpoints may be unavailable depending on your region and/or Postman plan.\n\nFor a comprehensive set of examples of requests and responses, see the [**Postman API** collection](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a).\n\n## Getting started\n\nYou can get started with the Postman API by creating a copy of this definition in your workspace.\n\n### EU users\n\nFor users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.\n\n## About the Postman API\n\n- You must use a valid API Key to send requests to the API endpoints.\n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.\n- The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n- The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.\n- For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.\n- When calling the API Builder endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value.\n\n### IDs and UIDs\n\nAll items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:\n\n- An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.\n- The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID:\n    - `12345678` is the user's ID.\n    - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.\n\n### Enum values\n\nAny documented enum values should be considered partial lists and may change over time.\n\n### 403 response for unavailable features\n\nDepending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the \"This feature isn't available in your region.\" detail.\n\n### 503 response\n\nAn HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.\n\nIf the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Authentication\n\nPostman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.\n\nYou must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will use it to make API calls.\n\n### SCIM authentication\n\nWhile all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Rate and usage limits\n\nAPI access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. Postman Monitors, the GET `/collections`, and the GET `/workspaces` endpoint have a rate limit of **10 calls in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/).\n\nWhen you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:\n\n- `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API.\n- `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.\n\n## Support\n\nFor help regarding accessing the Postman API, you can:\n\n- Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.\n- Reach out to the [Postman community](https://community.postman.com/).\n- Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Policies\n\n- [Postman Terms of Service](http://www.postman.com/legal/terms/)\n- [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)\n"
  version: '1.0'
  termsOfService: https://www.postman.com/legal/terms/
  contact:
    name: Postman Support
    email: help@postman.com
    url: https://www.postman.com/community/
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
security:
- PostmanApiKey: []
- scimApiKey: []
tags:
- name: API Versions
  description: The **API Versions** endpoints enable you to manage your [API's versions](https://learning.postman.com/docs/designing-and-developing-your-api/versioning-an-api/versioning-an-api-overview/#publishing-an-api-version). Only users with the [API Admin](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#api-roles) or [Workspace Admin](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#workspace-roles) role can publish and manage versions.
paths:
  /apis/{apiId}/versions:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/v10Accept'
    get:
      summary: APIs.io Engineering Platform Get all versions
      description: Gets all the published versions of an API.
      operationId: getApiVersions
      tags:
      - API Versions
      responses:
        '200':
          $ref: '#/components/responses/getApiVersions'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/featureUnavailable403Error'
        '404':
          $ref: '#/components/responses/apiVersions404Response'
        '422':
          $ref: '#/components/responses/v9Unsupported'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/limit'
    post:
      summary: APIs.io Engineering Platform Create a version
      description: 'Creates a new API version asynchronously and immediately returns an HTTP `202 Accepted` response. The response contains a polling link to the task status API in the `Location` header.


        This endpoint is equivalent to publishing a version in Postman app, which is the snapshot of API collections and schema at a given point in time.

        '
      operationId: createApiVersion
      tags:
      - API Versions
      requestBody:
        $ref: '#/components/requestBodies/createApiVersion'
      responses:
        '202':
          $ref: '#/components/responses/createApiVersion'
        '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/apiVersions404Response'
        '422':
          $ref: '#/components/responses/apiVersion422ErrorStateInconsistent'
        '500':
          $ref: '#/components/responses/common500Error'
  /apis/{apiId}/versions/{versionId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/apiVersionId'
    - $ref: '#/components/parameters/v10Accept'
    put:
      summary: APIs.io Engineering Platform Update a version
      description: 'Updates an API version.


        **Note:**


        This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication.

        '
      operationId: updateApiVersion
      tags:
      - API Versions
      requestBody:
        $ref: '#/components/requestBodies/updateApiVersion'
      responses:
        '200':
          $ref: '#/components/responses/updateApiVersion'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/apiVersion404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a version
      description: 'Deletes an API version. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication.

        '
      operationId: deleteApiVersion
      tags:
      - API Versions
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/apiVersion400ErrorInstanceNotFound'
                - $ref: '#/components/schemas/v10HeaderMissing'
              examples:
                API Version Not Found:
                  $ref: '#/components/examples/apiVersion400ErrorInstanceNotFound'
                Missing v10 Accept Header:
                  $ref: '#/components/examples/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/api401ErrorUnauthorized'
        '403':
          $ref: '#/components/responses/api403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/apiVersion404ErrorNotFound'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  schemas:
    limit:
      type: integer
      default: 10
      example: 10
    apiVersion404ErrorNotFound:
      title: API Version Not Found
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: VersionNotFound
        title:
          type: string
          description: A short summary of the problem.
          example: API Version not found.
        detail:
          type: string
          description: Information about the error.
          example: We could not find the API Version you are looking for.
    apiVersionId:
      type: string
      example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
    apiVersion400ErrorInstanceNotFound:
      title: API Version Not Found
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
              description: The type of error.
              example: instanceNotFoundError
            message:
              type: string
              description: The error message.
              example: We could not find the API version you are looking for
    apiSchema403ErrorForbidden:
      title: Forbidden
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: ForbiddenError
        title:
          type: string
          description: A short summary of the problem.
          example: You are not permitted to perform the action.
        detail:
          type: string
          description: Information about the error.
          example: You do not have access to perform this operation.
    cursor:
      type: string
      example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
    featureUnavailable403Error:
      title: Feature Unavailable
      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/forbidden
        title:
          type: string
          description: A short summary of the problem.
          example: Forbidden
        detail:
          type: string
          description: Information about the error.
          example: This feature isn't available in your region.
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
    api404ErrorNotFound:
      title: API Not Found
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: instanceNotFoundError
        title:
          type: string
          description: A short summary of the problem.
          example: We could not find the API you are looking for
        detail:
          type: string
          description: Information about the error.
          example: We could not find the API you are looking for
    api403ErrorForbidden:
      title: Forbidden
      type: object
      properties:
        type:
          type: string
          description: The type of error.
          example: ForbiddenError
        title:
          type: string
          description: A short summary of the problem.
          example: You are not permitted to perform the action.
        detail:
          type: string
          description: Information about the error.
          example: Please ensure that you have required permissions
    v10HeaderMissing:
      title: Missing v10 Accept Header
      type: object
      properties:
        name:
          type: string
          description: The error name.
          example: instanceNotFoundError
        message:
          type: string
          description: The error message.
          example: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header.
  responses:
    v10HeaderMissing:
      description: Missing v10 Accept Header
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/v10HeaderMissing'
          examples:
            Missing v10 Accept Header:
              $ref: '#/components/examples/v10HeaderMissing'
    updateApiVersion:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
                description: The version's ID.
                example: 8d7ba74e-2c36-4e36-a263-f3c0c9ae21d2
              name:
                type: string
                description: The version's name.
                example: Release 1.5
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the version was created.
                example: '2022-06-09T14:48:45.000Z'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the version was last updated.
                example: '2022-06-09T19:50:49.000Z'
              releaseNotes:
                type: string
                description: The version's release notes.
                example: This is the first public release update.
          example:
            createdAt: '2022-06-09T14:48:45.000Z'
            updatedAt: '2022-06-09T19:50:49.000Z'
            id: 8d7ba74e-2c36-4e36-a263-f3c0c9ae21d2
            name: Release 1.5
            releaseNotes: This is the first public release update.
    v9Unsupported:
      description: v9 Unsupported
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: unsupportedEntityError
              title:
                type: string
                description: A short summary of the problem.
                example: Unsupported API
              detail:
                type: string
                description: Details about the error.
                example: This endpoint does not support v9 APIs.
          example:
            type: unsupportedEntityError
            title: Unsupported API
            detail: This endpoint does not support v9 APIs.
    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
    api403ErrorAndFeatureUnavailable:
      description: Forbidden
      content:
        application/json:
          schema:
            anyOf:
            - $ref: '#/components/schemas/api403ErrorForbidden'
            - $ref: '#/components/schemas/featureUnavailable403Error'
          examples:
            Forbidden:
              $ref: '#/components/examples/api403ErrorForbidden'
            Feature Unavailable:
              $ref: '#/components/examples/featureUnavailable403Error'
    apiVersions404Response:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/api404ErrorNotFound'
          examples:
            API Not Found:
              $ref: '#/components/examples/api404ErrorNotFound'
    getApiVersions:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            description: Information about the API's versions.
            properties:
              meta:
                type: object
                description: The response's meta information for paginated results.
                properties:
                  limit:
                    type: integer
                    description: The maximum number of records in the paginated response.
                    example: 100
                  total:
                    type: integer
                    description: The number of records that match the defined criteria.
                    example: 1000
                  nextCursor:
                    type: string
                    format: base64
                    description: The pagination cursor that points to the next record in the results set.
                    example: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
              versions:
                type: array
                items:
                  type: object
                  title: API Version Data Schema
                  description: Information about the API version.
                  properties:
                    id:
                      type: string
                      description: The version's ID.
                      example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                    name:
                      type: string
                      description: The version's name.
                      example: Release 1.0
                    createdAt:
                      type: string
                      format: date-time
                      description: The date and time at which the version was created.
                      example: '2023-06-09T14:48:45.000Z'
                    updatedAt:
                      type: string
                      format: date-time
                      description: The date and time at which the version was last updated.
                      example: '2023-06-09T14:48:45.000Z'
                    releaseNotes:
                      type: string
                      description: The version's release notes.
                      example: This is the first release.
          example:
            versions:
            - createdAt: '2022-06-09T14:48:45.000Z'
              updatedAt: '2022-06-09T19:50:49.000Z'
              id: 07d940bf-40fc-4acd-a11e-be6769894af0
              name: Release 2.0
              releaseNotes: This is the second release of the Test API.
            - createdAt: '2022-06-09T14:48:45.000Z'
              updatedAt: '2022-06-09T19:50:49.000Z'
              id: 3563baaa-07a2-46ed-9fd2-0e8a3c5f7ec2
              name: Release 1.0
              releaseNotes: This is the first release of the Test API. For more information, read the documentation.
            meta:
              nextCursor: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk=
              limit: 2
              total: 1000
    createApiVersion:
      description: Accepted
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
                description: The version's ID.
                example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the version was created.
                example: '2023-06-09T14:48:45.000Z'
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the version was last updated.
                example: '2023-06-09T19:50:49.000Z'
              name:
                type: string
                description: The version's name.
                example: v1
              releaseNotes:
                type: string
                description: Information about the API version release. For example, changelog notes.
                example: This is the first release.
          example:
            createdAt: '2023-06-09T14:48:45.000Z'
            updatedAt: '2023-06-09T19:50:49.000Z'
            id: 12ece9e1-2abf-4edc-8e34-de66e74114d2
            name: v1
            releaseNotes: This is the first release.
      headers:
        Location:
          $ref: '#/components/headers/Location'
    apiVersion422ErrorStateInconsistent:
      description: API State Inconsistent
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: APIStateInconsistent
              title:
                type: string
                description: A short summary of the problem.
                example: API state seems to be inconsistent.
              detail:
                type: string
                description: Details about the error.
                example: Please perform a Git push from the Postman app to sync state between app and repository.
          example:
            type: APIStateInconsistent
            title: API state seems to be inconsistent.
            detail: Please perform a Git push from the Postman app to sync state between app and repository.
    apiVersion404ErrorNotFound:
      description: API Version Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/apiVersion404ErrorNotFound'
          examples:
            API Version Not Found:
              $ref: '#/components/examples/apiVersion404ErrorNotFound'
    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
  parameters:
    apiVersionId:
      name: versionId
      in: path
      required: true
      description: The API's version ID.
      schema:
        $ref: '#/components/schemas/apiVersionId'
    cursor:
      name: cursor
      in: query
      description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
      schema:
        $ref: '#/components/schemas/cursor'
    apiId:
      name: apiId
      in: path
      required: true
      description: The API's ID.
      schema:
        type: string
        example: 90ca9f5a-c4c4-11ed-afa1-0242ac120002
    v10Accept:
      name: Accept
      in: header
      required: true
      description: The `application/vnd.api.v10+json` request header required to use the endpoint.
      schema:
        type: string
        enum:
        - application/vnd.api.v10+json
        example: application/vnd.api.v10+json
    limit:
      name: limit
      in: query
      description: The maximum number of rows to return in the response.
      schema:
        $ref: '#/components/schemas/limit'
  examples:
    apiVersion404ErrorNotFound:
      value:
        type: VersionNotFound
        title: API Version not found.
        details: We could not find the API Version you are looking for.
    apiVersion400ErrorInstanceNotFound:
      value:
        error:
          name: instanceNotFoundError
          message: We could not find the API version you are looking for
    api403ErrorForbidden:
      value:
        title: You are not permitted to perform the action.
        detail: Please ensure that you have required permissions
        type: ForbiddenError
    apiSchema403ErrorForbidden:
      value:
        title: You are not permitted to perform the action.
        detail: You do not have access to perform this operation.
        type: ForbiddenError
    featureUnavailable403Error:
      value:
        type: https://api.postman.com/problems/forbidden
        title: Forbidden
        detail: This feature isn't available in your region.
        status: 403
    v10HeaderMissing:
      value:
        name: instanceNotFoundError
        message: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header.
    api404ErrorNotFound:
      value:
        type: instanceNotFoundError
        title: We could not find the API you are looking for
        detail: We could not find the API you are looking for.
  requestBodies:
    createApiVersion:
      content:
        application/json:
          schema:
            anyOf:
            - type: object
              title: Create Version Schema (Not Git-Linked)
              description: Information about the API version.
              required:
              - name
              - schemas
              - collections
              properties:
                name:
                  type: string
                  description: The version's name.
                  example: v1
                schemas:
                  type: array
                  description: A list of the version's schemas.
                  items:
                    type: object
                    description: Information about the schema.
                    properties:
                      id:
                        type: string
                        description: The schema's ID.
                        example: 5381f010-c4c1-11ed-afa1-0242ac120002
                collections:
                  type: array
                  description: A list of the version's collections.
                  items:
                    type: object
                    description: Information about the collection.
                    properties:
                      id:
                        type: string
                        description: The collection's ID.
                        example: 123456-12ece9e1-2abf-4edc-8e34-de66e74114d2
                releaseNotes:
                  type: string
                  description: Information about the API version release. For example, changelog notes.
                  example: This is the first release.
            - type: object
              title: Create Version Schema (Git-Linked with root File)
              description: Information about the API version.
              required:
              - name
              - branch
              - schemas
              - collections
              properties:
                name:
                  type: string
                  description: The version's name.
                  example: v1
                branch:
                  type: string
                  description: The branch ID.
                  example: develop
                schemas:


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