openapi.yaml

openapi: 3.0.1
info:
  title: go-orm-api
  description: go-orm-api
  termsOfService: https://blackdevs.com.br
  contact:
    name: Julio Scheidt
    email: julio@blackdevs.com.br
    url: https://blackdevs.com.br
  license:
    name: MIT License
    url: https://raw.githubusercontent.com/juliocesarscheidt/go-orm-api-clean-arch/main/LICENSE.md
  version: 0.0.1

servers:
  - url: http://go-orm-api.{NAMESPACE}.svc.cluster.local:8000

tags:
  - name: HealthChechServices
    description: Services related to Health Chech resources
  - name: UserServices
    description: Services related to User resources

paths:
  /api/v1/health/live:
    get:
      tags:
        - HealthChechServices
      summary: get liveness
      description: get liveness
      operationId: getLiveness
      responses:
        '200':
          description: 'OK'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        example: 'Alive'
                  metadata:
                    $ref: '#/components/schemas/Metadata'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

  /api/v1/health/ready:
    get:
      tags:
        - HealthChechServices
      summary: get readiness
      description: get readiness
      operationId: getReadiness
      responses:
        '200':
          description: 'OK'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        example: 'Ready'
                  metadata:
                    $ref: '#/components/schemas/Metadata'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

  /api/v1/users:
    post:
      tags:
        - UserServices
      summary: create user
      description: create user
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/UserBodyCreate'
                - type: object
                  properties:
                    password:
                      $ref: '#/components/schemas/Password'

      responses:
        '201':
          description: 'Created'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserSuccessResponse'
        '400':
          description: 'Bad request'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseBadRequest'
        '422':
          description: 'Unprocessable Entity'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseUnprocessableEntityInvalidPasswordLength'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

    get:
      tags:
        - UserServices
      summary: list users
      description: list users
      operationId: listUsers
      parameters:
        - name: page
          in: query
          description: Page to search
          required: true
          schema:
            type: integer
            example: 0
            minimum: 0
        - name: size
          in: query
          description: Size of page
          required: true
          schema:
            type: integer
            example: 50
            maximum: 100
      responses:
        '200':
          description: 'OK'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersSuccessResponse'
        '401':
          description: 'Unauthorized'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseUnauthorized'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

  /api/v1/users/{id}:
    get:
      tags:
        - UserServices
      summary: get user
      description: get user
      operationId: getUser
      parameters:
      - name: id
        in: path
        description: Id for user
        required: true
        schema:
          $ref: '#/components/schemas/Id'
      responses:
        '200':
          description: 'OK'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserSuccessResponse'
        '400':
          description: 'Bad request'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseBadRequest'
        '401':
          description: 'Unauthorized'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseUnauthorized'
        '404':
          description: 'Not found'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseNotFound'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

    patch:
      tags:
        - UserServices
      summary: update user
      description: update user
      operationId: updateUser
      parameters:
      - name: id
        in: path
        description: Id for user
        required: true
        schema:
          $ref: '#/components/schemas/Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserBodyUpdate'
      responses:
        '202':
          description: 'Accepted'
        '400':
          description: 'Bad request'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseBadRequest'
        '401':
          description: 'Unauthorized'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseUnauthorized'
        '404':
          description: 'Not found'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseNotFound'

        '422':
          description: 'Unprocessable Entity'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseUnprocessableEntityInvalidPasswordLength'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

    delete:
      tags:
        - UserServices
      summary: delete user
      description: delete user
      operationId: deleteUser
      parameters:
      - name: id
        in: path
        description: Id for user
        required: true
        schema:
          $ref: '#/components/schemas/Id'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseBadRequest'
        '401':
          description: 'Unauthorized'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseUnauthorized'
        '404':
          description: 'Not found'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseNotFound'
        '500':
          description: 'Internal server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultResponseServerError'

components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

  schemas:
    DefaultResponseBadRequest:
      type: object
      properties:
        message:
          type: string
          description: 'Status code'
          example: 'Bad request'

    DefaultResponseUnauthorized:
      type: object
      properties:
        message:
          type: string
          description: 'Status code'
          example: 'Unauthorized'

    DefaultResponseNotFound:
      type: object
      properties:
        message:
          type: string
          description: 'Status code'
          example: 'Not found'

    ResponseUnprocessableEntityInvalidPasswordLength:
      type: object
      properties:
        message:
          type: string
          description: 'Status code'
          example: 'Invalid password length, the password must have at least 8 and at most 50 characters'

    DefaultResponseServerError:
      type: object
      properties:
        message:
          type: string
          description: 'Status code'
          example: 'Internal server error'

    Id:
      type: number
      example: 1

    Name:
      type: string
      example: John Doe

    Email:
      type: string
      example: johndoe@mail.com

    Password:
      type: string
      minLength: 8
      maxLength: 50

    Metadata:
      type: object
      nullable: true
      properties:
        total:
          type: number
          example: 10

    CreatedAt:
      type: string
      format: date-time
      example: '2021-01-01T12:00:00.000Z'

    UpdatedAt:
      type: string
      format: date-time
      example: '2021-01-01T12:00:00.000Z'

    DeletedAt:
      anyOf:
        - type: string
          format: date-time
          example: '2021-01-01T12:00:00.000Z'
        - type: string
          example: ""

    UserBodyCreate:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        email:
          $ref: '#/components/schemas/Email'

    UserBodyUpdate:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        password:
          $ref: '#/components/schemas/Password'

    UserFull:
      properties:
        id:
          $ref: '#/components/schemas/Id'
        name:
          $ref: '#/components/schemas/Name'
        email:
          $ref: '#/components/schemas/Email'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        deleted_at:
          $ref: '#/components/schemas/DeletedAt'

    CreateUserSuccessResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Id'
        metadata:
          $ref: '#/components/schemas/Metadata'

    GetUserSuccessResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserFull'
        metadata:
          $ref: '#/components/schemas/Metadata'

    ListUsersSuccessResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserFull'
        metadata:
          $ref: '#/components/schemas/Metadata'