Documentation Updates

Requirement

• Updated documentation must be released when API changes are released.
• Published API documentation that matches production behavior must be easily accessible.

Follow the guidance within the Documentation section while writing your API and its documentation. Documenting your API correctly is vital for VA to operate effectively and efficiently. Using a tool for automatically generating the documentation is highly recommended.

Providing an OpenAPI Specification (OAS) for an API is not a one and done activity. It is fundamental to the API lifecycle, and must be kept up-to-date as the API evolves. Release the documentation changes as part of the release when the API behavior changes. Follow the Release Notes guidance when the release occurs.