swagger.json

{
  "basePath": "/",
  "consumes": ["application/json"],
  "definitions": {
    "TokenAPI": {
      "properties": {
        "userId": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "role": {
          "type": "string"
        },
        "accessToken": {
          "type": "string"
        },
        "refreshToken": {
          "type": "string"
        },
        "expiresIn": {
          "type": "number",
          "format": "double"
        }
      },
      "required": ["userId", "username", "role", "accessToken", "refreshToken", "expiresIn"],
      "type": "object",
      "additionalProperties": false
    },
    "ErrorValidacion": {
      "properties": {
        "propertyPath": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "required": ["propertyPath", "code", "message"],
      "type": "object",
      "additionalProperties": false
    },
    "ErrorResponse": {
      "properties": {
        "stack": {
          "type": "string",
          "x-nullable": true
        },
        "result": {
          "type": "string",
          "enum": ["error"]
        },
        "status": {
          "type": "number",
          "format": "double"
        },
        "userMessage": {
          "type": "string"
        },
        "developerMessage": {
          "type": "string"
        },
        "validationErrors": {
          "items": {
            "$ref": "#/definitions/ErrorValidacion"
          },
          "type": "array"
        }
      },
      "required": ["result", "status", "userMessage", "developerMessage", "validationErrors"],
      "type": "object",
      "additionalProperties": false
    },
    "TokenRequest": {
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      },
      "required": ["username", "password"],
      "type": "object",
      "additionalProperties": false,
      "example": {
        "username": "ipianetti",
        "password": "1234"
      }
    },
    "RefreshTokenRequest": {
      "properties": {
        "refreshToken": {
          "type": "string"
        }
      },
      "required": ["refreshToken"],
      "type": "object",
      "additionalProperties": false,
      "example": {
        "refreshToken": "427c5188b462e6ed9ccfa89f46e91a0"
      }
    },
    "UsuarioAPI": {
      "properties": {
        "id": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "role": {
          "type": "string"
        }
      },
      "required": ["id", "username", "role"],
      "type": "object",
      "additionalProperties": false
    },
    "UsuarioResponseData": {
      "properties": {
        "result": {
          "type": "string",
          "default": "ok",
          "x-nullable": true
        },
        "status": {
          "type": "number",
          "format": "double",
          "default": 200,
          "x-nullable": true
        },
        "data": {
          "$ref": "#/definitions/UsuarioAPI"
        },
        "userMessage": {
          "type": "string"
        },
        "actions": {
          "type": "string"
        }
      },
      "required": ["data", "userMessage", "actions"],
      "type": "object",
      "additionalProperties": false
    },
    "ChangePasswordRequest": {
      "properties": {
        "oldPassword": {
          "type": "string"
        },
        "newPassword": {
          "type": "string"
        }
      },
      "required": ["oldPassword", "newPassword"],
      "type": "object",
      "additionalProperties": false,
      "example": {
        "oldPassword": "asdf",
        "newPassword": "1234"
      }
    },
    "StatusApp": {
      "properties": {
        "app": {
          "type": "boolean"
        },
        "database": {
          "type": "boolean"
        },
        "error": {
          "type": "boolean"
        },
        "errors": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": ["app", "database", "error", "errors"],
      "type": "object",
      "additionalProperties": false
    },
    "AppInfo": {
      "properties": {
        "version": {
          "type": "string"
        },
        "revision": {
          "type": "string"
        },
        "branch": {
          "type": "string"
        },
        "buildDate": {
          "type": "string"
        },
        "buildNumber": {
          "type": "string"
        }
      },
      "required": ["version", "revision", "branch", "buildDate", "buildNumber"],
      "type": "object",
      "additionalProperties": false
    },
    "HealthCheck": {
      "properties": {
        "status": {
          "$ref": "#/definitions/StatusApp"
        },
        "appInfo": {
          "$ref": "#/definitions/AppInfo"
        }
      },
      "required": ["status", "appInfo"],
      "type": "object",
      "additionalProperties": false
    },
    "MetadataResponse": {
      "properties": {
        "offset": {
          "type": "number",
          "format": "double"
        },
        "limit": {
          "type": "number",
          "format": "double"
        },
        "count": {
          "type": "number",
          "format": "double"
        }
      },
      "required": ["offset", "limit", "count"],
      "type": "object",
      "additionalProperties": false
    },
    "UsuarioAPIPaginacion": {
      "properties": {
        "metadata": {
          "$ref": "#/definitions/MetadataResponse"
        },
        "results": {
          "items": {
            "$ref": "#/definitions/UsuarioAPI"
          },
          "type": "array"
        }
      },
      "required": ["metadata", "results"],
      "type": "object",
      "additionalProperties": false
    },
    "UsuarioResponsePaginacion": {
      "properties": {
        "result": {
          "type": "string",
          "default": "ok",
          "x-nullable": true
        },
        "status": {
          "type": "number",
          "format": "double",
          "default": 200,
          "x-nullable": true
        },
        "data": {
          "$ref": "#/definitions/UsuarioAPIPaginacion"
        },
        "userMessage": {
          "type": "string"
        },
        "actions": {
          "type": "string"
        }
      },
      "required": ["data", "userMessage", "actions"],
      "type": "object",
      "additionalProperties": false
    },
    "UsuarioCreationRequest": {
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "role": {
          "type": "string"
        }
      },
      "required": ["username", "password", "role"],
      "type": "object",
      "additionalProperties": false
    },
    "UsuarioUpdateRequest": {
      "properties": {
        "username": {
          "type": "string",
          "x-nullable": true
        },
        "role": {
          "type": "string",
          "x-nullable": true
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "info": {
    "title": "api-node",
    "version": "0.0.1",
    "description": "Node REST API: https://github.com/bipiane/api-node"
  },
  "paths": {
    "/auth/token": {
      "post": {
        "operationId": "token",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Ok",
            "schema": {
              "$ref": "#/definitions/TokenAPI"
            }
          },
          "400": {
            "description": "Username y password son requeridos",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "401": {
            "description": "Username o password incorrecto",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Obtención de Token JWT con username y password",
        "tags": ["Auth"],
        "security": [],
        "parameters": [
          {
            "in": "body",
            "name": "data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TokenRequest"
            }
          }
        ]
      }
    },
    "/auth/refresh": {
      "post": {
        "operationId": "refresh",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Ok",
            "schema": {
              "$ref": "#/definitions/TokenAPI"
            }
          },
          "400": {
            "description": "refreshToken es requerido",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "401": {
            "description": "RefreshToken incorrecto o revocado",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Obtención de Token JWT con refresh token",
        "tags": ["Auth"],
        "security": [],
        "parameters": [
          {
            "in": "body",
            "name": "data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/RefreshTokenRequest"
            }
          }
        ]
      }
    },
    "/auth/revoke": {
      "get": {
        "operationId": "revokeToken",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Refresh Token revocado correctamente"
          },
          "404": {
            "description": "No se encontró usuario con ID 123",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "409": {
            "description": "Errores de validación",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Revoca o vence el refresh token del usuario",
        "tags": ["Auth"],
        "security": [
          {
            "access_token": []
          }
        ],
        "parameters": []
      }
    },
    "/auth/changePassword": {
      "put": {
        "operationId": "changePassword",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Ok",
            "schema": {
              "$ref": "#/definitions/UsuarioResponseData"
            }
          },
          "400": {
            "description": "La clave nueva y actual clave son requeridas",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "401": {
            "description": "La clave actual es incorrecta",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "409": {
            "description": "Errores de validación",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Modificar clave",
        "tags": ["Auth"],
        "security": [
          {
            "access_token": []
          }
        ],
        "parameters": [
          {
            "in": "body",
            "name": "data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ChangePasswordRequest"
            }
          }
        ]
      }
    },
    "/health": {
      "get": {
        "operationId": "getHealthCheck",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Ok",
            "schema": {
              "$ref": "#/definitions/HealthCheck"
            }
          }
        },
        "summary": "Obtiene el estado de salud e información de la App",
        "tags": ["Health"],
        "security": [],
        "parameters": []
      }
    },
    "/api/v1/usuarios": {
      "get": {
        "operationId": "findAllUsuarios",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Ok",
            "schema": {
              "$ref": "#/definitions/UsuarioResponsePaginacion"
            }
          }
        },
        "summary": "Obtiene una lista de usuarios",
        "tags": ["Usuario"],
        "security": [
          {
            "access_token": ["SUPER_ADMIN"]
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "format": "double",
            "type": "number"
          },
          {
            "in": "query",
            "name": "offset",
            "required": false,
            "format": "double",
            "type": "number"
          }
        ]
      },
      "post": {
        "operationId": "saveUsuario",
        "produces": ["application/json"],
        "responses": {
          "201": {
            "description": "Usuario creado correctamente",
            "schema": {
              "$ref": "#/definitions/UsuarioResponseData"
            }
          },
          "409": {
            "description": "Errores de validación",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Permite crear un usuario",
        "tags": ["Usuario"],
        "security": [
          {
            "access_token": ["SUPER_ADMIN"]
          }
        ],
        "parameters": [
          {
            "in": "body",
            "name": "data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UsuarioCreationRequest"
            }
          }
        ]
      }
    },
    "/api/v1/usuarios/{id}": {
      "get": {
        "operationId": "findUsuario",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Ok",
            "schema": {
              "$ref": "#/definitions/UsuarioResponseData"
            }
          },
          "404": {
            "description": "No se encontró usuario con ID 123",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Obtiene un usuario por ID",
        "tags": ["Usuario"],
        "security": [
          {
            "access_token": ["SUPER_ADMIN"]
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ]
      },
      "put": {
        "operationId": "updateUsuario",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Usuario actualizado correctamente",
            "schema": {
              "$ref": "#/definitions/UsuarioResponseData"
            }
          },
          "404": {
            "description": "No se encontró usuario con ID 123",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "409": {
            "description": "Errores de validación",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Permite actualizar un usuario por ID",
        "tags": ["Usuario"],
        "security": [
          {
            "access_token": ["SUPER_ADMIN"]
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "data",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UsuarioUpdateRequest"
            }
          }
        ]
      },
      "delete": {
        "operationId": "deleteUsuario",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Usuario eliminado correctamente",
            "schema": {
              "$ref": "#/definitions/UsuarioResponseData"
            }
          },
          "404": {
            "description": "No se encontró usuario con ID 123",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        },
        "summary": "Permite borrar un usuario por ID",
        "tags": ["Usuario"],
        "security": [
          {
            "access_token": ["SUPER_ADMIN"]
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "type": "string"
          }
        ]
      }
    }
  },
  "produces": ["application/json"],
  "swagger": "2.0",
  "securityDefinitions": {
    "access_token": {
      "name": "Authorization",
      "type": "apiKey",
      "in": "header",
      "description": "Access Token JWT"
    }
  }
}