api.yaml

paths:
  /config:
    post:
      tags: ['Configuration']
      operationId: set_config
      description: >-
        Sets configuration resources on the traffic generator.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '../config/config.yaml#/components/schemas/Config'
      responses:
        '200':
          $ref: '../result/request.yaml#/components/responses/Success'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
    get:
      tags: ['Configuration']
      operationId: get_config
      responses:
        '200':
          description: >-
            Config response from the traffic generator
          content:
            application/json:
              schema:
                $ref: '../config/config.yaml#/components/schemas/Config'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
    patch:
      tags: ['Configuration']
      operationId: update_config
      description: >-
        Updates specific attributes of resources configured on the traffic generator.
        The fetched configuration shall reflect the updates applied successfully.

        The Response.Warnings in the Success response is available for
        implementers to disclose additional information about a state change
        including any implicit changes that are outside the scope of the state
        change.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '../config/update.yaml#/components/schemas/Config.Update'
      responses:
        '200':
          $ref: '../result/request.yaml#/components/responses/Success'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /config/append:
    patch:
      tags: ['Configuration']
      operationId: append_config
      description: >-
        Append new attributes of resources to existing configuration on the traffic generator.
        Resource names should not be part of existing configuration of that resource type;
        it should be unique for the operation to succeed. A failed append might leave the
        configuration in an undefined state and if the error is due to some invalid or unsupported
        configuration in the appended resources, it is expected that the user fix the error and 
        restart from SetConfig operation.
        The fetched configuration shall also reflect the new configuration applied successfully.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '../config/append.yaml#/components/schemas/Config.Append'
      responses:
        '200':
          $ref: '../result/request.yaml#/components/responses/Success'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /config/delete:
    patch:
      tags: ['Configuration']
      operationId: delete_config
      description: >-
        Delete attributes of resources from existing configuration on the traffic generator.
        Resource names should already be part of existing configuration of that resource type;
        for the operation to succeed. A failed delete will leave the configuration in an undefined
        state and if the error is due to some invalid or unsupported configuration in the deleted 
        resources, it is expected that the user fix the error and restart from SetConfig operation.
        On successful deletion the fetched configuration shall not reflect the removed configuration.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '../config/delete.yaml#/components/schemas/Config.Delete'
      responses:
        '200':
          $ref: '../result/request.yaml#/components/responses/Success'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /control/state:
    post:
      tags: ['Control']
      operationId: set_control_state
      description: >-
        Sets the operational state of configured resources.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '../control/state.yaml#/components/schemas/Control.State'
      responses:
        '200':
          $ref: '../result/request.yaml#/components/responses/Success'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /control/action:
    post:
      tags: ['Control']
      operationId: set_control_action
      description: >-
        Triggers actions against configured resources.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '../control/action.yaml#/components/schemas/Control.Action'
      responses:
        '200':
          description: >-
            Response for actions triggered against configured resources.
          content:
            application/json:
              schema:
                $ref: '../control/action.yaml#/components/schemas/Control.Action.Response'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /monitor/metrics:
    description: >-
      Metrics API
    post:
      tags: ['Monitor']
      operationId: get_metrics
      requestBody:
        description: >-
          Request to traffic generator for metrics of choice
        required: true
        content:
          application/json:
            schema:
              $ref: '../result/metrics.yaml#/components/schemas/Metrics.Request'
      responses:
        '200':
          description: >-
            Response from traffic generator for chosen metrics
          content:
            application/json:
              schema:
                $ref: '../result/metrics.yaml#/components/schemas/Metrics.Response'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /monitor/states:
    description: >-
      States API
    post:
      tags: ['Monitor']
      operationId: get_states
      requestBody:
        description: >-
          Request to traffic generator for states of choice
        required: true
        content:
          application/json:
            schema:
              $ref: '../result/states.yaml#/components/schemas/States.Request'
      responses:
        '200':
          description: >-
            Response from traffic generator for chosen states
          content:
            application/json:
              schema:
                $ref: '../result/states.yaml#/components/schemas/States.Response'
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2
  /monitor/capture:
    description: >-
      Capture results API
    post:
      tags: ['Monitor']
      operationId: get_capture
      requestBody:
        description: >-
          Capture results request to the traffic generator.
        required: true
        content:
          application/json:
            schema:
              $ref: '../result/capture.yaml#/components/schemas/Capture.Request'
      responses:
        '200':
          description: >-
            Capture results response from the traffic generator.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
          x-field-uid: 1
        default:
          $ref: '../result/request.yaml#/components/responses/Failure'
          x-field-uid: 2