Switstack Suite API

openapi: 3.2.0
info:
  title: Swittest API 🚀 Suite API
  description: '

    ### Prerequisites

    To use this API, you must have an active organization and an active user. If you don''t have an account yet, please contact us at [contact@switstack.io](mailto:contact@switstack.io).


    ### Roles

    - **Data**: Can get test suites, tests, configs and vcards.

    - **Full**: Can fully use swittest.


    ### Authentication

    To make authenticated requests, call `/auth/token` with your credentials and the appropriate grant type. An access token will be returned, which must be included in the request''s Authorization header using the Bearer prefix (`Authorization: Bearer <access_token>`).


    '
  version: 0.13.0
tags:
- name: Suite
paths:
  /api/suites:
    get:
      tags:
      - Suite
      summary: List Test Suites
      operationId: list_test_suites
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
                title: Response List Test Suites Api Suites Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
  /api/suites/{test_suite_name_or_index}:
    get:
      tags:
      - Suite
      summary: Get Test Suite
      operationId: get_test_suite
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: test_suite_name_or_index
        in: path
        required: true
        schema:
          type: string
          title: Test Suite Name Or Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestSuiteSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TestListSchema:
      properties:
        name:
          type: string
          title: Name
        poi_config:
          $ref: '#/components/schemas/POIConfigSchema'
      additionalProperties: false
      type: object
      required:
      - name
      - poi_config
      title: TestListSchema
    ToolEnum:
      type: string
      enum:
      - swittest
      - fime
      - gallit
      title: ToolEnum
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SchemeEnum:
      type: string
      enum:
      - mastercard
      - amex
      - discover
      - jcb
      - cup
      - rupay
      - eftpos
      - cpace
      title: SchemeEnum
    TypeEnum:
      type: string
      enum:
      - l2
      - l3
      title: TypeEnum
    POIConfigSchema:
      properties:
        name:
          type: string
          title: Name
        bin_config:
          anyOf:
          - type: string
          - type: 'null'
          title: Bin Config
        capk_list:
          anyOf:
          - type: string
          - type: 'null'
          title: Capk List
        cr_list:
          anyOf:
          - type: string
          - type: 'null'
          title: Cr List
        emv_config:
          type: string
          title: Emv Config
      additionalProperties: false
      type: object
      required:
      - name
      - emv_config
      title: POIConfigSchema
    TestSuiteSchema:
      properties:
        name:
          type: string
          title: Name
        version:
          type: string
          title: Version
        date:
          type: string
          format: date
          title: Date
        environment:
          $ref: '#/components/schemas/EnvironmentSchema'
        tests:
          items:
            $ref: '#/components/schemas/TestListSchema'
          type: array
          title: Tests
      additionalProperties: false
      type: object
      required:
      - name
      - version
      - date
      - environment
      - tests
      title: TestSuiteSchema
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    EnvironmentSchema:
      properties:
        tool:
          $ref: '#/components/schemas/ToolEnum'
        type:
          $ref: '#/components/schemas/TypeEnum'
        scheme:
          $ref: '#/components/schemas/SchemeEnum'
        test_suite_version:
          type: string
          title: Test Suite Version
      additionalProperties: false
      type: object
      required:
      - tool
      - type
      - scheme
      - test_suite_version
      title: EnvironmentSchema
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: auth/token