openapi: 3.0.3
info:
  title: SquashTM REST API
  version: 14.0.0
  description: Partial API specification for retrieving Test Plan Items (TPI) and synchronized requirements. Includes the essential endpoints required for the Xsquash Cloud plugin.

servers:
  - url: "{baseUrl}/api/rest/latest"
    description: Base URL of your SquashTM instance
    variables:
      baseUrl:
        default: "https://squashtm.example.com"

paths:
  /attachments/{id}/content:
    get:
      summary: Download attachment content
      description: Downloads the content of the attachment identified by `id`
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the attachment
          schema:
            type: integer
      responses:
        '200':
          description: Returns the attachment content
          content:
            application/octet-stream: {}

  /requirements:
    get:
      summary: Get synchronized requirements
      description: Returns requirements linked to a remote ticket
      parameters:
        - name: remote_key
          in: query
          required: true
          schema: { type: string }
        - name: server_name
          in: query
          required: true
          schema: { type: string }
        - name: fields
          in: query
          required: false
          schema: { type: string }
        - name: page
          in: query
          required: false
          schema: { type: integer, default: 0 }
        - name: size
          in: query
          required: false
          schema: { type: integer, default: 20 }
        - name: sort
          in: query
          required: false
          schema: { type: string }
      responses:
        '200': { description: OK }

  /test-plan-items:
    get:
      summary: Get Test Plan Items (TPI)
      description: Returns TPI linked to a synchronized requirement
      parameters:
        - name: remote_key
          in: query
          required: true
          schema: { type: string }
        - name: server_name
          in: query
          required: true
          schema: { type: string }
        - name: fields
          in: query
          required: false
          schema: { type: string }
        - name: page
          in: query
          required: false
          schema: { type: integer, default: 0 }
        - name: size
          in: query
          required: false
          schema: { type: integer, default: 20 }
        - name: sort
          in: query
          required: false
          schema: { type: string }
      responses:
        '200': { description: OK }

  /xsquash/is-valid-license:
    get:
      summary: Check if SquashTM license is valid
      description: Returns whether the current SquashTM license is valid
      responses:
        '200':
          description: License validity status
          content:
            application/json:
              schema:
                type: boolean