swagger/cablemodem.json

{
  "swagger": "2.0",
  "info": {
    "description": "API REST para Flowdat Cablemodem.",
    "version": "1.0.0",
    "title": "Cablemodem Flowdat"
  },
  "host": "flowdatHost",
  "basePath": "/api",
  "schemes": [
    "https"
  ],
  "paths": {
    "/nodes.json": {
      "get": {
        "tags": [
          "Node"
        ],
        "summary": "Obtener Nodos por id, id Nodo Padre, nombre.",
        "description": "",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id de nodo que quiere obtener.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[parent]",
            "in": "query",
            "description": "Id del nodo padre del Nodo que quiere obtener.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[name]",
            "in": "query",
            "description": "Nombre del nodo que quiere obtener.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[tenancyId]",
            "in": "query",
            "description": "Tenancy de nodo.",
            "required": false,
            "type": "integer",
            "default": 2
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": null
          },
          {
            "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 exitosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Node"
              }
            }
          },
          "400": {
            "description": "Nodo inválido."
          },
          "404": {
            "description": "Nodo no encontrado."
          }
        }
      }
    },
    "/nodes/{id}.json": {
      "get": {
        "tags": [
          "Node"
        ],
        "summary": "Obtener Nodo por id.",
        "description": "",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id de Nodo que quiere obtener.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Node"
            }
          },
          "400": {
            "description": "Nodo inválido."
          },
          "404": {
            "description": "Nodo no encontrado."
          }
        }
      }
    },
    "/profiles.json": {
      "get": {
        "tags": [
          "Profile"
        ],
        "summary": "Obtener Perfiles por id, nombre.",
        "description": "",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id de perfil que quiere obtener.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[name]",
            "in": "query",
            "description": "Nombre del perfil que quiere obtener.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[downstream]",
            "in": "query",
            "description": "Valor de downstream.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[upstream]",
            "in": "query",
            "description": "Valor de upstream.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[filtroUpload]",
            "in": "query",
            "description": "Valor de filtro de upload.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[filtroDownload]",
            "in": "query",
            "description": "Valor de filtro de download.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[maxCpe]",
            "in": "query",
            "description": "Max Cpe.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[tenancyId]",
            "in": "query",
            "description": "Tenancy de Perfil.",
            "required": false,
            "type": "integer",
            "default": 2
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": null
          },
          {
            "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 exitosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Profile"
              }
            }
          },
          "400": {
            "description": "Perfil inválido."
          },
          "404": {
            "description": "Perfil no encontrado."
          }
        }
      }
    },
    "/profiles/{id}.json": {
      "get": {
        "tags": [
          "Profile"
        ],
        "summary": "Obtener Perfil por id",
        "description": "",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del perfil que quiere obtener.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Profile"
            }
          },
          "400": {
            "description": "Perfil inválido."
          },
          "404": {
            "description": "Perfil no encontrado."
          }
        }
      }
    },
    "/cablemodemmodels.json": {
      "get": {
        "tags": [
          "Cablemodem Model"
        ],
        "summary": "Obtener modelos de cablemodem por id o nombre.",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id del modelo de cablemodem que quiere obtener.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[name]",
            "in": "query",
            "description": "Nombre del modelo de cablemodem que quiere obtener.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": null
          },
          {
            "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 exitosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CablemodemModel"
              }
            }
          },
          "400": {
            "description": "Modelo de cablemodem inválido."
          },
          "404": {
            "description": "Modelo de cablemodem no encontrado."
          }
        }
      }
    },
    "/cablemodemmodels/{id}.json": {
      "get": {
        "tags": [
          "Cablemodem Model"
        ],
        "summary": "Obtener modelos de cablemodem por id.",
        "description": "",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id de modelo de cablemodem que quiere obtener.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/CablemodemModel"
            }
          },
          "400": {
            "description": "Modelo de cablemodem inválido."
          },
          "404": {
            "description": "Modelo de cablemodem no encontrado."
          }
        }
      }
    },
    "/cablemodems.json": {
      "get": {
        "tags": [
          "Cablemodem"
        ],
        "summary": "Encuentra cablemodem por Id, client, modelo, mac, nodo, perfil o tenencia.",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id del cablemodem.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[clientId]",
            "in": "query",
            "description": "Id del cliente.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[mac]",
            "in": "query",
            "description": "MAC del cablemodem.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[node]",
            "in": "query",
            "description": "Id del nodo.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[profile]",
            "in": "query",
            "description": "Id del perfil de cablemodem.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[model]",
            "in": "query",
            "description": "Id del modelo de cablemodem.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[tenancyId]",
            "in": "query",
            "description": "Id de la tenencia donde se encuentra cargado el cablemodem. Por defecto se utiliza la tenencia base.",
            "required": false,
            "type": "integer",
            "default": 2
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": null
          },
          {
            "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/Cablemodem"
              }
            }
          },
          "400": {
            "description": "Valor incorrecto."
          }
        }
      },
      "post": {
        "tags": [
          "Cablemodem"
        ],
        "summary": "Crear una cablemodem",
        "description": "Creación de un cablemodem. Dentro de los objetos solo se debe pasar el id.",
        "operationId": "create",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Crea un cablemodem a partir del objeto.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CablemodemCRUD"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Cablemodem"
              }
            }
          },
          "400": {
            "description": "Valor incorrecto."
          }
        }
      }
    },
    "/cablemodems/{id}.json": {
      "put": {
        "tags": [
          "Cablemodem"
        ],
        "summary": "Actualiza un cablemodem.",
        "description": "Modificación de un cablemodem. Dentro de los objetos solo debe pasar el id.",
        "operationId": "update",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Ingresar el Id de un cablemodem que va a editar.",
            "type": "string",
            "required": true
          },
          {
            "in": "body",
            "name": "body",
            "description": "Objeto cablemodem que necesita ser modificado.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/CablemodemCRUD"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Cablemodem"
              }
            }
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          },
          "404": {
            "description": "Cablemodem no encontrado."
          },
          "405": {
            "description": "Validation exception."
          }
        }
      },
      "delete": {
        "tags": [
          "Cablemodem"
        ],
        "summary": "Eliminar un cablemodem",
        "description": "Elimina un cablemodem. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "delete",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del cablemodem que necesita eliminar.",
            "required": true,
            "type": "intenger"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa."
          },
          "400": {
            "description": "Cablemodem no válido."
          },
          "404": {
            "description": "Cablemodem no encontrado."
          }
        }
      },
      "get": {
        "tags": [
          "Cablemodem"
        ],
        "summary": "Obtener cablemodem por Id",
        "description": "",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del cablemodem a consultar.",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Cablemodem"
            }
          },
          "400": {
            "description": "Id de cablemodem inválido."
          },
          "404": {
            "description": "Cablemodem no encontrado."
          }
        }
      }
    },
    "/cablemodem/{id}/apply/{workflow}/{transition}": {
      "get": {
        "tags": [
          "Cablemodem"
        ],
        "summary": "Aplicar acción sobre cablemodem.",
        "description": "",
        "operationId": "apply",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del cablemodem",
            "required": true,
            "type": "integer"
          },
          {
            "name": "workflow",
            "in": "path",
            "description": "Workflow del cablemodem",
            "required": true,
            "type": "string",
            "enum": [
              "cablemodem_workflow"
            ]
          },
          {
            "name": "transition",
            "in": "path",
            "description": "Acción del Workflow",
            "required": true,
            "type": "string",
            "enum": [
              "active",
              "disable"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Cablemodem"
            }
          },
          "400": {
            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
          },
          "404": {
            "description": "Error al aplicar la transición."
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "securityDefinitions": {
    "basicAuth": {
      "type": "basic"
    }
  },
  "definitions": {
    "Node": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del nodo."
        },
        "name": {
          "type": "string",
          "description": "Nombre del nodo."
        },
        "parent": {
          "type": "integer",
          "description": "Id del nodo padre."
        },
        "childs": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Node"
          },
          "description": "Listado de Nodos hijos."
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia a la que pertenece el NAP.",
          "default": 2
        }
      }
    },
    "CablemodemModel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del modelo."
        },
        "name": {
          "type": "string",
          "description": "Nombre del modelo."
        }
      }
    },
    "Profile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del perfil."
        },
        "name": {
          "type": "string",
          "description": "Nombre del perfil."
        },
        "downstream": {
          "type": "integer",
          "description": "Down stream"
        },
        "upstream": {
          "type": "integer",
          "description": "Up stream"
        },
        "filtroUpload": {
          "type": "integer",
          "description": "Upload"
        },
        "filtroDownload": {
          "type": "integer",
          "description": "Download"
        },
        "maxCpe": {
          "type": "integer",
          "description": "Max cpe"
        },
        "extraData": {
          "type": "string",
          "format": "json"
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia a la que pertenece al perfil.",
          "default": 2
        }
      }
    },
    "Cablemodem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del cablemodem."
        },
        "clientId": {
          "description": "Id del cliente.",
          "type": "integer"
        },
        "mac": {
          "description": "MAC del cablemodem.",
          "type": "string"
        },
        "node": {
          "$ref": "#/definitions/Node"
        },
        "profile": {
          "$ref": "#/definitions/Profile"
        },
        "model": {
          "$ref": "#/definitions/CablemodemModel"
        },
        "activationCode": {
          "type": "string",
          "description": "Código de activación."
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia a la que pertenece al perfil.",
          "default": 2
        }
      }
    },
    "CablemodemCRUD": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del cablemodem."
        },
        "clientId": {
          "description": "Id del cliente.",
          "type": "integer"
        },
        "mac": {
          "description": "MAC del cablemodem.",
          "type": "string"
        },
        "node": {
          "description": "Id del nodo.",
          "type": "integer"
        },
        "profile": {
          "description": "Id del perfil.",
          "type": "integer"
        },
        "model": {
          "description": "Id del modelo.",
          "type": "integer"
        },
        "activationCode": {
          "type": "string",
          "description": "Código de activación."
        },
        "transitionState": {
          "description": "success",
          "type": "string",
          "default": "success"
        },
        "tenancyId": {
          "type": "integer",
          "description": "Id de la tenencia a la que pertenece al perfil.",
          "default": 2
        }
      }
    }
  }
}