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

Feat: Add RSwag to generate API Documentation #641

Open
wants to merge 50 commits into
base: master
Choose a base branch
from

Conversation

atinybeardedman
Copy link
Contributor

@atinybeardedman atinybeardedman commented Jul 30, 2023

Overview

Adds the rswag gem and generates the default specs for the existing controllers. This generates interactive documentation to view the Open API Documentation for the endpoints.

Notes

  • All the specs generated have been marked as pending, as they need to be filled in with correct details. These specs will actually hit the controller in order to generate the example data and will fail if they do not receive the correct response. Ideally future contributors to the repo can work incrementally on each spec to generate this example data.

@johnpaulashenfelter johnpaulashenfelter added language:ruby Pull requests that update Ruby code RubyForGood: 2023 labels Jul 30, 2023
@atinybeardedman atinybeardedman marked this pull request as ready for review July 30, 2023 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language:ruby Pull requests that update Ruby code RubyForGood: 2023
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants