Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate and deploy API documentation with UI #357

Merged
merged 8 commits into from
Nov 14, 2024
Merged

Conversation

ZoogieZork
Copy link
Contributor

@ZoogieZork ZoogieZork commented Nov 14, 2024

Description

Generate the REST API documentation from the OpenAPI spec as part of the UI build and deploy.

This switches to Redocly-CLI, which is pulled in as a dev dependency so we can keep it updated as part of our regular dependency updates. Redocly-CLI offers OpenAPI 3.1 support, extensions to make the documentation easier to read and navigate, and an extensive linter.

Note

This does not add a link to the UI to access the API documentation; we are planning on linking to it from the internal documentation for now.

Motivation and Context

  • Removes the requirement to manually install an external tool (swagger-codegen) to generate the API docs.
  • Adds regular linting of the spec file.

How Has This Been Tested?

Tested in non-prod environment.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change

Checklist

  • My code follows conforms to the coding standards.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Generation of the API documentation has been moved to the UI build
process, so the spec file needs to be contained within the UI source
tree so the CI build can access it.

We add a symlink in the old location for convenience.
This has been moved to the UI build process.
@ZoogieZork ZoogieZork marked this pull request as ready for review November 14, 2024 18:46
@ZoogieZork ZoogieZork requested a review from a team as a code owner November 14, 2024 18:46
@ZoogieZork ZoogieZork merged commit a2683ea into main Nov 14, 2024
6 checks passed
@ZoogieZork ZoogieZork deleted the zoogiezork/redocly branch November 14, 2024 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants