playground.yml

openapi: 3.0.0
info:
  title: API Playground
  version: 1.0.0
  description: This is the API documentation for the API Playground.
servers:
  - url: http://localhost:10500
paths:
  /auth/:
    post:
      summary: Generate a token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: Token generated
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
  /auth/{name}:
    delete:
      summary: Delete a token
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Token deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
    get:
      summary: Get a token by name
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Token retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
  /auth/tokens:
    get:
      summary: Get all tokens
      responses:
        '200':
          description: List of tokens
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /employees:
    get:
      summary: Get paginated list of employees
      parameters:
        - name: page
          in: query
          schema:
            type: integer
        - name: limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: List of employees
          content:
            application/json:
              schema:
                type: object
                properties:
                  length:
                    type: number
                  employees:
                    type: array
                    items:
                      $ref: '#/components/schemas/Employee'
    put:
      summary: Create a new employee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - employee
              properties:
                employee:
                  $ref: '#/components/schemas/Employee'
      responses:
        '201':
          description: Employee created
          content:
            application/json:
              schema:
                type: object
                properties:
                  employee:
                    $ref: '#/components/schemas/Employee'
  /employees/{id}:
    get:
      summary: Get an employee by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 6
            maxLength: 6
      responses:
        '200':
          description: Employee retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  employee:
                    $ref: '#/components/schemas/Employee'
        '404':
          description: Not Found
    patch:
      summary: Update an employee by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 6
            maxLength: 6
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - employee
              properties:
                employee:
                  $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Employee updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  employee:
                    $ref: '#/components/schemas/Employee'
  /departments:
    get:
      summary: Get paginated list of departments
      parameters:
        - name: page
          in: query
          schema:
            type: integer
        - name: limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: List of departments
          content:
            application/json:
              schema:
                type: object
                properties:
                  length:
                    type: number
                  departments:
                    type: array
                    items:
                      $ref: '#/components/schemas/Department'
    put:
      summary: Create a new department
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - department
              properties:
                department:
                  $ref: '#/components/schemas/Department'
      responses:
        '201':
          description: Department created
          content:
            application/json:
              schema:
                type: object
                properties:
                  department:
                    $ref: '#/components/schemas/Department'
  /departments/{id}:
    get:
      summary: Get a department by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 3
            maxLength: 3
      responses:
        '200':
          description: Department retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  department:
                    $ref: '#/components/schemas/Department'
        '404':
          description: Not Found
    patch:
      summary: Update a department by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 3
            maxLength: 3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - department
              properties:
                department:
                  $ref: '#/components/schemas/Department'
      responses:
        '200':
          description: Department updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  department:
                    $ref: '#/components/schemas/Department'
  /echo:
    get:
      summary: Echo request
      responses:
        '200':
          description: Echo response
          content:
            application/json:
              schema:
                type: object
                properties:
                  uri:
                    type: string
                  method:
                    type: string
                  body:
                    type: string
components:
  schemas:
    User:
      type: object
      properties:
        name:
          type: string
    Employee:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/EmployeeId'
        first:
          type: string
          minLength: 1
        last:
          type: string
          minLength: 1
        job:
          type: string
          minLength: 1
        workdept:
          $ref: '#/components/schemas/DepartmentId'
        salary:
          type: number
          minimum: 1
    EmployeeId:
      type: string
      minLength: 6
      maxLength: 6
      description: Employee ID length is 6
    DepartmentId:
      type: string
      minLength: 3
      maxLength: 3
      description: Department ID length is 3
    Department:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/DepartmentId'
        name:
          type: string
        location:
          type: string
          description: Can be undefined if no location is set.
        manager:
          $ref: '#/components/schemas/EmployeeId'
          description: Can be null if no manager is set.