Netcracker Custom API

openapi: 3.2.0
info:
  title: APIHUB Registry – External Custom 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: Custom
  description: Custom APIs.
paths:
  /api/v1/system/info:
    get:
      tags:
      - Custom
      summary: Get system info.
      description: Get system info.
      operationId: getInfo
      parameters: []
      responses:
        '200':
          description: Successful execution
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemInfo'
              examples:
                SystemInfo:
                  $ref: '#/components/examples/SystemInfo'
        '500':
          $ref: '#/components/examples/InternalServerError'
components:
  examples:
    InternalServerError:
      description: 'Example: default internal server error response'
      value:
        status: 500
        code: APIHUB-8000
        reason: InternalServerError
        message: InternalServerError
    SystemInfo:
      description: Example of the system description
      value:
        backendVersion: master-20250522.080756-379-RELEASE
        productionMode: true
        migrationInProgress: false
        aiChatEnabled: false
        externalLinks:
        - User guide|https://www.example.com/guide
        - Support team|https://www.example.com/support]
        featureFlags:
          useV3Search: false
          previousVersionStatusValidation: true
  schemas:
    SystemInfo:
      description: Information about the APIHUB product
      type: object
      properties:
        backendVersion:
          description: Current backend version
          type: string
          example: main-20220727.092034-53
        productionMode:
          description: Production environment flag
          type: boolean
        externalLinks:
          description: List of links to the external resource, for example URL to the documentation or URL pointing to the contact information of support group.
          type: array
          items:
            description: 'Title for the link and corresponding URL. Value must written in the following format <linkTitle>|<URL>. If array item does not contain vertical bar (|), then this item will be skipped.

              '
            type: string
          example:
          - User guide|https://www.example.com/guide
          - Support team|https://www.example.com/support
        migrationInProgress:
          description: Identifies if a full migration is currently in progress. Returns false when no migration or only a partial migration is running.
          type: boolean
          default: false
        aiChatEnabled:
          description: Mirrors the ai.chat.enabled kill-switch. When false, AI chat routes are not registered.
          type: boolean
          default: false
        featureFlags:
          description: Feature flags for the system
          type: object
          properties:
            useV3Search:
              description: When true, signals to use v3 search API instead of v4 search API.
              type: boolean
              default: false
              deprecated: true
            previousVersionStatusValidation:
              description: When true, previous version status validation is enforced on publish and patch endpoints. When false, the system runs with the legacy behaviour.
              type: boolean
              default: true
  securitySchemes:
    BearerAuth:
      type: http
      description: 'Bearer token authentication (JWT). Default security scheme for API usage. Provide Authorization: Bearer <token>.'
      scheme: bearer
      bearerFormat: JWT
    CookieAuth:
      type: apiKey
      in: cookie
      name: apihub-access-token
      description: Authentication via the `apihub-access-token` cookie.
    api-key:
      type: apiKey
      description: API key authentication. Send the key in the api-key header.
      name: api-key
      in: header
    BasicAuth:
      type: http
      description: Login/password authentication.
      scheme: basic
    PersonalAccessToken:
      type: apiKey
      description: Personal access token authentication. Send the token in the X-Personal-Access-Token header; use for user-issued/script access.
      name: X-Personal-Access-Token
      in: header
    RefreshTokenAuth:
      type: apiKey
      in: cookie
      name: apihub-refresh-token
      description: Authentication via refresh token cookie
externalDocs:
  description: Find out more about this project and repository documentation
  url: https://github.com/Netcracker/qubership-apihub