Skip to content

Feat: Add RSwag to generate API Documentation #641

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
Open
atinybeardedman wants to merge 50 commits into
base: master
Choose a base branch
from
Open

Feat: Add RSwag to generate API Documentation #641

atinybeardedman wants to merge 50 commits into from

Conversation

@atinybeardedman
Copy link
Contributor

@atinybeardedman atinybeardedman commented Jul 30, 2023 •
edited
Loading

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.

sean-dickinson and others added 30 commits July 29, 2023 10:34
@sean-dickinson
feat: add rswag gem
9d534a2
@sean-dickinson
feat: run rswag:api:install
7bda61c
@sean-dickinson
feat: run rswag:ui:install
e8db575
@sean-dickinson
feat: run rswag:specs:install
768ad72
@sean-dickinson
feat: working rswag test
25328d6
@sean-dickinson
fix: remove generated tests
67ef985
@johnpaulashenfelter
Add localhost default
a64754f
@sean-dickinson
lint
d692cdb
@johnpaulashenfelter
Hardcode localhost as host for now
d46b641
@johnpaulashenfelter
Add swagger for api/v1/countries
ef089df
@sean-dickinson
feat: disable dry run for swagger generation
3d072cb
@sean-dickinson
fix: countries swagger spec with real id
10f9285
@johnpaulashenfelter
Add swagger request specs for controllers and regenerate swagger file
5efb2c0
@johnpaulashenfelter
Add request specs for all API controllers with auth
20d3678
@sean-dickinson
feat: only load swagger engine in dev
b106ad0
@sean-dickinson
Merge branch 'add-rswag' of github.com:rubyforgood/Flaredown into add…
6df149d 
…-rswag
@johnpaulashenfelter
Move mandatory API authentication to swagger_helper
b2f1681
@sean-dickinson
fix: functional users patch
9a1df45
@sean-dickinson
fix: simplify users swagger spec
662709d
@sean-dickinson
fix: remove unneeded auth in users spec
5d1d748
@sean-dickinson
feat: add rswag gem
6805edb
@sean-dickinson
feat: run rswag:api:install
73ca67f
@sean-dickinson
feat: run rswag:ui:install
a517ad7
@sean-dickinson
feat: run rswag:specs:install
95e0b06
@sean-dickinson
feat: working rswag test
05ee623
@sean-dickinson
fix: remove generated tests
39f72cb
@johnpaulashenfelter @sean-dickinson
Add localhost default
57cab67
@sean-dickinson
lint
63bd7a2
@johnpaulashenfelter @sean-dickinson
Hardcode localhost as host for now
01a2fda
@johnpaulashenfelter @sean-dickinson
Add swagger for api/v1/countries
cbbf8f8
@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

Reviewers

No reviews

Assignees

No one assigned

Labels

language:ruby Pull requests that update Ruby code RubyForGood: 2023

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@atinybeardedman @johnpaulashenfelter @sean-dickinson