Netcracker Export API

openapi: 3.2.0
info:
  title: APIHUB Registry – External Export API
  description: 'Public-facing API contract for APIHUB. This API is intended for external and integration clients and covers package/catalog operations, publication workflows, search, user/profile actions, and selected administration capabilities secured by APIHUB authentication schemes.

    '
  contact:
    name: Netcracker Opensource Group
    email: opensourcegroup@netcracker.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '2026.1'
  x-api-kind: BWC
servers:
- url: https://{apihub}.qubership.org
  description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
  variables:
    apihub:
      description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
      enum:
      - apihub
      - dev.apihub
      - staging.apihub
      default: apihub
security:
- BearerAuth: []
- CookieAuth: []
- api-key: []
- PersonalAccessToken: []
tags:
- name: Export
  description: Export API documentation.
paths:
  /api/v1/export:
    post:
      tags:
      - Export
      summary: Async export of version, document or operations group
      description: 'Start export of package version, one document or operations group. Use ```GET /api/v1/export/{exportId}/status``` to get status of export and exported file itself.\

        Export of document is currently available for documents with type openapi-3-1, openapi-3-0, or openapi-2-0 and is intended to retrieve content with some transformations. For other document types, use GET /api/v2/packages/{packageId}/versions/{version}/files/{slug} to obtain the original document content.\

        Export of operations group is currently available for groups with apiType = REST, GraphQL or AsyncAPI.

        '
      operationId: postExport
      requestBody:
        description: "Defines an entity that shall be exported and export settings.\\\nThe following entities can be exported:\n  - **version** - export of all documents from the version.\n  - **OpnAPI document** - export of one specific document with type openapi-3-1, openapi-3-0, or openapi-2-0.\n  - **REST operations group** - export of operations group. Only operations group with apiType = REST can be exported.\n  - **GraphQL operations group** - export of operations group. Only operations group with apiType = GraphQL can be exported.\n  - **AsyncAPI operations group** - export of operations group. Only operations group with apiType = AsyncAPI can be exported.\n"
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/ExportVersion'
              - $ref: '#/components/schemas/ExportRestDocument'
              - $ref: '#/components/schemas/ExportRestOperationsGroup'
              - $ref: '#/components/schemas/ExportGraphqlOperationsGroup'
              - $ref: '#/components/schemas/ExportAsyncapiOperationsGroup'
              discriminator:
                propertyName: exportedEntity
      responses:
        '202':
          description: Export process started
          content:
            application/json:
              schema:
                type: object
                properties:
                  exportId:
                    type: string
                    description: Export process Id
                    format: uuid
                    example: 9c8e9045-dd9c-4946-b9e4-e05e3f41c4cc
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v1/export/{exportId}/status:
    parameters:
    - name: exportId
      description: Export process id.
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9c8e9045-dd9c-4946-b9e4-e05e3f41c4cc
    get:
      tags:
      - Export
      summary: Get status of async export
      description: 'Get status of async export operation (POST /api/v1/export). If file for export is ready, then it will be returned. The resulting file is stored temporarily; once deleted, it needs to be re-calculated.

        '
      operationId: getExportIdStatus
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    description: 'Export process status.\

                      "none" status means - not started.

                      '
                    type: string
                    enum:
                    - running
                    - error
                    - none
                  message:
                    description: The message for **error** status.
                    type: string
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: 'File to download.

                  '
          headers:
            Content-Disposition:
              schema:
                type: string
                description: "File name for exported entity.\n  - if version was exported: <packageId>_<version>.<extension>\n  - if document was exported: <packageId>_<version>_<file name>.<extension>\n  - if operations group was exported: <packageId>_<version>_<group name>.<extension>\n"
                example: attachment; filename="PCKG1.zip"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Unauthorized:
                  $ref: '#/components/examples/Unauthorized'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
                FileNotFound:
                  $ref: '#/components/examples/FileNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v2/packages/{packageId}/versions/{version}/sources:
    parameters:
    - $ref: '#/components/parameters/packageId'
    - name: version
      in: path
      description: Package version. The mask <version>@<revision> may be used to get resouces of the specific revision. If the @revision is not provided, the latest version's revision will be used.
      required: true
      schema:
        type: string
        example: '2022.3'
    get:
      tags:
      - Export
      summary: Export sources of package version
      description: 'Export sources of package version as a zip archive.

        '
      operationId: getPackagesIdVersionsIdSources
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: ZIP file with pacakge version sources to download
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
                FileNotFound:
                  $ref: '#/components/examples/FileNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v3/packages/{packageId}/versions/{version}/{apiType}/export/groups/{groupName}/buildType/{buildType}:
    parameters:
    - $ref: '#/components/parameters/packageId'
    - $ref: '#/components/parameters/version'
    - name: apiType
      description: Type of the API.
      in: path
      required: true
      schema:
        type: string
        enum:
        - rest
    - name: buildType
      description: 'Type of the build process for OpeanAPI specification tranformation. Available options are:

        - **reducedSourceSpecifications** - proccess that finds source specifications for all operations from operation group and removes from these specifications operations other than those that are included into operation group.

        - **mergedSpecification** - process the merges all operations from an operation group into one specification.

        '
      in: path
      required: true
      schema:
        type: string
        enum:
        - reducedSourceSpecifications
        - mergedSpecification
    - name: groupName
      in: path
      required: true
      description: Name of the operation group
      schema:
        type: string
    get:
      deprecated: true
      x-deprecation-reason: POST /api/v1/export shall be used instead of the current operation.
      tags:
      - Export
      summary: Export operations group as OpenAPI documents
      description: 'Export all operations from an operations group (with apiType = REST API) as OpenAPI specification(s).

        '
      operationId: getPackagesIdVersionsIdExportGroupNameV3
      parameters:
      - name: format
        in: query
        required: true
        description: 'Format of the exported file.\

          If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\

          If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType.

          '
        schema:
          type: string
          enum:
          - yaml
          - json
          - html
          default: json
      responses:
        '200':
          description: Success
          content:
            application/zip:
              schema:
                type: string
                format: binary
                description: ZIP file to download. ZIP will be returned if buildType = reducedSourceSpecifications
            application/json:
              schema:
                type: string
                format: binary
                description: JSON file to download. JSON will be returned if buidType = mergedspecification and format = json
            application/yaml:
              schema:
                type: string
                format: binary
                description: YAML file to download. YAML will be returned if buidType = mergedspecification and format = yaml
          headers:
            Content-Disposition:
              schema:
                type: string
                description: File name
                example: attachment; filename="<groupName>_<package.id>_<version>.zip"
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v2/packages/{packageId}/versions/{version}/files/{slug}/doc:
    parameters:
    - $ref: '#/components/parameters/packageId'
    - $ref: '#/components/parameters/version'
    - $ref: '#/components/parameters/slug'
    get:
      deprecated: true
      x-deprecation-reason: POST /api/v1/export shall be used instead of the current operation.
      tags:
      - Export
      summary: Export offline API documentation by selected file
      description: 'Export of offline API documentation by selected file as a zip archive.

        Type of the documentation file is provided as input parameters:

        - interactive - html document

        - raw - yaml/json document.

        '
      operationId: getPackagesIdVersionsIdFilesSlugDoc
      parameters:
      - name: docType
        in: query
        description: Type of the exported documentation.
        required: false
        schema:
          type: string
          enum:
          - interactive
          - raw
          default: interactive
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: Documentation ZIP file (if docType = interactive) or yaml/json (if docType = raw) to download
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
                FileNotFound:
                  $ref: '#/components/examples/FileNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v2/packages/{packageId}/versions/{version}/sourceData:
    parameters:
    - $ref: '#/components/parameters/packageId'
    - $ref: '#/components/parameters/version'
    get:
      tags:
      - Export
      summary: Export sources of package version with build config
      description: 'Export sources of package version as a zip archive and build configuration that was used for this version.

        '
      operationId: getPackageVersionSourcesWithBuildConfig
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: Build configuration and ZIP file with package version sources to download
                properties:
                  sources:
                    type: string
                    description: ZIP file with package version sources to download
                  config:
                    $ref: '#/components/schemas/BuildConfig'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
                FileNotFound:
                  $ref: '#/components/examples/FileNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v2/packages/{packageId}/versions/{version}/doc:
    parameters:
    - $ref: '#/components/parameters/packageId'
    - $ref: '#/components/parameters/version'
    get:
      deprecated: true
      x-deprecation-reason: POST /api/v1/export shall be used instead of the current operation.
      tags:
      - Export
      summary: Export offline API documentation by selected versions
      description: 'Export of offline API documentation by selected version (all files) as a zip archive.

        Type of the documentation file is provided as input parameters:

        * interactive - html document.

        '
      operationId: getPackagesIdVersionsIdDoc
      parameters:
      - name: docType
        in: query
        description: Type of the exported documentation.
        required: false
        schema:
          type: string
          enum:
          - interactive
          default: interactive
      responses:
        '200':
          description: Success
          content:
            application/zip:
              schema:
                type: string
                format: binary
                description: Documentation ZIP file to download
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v1/packages/{packageId}/versions/{version}/ddl/export/entities:
    get:
      tags:
      - Export
      summary: Export DDL entities to xlsx file
      description: Export DDL contract entities of a package version. Only `table` entities are supported now.
      operationId: getPackageVersionDdlEntitiesExport
      parameters:
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - name: refPackageId
        description: Filter by package id of ref package, shall be used in case of dashboard.
        in: query
        schema:
          type: string
      - name: textFilter
        in: query
        description: Filter by DDL entity name (case-insensitive substring match).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/xlsx:
              schema:
                type: string
                format: binary
                description: xlsx file to download
          headers:
            Content-Disposition:
              schema:
                type: string
                description: xlsx file name
                example: attachment; filename="DDLEntities_package.id_version.xlsx"
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v1/packages/{packageId}/versions/{version}/ddl/export/changes:
    get:
      tags:
      - Export
      summary: Export DDL changes to xlsx file
      description: Export DDL contract changes between two compared package versions. Only `table` entities are supported now.
      operationId: getPackageVersionDdlChangesExport
      parameters:
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/severity'
      - $ref: '#/components/parameters/previousVersion'
      - $ref: '#/components/parameters/previousVersionPackageId'
      - name: refPackageId
        description: Filter by package id of ref package and previous ref package.
        in: query
        schema:
          type: string
      - name: textFilter
        in: query
        description: Filter by DDL entity name (case-insensitive substring match).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/xlsx:
              schema:
                type: string
                format: binary
                description: xlsx file to download
          headers:
            Content-Disposition:
              schema:
                type: string
                description: xlsx file name
                example: attachment; filename="DDLChanges_package.id_version.xlsx"
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
                VersionNotFound:
                  $ref: '#/components/examples/VersionNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v1/packages/{packageId}/versions/{version}/mcp/export/{entity}:
    get:
      tags:
      - Export
      summary: Export MCP contract entities to xlsx file
      description: Export MCP discovery contract entities of a package version.
      operationId: getPackageVersionMcpEntitiesExport
      parameters:
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/mcpEntity'
      - name: refPackageId
        description: Filter by package id of ref package, shall be used in case of dashboard.
        in: query
        schema:
          type: string
      - name: textFilter
        in: query
        description: Filter by MCP entity title and description (case-insensitive substring match).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/xlsx:
              schema:
                type: string
                format: binary
                description: xlsx file to download
          headers:
            Content-Disposition:
              schema:
                type: string
                description: xlsx file name
                example: attachment; filename="MCPEntities_package.id_version.xlsx"
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
  /api/v2/packages/{packageId}/versions/{version}/export/shareability-report:
    parameters:
    - $ref: '#/components/parameters/packageId'
    - $ref: '#/components/parameters/version'
    get:
      tags:
      - Export
      summary: Generate shareability report
      description: 'Generate a shareability status xlsx report for all documents in a group, including all sub-groups and packages.

        Rows are sorted by package name, document name, slug. Requires read permission on the group.

        '
      operationId: generateShareabilityReport
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: xlsx file to download
          headers:
            Content-Disposition:
              schema:
                type: string
                description: xlsx file name
                example: attachment; filename="shareability_report_group.id_2024.1_20240101120000.xlsx"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '40

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netcracker/refs/heads/main/openapi/netcracker-export-api-openapi.yml