-
Story
-
Resolution: Won't Do
-
Medium
-
None
The current AAI documentation on readthedocs covers some aspects of:
- graphadmin API
- resources API
- traversal API
Other parts of the API are covered by swagger-generated files.
From an end-user perspective, maybe they don't need to know specifics of which microservice provides which API, but from the points of view of administrators and developers, these details matter.
There are currently nearly 30 AAI microservices and it is not clear that the API of each one has been documented. Some of them even have confusing name clashes, e.g. the /nodes/ query path of resources API and the /nodes-query/ query path of traversal API. There are also data formats that could be passed in to the URLs that do not appear to have documentation.
This situation should be improved.