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

Write and use API specification #349

Open
5 of 7 tasks
mjgiarlo opened this issue Mar 26, 2020 · 0 comments
Open
5 of 7 tasks

Write and use API specification #349

mjgiarlo opened this issue Mar 26, 2020 · 0 comments

Comments

@mjgiarlo
Copy link
Member

mjgiarlo commented Mar 26, 2020

Component parts:

  • Create openapi.yml
  • Validate openapi.yml in the CI build
  • Add OpenAPI validation badge to the README
  • Add Committee gem and enable request validation (ideally, also add response validation; if you don't, add the commented-out response validation code and write up a new issue), then fix all the stuff that breaks
  • Create docs/ folder (copy artifacts from another repo, e.g., dor-services-app
  • Enable GitHub Pages with the docs/ folder as the source (and don't use the Theme Chooser)
  • Verify that the automagic OpenAPI documentation works: https://sul-dlss.github.io/workflow-server-rails/
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 a pull request may close this issue.

3 participants