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.

Sign up for GitHub

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

Jump to bottom

Automate OpenAPI documentation publishing #411

Open
therzka opened this issue Nov 30, 2022 · 0 comments · May be fixed by #412
Open

Automate OpenAPI documentation publishing #411

therzka opened this issue Nov 30, 2022 · 0 comments · May be fixed by #412
Assignees
@therzka
Labels
✍️ documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code
Milestone
Finalizing

Comments

@therzka
Copy link
Collaborator

therzka commented Nov 30, 2022 •
edited

It would be ideal to set up actions to do the following using the OpenAPI spec we define:

  • automatically bundle the schema
  • automatically lint the schema on push
  • automatically generate SwaggerUI from the schema
  • automatically publish the SwaggerUI to GitHub Pages or an external site
@therzka therzka added the ✍️ documentation Improvements or additions to documentation label Nov 30, 2022
@therzka therzka linked a pull request Nov 30, 2022 that will close this issue
Draft
1 task
@manishapriya94 manishapriya94 mentioned this issue Jan 17, 2023
Open
11 tasks
@manishapriya94 manishapriya94 added this to the Finalizing milestone Jan 18, 2023
@manishapriya94 manishapriya94 mentioned this issue Feb 2, 2023
Closed
10 tasks
@therzka therzka added the github_actions Pull requests that update GitHub Actions code label Feb 21, 2023
@therzka therzka changed the title [Documentation] [Actions] Automate OpenAPI documentation publishing Automate OpenAPI documentation publishing Feb 21, 2023
@therzka therzka self-assigned this Feb 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@therzka therzka

Labels
✍️ documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code
Projects
None yet
Milestone
Finalizing
Development

Successfully merging a pull request may close this issue.

[DO NOT MERGE] Add actions to lint OpenAPI schema and generate Swagger UI therzka/amplify
2 participants
@therzka @manishapriya94