You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the interests of keeping the model simple and understandable, The UML profile for OpenAPI embeds some opinionated rules about the request/response structure for GET/POST/PATCH/PUT/DELETE. for example
GET request is an ID or query string and response is the whole data structure
POST request is the whole data structure and response is the ID
PATCH request is any subset of the data structure and response is the whole (updated) data structure
PUT request is the whole data structure and response is the whole (updated) data structure.
Mostly they work ok but there are cases when you want a property of the structure to be in the server response but not settable by the client. For example a customs clearance status is something the server defines and communicates to the client (in a GET response) but is certainly not something the client can set (so should not be available in the POST/PATCH/PUT request.
Therefore we should allow the UML designer to use the native UML "readOnly" tag on any property. And the result in the generated spec should be that the property appears in GET and PATCH/PUT response but not in POST/PUT/PATCH request.
The text was updated successfully, but these errors were encountered:
In the interests of keeping the model simple and understandable, The UML profile for OpenAPI embeds some opinionated rules about the request/response structure for GET/POST/PATCH/PUT/DELETE. for example
Mostly they work ok but there are cases when you want a property of the structure to be in the server response but not settable by the client. For example a customs clearance status is something the server defines and communicates to the client (in a GET response) but is certainly not something the client can set (so should not be available in the POST/PATCH/PUT request.
Therefore we should allow the UML designer to use the native UML "readOnly" tag on any property. And the result in the generated spec should be that the property appears in GET and PATCH/PUT response but not in POST/PUT/PATCH request.
The text was updated successfully, but these errors were encountered: