test-spec

openapi: 3.0.0
info:
  title: Technical Writer Tasks API
<<<<<<< HEAD
  description: Kfir revised june 3rd #3
=======
  description: Kfir June 3rd
>>>>>>> 34777ab (Revised by kfir june 3rd)
  version: 1.0.0
servers:
  - url: https://api.techwriter.xyz
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
  schemas:
    Task:
      type: object
      properties:
        task_id:
          type: integer
          description: The id of the identified task.
          example: 17
        title:
          type: string
          description: The name of the task.
          example: Update POST /task endpoint request body
        description:
          type: string
          description: Detailed information about a task.
          example: Complete the request body section for POST/task endpoint.
        status:
          $ref: '#/components/schemas/StatusEnum'
        category:
          $ref: '#/components/schemas/CategoryEnum'
        last_updated:
          type: string
          format: date
          description: The date of the latest edit to the task.
          example: '2025-04-03'
        connected_tasks:
          type: array
          items:
            $ref: '#/components/schemas/ConnectedTask'
    TaskInput:
      type: object
      properties:
        title:
          type: string
          description: The name of the task.
          example: Update POST /task endpoint request body
        description:
          type: string
          description: Detailed information about a task.
          example: Complete the request body section for POST/task endpoint.
        status:
          $ref: '#/components/schemas/StatusEnum'
        category:
          $ref: '#/components/schemas/CategoryEnum'
        connected_tasks:
          type: array
          description: An array of tasks related to the identified task.
          items:
            type: integer
            example: 12
      required:
        - title
        - description
    ConnectedTask:
      type: object
      description: A task related to the identified task.
      properties:
        task_id:
          type: integer
          description: The id of the identified task.
          example: 12
        title:
          type: string
          description: The name of the task.
          example: Validate Technical Writer Tasks API OAS
        description:
          type: string
          description: Detailed information about a task.
          example: Correct errors in the existing TWT API OAS to validate the specification file.
        status:
          $ref: '#/components/schemas/StatusEnum'
    StatusEnum:
      type: string
      enum:
        - OPEN
        - IN_PROGRESS
        - COMPLETED
      description: The position of the task in the workflow.
      default: OPEN
    CategoryEnum:
      type: string
      enum:
        - API_DOCS
        - HELP_CENTER
        - SDK_DOCS
        - OAS_FILE
      description: A label used for organizing and tracking a task.
      default: API_DOCS
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Bad Request
            message: The request does not match the expected schema or has incorrect fields.
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource cannot be found.
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: The API key is missing or invalid.
      headers:
        WWW_Authenticate:
          schema:
            type: string
    TooManyRequests:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too Many Requests
            message: This endpoint has received too many requests from the current API key.
security:
  - ApiKeyAuth: []
paths:
  /tasks:
    get:
      summary: Get Tech Writer tasks
      operationId: getTasks
      description: Get all current technical writer tasks.
      parameters:
        - name: status
          in: query
          description: Filter tasks by status.
          required: false
          schema:
            $ref: '#/components/schemas/StatusEnum'
        - name: category
          in: query
          description: Filter tasks by category.
          required: false
          schema:
            $ref: '#/components/schemas/CategoryEnum'
        - name: updatedAfter
          in: query
          description: Filter tasks that have been updated after a specific date (YYYY-MM-DD).
          required: false
          schema:
            type: string
            format: date
            example: YYYY-MM-DD
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Request limit for the current time window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: The number of requests left for the current time window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: date-time
              description: The date/time at which the current rate limit window resets.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'

src/api-service/api-spec-v1/categories/swap/paths/swap_operations:
  post:
    operationId: createSwapOperation
    summary: Create swap operation [Kfir Levi July 3rd 2025!]
    description: |-
      Create swap operation based on a provided quote Id [by Kfir Levi]

      Note: These endpoints are currently in beta and might be subject to changes.

      If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.

      Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor.
    tags:
      - Swap (Beta)
    parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SwapOperationRequest'
    responses:
      '201':
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapOperation'
      default:
        $ref: '#/components/responses/Error'
  get:
    operationId: getSwapOperations
    summary: Get Operations list
    description: |-
      Return a list of swap operations for the specific workspace
      The operations are sorted by creation date in descending order, meaning the most recent operation appears first.

      Note:These endpoints are currently in beta and might be subject to changes.

      If you want to participate and learn more about the Fireblocks TAP, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.

      Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
    tags:
      - Swap (Beta)
    parameters:
      - name: pageCursor
        required: false
        in: query
        description: Cursor of the required page
        schema:
          type: string
      - name: pageSize
        required: false
        in: query
        description: Number of items in a page, Acceptable values are 1-100. Maximum value is 100
        example: 10
        schema:
          minimum: 1
          maximum: 100
          default: 10
          type: number
    responses:
      '200':
        description: A paginated response containing OperationDto objects
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapOperationsPaginatedResponse'
      default:
        $ref: '#/components/responses/Error'

  /task:
    post:
      summary: Add new Tech Writer task
      operationId: addTask
      description: Create a new technical writer task.
      requestBody:
        required: true
        description: Create a new task.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Request limit for the current time window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Just a test decrp
            X-RateLimit-Reset:
              schema:
                type: string
                format: date-time
              description: The date/time at which the current rate limit window resets.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'