Clarity Tickets API

openapi: 3.2.0
info:
  title: Fast Tickets API
  version: 0.1.0
tags:
- name: Tickets
paths:
  /api/v1/tickets:
    post:
      tags:
      - Tickets
      summary: Get Tickets
      operationId: get_tickets_api_v1_tickets_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketsRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/tickets/{ticket_id}/fields:
    patch:
      tags:
      - Tickets
      summary: Update Ticket Fields
      description: 'Update editable fields on a ticket by re-injecting it through

        data-injection-service with every inference step — and translation — skipped.


        Editable keys are ``score``, ``score_scale`` and ``*__filter`` fields

        (new ``*__filter`` fields are created on the fly); ``null`` or ``[]`` clears

        one. Restricted to owner / superuser / survey superuser roles and admins.


        A request that matches what is already stored returns ``unchanged`` without

        calling DIS at all.


        Raises:

        HTTPException: 400 on invalid fields, on a value the index mapping

        cannot hold, or on an out-of-range score, 403 on insufficient role,

        404 when the ticket does not exist, 502 when

        data-injection-service fails or is unreachable.'
      operationId: update_ticket_fields_api_v1_tickets__ticket_id__fields_patch
      security:
      - HTTPBearer: []
      parameters:
      - name: ticket_id
        in: path
        required: true
        schema:
          type: string
          title: Ticket Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTicketFieldsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTicketFieldsResponse'
        '400':
          description: The requested fields or values are not editable
        '403':
          description: Role is not allowed to edit ticket fields
        '404':
          description: Ticket not found in the project index
        '502':
          description: data-injection-service failed or is unreachable
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/tickets/{ticket_id}:
    get:
      tags:
      - Tickets
      summary: Get Ticket Info
      operationId: get_ticket_info_api_v1_tickets__ticket_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: ticket_id
        in: path
        required: true
        schema:
          type: string
          title: Ticket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TicketsRequest:
      properties:
        filters:
          items:
            $ref: '#/components/schemas/QueryFilter'
          type: array
          title: Filters
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
        sorted_by:
          items:
            $ref: '#/components/schemas/QuerySort'
          type: array
          title: Sorted By
      type: object
      required:
      - filters
      - limit
      - offset
      - sorted_by
      title: TicketsRequest
    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
    UpdateTicketFieldsRequest:
      properties:
        fields:
          additionalProperties: true
          type: object
          title: Fields
      type: object
      required:
      - fields
      title: UpdateTicketFieldsRequest
    UpdateTicketFieldsResponse:
      properties:
        status:
          type: string
          title: Status
        unique_id:
          type: string
          title: Unique Id
        fields:
          additionalProperties: true
          type: object
          title: Fields
      type: object
      required:
      - status
      - unique_id
      - fields
      title: UpdateTicketFieldsResponse
    QuerySort:
      properties:
        key:
          type: string
          title: Key
        order:
          anyOf:
          - type: string
            const: asc
          - type: string
            const: desc
          title: Order
          default: asc
      type: object
      required:
      - key
      title: QuerySort
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    QueryFilter:
      properties:
        type:
          anyOf:
          - type: string
            const: exists
          - type: string
            const: list
          - type: string
            const: nested
          - type: string
            const: range
          - type: string
            const: text
          title: Type
        key:
          type: string
          title: Key
        values:
          anyOf:
          - items:
              type: string
            type: array
          - items:
              type: integer
            type: array
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: string
          - type: 'null'
          title: Values
        min:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Min
        max:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Max
        operator:
          anyOf:
          - type: string
            const: eq
          - type: string
            const: neq
          - type: string
            const: contains
          title: Operator
          default: eq
        generated:
          type: boolean
          title: Generated
          default: false
      type: object
      required:
      - type
      - key
      title: QueryFilter
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic