openapi: 3.0.0
info:
  title: Tickets API
  version: 1.0.0
paths:
  /acs/GetDownloadTicketByIdAndType:
    get:
      summary: get ticket's metadata
      operationId: GetDownloadTicketByIdAndType
      parameters:
      - in: query
        name: AssetReferenceId
        description: asset identifier
        required: true
        schema:
          type: integer
      - in: query
        name: AssetReferenceType
        description: asset type
        required: true
        schema:
          type: integer
      - in: query
        name: Tags
        description: asset tags
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: Revision
        description: asset revision
        required: false
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDownloadTicketResponse'

  /acs/GetDownloadTicketsByTags:
    get:
      summary: get multiple ticket's metadata
      operationId: GetDownloadManyTicketsByIdAndType
      parameters:
      - in: query
        name: AssetReferenceId
        description: asset identifier
        required: true
        schema:
          type: integer
      - in: query
        name: AssetReferenceType
        description: asset type
        required: true
        schema:
          type: integer
      - in: query
        name: Tags
        description: asset tags
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: Revision
        description: asset revision
        required: false
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDownloadTicketsByTagsResponse'

components:
  schemas:
    TicketAssetMetaData:
      type: object
      properties:
        Url:
          type: string
          description: url to download the asset file
        RevisionLink:
          type: string
          description: ...
        Method:
          type: string
          description: ... maybe available http method for url
        Token:
          type: string
          description: ...
        MaxTimeout:
          type: integer
          description: ...
        FilePath:
          type: string
          description: path to asset file in S3
        Revision:
          type: string
          description: some revision
        FileAccessPermissions:
          type: integer
          description: some magic numbers for some permissions
        BinaryChecksum:
          type: string
          description: checksum of the file (I think it's responsibility of the S3 storage)
        IsFound:
            type: boolean
            description: exists asset file or not (I think 404 should be used instead of this)

    GetDownloadTicketResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/TicketAssetMetaData'


    GetDownloadTicketsByTagsResponse:
      type: array
      items:
        $ref: '#/components/schemas/TicketAssetMetaData'