API catalogue - existing APIs documented to a minimum standard
Uplift documentation for all existing APIs to a minimum standard, so that external developers can easily learn what the API does, how to use the API, how to test it, how to onboard and where to get help and support.
Done
make-learning-easier
platform
platform-phase-2
Suggested by:
API Management Team
•
Upvoted: 13 May, '22
•
Comments: 2
Comments: 2
-
30 May, '22
Tony Heap AdminThis is now done for what we call the "real" APIs i.e. anything that is directly callable, as opposed to MESH messaging specs or NEMS event specs or API standards. We still need to complete it for those other categories.
-
08 Dec, '22
Tony Heap AdminWe have now documented all the MESH messaging specs and NEMS event specs to a minimum standard.
And I think the API standard specs are also "good enough".
So I'm saying this is done.