Netcracker Operations API

openapi: 3.2.0
info:
  title: APIHUB Registry – External Operations 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: Operations
  description: Operations APIs.
paths:
  /api/v2/packages/{packageId}/versions/{version}/{apiType}/operations:
    get:
      tags:
      - Operations
      summary: Get list of operations
      description: 'Full list of operations without grouping by parent specification document.

        The result list depends on the API type.

        '
      operationId: getPackagesIdVersionsIdApiTypeOperations
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/apiAudience'
      - $ref: '#/components/parameters/asyncapiChannel'
      - $ref: '#/components/parameters/asyncapiProtocol'
      - name: skipRefs
        in: query
        description: 'If false and package has references, then package references (including references to the deleted package versions) shall be resolved.

          '
        schema:
          type: boolean
          default: false
      - name: textFilter
        in: query
        description: 'Filter by title/path/method. Custom tag format in search is key: value. Search works as a complete match.

          For AsyncAPI: searches by message title(or messageId), channel title(or channelId) or operation action.

          '
        schema:
          type: string
      - name: documentSlug
        in: query
        description: Filter by document
        schema:
          type: string
          example: billing-rating-catalog-integration-service1-json
      - name: tag
        in: query
        description: 'Name of the tag for filtering/grouping.

          A full match is required. To get the list of available tags use GET /tags API.

          '
        schema:
          type: string
          example: RestControllerV5
      - name: emptyTag
        in: query
        description: 'Flag, filtering the operations without tags at all.


          In response will be returned the list of operations, on what the tag is not filled in.


          This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter.

          '
        schema:
          type: boolean
          default: false
      - name: group
        in: query
        description: 'Name of the group for filtering.\

          Either "group" or "emptyGroup" (= true) can be sent in the request, if both of them are specified then 400 will be returned in the response.

          '
        schema:
          type: string
          example: v1
      - name: emptyGroup
        in: query
        description: 'Flag for filtering operations without a group.\

          Either "group" or "emptyGroup" (= true) can be sent in the request, if both of them are specified then 400 will be returned in the response.

          '
        schema:
          type: boolean
          default: false
      - name: kind
        description: 'Operation kind.

          * bwc - API with backward compatibility support (a.k.a. public).

          * no-bwc - API without backward compatibility support (a.k.a. internal).

          * experimental - APIs for feature testing. Usage is not recommended.

          '
        in: query
        schema:
          type: string
          enum:
          - all
          - bwc
          - no-bwc
          - experimental
          default: all
      - name: deprecated
        description: Filter operations by 'deprecated' status.
        in: query
        schema:
          type: string
          enum:
          - all
          - 'true'
          - 'false'
          default: all
      - name: includeData
        in: query
        description: Include the operation's content data.
        schema:
          type: boolean
          default: false
      - name: ids
        in: query
        description: List of the operationId to filter.
        schema:
          type: array
          items:
            type: string
          example:
          - get-quoteManagement-v5-quote
          - post-quoteManagement-v5-quote
      - name: refPackageId
        description: Filter by package id of ref package, shall be used in case of dashboard.
        in: query
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                description: List of operations.
                type: object
                properties:
                  operations:
                    type: array
                    items:
                      allOf:
                      - oneOf:
                        - $ref: '#/components/schemas/RestOperation'
                        - $ref: '#/components/schemas/GraphQLOperation'
                        - $ref: '#/components/schemas/ProtobufOperation'
                        - $ref: '#/components/schemas/AsyncAPIOperation'
                      - type: object
                        properties:
                          data:
                            description: 'Content of the operation as a JSON object.

                              Required, if includeData: true.

                              '
                            type: object
                          customTags:
                            description: 'Custom tags.

                              '
                            type: object
                          packageRef:
                            description: 'Parent package and version link.

                              Created by the concatenation of the packageId and version name with At sign.

                              '
                            type: string
                            example: QS.CloudQSS.CPQ.Q-TMF@2023.2
                  packages:
                    $ref: '#/components/schemas/PackagesMap'
        '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}/{apiType}/operations/{operationId}/deprecatedItems:
    get:
      tags:
      - Operations
      summary: Deprecated items of single operation
      description: 'Get list of all deprecated items inside of the single operation.\

        Deprecated item is entity that is deprecated inside of API operation. For example for REST API it can be parameter or schema, for GraphQL API - field or enum value.

        '
      operationId: getPackagesIdVersionsApiTypeOperationsIddeprecatedItems
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/operationId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  deprecatedItems:
                    $ref: '#/components/schemas/DeprecatedItems'
        '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
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
        '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}/{apiType}/operations/{operationId}/models/{modelName}/usages:
    get:
      tags:
      - Operations
      summary: List of operations with the same model
      description: 'Get list of operations that have the same model

        '
      operationId: getPackagesIdVersionsApiTypeOperationsIdModelsModelName
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/operationId'
      - $ref: '#/components/parameters/modelName'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  modelUsages:
                    description: List of operationIds and model names
                    type: array
                    items:
                      type: object
                      properties:
                        operationId:
                          description: Operation unique identifier (slug). Not the same as operationId tag from the OpenAPI file.
                          type: string
                          example: get-quoteManagement-v5-quote
                        modelNames:
                          description: List of models with the same hash.
                          type: array
                          items:
                            type: string
        '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
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
        '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}/{apiType}/export/operations:
    get:
      tags:
      - Operations
      summary: Export operations to xlsx file
      description: 'Export operations of specific API type.

        '
      operationId: getPackagesIdVersionsIdApiTypeOperationsExport
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/apiAudience'
      - $ref: '#/components/parameters/asyncapiChannel'
      - $ref: '#/components/parameters/asyncapiProtocol'
      - name: textFilter
        in: query
        description: 'Filter by title/path/method.

          For AsyncAPI: searches by message title(or messageId), channel title(or channelId) or operation action.

          '
        schema:
          type: string
      - name: tag
        in: query
        description: 'Name of the tag for filtering/grouping.

          A full match is required. To get the list of available tags use GET /tags API.

          '
        schema:
          type: string
          example: RestControllerV5
      - name: emptyTag
        in: query
        description: 'Flag, filtering the operations without tags at all.

          In response will be returned the list of operations, on what the tag is not filled in.

          This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter.

          '
        schema:
          type: boolean
          default: false
      - name: kind
        description: 'Operation kind.

          * bwc - API with backward compatibility support (a.k.a. public).

          * no-bwc - API without backward compatibility support (a.k.a. internal).

          * experimental - APIs for feature testing. Usage is not recommended.

          '
        in: query
        schema:
          type: string
          enum:
          - all
          - bwc
          - no-bwc
          - experimental
          default: all
      - name: group
        in: query
        description: 'Name of the group for filtering.\

          The filter is applied only to the groups of current version. Groups from previous version will be ignored.\

          Either "group" or "emptyGroup" (= true) can be sent in the request, if both of them are specified then 400 will be returned in the response.

          '
        schema:
          type: string
          example: v1
      - name: emptyGroup
        in: query
        description: 'Flag for filtering operations without a group.\

          The filter is applied only to the groups of current version. Groups from previous version will be ignored.\

          Either "group" or "emptyGroup" (= true) can be sent in the request, if both of them are specified then 400 will be returned in the response.

          '
        schema:
          type: boolean
          default: false
      - name: refPackageId
        description: Filter by package id of ref package, shall be used in case of dashboard.
        in: query
        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="APIOperations_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}/{apiType}/export/operations/deprecated:
    get:
      tags:
      - Operations
      summary: Export deprecated operations to xlsx file
      description: 'Export operations of specific API type.

        '
      operationId: getPackagesIdVersionsIdApiTypeDeprecatedOperationsExport
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/apiAudience'
      - $ref: '#/components/parameters/asyncapiChannel'
      - $ref: '#/components/parameters/asyncapiProtocol'
      - name: textFilter
        in: query
        description: 'Filter by title/path/method.

          For AsyncAPI: searches by message title(or messageId), channel title(or channelId) or operation action.

          '
        schema:
          type: string
      - name: tag
        in: query
        description: 'A full match is required.\

          Multiple tags separated by comma can be specified.

          '
        schema:
          type: string
          example: tag1, tag2
      - name: kind
        description: 'Operation kind.

          * bwc - API with backward compatibility support (a.k.a. public).

          * no-bwc - API without backward compatibility support (a.k.a. internal).

          * experimental - APIs for feature testing. Usage is not recommended.

          '
        in: query
        schema:
          type: string
          enum:
          - all
          - bwc
          - no-bwc
          - experimental
          default: all
      - name: emptyTag
        in: query
        description: 'Flag, filtering the operations without tags at all.

          In response will be returned the list of operations, on what the tag is not filled in.

          This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter.

          '
        schema:
          type: boolean
          default: false
      - name: group
        in: query
        description: 'Name of the group for filtering.\

          Either "group" or "emptyGroup" (= true) can be sent in the request, if both of them are specified then 400 will be returned in the response.

          '
        schema:
          type: string
          example: v1
      - name: emptyGroup
        in: query
        description: 'Flag for filtering operations without a group.\

          Either "group" or "emptyGroup" (= true) can be sent in the request, if both of them are specified then 400 will be returned in the response.

          '
        schema:
          type: boolean
          default: false
      - name: refPackageId
        description: Filter by package id of ref package, shall be used in case of dashboard.
        in: query
        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="APIOperations_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}/{apiType}/operations/{operationId}:
    get:
      tags:
      - Operations
      summary: Get operation details
      description: 'Operation''s parameters and data.

        The result depends on the API type.

        '
      operationId: getPackagesIdVersionsIdApiTypeOperationsId
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/operationId'
      - name: includeData
        in: query
        description: Include the operation's content data.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - oneOf:
                  - $ref: '#/components/schemas/RestOperation'
                  - $ref: '#/components/schemas/GraphQLOperation'
                  - $ref: '#/components/schemas/ProtobufOperation'
                  - $ref: '#/components/schemas/AsyncAPIOperation'
                - type: object
                  required:
                  - data
                  properties:
                    data:
                      description: Content of the operation as a JSON object.
                      type: object
                    customTags:
                      description: 'Custom tags.

                        '
                      type: object
        '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}/{apiType}/operations/{operationId}/changes:
    get:
      tags:
      - Operations
      summary: Single operation change log
      description: 'Get changes of one operation between current and previous published package version.

        The result depends on the API type.

        '
      operationId: getPackagesIdVersionsApiTypeOperationsIdChanges
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/operationId'
      - $ref: '#/components/parameters/severity'
      - $ref: '#/components/parameters/previousVersion'
      - $ref: '#/components/parameters/previousVersionPackageId'
      - in: query
        name: previousVersionOperationId
        description: Operation unique identifier from previous version (not the same as operationId tag from the OpenAPI file).\ Empty, if requested operation is added in the current version; otherwise, must be specified.
        schema:
          type: string
          example: get-quoteManagement-v5-quote-id
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  changes:
                    description: List of discrepancies data in the operation.
                    type: array
                    items:
                      $ref: '#/components/schemas/SingleOperationChange'
        '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
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
        '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}/{apiType}/operations/{operationId}/changes/summary:
    get:
      tags:
      - Operations
      summary: Single operation changes summary
      description: 'Get summary of changes for one operation between current and previous published package version.

        The result depends on the API type.

        '
      operationId: getPackagesIdVersionsApiTypeOperationsIdChangesSummary
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/operationId'
      - $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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeSummary'
        '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
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
        '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}/{apiType}/tags:
    get:
      tags:
      - Operations
      summary: Get list of operations tags
      description: 'Get list of operations tags in one published version.

        The result list depends on the API type.

        '
      operationId: getPackagesIdVersionsIdApiTypeTags
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/apiAudience'
      - name: textFilter
        in: query
        description: 'Filter by tag.

          Partial name is applicable.

          '
        schema:
          type: string
      - name: skipRefs
        in: query
        description: 'If false and package has references, then package references (including references to the deleted package versions) shall be resolved.

          '
        schema:
          type: boolean
          default: false
      - name: kind
        description: 'Operation kind.

          * bwc - API with backward compatibility support (a.k.a. public).

          * no-bwc - API without backward compatibility support (a.k.a. internal).

          * experimental - APIs for feature testing. Usage is not recommended.

          '
        in: query
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      - name: group
        in: query
        description: 'Name of the group for filtering.\

          Either "group" or "emptyGroup" (= true) can be

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