...
- Check Info object
- version: aligned with the released API version and formatted correctly (per Commonalities)
- description:
- contains sufficient in-line API documentation
- does not use Telco Jargon / abbreviations
- contains the section on auth from ICM
- presence of the x-camara-commonalities: 0.4.0
- Check servers object has the correct version format e.g. v0.xrc1 or v1rc1
- what about checks on security schemes ?
- is there a way to know if an API requires consent request ? where is that documented ? in the description in the Info object ? Is there a guidelines in ICM ?
- In externalDocs: Should we recommend pointing to just CAMARA, to the individua project or either is fine ?
description: Project documentation at CAMARA
url: https://github.com/camaraproject/ - shall error cases be explained in in-line documentation ? (info.description) It seems yes as per Commonalities/documentation/API-DocumentationTemplate.md - I think we need to update this document a bot.
test file(s) availability
...