swagger: "2.0"

info:
  version: 1.0.0
  title: API Specifications

schemes:
  - https
host: qa-ows-participant.theorchard.io
paths:
  /:
    get:
      summary: Hello World path.
      responses:
        200:
          description: 200 OK
          examples:
            text/html: "Hello Bill!"
  /{username}:
    get:
      summary: Hello World with an optional GET param "username".
      parameters:
        - in: path
          name: username
          required: true
          type: string
      responses:
        200:
          description: 200 OK
          examples:
            text/html: "Hello Bill!"
  /hello/:
    get:
      summary: Check the health of the application.
      responses:
        200:
          description: 200 OK
          examples:
            application/json: { "status": "ok" }
  /lookup/label-participants/uuids/tenant-hierarchy/:
    post:
      summary: Dataloader-style endpoint for looking up tenant hierarchies by uuids.
      parameters:
        - name: input
          in: body
          required: true
          schema:
            type: object
            properties:
              uuids:
                type: array
                description: Non-empty list of uuids
                items:
                  type: string
            required:
            - uuids
      responses:
        200:
          description: A list of label participants in dataloader-format
          schema:
            type: object
            properties:
              label_participants:
                type: array
                items:
                  type: object
                  description: If not found in datastore, null will be returned
                  properties:
                    uuid:
                      type: string
                    vendor_uuid:
                      type: string
                    subaccount_uuid:
                      type: string
                      description: If label_participant does not belong to a subaccount, null will be returned
                    company_brand_uuid:
                      type: string