tester_restapi.yaml

swagger: '2.0'
info:
  description: Control your test server with Extensive Automation API
  version: 22.2.0
  title: Swagger Tester - Extensive Automation
  contact:
    email: d.machard@gmail.com
  license:
    name: MIT
host: 127.0.0.1
basePath: /rest
schemes:
  - https
paths:
  /rest/adapters/adapter/add:
    post:
      tags:
        - adapters
      summary: Add a new adapter
      description: ''
      operationId: adaptersAdapterAdd
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            properties:
              package-name:
                type: string
              adapter-name:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/adapter/add",
                "message": "adapter added"
             }
        '400':
          description: Bad request provided
        '401':
          description: unauthorized
  /rest/adapters/check/syntax:
    post:
      tags:
        - adapters
      summary: check the syntax of a adapter
      description: ''
      operationId: adaptersCheckSyntax
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ file-content ]
            properties:
              file-content:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              success:
                type: boolean
              syntax-error:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/check/syntax",
                "file-content": "...."
              }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/adapters/directory/add:
    post:
      tags:
        - adapters
      summary: Add directory in the adapters storage
      description: ''
      operationId: adaptersDirectoryAdd
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ directory-name, directory-path ]
            properties:
              directory-name:
                type: string
              directory-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/directory/add",
                "message": "directory successfully added"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/directory/duplicate:
    post:
      tags:
        - adapters
      summary: Duplicate directory in the adapters storage
      description: ''
      operationId: adaptersDirectoryDuplicate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ directory-name, directory-path  ]
                properties:
                  directory-name:
                    type: string
                  directory-path:
                    type: string
              destination:
                type: object
                required: [ directory-name ]
                properties:
                  directory-name:
                    type: string
                  directory-path:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/directory/rename",
                "message": "directory successfully renamed"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/directory/move:
    post:
      tags:
        - adapters
      summary: Move directory
      description: ''
      operationId: adaptersDirectoryMove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ directory-name, directory-path  ]
                properties:
                  directory-name:
                    type: string
                  directory-path:
                    type: string
              destination:
                type: object
                required: [ directory-path ]
                properties:
                  directory-path:
                    type: string
      responses:
        '200':
          description: move response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/directory/move",
                "message": "directory successfully moved"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/directory/remove:
    post:
      tags:
        - adapters
      summary: remove directory in the adapters storage
      description: ''
      operationId: adaptersDirectoryRemove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ directory-path  ]
            properties:
              directory-path:
                type: string
              recursive:
                type: boolean
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/directory/remove",
                "message": "directory successfully removed"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/directory/rename:
    post:
      tags:
        - adapters
      summary: Rename directory in the adapters storage
      description: ''
      operationId: adaptersDirectoryRename
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, directory-name, directory-path ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
                  directory-path:
                    type: string
              destination:
                type: object
                required: [ project-id, directory-name ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/directory/rename",
                "message": "directory successfully renamed"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/download:
    post:
      tags:
        - adapters
      summary: download file from the test storage
      description: ''
      operationId: adaptersFileDownload
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              file-content:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/download",
                "file-content": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/duplicate:
    post:
      tags:
        - adapters
      summary: Duplicate file in the adapters storage
      description: ''
      operationId: adaptersFileDuplicate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, file-name, file-path, file-extension  ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
                  file-path:
                    type: string
                  file-extension:
                    type: string
              destination:
                type: object
                required: [ project-id, file-name ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/rename",
                "message": "file successfully renamed"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/move:
    post:
      tags:
        - adapters
      summary: Move file
      description: ''
      operationId: adaptersFileMove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ file-name, file-path, file-extension  ]
                properties:
                  file-name:
                    type: string
                  file-path:
                    type: string
                  file-extension:
                    type: string
              destination:
                type: object
                required: [ file-path ]
                properties:
                  file-path:
                    type: string
      responses:
        '200':
          description: move response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/move",
                "message": "file successfully moved"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/open:
    post:
      tags:
        - adapters
      summary: open and lock file from the test storage
      description: ''
      operationId: adaptersFileOpen
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              file-content:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/open",
                "file-content": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/remove:
    post:
      tags:
        - adapters
      summary: remove file in the adapters storage
      description: ''
      operationId: adaptersFileRemove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ file-path  ]
            properties:
              file-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/remove",
                "message": "file successfully removed"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/rename:
    post:
      tags:
        - adapters
      summary: Rename file in the adapters storage
      description: ''
      operationId: adaptersFileRename
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, file-name, file-path, file-extension  ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
                  file-path:
                    type: string
                  file-extension:
                    type: string
              destination:
                type: object
                required: [ project-id, file-name ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/rename",
                "message": "file successfully renamed"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/unlock:
    post:
      tags:
        - adapters
      summary: unlock file in the adapters storage
      description: ''
      operationId: adaptersFileUnlock
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ file-path, file-name, file-extension  ]
            properties:
              file-path:
                type: string
              file-name:
                type: string
              file-extension:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/unlock",
                "message": "file successfully unlocked"
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/file/upload:
    post:
      tags:
        - adapters
      summary: Upload file the test storage
      description: ''
      operationId: adaptersFileUpload
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path, file-name, file-extension, file-content ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
              file-name:
                type: string
              file-extension:
                type: string
              file-content:
                type: string
              overwrite:
                type: boolean
              close-after:
                type: boolean
              add-folders:
                type: boolean
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              code:
                type: integer
          examples:
            application/json: |
              {
                "cmd": "/adapters/file/upload",
                "code": 200
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/adapters/listing:
    get:
      tags:
        - adapters
      summary: Get the listing of all adapters.
      description: ''
      operationId: adaptersListing
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
      responses:
        '200':
          description: adapters listing
          schema :
            properties:
              cmd:
                type: string
              adapters-listing:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/adapters/listing",
                "adapters-listing": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/agents/disconnect:
    post:
      tags:
        - agents
      summary: Disconnect a agent by the name
      description: ''
      operationId: agentsDisconnect
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ agent-name ]
            properties:
              agent-name:
                type: string
      responses:
        '200':
          description:
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/agents/disconnect",
                "message: "agent successfully disconnected"
             }
        '400':
          description: Bad request provided
        '404':
          description: Agent not found
  /rest/agents/running:
    get:
      tags:
        - agents
      summary: Get all running agents
      description: ''
      operationId: agentsRunning
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
      responses:
        '200':
          description: running agents
          schema :
            properties:
              cmd:
                type: string
              agents-running:
                type: array
                items:
                  type: string
          examples:
            application/json: |
              {
                "cmd": "/agents/running",
                "agents-running": ...
             }
  /rest/results/comment/add:
    post:
      tags:
        - results
      summary: Add a comment in a test result
      description: ''
      operationId: resultsCommentAdd
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, comment, timestamp, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
              comment:
                type: string
              timstamp:
                type: string
      responses:
        '200':
          description:
          schema :
            properties:
              cmd:
                type: string
              result:
                type: string
                description: in base64
              result-name:
                type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/download/result",
                "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "result-name": "....",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "save-as": False,
                "save-as-dest: ""
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result by id not found
        '500':
          description: Server error
  /rest/results/comment/remove/all:
    post:
      tags:
        - results
      summary: Remove all comments in test result
      description: ''
      operationId: resultsCommentsRemoveAll
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description:
          schema :
            properties:
              cmd:
                type: string
              result:
                type: string
                description: in base64
              result-name:
                type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/download/result",
                "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "result-name": "....",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "save-as": False,
                "save-as-dest: ""
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result by id not found
        '500':
          description: Server error
  /rest/results/details:
    post:
      tags:
        - results
      summary: Get details of the test result
      description: ''
      operationId: resultsDetails
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              results:
                type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/details",
                "project-id": 25
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/results/download/image:
    post:
      tags:
        - results
      summary: Get image (png or jpg) from test result
      description: ''
      operationId: resultsDownloadImage
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id, image-name ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              image-name:
                type: string
      responses:
        '200':
          description: image
          schema :
            properties:
              cmd:
                type: string
              image:
                type: string
                description: in base64
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/download/image",
                "image": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/download/result:
    post:
      tags:
        - results
      summary: Get result file in test result
      description: ''
      operationId: resultsDownloadResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id, file-name ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              file-name:
                type: string
              save-as:
                type: boolean
                description: parameter only used in windows client
              save-as-name:
                type: string
                description: parameter only used in windows client
      responses:
        '200':
          description: image
          schema :
            properties:
              cmd:
                type: string
              result:
                type: string
                description: in base64
              result-name:
                type: string
              project-id:
                type: string
              save-as:
                  type: boolean
              save-as-name:
                  type: string
                  description: in base64
          examples:
            application/json: |
              {
                "cmd": "/results/download/result",
                "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "result-name": "....",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "save-as": False,
                "save-as-dest: ""
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result by id not found
        '500':
          description: Server error
  /rest/results/download/uncomplete:
    post:
      tags:
        - results
      summary: Get result events event if the test is not yet terminated
      description: ''
      operationId: resultsDownloadUncomplete
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
      responses:
        '200':
          description: image
          schema :
            properties:
              cmd:
                type: string
              result:
                type: string
                description: in base64
              result-name:
                type: string
              project-id:
                type: string
              save-as:
                  type: boolean
              save-as-name:
                  type: string
                  description: in base64
          examples:
            application/json: |
              {
                "cmd": "/results/download/uncomplete",
                "result": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "result-name": "....",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "save-as": False,
                "save-as-dest: ""
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result by id not found
        '500':
          description: Server error
  /rest/results/follow:
    post:
      tags:
        - results
      summary: Follow the result of one or several tests
      description: ''
      operationId: resultsFollow
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-ids, project-id ]
            properties:
              test-ids:
                type: string
              project-id:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              results:
                type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/follow",
                "project-id": 25
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/results/listing/basic:
    post:
      tags:
        - results
      summary: Get the listing id of all tests results.
      description: ''
      operationId: resultsListingIdByDatetime
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id ]
            properties:
              project-id:
                type: integer
      responses:
        '200':
          description: all tests results with id
          schema :
            properties:
              cmd:
                type: string
              listing:
                type: array
                items:
                  type: object
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/listing/basic",
                "listing":  [...]
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/results/listing/files:
    post:
      tags:
        - results
      summary: Get the listing of all tests results
      description: ''
      operationId: resultsListingFiles
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id ]
            properties:
              partial-list:
                type: boolean
              project-id:
                type: integer
      responses:
        '200':
          description: all test results with details
          schema :
            properties:
              cmd:
                type: string
              listing:
                type: list
                description: listing all test results
                items:
                  type: object
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/listing/files",
                "listing": [...],
                "nb-folders": 2,
                "nb-files":  2,
                "statistics": {...}
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/results/listing/by/id/datetime:
    post:
      tags:
        - results
      summary: Get the listing id of all tests results. Support date and time filtering.
      description: ''
      operationId: resultsListingIdByDatetime
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id ]
            properties:
              project-id:
                type: integer
              date:
                type: string
                description: filter results by date "YYYY-MM-DD", returns only results greater than the date provided
              time:
                type: string
                description: filter results by time "HH:MM:SS", returns only results greater than the time provided
      responses:
        '200':
          description: all tests results with id
          schema :
            properties:
              cmd:
                type: string
              listing:
                type: array
                items:
                  type: object
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/listing/by/id/datetime",
                "listing":  [...]
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/results/remove/by/date:
    post:
      tags:
        - results
      summary: Remove all tests results according to the date provided
      description: ''
      operationId: resultsRemoveByDate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ date, project-id ]
            properties:
              date:
                type: string
              project-id:
                type: string
      responses:
        '200':
          description: remove result
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
                description: message
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/remove/by/date",
                "message": "xxxxxxx",
                "project-id": 25
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/remove/by/id:
    post:
      tags:
        - results
      summary: Remove a test result according to the test id provided
      description: ''
      operationId: resultsRemoveById
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: string
      responses:
        '200':
          description: remove result
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
                description: message
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/remove",
                "message": "xxxx",
                "project-id": 25
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/report/comments:
    post:
      tags:
        - reports
      summary: Get all comments in one report
      description: ''
      operationId: resultsReportComments
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description: all test reports
          schema :
            properties:
              cmd:
                type: string
              comments:
                type: string
                description: in base64 and gzipped
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/reports",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "comments": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/report/designs:
    post:
      tags:
        - reports
      summary: Get all report designs
      description: ''
      operationId: resultsReportDesigns
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description: all test reports
          schema :
            properties:
              cmd:
                type: string
              test-report:
                type: string
                description: in base64 and gzipped
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/reports",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "xml-design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/report/events:
    post:
      tags:
        - reports
      summary: Get a report of events occured during the test
      description: ''
      operationId: resultsReportEvents
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description: all test reports
          schema :
            properties:
              cmd:
                type: string
              events:
                type: string
                description: in base64 and gzipped
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/reports",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "events": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/report/reviews:
    post:
      tags:
        - reports
      summary: Get all report reviews
      description: ''
      operationId: resultsReportReviews
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description: all test reports
          schema :
            properties:
              cmd:
                type: string
              test-report:
                type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/report/reviews",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "basic-review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/report/verdicts:
    post:
      tags:
        - reports
      summary: Get all report verdicts.
      description: ''
      operationId: resultsReportVerdicts
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description: all test reports
          schema :
            properties:
              cmd:
                type: string
              test-report:
                type: string
                description: in base64 and gzipped
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/reports",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "xml-verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/reports:
    post:
      tags:
        - reports
      summary: Get all reports of one test (advanced and basic in all formats).
      description: ''
      operationId: resultsReports
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: integer
              replay-id:
                type: string
      responses:
        '200':
          description: all test reports
          schema :
            properties:
              cmd:
                type: string
              test-report:
                type: string
                description: in base64 and gzipped
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/reports",
                "test-id": "7dcc4836-e989-49eb-89b7-5ec1351d2ced",
                "basic-review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "review": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "xml-verdict": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "xml-design": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "comments": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV....",
                "events": "eJztfHnPq9iZ5/+R+ju8qqiVbjkV...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/status:
    post:
      tags:
        - results
      summary: Get the status of the test (not-running, running, complete).
      description: ''
      operationId: resultsStatus
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: string
      responses:
        '200':
          description: result status of a test
          schema :
            properties:
              cmd:
                type: string
              test-status:
                type: string
                description: running/not-running/complete
              test-progress:
                type: integer
                description: progress in percent
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/status",
                "test-status": "running",
                "test-id": "af0b2587-459e-42eb-a4da-e3e6fa227719",
                "test-progress": 25
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/upload/file:
    post:
      tags:
        - results
      summary: Upload a file in the test result
      description: ''
      operationId: resultsUploadFile
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          required: true
          schema:
            required: [ result-path, file-name, file-content ]
            properties:
              result-path:
                type: string
              file-name:
                type: string
              file-content:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/upload/file",
                "message": "success"
             }
        '400':
          description: Bad request provided
        '403':
          description: Extension file refused
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/results/verdict:
    post:
      tags:
        - results
      summary: Get the end result of the test (undefined, pass, fail).
      description: ''
      operationId: resultsVerdict
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-id, project-id ]
            properties:
              test-id:
                type: string
              project-id:
                type: string
      responses:
        '200':
          description: tests end result
          schema :
            properties:
              cmd:
                type: string
              test-verdict:
                type: string
                description: undefined, pass, fail
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/results/verdict",
                "test-verdict": "undefined",
                "test-id": "af0b2587-459e-42eb-a4da-e3e6fa227719"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '404':
          description: Test result not found
        '500':
          description: Server error
  /rest/tests/listing/basic:
    post:
      tags:
        - tests
      summary: Get the listing of all tests in basic mode.
      description: ''
      operationId: testsBasicListing
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id ]
            properties:
              project-id:
                type: integer
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              listing:
                type: array
                items:
                  type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/listing/basic",
                "listing": ["/Snippets/UI/03_OpenBrowser.tux", "/Snippets/UI/05_MaximizeBrowser.tux"],
                "project-id": 1
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/check/syntax:
    post:
      tags:
        - tests
      summary: check the syntax of a test (unit, abstract and suite)
      description: ''
      operationId: testsCheckSyntax
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-definition, test-execution, test-properties, test-name, test-path, test-extension ]
            properties:
              test-definition:
                type: string
              test-execution:
                type: string
              test-properties:
                type: string
              test-name:
                type: string
              test-path:
                type: string
              test-extension:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              status:
                type: boolean
              error-msg:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/check/syntax/string",
                "status": True,
                "error-msg": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/tests/check/syntax/tpg:
    post:
      tags:
        - tests
      summary: check the syntax of a test (plan and global)
      description: ''
      operationId: testsCheckSyntaxTpg
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ test-execution, test-properties, test-name, test-path, test-extension ]
            properties:
              test-execution:
                type: array
                items:
                  type: string
              test-properties:
                type: string
              test-name:
                type: string
              test-path:
                type: string
              test-extension:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              status:
                type: boolean
              error-msg:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/check/syntax/tpg",
                "status": True,
                "error-msg": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/tests/create/design:
    post:
      tags:
        - tests
      summary: create the design of a test (unit, abstract and suite)
      description: ''
      operationId: testsCreateDesign
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, test-definition, test-execution, test-properties, test-name, test-path, test-extension ]
            properties:
              project-id:
                type: integer
              test-definition:
                type: string
              test-execution:
                type: string
              test-properties:
                type: string
              test-name:
                type: string
              test-path:
                type: string
              test-extension:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              status:
                type: boolean
              error-msg:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/check/design",
                "status": True,
                "error-msg": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/tests/create/design/tpg:
    post:
      tags:
        - tests
      summary: create the design of a test (plan and global)
      description: ''
      operationId: testsCreateDesignTpg
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, test-execution, test-properties, test-name, test-path, test-extension ]
            properties:
              project-id:
                type: integer
              test-execution:
                type: array
                items:
                  type: string
              test-properties:
                type: string
              test-name:
                type: string
              test-path:
                type: string
              test-extension:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              status:
                type: boolean
              error-msg:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/check/design/tpg",
                "status": True,
                "error-msg": "...."
             }
        '400':
          description: Bad request provided
        '500':
          description: Server error
  /rest/tests/listing/dict:
    post:
      tags:
        - tests
      summary: Get the listing of all tests in dict mode.
      description: ''
      operationId: testsDictListing
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id ]
            properties:
              project-id:
                type: integer
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              listing:
                type: array
                items:
                  type: string
              project-id:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/listing/dict",
                "listing": {},
                "project-id": 1
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/directory/add:
    post:
      tags:
        - tests
      summary: Add directory in the test storage
      description: ''
      operationId: testsDirectoryAdd
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, directory-name, directory-path ]
            properties:
              project-id:
                type: integer
              directory-name:
                type: string
              directory-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/directory/add",
                "message": "directory successfully added"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/directory/duplicate:
    post:
      tags:
        - tests
      summary: Duplicate directory in the test storage
      description: ''
      operationId: testsDirectoryDuplicate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, directory-name, directory-path ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
                  directory-path:
                    type: string
              destination:
                type: object
                required: [ project-id, file-name ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
                  directory-path:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/directory/rename",
                "message": "directory successfully renamed"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/directory/move:
    post:
      tags:
        - tests
      summary: Move directory in the test storage
      description: ''
      operationId: testsDirectoryMove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, directory-name, directory-path  ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
                  directory-path:
                    type: string
              destination:
                type: object
                required: [ project-id, directory-path ]
                properties:
                  project-id:
                    type: integer
                  directory-path:
                    type: string
      responses:
        '200':
          description: move response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/directory/move",
                "message": "directory successfully moved"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/directory/remove:
    post:
      tags:
        - tests
      summary: remove directory in the test storage
      description: ''
      operationId: testsDirectoryRemove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, directory-path  ]
            properties:
              project-id:
                type: integer
              directory-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/directory/remove",
                "message": "directory successfully removed"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/directory/rename:
    post:
      tags:
        - tests
      summary: Rename directory in the test storage
      description: ''
      operationId: testsDirectoryRename
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, directory-name, directory-path ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
                  directory-path:
                    type: string
              destination:
                type: object
                required: [ project-id, directory-name ]
                properties:
                  project-id:
                    type: integer
                  directory-name:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/directory/rename",
                "message": "directory successfully renamed"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/download:
    post:
      tags:
        - tests
      summary: download file from the test storage
      description: ''
      operationId: testsFileDownload
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              file-content:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/download",
                "file-content": "...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/duplicate:
    post:
      tags:
        - tests
      summary: Duplicate file in the test storage
      description: ''
      operationId: testsFileDuplicate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, file-name, file-path, file-extension  ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
                  file-path:
                    type: string
                  file-extension:
                    type: string
              destination:
                type: object
                required: [ project-id, file-path, file-name ]
                properties:
                  project-id:
                    type: integer
                  file-path:
                    type: string
                  file-name:
                    type: string
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/rename",
                "message": "file successfully renamed"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/move:
    post:
      tags:
        - tests
      summary: Move file in the test storage
      description: ''
      operationId: testsFileMove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, file-name, file-path, file-extension  ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
                  file-path:
                    type: string
                  file-extension:
                    type: string
              destination:
                type: object
                required: [ project-id, file-path ]
                properties:
                  project-id:
                    type: integer
                  file-path:
                    type: string
              upload_location:
                required: [upload_location]
                properties:
                  upload_location: boolean
      responses:
        '200':
          description: move response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/move",
                "message": "file successfully moved"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/open:
    post:
      tags:
        - tests
      summary: open and lock file from the test storage
      description: ''
      operationId: testsFileOpen
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
              ignore-lock:
                type: boolean
              read-only:
                type: boolean
              custom-param:
                type: integer
              destination-id:
                type: integer
              action-id:
                type: integer
              extra:
                type: object
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              file-content:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/open",
                "file-content": "...."
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/remove:
    post:
      tags:
        - tests
      summary: remove file in the test storage
      description: ''
      operationId: testsFileRemove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path  ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/remove",
                "message": "file successfully removed"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/rename:
    post:
      tags:
        - tests
      summary: Rename file in the test storage
      description: ''
      operationId: testsFileRename
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ source, destination ]
            properties:
              source:
                type: object
                required: [ project-id, file-name, file-path, file-extension  ]
                properties:
                  project-id:
                    type: integer
                  file-name:
                    type: string
                  file-path:
                    type: string
                  file-extension:
                    type: string
              destination:
                type: object
                required: [ file-name ]
                properties:
                  file-name:
                    type: string
              upload_location:
                required: [upload_location]
                properties:
                  upload_location: boolean
      responses:
        '200':
          description: rename response
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/rename",
                "message": "file successfully renamed"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/unlock:
    post:
      tags:
        - tests
      summary: unlock file in the test storage
      description: ''
      operationId: testsFileUnlock
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path, file-name, file-extension  ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
              file-name:
                type: string
              file-extension:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/file/unlock",
                "message": "file successfully unlocked"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/file/upload:
    post:
      tags:
        - tests
      summary: Upload file the test storage
      description: ''
      operationId: testsFileUpload
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path, file-name, file-extension, file-content ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
              file-name:
                type: string
              file-extension:
                type: string
              file-content:
                type: string
              overwrite:
                type: boolean
              close-after:
                type: boolean
              add-folders:
                type: boolean
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              code:
                type: integer
          examples:
            application/json: |
              {
                "cmd": "/tests/file/upload",
                "code": 200
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /tests/find/file-usage:
    post:
      tags:
        - tests
      summary:  Finding script usages included in test plans and globals
      description: ''
      operationId: testsFindFileUsage
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, file-path ]
            properties:
              project-id:
                type: integer
              file-path:
                type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              folder-content:
                type: dict
          examples:
            application/json: |
              {
                "cmd": "/tests/find/file-usage",
                "folder-content": {}
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/listing:
    post:
      tags:
        - tests
      summary: Get the listing of all tests.
      description: ''
      operationId: testsListing
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id ]
            properties:
              project-id:
                type: integer
              for-saveas:
                type: boolean
              for-runs:
                type: boolean
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              listing:
                type: array
                items:
                  type: string
              project-id:
                type: integer
          examples:
            application/json: |
              {
                "cmd": "/tests/listing",
                "listing": [],
                "project-id": 1
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/schedule:
    post:
      tags:
        - tests
      summary: Schedule a test unit/suite
      description: ''
      operationId: testsSchedule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, test-extension, test-path, test-name]
            properties:
              project-id:
                type: integer
              test-definition:
                type: string
              test-execution:
                type: string
              test-properties:
                type: object
              test-extension:
                type: string
              test-path:
                type: string
              test-name:
                type: string
              schedule-id:
                type: integer
                description: '0 => now, 1 => at, 2 => in'
              schedule-at:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              schedule-repeat:
                type: integer
              probes-enabled:
                type: boolean
              debug-enabled:
                type: boolean
              notifications-enabled:
                type: boolean
              logs-enabled:
                type: boolean
              from-time:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              to-time:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              tab-id:
                type: integer
              step-mode:
                type: boolean
              breakpoint-mode:
                type: boolean
              background-mode:
                type: boolean
              test-inputs:
                type: array
                description: Test inputs parameters can be used to overwrite the original test parameters
                items:
                  type: object
                  required: [ name, value, type ]
                  properties:
                    name:
                      type: string
                    type:
                      type: string
                    value:
                      type: string
      responses:
        '200':
          description: tests listing
          schema :
            properties:
              cmd:
                type: string
              test-id:
                type: string
              task-id:
                type: string
              tab-id:
                type: string
              test-name:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/schedule",
                "message": ""
                "test-id": "",
                "task-id": "",
                "tab-id": ""
                "test-name": ""
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/schedule/group:
    post:
      tags:
        - tests
      summary: Schedule a group of tests
      description: ''
      operationId: testsScheduleGroup
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ tests, postpone-at, parallel-mode, postpone-mode]
            properties:
              tests:
                type: array
                items:
                  type: string
              postpone-at:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              parallel-mode:
                type: boolean
              postpone-mode:
                type: boolean
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/schedule/group",
                "message": "success"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/tests/schedule/tpg:
    post:
      tags:
        - tests
      summary: Schedule a testplan or test global
      description: ''
      operationId: testsScheduleTpg
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, test-extension, test-path, test-name]
            properties:
              project-id:
                type: integer
              test-execution:
                type: string
              test-properties:
                type: object
              test-extension:
                type: string
              test-path:
                type: string
              test-name:
                type: string
              schedule-id:
                type: integer
                description: '0 => now, 1 => at, 2 => in'
              schedule-at:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              schedule-repeat:
                type: integer
              probes-enabled:
                type: boolean
              debug-enabled:
                type: boolean
              notifications-enabled:
                type: boolean
              logs-enabled:
                type: boolean
              from-time:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              to-time:
                type: array
                description: '[ Y,M,D,H,M,S ]'
                items:
                  type: integer
              tab-id:
                type: integer
              step-mode:
                type: boolean
              breakpoint-mode:
                type: boolean
              background-mode:
                type: boolean
              test-inputs:
                type: array
                description: Test inputs parameters can be used to overwrite the original test parameters
                items:
                  type: object
                  required: [ name, value, type ]
                  properties:
                    name:
                      type: string
                    type:
                      type: string
                    value:
                      type: string
      responses:
        '200':
          schema :
            properties:
              cmd:
                type: string
              test-id:
                type: string
              task-id:
                type: string
              tab-id:
                type: string
              test-name:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "cmd": "/tests/schedule/tpg"
             }
        '400':
          description: Bad request provided
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/variables/add/:
    post:
      tags:
        - variables
      summary: Add test variable in project, variables can be accessible from test
      description: ''
      operationId: variablesAdd
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [ project-id, variable-name,variable-value]
            properties:
              variable-name:
                type: string
              variable-value:
                type: string
                description: in json format
              project-id:
                type: integer
      responses:
        '200':
          description: variable successfully added
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
              variable-id:
                type: string
          examples:
            application/json: |
              {
                "message": "variable successfully added",
                "cmd": "/variables/add",
                "variable-id": "95"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project | Variable already exists
        '500':
          description: Server error
  /rest/variables/duplicate:
    post:
      tags:
        - variables
      summary: Duplicate test variable in project
      description: ''
      operationId: variablesDuplicate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [project-id, variable-id]
            properties:
              variable-id:
                type: string
              project-id:
                type: integer
      responses:
        '200':
          description: variable successfully duplicated
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
              variable-id:
                type: string
          examples:
            application/json: |
              {
                "message": "variable successfully duplicated",
                "cmd": "/variables/duplicate",
                "variable-id": "95"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project
        '404':
          description: Variable not found
        '500':
          description: Server error
  /rest/variables/listing:
    post:
      tags:
        - variables
      summary: Get a listing of all test variables according to the project id or name
      description: ''
      operationId: variablesListing
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [project-id]
            properties:
              project-id:
                type: integer
      responses:
        '200':
          description: variables listing
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
              variables:
                type: array
                description: variables list in json format
                items:
                  type: object
                  required: [ project-id, id, name, value ]
                  properties:
                    project-id:
                      type: integer
                    id:
                      type: integer
                    name:
                      type: string
                    value:
                      type: string
          examples:
            application/json: |
              {
                "variables": [
                               {
                                "project_id": 1,
                                "id": 1,
                                "value": false,
                                "name": "DEBUG"
                              }
                            ],
                "cmd": "/variables/listing"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project
        '500':
          description: Server error
  /rest/variables/remove:
    post:
      tags:
        - variables
      summary: Remove test variable in project
      description: ''
      operationId: variablesRemove
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [project-id, variable-id]
            properties:
              variable-id:
                type: string
              project-id:
                type: integer
      responses:
        '200':
          description: variable successfully removed
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "message": "variable successfully removed",
                "cmd": "/variables/remove"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project
        '404':
          description: Variable not found
        '500':
          description: Server error
  /rest/variables/search/by/id:
    post:
      tags:
        - variables
      summary: Search a variable according to the name or id
      description: ''
      operationId: variablesSearchById
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [project-id, variable-id]
            properties:
              project-id:
                type: integer
              variable-id:
                type: string
      responses:
        '200':
          description: search result
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
              variable:
                description: variable in json format in only one match
                type: object
                required: [ project-id, id, name, value ]
                properties:
                  project-id:
                    type: integer
                  id:
                    type: integer
                  name:
                    type: string
                  value:
                    type: string
              variables:
                type: array
                description: variables list in json format on several occurences
                items:
                  type: object
                  required: [ project-id, id, name, value ]
                  properties:
                    project-id:
                      type: integer
                    id:
                      type: integer
                    name:
                      type: string
                    value:
                      type: string
          examples:
            application/json: |
              {
                "variable": {
                              "project_id": 1,
                              "id": 95,
                              "value": "1.0",
                              "name": "VAR_AUTO"
                           },
                "cmd": "/variables/search/by/id"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project
        '404':
          description: Variable not found
        '500':
          description: Server error
  /rest/variables/search/by/name:
    post:
      tags:
        - variables
      summary: Search a variable according to the name or id
      description: ''
      operationId: variablesSearchByName
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [project-id, variable-name]
            properties:
              project-id:
                type: integer
              variable-name:
                type: string
      responses:
        '200':
          description: search result
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
              variable:
                description: variable in json format in only one match
                type: object
                required: [ project-id, id, name, value ]
                properties:
                  project-id:
                    type: integer
                  id:
                    type: integer
                  name:
                    type: string
                  value:
                    type: string
              variables:
                type: array
                description: variables list in json format on several occurences
                items:
                  type: object
                  required: [ project-id, id, name, value ]
                  properties:
                    project-id:
                      type: integer
                    id:
                      type: integer
                    name:
                      type: string
                    value:
                      type: string
          examples:
            application/json: |
              {
                "variable": {
                              "project_id": 1,
                              "id": 95,
                              "value": "1.0",
                              "name": "VAR_AUTO"
                           },
                "cmd": "/variables/search/by/name"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project
        '404':
          description: Variable not found
        '500':
          description: Server error
  /rest/variables/update:
    post:
      tags:
        - variables
      summary: Update test variable in project
      description: ''
      operationId: variablesUpdate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: Cookie
          in: header
          description: session_id=NjQyOTVmOWNlMDgyNGQ2MjlkNzAzNDdjNTQ3ODU5MmU5M
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            required: [project-id, variable-id]
            properties:
              variable-id:
                type: string
              variable-name:
                type: string
              variable-value:
                type: string
                description: with json format
              project-id:
                type: integer
      responses:
        '200':
          description: variable successfully updated
          schema :
            properties:
              cmd:
                type: string
              message:
                type: string
          examples:
            application/json: |
              {
                "message": "variable successfully updated",
                "cmd": "/variables/update"
             }
        '400':
          description: Bad request provided | Bad project id provided | Bad json provided in value
        '403':
          description: Access denied to this project
        '404':
          description: Variable not found
        '500':
          description: Server error