rav_api_unresolved.yaml

openapi: 3.0.0
info:
  description: RAV API
  version: "1.0.0-oas3"
  title: RAV API
  contact:
    email: name@mail.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
  - name: developers
    description: Operations available to regular developers
paths:
  /configuration/{executeID}:
    parameters:
      - name: "executeID"
        description: >
          Identifier of experiment
        in: "path"
        schema:
          type: string
        required: true
    post:
      tags:
        - developers
      summary: adds configuration for an experiment
      operationId: setConfigurationExp
      description: Sets a new configuration on the RAV module
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configurationResp'
        '400':
          description: Malformed JSON content
        '409':
          description: Conflict
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configurationDict'
        description: New configuration for the module
    get:
      tags:
        - developers
      summary: get the configuration for an experiment
      operationId: getConfigurationExp
      description: |
        Returns the current configuration of the RAV module
      responses:
        '200':
          description: SUCCESS,
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configurationDict'
        '404':
          description: NOT FOUND
  /queue:
    get:
      tags:
        - developers
      summary: dump list of active RAV instances
      operationId: getResultsCommand
      description: |
        Returns the list of all the rav instances
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validationResultsList'
  /queue/{executeID}:
    parameters:
      - name: "executeID"
        description: >
          Identifier of experiment
        in: "path"
        schema:
          type: string
        required: true
    get:
      tags:
        - developers
      summary: dump results for specific experiment
      operationId: getExpResults
      description: |
        Returns the results of the specific experiment
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validationResultsInstance'
        '404':
          description: NOT FOUND
  /queue/{executeID}/{tcID}:
    parameters:
      - name: "executeID"
        description: >
          Identifier of experiment
        in: "path"
        schema:
          type: string
        required: true
      - name: "tcID"
        description: >
          Identifier of testcase
        in: "path"
        schema:
          type: string
        required: true
    get:
      tags:
        - developers
      summary: dump results for specific testcase
      operationId: getTcResults
      description: |
        Returns the results of the specific testcase
      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
      operationId: dumpMessages
      description: |
        Returns the messages consumed in all topic for all experiments
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesDict'
        '404':
          description: FAIL
  /terminate/{executeID}:
    parameters:
      - name: "executeID"
        description: >
          Identifier of experiment
        in: "path"
        schema:
          type: string
        required: true
    get:
      tags:
        - developers
      summary: terminate the experiment
      operationId: terminateExperiment
      description: |
        Terminates the experiment
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controlResponse'
        '404':
          description: NOT FOUND
  /terminate/{executeID}/{tcID}:
    parameters:
      - name: "executeID"
        description: >
          Identifier of experiment
        in: "path"
        schema:
          type: string
        required: true
      - name: "tcID"
        description: >
          Identifier of testcase
        in: "path"
        schema:
          type: string
        required: true
    get:
      tags:
        - developers
      summary: terminate current testcase of experiment
      operationId: terminateCurrentTestcase
      description: |
        Terminates the current testcase of the experiment
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commandResponse'
        '404':
          description: FAIL
  /validate/{executeID}/{tcID}:
    parameters:
    - name: "executeID"
      description: >
        Identifier of experiment
      in: "path"
      schema:
        type: string
      required: true
    - name: "tcID"
      description: >
        Identifier of testcase
      in: "path"
      schema:
        type: string
      required: true
    get:
      tags:
        - developers
      summary: start testcase validation
      operationId: startTestcaseValidation
      description: |
        Start the validation of the requests testcase
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commandResponse'
        '404':
          description: FAIL
        '500':
          description: BROKER NOT FOUND
  /status/{executeID}/{tcID}:
    parameters:
    - name: "executeID"
      description: >
        Identifier of experiment
      in: "path"
      schema:
        type: string
      required: true
    - name: "tcID"
      description: >
        Identifier of testcase
      in: "path"
      schema:
        type: string
      required: true
    get:
      tags:
        - developers
      summary: show validation status
      operationId: showTestcaseValidationStatus
      description: |
        Show the status of the validation
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusResponse'
        '404':
          description: FAIL
  /remove/{executeID}:
    parameters: 
    - name: "executeID"
      description: >
        Identifier of experiment
      in: "path"
      schema:
        type: string
      required: true
    delete:
      tags:
        - developers
      summary: remove a finished experiment
      operationId: removeExperiment
      description: |
        Remove an experiment instance that has finished
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controlResponse'
        '404':
          description: NOT FOUND
        '409':
          description: NOT FINISHED
    
servers:
  - url: 'https://virtserver.swaggerhub.com/myRAVorg/RAV_latest/1.0.0'
components:
  schemas:
    messagesDict:
      type: object
      properties:
        exampleExpId1:
          type: object
          properties:
            exampleExecutId1:
              type: object
              properties:
                exampleTopicName:
                  type: array
                  items: 
                    oneOf:
                    - type: string
                    - type: number
                  example: ['exampleMessage1', 'exampleMessage2']
    configurationDict:
      type: object
      required:
        - vertical
        - expID
        - executeID
        - testcases
      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:
            type: object
            properties:
              tcID:
                type: string
                example: "5e28a691-2a58-432f-a730-0fc98a9e75b8"
              configuration:
                $ref: '#/components/schemas/configuration'        
    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:
      type: object
      required:
        - topics
        - publish
      properties:
        topics:
          type: array
          items:
            $ref: '#/components/schemas/topic'
        publish:
          type: array
          items:
            $ref: '#/components/schemas/publishtopic'
    topic:
      type: object
      required:
        - brokerAddr
        - topic
        - metric
      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:
      type: object
      required:
        - brokerAddr
        - topic
        - kpi
        - unit
        - input
        - formula
        - interval
        - lowerBound
        - upperBound
      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: 
          oneOf:
            - type: string
            - type: number
          example: 1
        upperBound: 
          oneOf:
            - type: string
            - type: number
          example: 10
    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:
            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'
    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'