openapi.yml

openapi: 3.1.0
info:
  description: "Backend API for Blogs project."
  version: 1.0.0
  title: Blogs API
  contact:
    email: modscleo4@modscleo4.dev.br
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://localhost:3000
    description: Development server
  - url: https://blogs.modscleo4.dev.br/api/
    description: Production server
tags:
  - name: Auth
    description: Authentication
  - name: User
    description: Users
  - name: RSS
    description: RSS Feeds
  - name: Post
    description: Posts
  - name: Reply
    description: Post replies
  - name: Vote
    description: Post and Reply votes
paths:
  /auth/register:
    post:
      tags:
        - Auth
      summary: Register a new user
      operationId: auth.register
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestUser'
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthUser'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '409':
          description: Username or email already in use
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationErrorsResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /auth/user:
    get:
      tags:
        - Auth
      summary: Get current user
      operationId: auth.user.show
      security:
        - oauth2: []
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthUser'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    put:
      tags:
        - Auth
      summary: Update current user
      operationId: auth.user.update
      security:
        - oauth2: ['write:profile']
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestUser'
      responses:
        '200':
          description: User updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthUser'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Username or email already in use
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationErrorsResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    patch:
      tags:
        - Auth
      summary: Partially update current user
      operationId: auth.user.patch
      security:
        - oauth2: ['write:profile']
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestUser'
      responses:
        '200':
          description: User updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthUser'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Username or email already in use
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ValidationErrorsResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/index.rss:
    get:
      tags:
        - RSS
      summary: Get all posts in RSS format
      operationId: post.rss
      responses:
        '200':
          description: Posts found
          content:
            application/rss+xml:
              schema:
                $ref: '#/components/schemas/RSS'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/user/@{username}.rss:
    get:
      tags:
        - RSS
      summary: Get all posts from a user in RSS format
      operationId: user.rss
      parameters:
        - name: username
          in: path
          description: User's username
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Posts found
          content:
            application/rss+xml:
              schema:
                $ref: '#/components/schemas/RSS'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/user/@{username}:
    get:
      tags:
        - User
      summary: Get user by username
      operationId: user.showByUsername
      parameters:
        - name: username
          in: path
          description: User's username
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/user/{id}:
    get:
      tags:
        - User
      summary: Get user by ID
      operationId: user.show
      parameters:
        - name: id
          in: path
          description: User's ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/post:
    get:
      tags:
        - Post
      summary: Get all posts
      operationId: post.list
      parameters:
        - name: fields
          in: query
          description: Post's fields
          required: false
          schema:
            type: string
            example: id,title,resume,content,createdAt,updatedAt
        - name: username
          in: query
          description: Post's author username
          required: false
          schema:
            type: string
            example: myusername
      responses:
        '200':
          description: Posts found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PostList'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    post:
      tags:
        - Post
      summary: Create a new post
      operationId: post.create
      security:
        - oauth2: ['write:posts']
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPost'
      responses:
        '201':
          description: Post created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/post/{id}:
    get:
      tags:
        - Post
      summary: Get a post by ID
      operationId: post.show
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Post found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    put:
      tags:
        - Post
      summary: Update a post by ID
      operationId: post.update
      security:
        - oauth2: ['write:posts']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPost'
      responses:
        '200':
          description: Post updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    patch:
      tags:
        - Post
      summary: Partially update a post by ID
      operationId: post.patch
      security:
        - oauth2: ['write:posts']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPost'
      responses:
        '200':
          description: Post updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    delete:
      tags:
        - Post
      summary: Delete a post by ID
      operationId: post.destroy
      security:
        - oauth2: ['delete:posts']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Post deleted
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/post/{postId}/reply:
    post:
      tags:
        - Reply
      summary: Reply to a Post
      operationId: post.reply.create
      security:
        - oauth2: ['write:replies']
      parameters:
        - name: postId
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestReply'
      responses:
        '201':
          description: Reply created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reply'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/reply/{replyId}/reply:
    post:
      tags:
        - Reply
      summary: Reply to a Reply
      operationId: reply.reply.create
      security:
        - oauth2: ['write:replies']
      parameters:
        - name: replyId
          in: path
          description: Parent Reply's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestReply'
      responses:
        '201':
          description: Reply created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reply'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/reply/{id}:
    get:
      tags:
        - Reply
      summary: Get a reply by ID
      operationId: reply.show
      parameters:
        - name: id
          in: path
          description: Reply's ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Reply found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reply'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '404':
          description: Reply not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    put:
      tags:
        - Reply
      summary: Update a reply by ID
      operationId: reply.update
      security:
        - oauth2: ['write:replies']
      parameters:
        - name: id
          in: path
          description: Reply's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestReply'
      responses:
        '200':
          description: Reply updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reply'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Reply not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    patch:
      tags:
        - Reply
      summary: Partially update a reply by ID
      operationId: reply.patch
      security:
        - oauth2: ['write:replies']
      parameters:
        - name: id
          in: path
          description: Reply's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestReply'
      responses:
        '200':
          description: Reply updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reply'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Reply not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    delete:
      tags:
        - Reply
      summary: Delete a reply by ID
      operationId: reply.destroy
      security:
        - oauth2: ['delete:replies']
      parameters:
        - name: id
          in: path
          description: Reply's ID
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Reply deleted
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Reply not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/post/{id}/vote:
    get:
      tags:
        - Vote
      summary: Get the current vote on a post
      operationId: post.vote.show
      security:
        - oauth2: []
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Vote found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVote'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post or Vote not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    put:
      tags:
        - Vote
      summary: Vote on a post
      operationId: post.vote.update
      security:
        - oauth2: ['vote:posts']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPostVote'
      responses:
        '200':
          description: Post voted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVote'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    delete:
      tags:
        - Vote
      summary: Delete a post vote by ID
      operationId: post.vote.destroy
      security:
        - oauth2: ['vote:posts']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Vote deleted
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post or Vote not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
  /v1/reply/{id}/vote:
    get:
      tags:
        - Vote
      summary: Get the current vote on a reply
      operationId: reply.vote.show
      security:
        - oauth2: []
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Vote found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVote'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post or Vote not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    put:
      tags:
        - Vote
      summary: Vote on a reply
      operationId: reply.vote.update
      security:
        - oauth2: ['vote:replies']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPostVote'
      responses:
        '200':
          description: Post voted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVote'
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
    delete:
      tags:
        - Vote
      summary: Delete a reply vote by ID
      operationId: reply.vote.destroy
      security:
        - oauth2: ['vote:replies']
      parameters:
        - name: id
          in: path
          description: Post's ID
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Vote deleted
        '400':
          description: Invalid request
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationErrorResponse'
                  - $ref: '#/components/schemas/ValidationErrorsResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Post or Vote not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 password flow
      flows:
        password:
          tokenUrl: oauth/token
          scopes:
            write:profile: Write profile
            write:posts: Write posts
            vote:posts: Vote posts
            delete:posts: Delete posts
            write:replies: Write replies
            vote:replies: Vote replies
            delete:replies: Delete replies
  schemas:
    ProblemDetailsResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type
          example: about:blank
        title:
          type: string
          description: Error title
          example: Invalid request
        status:
          type: integer
          description: HTTP status code
          example: 400
        detail:
          type: string
          description: Error detail
          example: Invalid body
        instance:
          type: string
          description: Error instance
          example: /auth/register
    ServerErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ProblemDetailsResponse'
        - type: object
          properties:
            stack:
              type: array
              description: Error stack
              items:
                type: object
                properties:
                  method:
                    type: string
                    description: Method name
                    example: AppController.index
                  file:
                    type: string
                    description: File name
                    example: AppController.ts
                  line:
                    type: integer
                    description: Line number
                    example: 10
                  column:
                    type: integer
                    description: Column number
                    example: 10
    ValidationErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ProblemDetailsResponse'
        - type: object
          properties:
            error:
              type: string
              description: Single validation error (if it's not related to a field)
              example: Invalid body
    ValidationErrorsResponse:
      allOf:
        - $ref: '#/components/schemas/ProblemDetailsResponse'
        - type: object
          properties:
            errors:
              type: object
              description: Validation errors
              example: { "username": ["This field is required"], "password": ["This field is required"] }
              patternProperties:
                ^[a-zA-Z0-9_]+$:
                  type: array
                  items:
                    type: string
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ProblemDetailsResponse'
        - type: object
    RequestUser:
      type: object
      required:
        - username
        - email
        - name
        - password
      properties:
        username:
          type: string
          description: User's username
          example: myusername
        email:
          type: string
          description: User's email
          example: username@example.com
        name:
          type: string
          description: User's name
          example: My Name
        bio:
          type: string
          description: User's bio
          example: My bio
        password:
          type: string
          description: User's password
          example: "12345678"
    AuthUser:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: User's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        username:
          type: string
          description: User's username
          example: myusername
        email:
          type: string
          description: User's email
          example: username@example.com
        name:
          type: string
          description: User's name
          example: My Name
        bio:
          type: string
          description: User's bio
          example: My bio
          nullable: true
        emailVerifiedAt:
          type: string
          format: date-time
          description: User's email verification date
          example: "2021-01-01T00:00:00.000Z"
          nullable: true
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: User's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        username:
          type: string
          description: User's username
          example: myusername
        name:
          type: string
          description: User's name
          example: My Name
        bio:
          type: string
          description: User's bio
          example: My bio
          nullable: true
        posts:
          type: integer
          description: User's posts count
          example: 1
    Content:
      type: object
      required:
        - time
        - blocks
        - version
      properties:
        time:
          type: integer
          description: Content's time
          example: 1612128000000
        blocks:
          type: array
          description: Content's body
          items:
            type: object
            required:
              - type
              - data
            properties:
              type:
                type: string
                description: Block's type
                example: paragraph
              data:
                type: object
                description: Block's data
                example: { "text": "My post content" }
        version:
          type: string
          description: Content's version
          example: 2.18.0
    RequestPost:
      type: object
      required:
        - title
        - resume
        - content
      properties:
        title:
          type: string
          description: Post's title
          example: My Post
        resume:
          type: string
          description: Post's resume
          example: My post resume
        content:
          $ref: '#/components/schemas/Content'
        imageUrl:
          type: string
          description: Post's image URL
          example: https://example.com/image.png
    PostList:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Post's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        userId:
          type: string
          format: uuid
          description: Post's user UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        title:
          type: string
          description: Post's title
          example: My Post
        resume:
          type: string
          description: Post's resume
          example: My post resume
        content:
          $ref: '#/components/schemas/Content'
        imageUrl:
          type: string
          description: Post's image URL
          example: https://example.com/image.png
        createdAt:
          type: string
          format: date-time
          description: Post's creation date
          example: "2021-01-01T00:00:00.000Z"
        updatedAt:
          type: string
          format: date-time
          description: Post's last update date
          example: "2021-01-01T00:00:00.000Z"
          nullable: true
    Post:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Post's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        userId:
          type: string
          format: uuid
          description: Post's user UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        title:
          type: string
          description: Post's title
          example: My Post
        resume:
          type: string
          description: Post's resume
          example: My post resume
        content:
          $ref: '#/components/schemas/Content'
        imageUrl:
          type: string
          description: Post's image URL
          example: https://example.com/image.png
        createdAt:
          type: string
          format: date-time
          description: Post's creation date
          example: "2021-01-01T00:00:00.000Z"
        updatedAt:
          type: string
          format: date-time
          description: Post's last update date
          example: "2021-01-01T00:00:00.000Z"
          nullable: true
        replies:
          type: array
          description: Post's replies
          items:
            type: string
            format: uuid
            description: Reply's UUID
            example: 123e4567-e89b-12d3-a456-426614174000
        votes:
          type: object
          description: Post's votes by kind
          example: { "UPVOTE": 1, "DOWNVOTE": 0 }
          patternProperties:
            ^[a-zA-Z0-9_]+$:
              type: integer
              description: Vote's count
              example: 1
    RequestReply:
      type: object
      required:
        - content
      properties:
        content:
          $ref: '#/components/schemas/Content'
    Reply:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Reply's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        userId:
          type: string
          format: uuid
          description: Reply's user UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        postId:
          type: string
          format: uuid
          description: Reply's post UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        replyId:
          type: string
          format: uuid
          description: Reply's parent reply UUID
          nullable: true
          example: 123e4567-e89b-12d3-a456-426614174000
        content:
          $ref: '#/components/schemas/Content'
        createdAt:
          type: string
          format: date-time
          description: Reply's creation date
          example: "2021-01-01T00:00:00.000Z"
        updatedAt:
          type: string
          format: date-time
          description: Reply's last update date
          example: "2021-01-01T00:00:00.000Z"
          nullable: true
        replies:
          type: array
          description: Reply's replies
          items:
            type: string
            format: uuid
            description: Reply's UUID
            example: 123e4567-e89b-12d3-a456-426614174000
        votes:
          type: object
          description: Reply's votes by kind
          example: { "UPVOTE": 1, "DOWNVOTE": 0 }
          patternProperties:
            ^[a-zA-Z0-9_]+$:
              type: integer
              description: Vote's count
              example: 1
    RequestPostVote:
      type: object
      properties:
        kind:
          type: string
          description: Vote kind
          example: UPVOTE
    PostVote:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Vote's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        postId:
          type: string
          format: uuid
          description: Post's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        userId:
          type: string
          format: uuid
          description: User's UUID
          example: 123e4567-e89b-12d3-a456-426614174000
        kind:
          type: string
          description: Vote kind
          example: UPVOTE
        createdAt:
          type: string
          format: date-time
          description: Post's creation date
          example: "2021-01-01T00:00:00.000Z"
        updatedAt:
          type: string
          format: date-time
          description: Post's last update date
          example: "2021-01-01T00:00:00.000Z"
          nullable: true
    RSS:
      type: object
      xml:
        name: rss
      properties:
        version:
          type: string
          description: RSS version
          example: '2.0'
          xml:
            attribute: true
        channel:
          type: object
          properties:
            title:
              type: string
              description: Name of the channel
              example: My RSS
            description:
              type: string
              description: Phrase or sentence describing the channel.
              example: My RSS description
            link:
              type: string
              description: The URL to the HTML website corresponding to the channel.
              example: https://example.com/rss
            items:
              type: array
              description: Channel items
              items:
                type: object
                properties:
                  title:
                    type: string
                    description: The title of the item.
                    example: My Item
                  description:
                    type: string
                    description: The item synopsis.
                    example: My Item description
                  link:
                    type: string
                    description: The URL of the item.
                    example: https://example.com/item
                  guid:
                    type: string
                    description: A string that uniquely identifies the item.
                    example: 123e4567-e89b-12d3-a456-426614174000
                  pubDate:
                    type: string
                    format: date-time
                    description: Indicates when the item was published.
                    example: "Sat, 07 Sep 2002 00:00:01 GMT"