I'd like to introduce the concept of API definition filtering to the HSDA design discussion. In an effort to help ensure the API design speak to as wide as possible audience as we can, I'd like to build on discussion around data filtering, and schema filtering, and allow for labeling and packaging up of the API paths using the OpenAPI tagging.
In the OpenAPI, each path can have one or many tags associated with it. We can create a simple set (/organizations/, /locations/, /services/, /search), and a more complete set with all the direct paths to sub elements--reducing cognitive load for new users, while also allowing for access to precise paths for directly updating phone number, or an address without being bothered with entire schema.
I'll work on an example to show how API definition filtering can be used to reduce complexity in API documentation.
I'd like to introduce the concept of API definition filtering to the HSDA design discussion. In an effort to help ensure the API design speak to as wide as possible audience as we can, I'd like to build on discussion around data filtering, and schema filtering, and allow for labeling and packaging up of the API paths using the OpenAPI tagging.
In the OpenAPI, each path can have one or many tags associated with it. We can create a simple set (/organizations/, /locations/, /services/, /search), and a more complete set with all the direct paths to sub elements--reducing cognitive load for new users, while also allowing for access to precise paths for directly updating phone number, or an address without being bothered with entire schema.
I'll work on an example to show how API definition filtering can be used to reduce complexity in API documentation.