Nym Technologies

Nym Technologies UNSTABLE - DO **NOT** USE API

The UNSTABLE - DO **NOT** USE API from Nym Technologies — 4 operation(s) for unstable - do **not** use.

GitHub OpenAPI

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nym-technologies/refs/heads/main/openapi/nym-technologies-unstable-do-not-use-api-openapi.yml

OpenAPI Specification

nym-technologies-unstable-do-not-use-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Node Status API Status UNSTABLE - DO **NOT** USE API
  description: ''
  contact:
    name: Nym Technologies SA
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 4.6.2
tags:
- name: UNSTABLE - DO **NOT** USE
paths:
  /v1/status/gateways/unstable/{identity}/test-results:
    get:
      tags:
      - UNSTABLE - DO **NOT** USE
      operationId: gateway_test_results
      parameters:
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: identity
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
  /v1/status/mixnodes/unstable/{mix_id}/test-results:
    get:
      tags:
      - UNSTABLE - DO **NOT** USE
      operationId: mixnode_test_results
      parameters:
      - name: mix_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/u32'
      - name: output
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Output'
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          minimum: 0
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
            application/bincode:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
  /v1/status/network-monitor/unstable/run/latest/details:
    get:
      tags:
      - UNSTABLE - DO **NOT** USE
      operationId: latest_monitor_run_report
      parameters:
      - name: output
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Output'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMonitorRunDetailsResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NetworkMonitorRunDetailsResponse'
            application/bincode:
              schema:
                $ref: '#/components/schemas/NetworkMonitorRunDetailsResponse'
  /v1/status/network-monitor/unstable/run/{monitor_run_id}/details:
    get:
      tags:
      - UNSTABLE - DO **NOT** USE
      operationId: monitor_run_report
      parameters:
      - name: output
        in: query
        required: false
        schema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Output'
      - name: monitor_run_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMonitorRunDetailsResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/NetworkMonitorRunDetailsResponse'
            application/bincode:
              schema:
                $ref: '#/components/schemas/NetworkMonitorRunDetailsResponse'
components:
  schemas:
    TestNode:
      type: object
      properties:
        identity_key:
          type:
          - string
          - 'null'
        node_id:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
    PartialTestResult:
      type: object
      required:
      - monitor_run_id
      - timestamp
      - test_routes
      properties:
        monitor_run_id:
          type: integer
          format: int64
        overall_reliability_for_all_routes_in_monitor_run:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
        test_routes:
          $ref: '#/components/schemas/TestRoute'
        timestamp:
          type: integer
          format: int64
    PaginatedResponse:
      type: object
      required:
      - pagination
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PartialTestResult'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Output:
      type: string
      enum:
      - json
      - yaml
      - bincode
    u32:
      type: integer
      format: int32
      minimum: 0
    TestRoute:
      type: object
      required:
      - gateway
      - layer1
      - layer2
      - layer3
      properties:
        gateway:
          $ref: '#/components/schemas/TestNode'
        layer1:
          $ref: '#/components/schemas/TestNode'
        layer2:
          $ref: '#/components/schemas/TestNode'
        layer3:
          $ref: '#/components/schemas/TestNode'
    NetworkMonitorRunDetailsResponse:
      type: object
      required:
      - monitor_run_id
      - network_reliability
      - total_sent
      - total_received
      - mixnode_results
      - gateway_results
      properties:
        gateway_results:
          type: object
          additionalProperties:
            type: integer
            minimum: 0
          propertyNames:
            type: integer
            format: int32
            minimum: 0
        mixnode_results:
          type: object
          additionalProperties:
            type: integer
            minimum: 0
          propertyNames:
            type: integer
            format: int32
            minimum: 0
        monitor_run_id:
          type: integer
          format: int64
        network_reliability:
          type: number
          format: double
        total_received:
          type: integer
          minimum: 0
        total_sent:
          type: integer
          minimum: 0
    Pagination:
      type: object
      required:
      - total
      - page
      - size
      properties:
        page:
          type: integer
          format: int32
          minimum: 0
        size:
          type: integer
          minimum: 0
        total:
          type: integer
          minimum: 0