Description
As the REST framework matures in support for automated documentation and federated ownership, we need to ensure the expected processes are well documented. This is especially important and relevant as we begin asking more teams to onboard to our systems and self-manage their API modules.
Conditions of acceptance
- Create a user guide for how to generate an OpenAPI spec within the REST Framework.
- The instructions should be guided by and emphasize the fields required by linting.
- Include instructions for how to define examples, where needed:
- How to define request parameter examples.
- How and where to define JSON response examples.
- Include instructions for how to generate a spec locally, then test it using the linter tool.
- Review guide with team.
- Publish on MediaWIki --> Consult with Halley & Alex for where to put it in the IA (potentially a new section for "API builders" or something similar)