Netcracker Operation groups API

openapi: 3.2.0
info:
  title: APIHUB Registry – External Operation groups 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: Operation groups
  description: Operation groups
paths:
  /api/v3/packages/{packageId}/versions/{version}/{apiType}/build/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
    post:
      deprecated: true
      x-deprecation-reason: POST /api/v1/export shall be used instead of the current operation.
      tags:
      - Operation groups
      summary: Async document transformation
      description: 'Async task for document transformation. Document transformation is required for exporting operations group.

        * **200 Documents transformation completed successfully** if documents were already transformed.


        * **202 Accepted** will be returned after starting process for documents transformation.

        '
      operationId: postGenerateDocumentV3
      parameters:
      - name: clientBuild
        in: query
        description: Client-side package build will be used.
        required: false
        schema:
          type: boolean
          default: false
      - name: builderId
        in: query
        required: false
        description: Builder identifier. **Required** if clientBuild=true.
        schema:
          type: string
      - name: reCalculate
        in: query
        description: 'Flag for the force document re-calculation.

          May be used after the previous API call with **error** status.

          '
        schema:
          type: boolean
          default: false
      - name: format
        in: query
        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: Documents transformation completed successfully
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                description: build config
                properties:
                  packageId:
                    description: Package unique identifier (full alias).
                    type: string
                    example: QS.CQSS.CPQ.TMF
                  version:
                    description: 'Package version.

                      The mask <version>@<revision> will be used for return in a specific revision.

                      If the @<revision> was not transmitted in the request - it won''t be returned in response. Consider the version as the latest one.

                      '
                    type: string
                    example: 2022.3@3
                  apiType:
                    description: Document transformation is available only for apiType = REST
                    type: string
                    enum:
                    - rest
                  groupName:
                    description: Name of the group
                    type: string
                    example: v1
                  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.

                      '
                    type: string
                    enum:
                    - reducedSourceSpecifications
                    - mergedSpecification
                  format:
                    type: string
                    enum:
                    - yaml
                    - json
                    - html
                  createdBy:
                    description: The user who created the object
                    type: string
                  buildId:
                    description: Id of the created build.
                    type: string
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    description: Calculation process status.
                    type: string
                    enum:
                    - running
                    - error
                  message:
                    description: The message for **error** status.
                    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
        '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'
        '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:
      - Operation groups
      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/v3/packages/{packageId}/versions/{version}/{apiType}/groups:
    post:
      tags:
      - Operation groups
      summary: Create manual operation group
      description: 'Create manual operation group.\

        Manual groups can be created for both packages and dashboards. One group can contain operations of one API type only.

        '
      operationId: PostPackageIdVersionApiTypeGroupsV3
      parameters:
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/apiType'
      requestBody:
        description: New version group
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - groupName
              properties:
                groupName:
                  description: Name of new group. Name must be unique within one API type.
                  type: string
                description:
                  description: Description of created group.
                  type: string
                template:
                  description: 'OpenAPI specification template that will be used to export operations from an operation group with buildType = mergedSpecification.\

                    Template can only be specified for the group with apiType = rest.\

                    Both YAML and JSON file formats are supported.

                    '
                  type: string
                  format: binary
      responses:
        '201':
          description: Created
        '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: {}
        '403':
          description: Forbidden
          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}/groups/{groupName}:
    get:
      tags:
      - Operation groups
      summary: Get list of operations for operation group
      operationId: getPackagesIdVersionsIdApiTypeGroupsGroupName
      description: 'Get list of operations from operation group. The result list depends on the API type.

        '
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/groupName'
      - $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: 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: onlyAddable
        in: query
        description: 'Flag for filtering operations that are not included in this group


          true - will return all operations from version except operations that are already included in this group


          false - will return all operations that are included in this group

          '
        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: 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 group operations.
                type: object
                properties:
                  operations:
                    type: array
                    description: 'List of grouped operations that were present in the previous revision and are deleted in the current revision.

                      '
                    items:
                      allOf:
                      - oneOf:
                        - $ref: '#/components/schemas/RestOperation'
                        - $ref: '#/components/schemas/GraphQLOperation'
                        - $ref: '#/components/schemas/ProtobufOperation'
                        - $ref: '#/components/schemas/AsyncAPIOperation'
                      - type: object
                        properties:
                          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'
    delete:
      tags:
      - Operation groups
      summary: Delete operation group
      description: 'Delete version group.

        '
      operationId: getPackagesIdVersionsIdApiTypeGroups
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/groupName'
      responses:
        '204':
          description: No content
          content: {}
        '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'
              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: {}
        '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}/groups/{groupName}:
    patch:
      tags:
      - Operation groups
      summary: Update parameters of operation group
      description: 'Update parameters of operations group.

        '
      operationId: patchPackageIdVersionApiTypeGroupName
      parameters:
      - name: groupName
        description: Old groupName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      requestBody:
        description: Version group update parameters
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                groupName:
                  description: 'Name of new group. Name must be unique within one API type.\

                    Group name can be changed only for manual group.

                    '
                  type: string
                description:
                  description: Description of the operation group (can be update for the manual or rest path prefix group)
                  type: string
                template:
                  description: 'OpenAPI specification template that will be used to export operations from an operation group with buildType = mergedSpecification.\

                    Template can be specified for the manual or rest path prefix group, but only with apiType = rest.\

                    Both YAML and JSON file formats are supported.

                    '
                  type: string
                  format: binary
                operations:
                  type: array
                  description: Operations in the group. One group can contain no more than 200 operations.
                  items:
                    type: object
                    required:
                    - operationId
                    properties:
                      packageId:
                        description: 'ID of package.\

                          PackageId and version shall be specified in case of dashboard to identify source package.

                          If packageId and version are not specified, this will mean that the source of the operation is the current package version.

                          '
                        type: string
                        example: QS.CloudQSS.CPQ.Q-TMF
                      version:
                        description: Version and revision of the package.
                        type: string
                        example: 2023.3@3
                      operationId:
                        description: Operation unique identifier.
                        type: string
                        example: get-quoteManagement-v5-quote
      responses:
        '204':
          description: No content
          content: {}
        '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: {}
        '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: {}
        '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}/{apiType}/groups/{groupName}/template:
    get:
      tags:
      - Operation groups
      summary: Get export template of operation group
      description: 'Export OpenAPI specification template from an operation group (manual or rest path prefix).

        This feature is supported only for apiType = rest.

        '
      operationId: getPackageIdVersionApiTypeGroupNameTemplate
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/packageId'
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/groupName'
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: template
          headers:
            Content-Disposition:
              schema:
                type: string
                description: file name
                example: attachment; filename="<file name>.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/v3/packages/{packageId}/versions/{version}/{apiType}/groups/{groupName}/publish:
    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
        - graphql
        - asyncapi
    - name: groupName
      in: path
      required: true
      description: Name of the operation group
      schema:
        type: string
    post:
      tags:
      - Operation groups
      summary: Start operation group publication
      description: 'Start operation group publish process.\

        In this process all operations from operation group will be published to the selected package version.

        '
      operationId: postOperationGroupPublish
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - packageId
              - version
              - status
              properties:
                packageId:
                  description: Package unique identifier (full alias).
                  type: string
                  example: QS.CQSS.CPQ.TMF
                version:
                  description: Version name for publication in package.
                  type: string
                  example: '2022.3'
                previousVersion:
                  description: Name of the previous published version in package.
                  type: string
                  example: '2022.2'
                previousVersionPackageId:
                  description: Package id of the previous version. The parameter may be empty if the value is equal to the packageId.
                  type: string
                  example: QS.CloudQSS.CPQ.Q-TMF
                status:
                  $ref: '#/components/schemas/VersionStatusEnum'
                versionLabels:
                  description: List of version labels in package.
                  type: array
                  items:
                    type: string
                  example:
                  - part-of:CloudQSS-CPQBE
      responses:
        '202':
          description: Publish process started


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