swagger/radius.json

{
  "swagger": "2.0",
  "info": {
    "description": "API REST para Flowdat Radius.",
    "version": "1.0.0",
    "title": "Base Flowdat"
  },
  "host": "flowdatHost",
  "basePath": "/api",
  "schemes": [
    "https"
  ],
  "paths": {
    "/profiles.json": {
      "get": {
        "tags": [
          "Profile"
        ],
        "summary": "Encuentra perfile por Id, nombre o tenencia.",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id del perfil.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[name]",
            "in": "query",
            "description": "Nombre del perfil.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[tenancyId]",
            "in": "query",
            "description": "Id de la tenencia donde se encuentra cargado el perfil. Por defecto se utiliza la tenencia base.",
            "required": false,
            "type": "integer",
            "default": 2
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Criteria = 1 > Permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": 1
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Cantidad de registros por página.",
            "default": 20,
            "type": "integer"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Número de página a buscar.",
            "default": 0,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Profile"
              }
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      }
    },
    "/profiles/{id}.json": {
      "get": {
        "tags": [
          "Profile"
        ],
        "summary": "Obtiene los datos del perfil",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del perfil.",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "$ref": "#/definitions/Profile"
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      }
    },
    "/accesses.json": {
      "get": {
        "tags": [
          "Access"
        ],
        "summary": "Encuentra access por Id, nombre, perfile, cliente o tenencia.",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id del acceso.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[name]",
            "in": "query",
            "description": "Nombre del acceso.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[profile]",
            "in": "query",
            "description": "Id del perfil.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[clientId]",
            "in": "query",
            "description": "Id del cliente.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[tenancyId]",
            "in": "query",
            "description": "Id de la tenencia donde se encuentra cargado el cliente. Por defecto se utiliza la tenencia base.",
            "required": false,
            "type": "integer",
            "default": 2
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Criteria = 1 > Permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": 1
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Cantidad de registros por página.",
            "default": 20,
            "type": "integer"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Número de página a buscar.",
            "default": 0,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Access"
              }
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      },
      "post": {
        "tags": [
          "Access"
        ],
        "summary": "Crear un acceso",
        "description": "Creación de un acceso. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "create",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Crea un acceso a partir del objeto.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/AccessCRUD"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Access"
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      }
    },
    "/accesses/{id}.json": {
      "put": {
        "tags": [
          "Access"
        ],
        "summary": "Actualiza un acceso.",
        "description": "Modificación de un acceso. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "update",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Ingresar el Id del cliente que va a editar.",
            "type": "string",
            "required": true
          },
          {
            "in": "body",
            "name": "body",
            "description": "Objeto acceso que necesita ser modificado.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/AccessCRUD"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Access"
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      },
      "delete": {
        "tags": [
          "Access"
        ],
        "summary": "Eliminar un acceso.",
        "description": "Elimina un acceso. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "delete",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del acceso que necesita eliminar.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Access"
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      },
      "get": {
        "tags": [
          "Access"
        ],
        "summary": "Obtener un acceso por Id",
        "description": "",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del acceso a consultar.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Access"
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "securityDefinitions": {
    "basicAuth": {
      "type": "basic"
    }
  },
  "definitions": {
    "Access": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del acceso."
        },
        "name": {
          "type": "string",
          "description": "Nombre del acceso."
        },
        "profile": {
          "$ref": "#/definitions/Profile"
        },
        "clientId": {
          "type": "integer",
          "description": "Id del cliente."
        },
        "password": {
          "type": "string",
          "description": "Contraseña del acceso."
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia",
          "default": 2
        }
      },
      "xml": {
        "name": "Access"
      }
    },
    "AccessCRUD": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del acceso."
        },
        "name": {
          "type": "string",
          "description": "Nombre del acceso."
        },
        "profile": {
          "type": "integer",
          "description": "Id del perfil."
        },
        "clientId": {
          "type": "integer",
          "description": "Id del cliente."
        },
        "password": {
          "type": "string",
          "description": "Contraseña del acceso."
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia",
          "default": 2
        }
      }
    },
    "Profile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del perfil."
        },
        "name": {
          "type": "string",
          "description": "Nombre del perfile."
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia del perfil.",
          "default": 2
        }
      },
      "xml": {
        "name": "Profile"
      }
    }
  }
}