소스 검색

Ref api#12 Updated the information about the responses.

Maximiliano Schvindt 6 년 전
부모
커밋
c448f94bf4
1개의 변경된 파일314개의 추가작업 그리고 62개의 파일을 삭제
  1. 314 62
      api.v1.json

+ 314 - 62
api.v1.json

@@ -50,7 +50,10 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -83,7 +86,10 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -195,7 +201,10 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -223,11 +232,23 @@
           }
         ],
         "responses": {
-          "default": {
+          "200": {
             "description": "Operación exitosa.",
             "schema": {
               "$ref": "#/definitions/ClientCRUD"
             }
+          },
+          "400": {
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
+          },
+          "409": {
+            "description": "Operación fallida, elemento duplicado.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -263,7 +284,16 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
+          },
+          "409": {
+            "description": "Operación fallida, elemento duplicado.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -294,7 +324,10 @@
             }
           },
           "400": {
-            "description": "Cliente no válido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -325,7 +358,10 @@
             }
           },
           "400": {
-            "description": "Id de cliente inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -358,7 +394,10 @@
             }
           },
           "400": {
-            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -391,7 +430,10 @@
             }
           },
           "400": {
-            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -471,7 +513,10 @@
             }
           },
           "400": {
-            "description": "Nodo inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -504,7 +549,10 @@
             }
           },
           "400": {
-            "description": "Nodo inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -612,7 +660,10 @@
             }
           },
           "400": {
-            "description": "Perfil inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -645,7 +696,10 @@
             }
           },
           "400": {
-            "description": "Perfil inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -710,7 +764,10 @@
             }
           },
           "400": {
-            "description": "Modelo de cablemodem inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -743,7 +800,10 @@
             }
           },
           "400": {
-            "description": "Modelo de cablemodem inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -844,7 +904,10 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -879,7 +942,16 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
+          },
+          "409": {
+            "description": "Operación fallida, elemento duplicado.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -915,7 +987,16 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
+          },
+          "409": {
+            "description": "Operación fallida, elemento duplicado.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -946,7 +1027,10 @@
             }
           },
           "400": {
-            "description": "Cablemodem no válido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -977,7 +1061,10 @@
             }
           },
           "400": {
-            "description": "Id de cablemodem inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1010,7 +1097,10 @@
             }
           },
           "400": {
-            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1043,7 +1133,10 @@
             }
           },
           "400": {
-            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1083,7 +1176,10 @@
             }
           },
           "400": {
-            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1163,7 +1259,10 @@
             }
           },
           "400": {
-            "description": "TCont profile inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1196,7 +1295,10 @@
             }
           },
           "400": {
-            "description": "TCont profile inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1276,7 +1378,10 @@
             }
           },
           "400": {
-            "description": "VLanID inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1309,7 +1414,10 @@
             }
           },
           "400": {
-            "description": "VLanID inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1389,7 +1497,10 @@
             }
           },
           "400": {
-            "description": "Traffic profile inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1422,7 +1533,10 @@
             }
           },
           "400": {
-            "description": "Traffic profile  inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1565,7 +1679,10 @@
             }
           },
           "400": {
-            "description": "Plantilla inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1598,7 +1715,10 @@
             }
           },
           "400": {
-            "description": "Plantilla inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1685,7 +1805,10 @@
             }
           },
           "400": {
-            "description": "NAP inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1718,7 +1841,10 @@
             }
           },
           "400": {
-            "description": "NAP inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1802,7 +1928,10 @@
             }
           },
           "400": {
-            "description": "Modelo de ONU inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1835,7 +1964,10 @@
             }
           },
           "400": {
-            "description": "Modelo de ONU inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1915,7 +2047,10 @@
             }
           },
           "400": {
-            "description": "OLT inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -1948,7 +2083,10 @@
             }
           },
           "400": {
-            "description": "OLT inválida."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2035,7 +2173,10 @@
             }
           },
           "400": {
-            "description": "Perfil inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2068,7 +2209,10 @@
             }
           },
           "400": {
-            "description": "Perfil inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2156,7 +2300,10 @@
             }
           },
           "400": {
-            "description": "Modelo de OLT inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2189,7 +2336,10 @@
             }
           },
           "400": {
-            "description": "Modelo de OLT inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2269,7 +2419,10 @@
             }
           },
           "400": {
-            "description": "Perfil inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2302,7 +2455,10 @@
             }
           },
           "400": {
-            "description": "Perfil inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2382,7 +2538,10 @@
             }
           },
           "400": {
-            "description": "VLanProfile inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2415,7 +2574,10 @@
             }
           },
           "400": {
-            "description": "VLanProfile inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2600,7 +2762,10 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2635,7 +2800,16 @@
             }
           },
           "400": {
-            "description": "Valor incorrecto."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
+          },
+          "409": {
+            "description": "Operación fallida, elemento duplicado.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -2671,7 +2845,16 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
+          },
+          "409": {
+            "description": "Operación fallida, elemento duplicado.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -2702,7 +2885,10 @@
             }
           },
           "400": {
-            "description": "Cliente no válido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -2733,7 +2919,10 @@
             }
           },
           "400": {
-            "description": "Id de cliente inválido."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2766,7 +2955,10 @@
             }
           },
           "400": {
-            "description": "Id de onu inválido, workflow o transición."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2799,7 +2991,10 @@
             }
           },
           "400": {
-            "description": "Id de onu inválido, workflow o transición."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2832,7 +3027,10 @@
             }
           },
           "400": {
-            "description": "Id de onu inválido, workflow o transición."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2865,7 +3063,10 @@
             }
           },
           "400": {
-            "description": "Id de onu inválido, workflow o transición."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2905,7 +3106,10 @@
             }
           },
           "400": {
-            "description": "Id de onu inválido, workflow o transición."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -2978,7 +3182,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -3011,7 +3218,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -3098,7 +3308,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -3133,7 +3346,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -3169,7 +3385,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -3200,7 +3419,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       },
@@ -3231,7 +3453,10 @@
             }
           },
           "400": {
-            "description": "Se produjo un error al ejecutar la acción."
+            "description": "Operación fallida.",
+            "schema": {
+              "$ref": "#/definitions/ResponseError"
+            }
           }
         }
       }
@@ -4145,6 +4370,33 @@
           "default": 2
         }
       }
+    },
+    "ResponseError": {
+      "type": "object",
+      "properties": {
+        "error": {
+          "$ref": "#/definitions/Error"
+        }
+      },
+      "xml": {
+        "name": "ResponseError"
+      }
+    },
+    "Error": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type":"integer",
+          "description":"Error Code"
+        },
+        "message": {
+          "type":"string",
+          "description": "Error Message"
+        }
+      },
+      "xml": {
+        "name": "Error"
+      }
     }
   }
 }