Conversation
According to Issue Aggreement
|
If the purpose of the document is no longer that of an example (indicated by the new title and description "Common data and errors for CAMARA APIs") it should contain only componentes/schemas which are already agreed as common across the sub projects. Which is only the error info schema, but not "MoneyAmount" and others. |
|
AFAIK, it was meant to be an example. @RubenBG7 :Was this scope somehow changed ? If not, could you kindly rename the doc accordingly (for e.g. Camara_common_examples.json)? |
PedroDiez
left a comment
There was a problem hiding this comment.
Some suggestions regarding HTTP "status", and "message" text
| "example": { | ||
| "status": 409, | ||
| "code": "CONFLICT", | ||
| "message": "Schema validation failed at ..." |
There was a problem hiding this comment.
| "message": "Schema validation failed at ..." | |
| "message": "A specified resource duplicate entry found" | |
| "example": { | ||
| "status": 400, | ||
| "code": "FAILED_PRECONDITION", | ||
| "message": "Schema validation failed at ..." |
There was a problem hiding this comment.
| "message": "Schema validation failed at ..." | |
| "message": "Request cannot be executed in the current system state." | |
| "$ref": "#/components/schemas/ErrorInfo" | ||
| }, | ||
| "example": { | ||
| "status": 400, |
There was a problem hiding this comment.
| "status": 400, | |
| "status": 412, | |
| "example": { | ||
| "status": 400, | ||
| "code": "OUT_OF_RANGE", | ||
| "message": "Schema validation failed at ..." |
There was a problem hiding this comment.
| "message": "Schema validation failed at ..." | |
| "message": "Client specified an invalid range." | |
| "$ref": "#/components/schemas/ErrorInfo" | ||
| }, | ||
| "example": { | ||
| "status": 503, |
There was a problem hiding this comment.
| "status": 503, | |
| "status": 504, | |
| "$ref": "#/components/schemas/ErrorInfo" | ||
| }, | ||
| "example": { | ||
| "status": 504, |
There was a problem hiding this comment.
| "status": 504, | |
| "status": 503, | |
| "default": "TOO_MANY_REQUESTS", | ||
| "description": "Either out of resource quota or reaching rate limiting." | ||
| } | ||
| "description": "Already Exists", |
There was a problem hiding this comment.
| "description": "Already Exists", | |
| "description": "Too Many Requests", | |
| "name": "API DIGITAL INTEGRATION", | ||
| "email": "apidigital.integration@telefonica.com" | ||
| } | ||
| "description": "Common data and errors for CAMARA APIs", |
There was a problem hiding this comment.
@RubenBG7 : Could you please change the description and title such that it clearly states that this is just a sample?
|
Confimed @shilpa-padgaonkar PR #176 make these ones obseolete |
According to Issue Aggreement