NGINX Stream Zone Sync API

openapi: 3.0.3
info:
  title: NGINX njs Scripting Connections Stream Zone Sync API
  version: '0.8'
  description: The NGINX njs module provides a JavaScript runtime embedded inside NGINX. It does not expose HTTP endpoints itself. Instead, it offers scripting objects (HTTP request, stream session, Fetch API, etc.) that are available within njs handler functions configured in the NGINX configuration file. This specification documents the key njs objects as OpenAPI schemas only; the paths object is intentionally empty because there are no REST endpoints to describe.
  x-generated-from: documentation
  contact:
    name: NGINX
    url: https://nginx.org/en/docs/njs/reference.html
  license:
    name: BSD-2-Clause
    url: https://nginx.org/LICENSE
tags:
- name: Stream Zone Sync
paths:
  /stream/zone_sync/:
    get:
      tags:
      - Stream Zone Sync
      summary: NGINX Return Sync Status of a Node
      description: Returns synchronization status of a cluster node.
      operationId: getStreamZoneSync
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NginxStreamZoneSync'
          examples:
            application/json:
              zones:
                zone1:
                  records_pending: 2061
                  records_total: 260575
                zone2:
                  records_pending: 0
                  records_total: 14749
              status:
                bytes_in: 1364923761
                msgs_in: 337236
                msgs_out: 346717
                bytes_out: 1402765472
                nodes_online: 15
          x-microcks-refs:
          - name: getStreamZoneSync200Example
            x-microcks-default: true
        '404':
          description: Unknown version (*UnknownVersion*)
          schema:
            $ref: '#/definitions/NginxError'
          examples:
            application/json:
              error: {}
              request_id: example-request_id
              href: example-href
          x-microcks-refs:
          - name: getStreamZoneSync404Example
            x-microcks-default: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  NginxStreamZoneSync:
    title: Stream Zone Sync Node
    type: object
    properties:
      zones:
        type: object
        title: Zone Sync Zones
        description: Synchronization information per each shared memory zone.
        additionalProperties:
          $ref: '#/definitions/NginxStreamZoneSyncZone'
        example: {}
      status:
        type: object
        description: Synchronization information per node in a cluster.
        properties:
          bytes_in:
            type: integer
            description: The number of bytes received by this node.
            example: 0
          msgs_in:
            type: integer
            description: The number of messages received by this node.
            example: 0
          msgs_out:
            type: integer
            description: The number of messages sent by this node.
            example: 0
          bytes_out:
            type: integer
            description: The number of bytes sent by this node.
            example: 0
          nodes_online:
            type: integer
            description: The number of peers this node is connected to.
            example: 0
        example: 200
    example:
      zones:
        zone1:
          records_pending: 2061
          records_total: 260575
        zone2:
          records_pending: 0
          records_total: 14749
      status:
        bytes_in: 1364923761
        msgs_in: 337236
        msgs_out: 346717
        bytes_out: 1402765472
        nodes_online: 15
  NginxStreamZoneSyncZone:
    title: Sync Zone
    description: Synchronization status of a shared memory zone.
    type: object
    properties:
      records_pending:
        type: integer
        description: The number of records that need to be sent to the cluster.
        example: 0
      records_total:
        type: integer
        description: The total number of records stored in the shared memory zone.
        example: 0
  NginxError:
    title: Error
    description: 'nginx error object.

      '
    type: object
    properties:
      error:
        type: object
        properties:
          status:
            type: integer
            description: HTTP error code.
            example: 200
          text:
            type: string
            description: Error description.
            example: example-text
          code:
            type: string
            description: Internal nginx error code.
            example: 200
        example: {}
      request_id:
        type: string
        description: The ID of the request, equals the value of the <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a> variable.
        example: example-request_id
      href:
        type: string
        description: Link to reference documentation.
        example: example-href
externalDocs:
  description: NGINX njs Reference
  url: https://nginx.org/en/docs/njs/reference.html