Tasks Open API Specification

tasks.yaml

openapi: 3.1.0
info:
  title: Tasks API
  description: A simple CRUD API for managing tasks.
  version: 1.0.0
  contact:
    name: API Support
    email: [email protected]
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT

servers:
  - url: https://api.tasks.com
    description: Production Server
  - url: http://localhost:8000/api
    description: Local Development Server

tags:
  - name: Tasks
    description: Endpoints for managing tasks.

paths:
  /tasks:
    get:
      description: Get all tasks
      operationId: getTasks
      tags:
        - Tasks
      security:
        - bearerAuth: []
      responses:
        '200':
          description: List of tasks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'
    post:
      description: Create a new task
      operationId: createTask
      tags:
        - Tasks
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreateRequest'
      responses:
        '201':
          description: Task created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /tasks/{taskId}:
    get:
      description: Get a specific task by ID
      operationId: getTaskById
      tags:
        - Tasks
      security:
        - bearerAuth: []
      parameters:
        - name: taskId
          in: path
          required: true
          description: ID of the task
          schema:
            type: integer
      responses:
        '200':
          description: Task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '404':
          description: Task not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

    put:
      description: Update a task
      operationId: updateTask
      tags:
        - Tasks
      security:
        - bearerAuth: []
      parameters:
        - name: taskId
          in: path
          required: true
          description: ID of the task
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskUpdateRequest'
      responses:
        '200':
          description: Task updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Task not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

    delete:
      description: Delete a task
      operationId: deleteTask
      tags:
        - Tasks
      security:
        - bearerAuth: []
      parameters:
        - name: taskId
          in: path
          required: true
          description: ID of the task
          schema:
            type: integer
      responses:
        '204':
          description: Task deleted successfully
        '404':
          description: Task not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    Task:
      type: object
      properties:
        id:
          type: integer
          example: 1
        title:
          type: string
          example: "Complete Laravel API Training"
        description:
          type: string
          nullable: true
          example: "Prepare training slides and examples."
        status:
          type: string
          enum: [pending, in_progress, completed]
          example: "pending"
        due_date:
          type: string
          format: date
          example: "2025-03-01"
        created_at:
          type: string
          format: date-time
          example: "2025-02-23T12:00:00Z"
        updated_at:
          type: string
          format: date-time
          example: "2025-02-23T12:00:00Z"

    TaskCreateRequest:
      type: object
      required:
        - title
        - status
      properties:
        title:
          type: string
          example: "Complete Laravel API Training"
        description:
          type: string
          nullable: true
          example: "Prepare training slides and examples."
        status:
          type: string
          enum: [pending, in_progress, completed]
          example: "pending"
        due_date:
          type: string
          format: date
          nullable: true
          example: "2025-03-01"

    TaskUpdateRequest:
      type: object
      properties:
        title:
          type: string
          example: "Update Laravel API training slides"
        description:
          type: string
          nullable: true
          example: "Refine the content with new Laravel 11 features."
        status:
          type: string
          enum: [pending, in_progress, completed]
          example: "in_progress"
        due_date:
          type: string
          format: date
          nullable: true
          example: "2025-03-10"

    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: "Task not found"
        errors:
          type: object
          nullable: true
          example: null