AsyncAPI Convert API

openapi: 3.2.0
info:
  version: 0.2.0
  title: AsyncAPI Server Convert API
  description: Server API providing official AsyncAPI tools
  contact:
    name: AsyncAPI Initiative
    email: info@asyncapi.io
    url: https://asyncapi.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.asyncapi.com/v1
tags:
- name: Convert
paths:
  /convert:
    post:
      summary: Convert the given AsyncAPI/OpenAPI document to AsyncAPI document with the…
      operationId: convert
      tags:
      - Convert
      externalDocs:
        name: Github Repository for the AsyncAPI Converter
        url: https://github.com/asyncapi/converter-js
      requestBody:
        description: Parameters to convert the spec.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConvertRequest'
      responses:
        '200':
          description: AsyncAPI document successfully converted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertResponse'
        '400':
          description: Failed to convert due to invalid AsyncAPI document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Failed to convert the given document due to invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Unexpected problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          default: about:blank
          example: https://api.asyncapi.com/problem/invalid-template-parameters
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable.

            '
          example: Invalid AsyncAPI document.
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          minimum: 100
          maximum: 600
          exclusiveMaximum: true
          example: 422
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
        instance:
          type: string
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
      required:
      - type
      - title
      - status
      additionalProperties: true
    ConvertRequest:
      type: object
      required:
      - source
      - format
      properties:
        source:
          description: The source document to be converted.
          oneOf:
          - $ref: '#/components/schemas/AsyncAPIDocument'
          - $ref: '#/components/schemas/OpenAPIDocument'
        target-version:
          description: The version of the AsyncAPI document to be converted to (only applicable for AsyncAPI documents).
          $ref: '#/components/schemas/SpecVersions'
        perspective:
          type: string
          description: The perspective of the conversion, e.g. "server", "client".
          default: server
          enum:
          - server
          - client
        format:
          type: string
          description: The format of the source document to be converted.
          enum:
          - asyncapi
          - openapi
    AsyncAPIDocument:
      description: AsyncAPI document in JSON or YAML.
      oneOf:
      - type: string
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.0.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.1.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.2.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.3.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.4.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.5.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.6.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/3.0.0.json
      - $ref: https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/3.1.0.json
    OpenAPIDocument:
      type: string
      description: OpenAPI document in JSON or YAML.
      oneOf:
      - type: string
      - $ref: https://spec.openapis.org/oas/3.0/schema/2024-10-18
    SpecVersions:
      type: string
      description: Valid specification versions for the AsyncAPI document.
      default: latest
      enum:
      - 2.0.0
      - 2.1.0
      - 2.2.0
      - 2.3.0
      - 2.4.0
      - 2.5.0
      - 2.6.0
      - 3.0.0
      - 3.1.0
      - latest
    ConvertResponse:
      type: object
      properties:
        converted:
          $ref: '#/components/schemas/AsyncAPIDocument'
x-provenance:
  method: harvested
  publisher: AsyncAPI
  source: https://api.asyncapi.com/v1/docs/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)