rav_api_resolved.yaml

openapi: 3.0.0
info:
  title: RAV API
  description: RAV API
  contact:
    email: name@mail.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0-oas3
servers:
- url: https://virtserver.swaggerhub.com/myRAVorg/RAV_latest/1.0.0
tags:
- name: developers
  description: Operations available to regular developers
paths:
  /configuration/{executeID}:
    get:
      tags:
      - developers
      summary: get the configuration for an experiment
      description: |
        Returns the current configuration of the RAV module
      operationId: getConfigurationExp
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS,
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configurationDict'
        "404":
          description: NOT FOUND
    post:
      tags:
      - developers
      summary: adds configuration for an experiment
      description: Sets a new configuration on the RAV module
      operationId: setConfigurationExp
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: New configuration for the module
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configurationDict'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configurationResp'
        "400":
          description: Malformed JSON content
        "409":
          description: Conflict
  /queue:
    get:
      tags:
      - developers
      summary: dump list of active RAV instances
      description: |
        Returns the list of all the rav instances
      operationId: getResultsCommand
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validationResultsList'
  /queue/{executeID}:
    get:
      tags:
      - developers
      summary: dump results for specific experiment
      description: |
        Returns the results of the specific experiment
      operationId: getExpResults
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validationResultsInstance'
        "404":
          description: NOT FOUND
  /queue/{executeID}/{tcID}:
    get:
      tags:
      - developers
      summary: dump results for specific testcase
      description: |
        Returns the results of the specific testcase
      operationId: getTcResults
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: tcID
        in: path
        description: |
          Identifier of testcase
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validationTestcaseResultsInstance'
        "404":
          description: FAIL
  /messages:
    get:
      tags:
      - developers
      summary: dump the consumed messages per experiment and topic
      description: |
        Returns the messages consumed in all topic for all experiments
      operationId: dumpMessages
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesDict'
        "404":
          description: FAIL
  /terminate/{executeID}:
    get:
      tags:
      - developers
      summary: terminate the experiment
      description: |
        Terminates the experiment
      operationId: terminateExperiment
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controlResponse'
        "404":
          description: NOT FOUND
  /terminate/{executeID}/{tcID}:
    get:
      tags:
      - developers
      summary: terminate current testcase of experiment
      description: |
        Terminates the current testcase of the experiment
      operationId: terminateCurrentTestcase
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: tcID
        in: path
        description: |
          Identifier of testcase
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commandResponse'
        "404":
          description: FAIL
  /validate/{executeID}/{tcID}:
    get:
      tags:
      - developers
      summary: start testcase validation
      description: |
        Start the validation of the requests testcase
      operationId: startTestcaseValidation
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: tcID
        in: path
        description: |
          Identifier of testcase
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commandResponse'
        "404":
          description: FAIL
        "500":
          description: BROKER NOT FOUND
  /status/{executeID}/{tcID}:
    get:
      tags:
      - developers
      summary: show validation status
      description: |
        Show the status of the validation
      operationId: showTestcaseValidationStatus
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: tcID
        in: path
        description: |
          Identifier of testcase
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusResponse'
        "404":
          description: FAIL
  /remove/{executeID}:
    delete:
      tags:
      - developers
      summary: remove a finished experiment
      description: |
        Remove an experiment instance that has finished
      operationId: removeExperiment
      parameters:
      - name: executeID
        in: path
        description: |
          Identifier of experiment
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controlResponse'
        "404":
          description: NOT FOUND
        "409":
          description: NOT FINISHED
components:
  schemas:
    messagesDict:
      type: object
      properties:
        exampleExpId1:
          $ref: '#/components/schemas/messagesDict_exampleExpId1'
    configurationDict:
      required:
      - executeID
      - expID
      - testcases
      - vertical
      type: object
      properties:
        vertical:
          type: string
          example: Smart Transportation
        expID:
          type: string
          example: ea0b4e14-8b54-4a7d-8635-8e0dacad334b
        executeID:
          type: string
          example: 38ab48eb-0867-4bc7-abfd-6642936f07ad
        testcases:
          type: array
          items:
            $ref: '#/components/schemas/configurationDict_testcases'
    configurationResp:
      type: object
      properties:
        experiment_found:
          type: boolean
          example: true
        status:
          type: string
          example: running
        instances_list:
          type: array
          items:
            $ref: '#/components/schemas/configurationDict'
    configuration:
      required:
      - publish
      - topics
      type: object
      properties:
        topics:
          type: array
          items:
            $ref: '#/components/schemas/topic'
        publish:
          type: array
          items:
            $ref: '#/components/schemas/publishtopic'
    topic:
      required:
      - brokerAddr
      - metric
      - topic
      type: object
      properties:
        brokerAddr:
          type: string
          example: 127.0.0.1:9092
        topic:
          type: string
          example: metric_1_topic
        metric:
          type: string
          example: metric_1_name
    publishtopic:
      required:
      - brokerAddr
      - formula
      - input
      - interval
      - kpi
      - lowerBound
      - topic
      - unit
      - upperBound
      type: object
      properties:
        brokerAddr:
          type: string
          example: 127.0.0.1:9092
        topic:
          type: string
          example: output_kpi_1_topic
        kpi:
          type: string
          example: output_kpi_1_name
        unit:
          type: string
          example: '%'
        input:
          type: array
          items:
            type: string
            example: metricId1
        formula:
          type: string
          example: latency + decision_time
        interval:
          type: number
          example: 1
        lowerBound:
          example: 1
          oneOf:
          - type: string
          - type: number
        upperBound:
          example: 10
          oneOf:
          - type: string
          - type: number
    validationResultsList:
      type: array
      items:
        $ref: '#/components/schemas/validationResultsInstance'
    validationResultsInstance:
      type: object
      properties:
        vertical:
          type: string
          example: Smart Transportation
        expID:
          type: string
          example: 123af1rcxhauq13-13r142f1-13f13f-121e
        executionID:
          type: string
          example: 123af1rcxhauq13-13r142f1-13f13f-121e
        testcases:
          type: array
          items:
            $ref: '#/components/schemas/configurationDict_testcases'
        added:
          type: string
          example: 02/06/2020, 04:22:36
        finished:
          type: string
          example: 02/06/2020, 04:23:47
        status:
          type: string
          example: finished
        validation:
          $ref: '#/components/schemas/validationResults'
    validationTestcaseResultsInstance:
      type: object
      properties:
        tcID:
          type: string
          example: 5e28a691-2a58-432f-a730-0fc98a9e75b8
        configuration:
          $ref: '#/components/schemas/configuration'
        added:
          type: string
          example: 02/06/2020, 04:22:36
        finished:
          type: string
          example: 02/06/2020, 04:23:47
        status:
          type: string
          example: finished
        validation:
          $ref: '#/components/schemas/validationResults'
    validationResults:
      type: object
      additionalProperties: true
    commandResponse:
      type: object
      properties:
        expID:
          type: string
          example: 123af1rcxhauq13-13r142f1-13f13f-121e
        executeID:
          type: string
          example: 899ad5f1-d161-4358-86fa-40e48ae15dff
        tcID:
          type: string
          example: 141af25ae25131b-13a112af-bcf259-f619
        status:
          type: string
          example: running
    statusResponse:
      type: object
      properties:
        status:
          type: string
          example: VALIDATING
        report:
          type: string
          example: /{vertical}/{expID}/{executeID}
    controlResponse:
      type: object
      properties:
        expID:
          type: string
          example: 123af1rcxhauq13-13r142f1-13f13f-121e
        executeID:
          type: string
          example: 6f47c9fa-3c7e-4187-a1b4-de0f1f349849
        status:
          type: string
          example: running
    messagesDict_exampleExpId1_exampleExecutId1:
      type: object
      properties:
        exampleTopicName:
          type: array
          example:
          - exampleMessage1
          - exampleMessage2
          items:
            oneOf:
            - type: string
            - type: number
    messagesDict_exampleExpId1:
      type: object
      properties:
        exampleExecutId1:
          $ref: '#/components/schemas/messagesDict_exampleExpId1_exampleExecutId1'
    configurationDict_testcases:
      type: object
      properties:
        tcID:
          type: string
          example: 5e28a691-2a58-432f-a730-0fc98a9e75b8
        configuration:
          $ref: '#/components/schemas/configuration'