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
At our last DHIS2 milestone demo, @david-mackessy showcased the /merge API endpoint. This endpoint is actually an operation and not a resource. It would be useful in my opinion if we syntactically distinguish between an API resource and an operation. For example, in FHIR, API operations are prefixed with a dollar sign (e.g., /$merge). One of the first benefits I see is that there would be no ambiguity with what is a resource and what is an operation. Another benefit is that we can apply special semantics when the endpoint is known to be an operation (e.g., tools which generate clients from the OpenAPI definition can generate code for operations in a different way). It should be relatively easy to implement this style of naming in a backwards compatible way for existing endpoints.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
At our last DHIS2 milestone demo, @david-mackessy showcased the
/merge
API endpoint. This endpoint is actually an operation and not a resource. It would be useful in my opinion if we syntactically distinguish between an API resource and an operation. For example, in FHIR, API operations are prefixed with a dollar sign (e.g.,/$merge
). One of the first benefits I see is that there would be no ambiguity with what is a resource and what is an operation. Another benefit is that we can apply special semantics when the endpoint is known to be an operation (e.g., tools which generate clients from the OpenAPI definition can generate code for operations in a different way). It should be relatively easy to implement this style of naming in a backwards compatible way for existing endpoints.Beta Was this translation helpful? Give feedback.
All reactions