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

Add Swagger documentation #46

Merged
merged 2 commits into from
Mar 26, 2023
Merged

Conversation

duffn
Copy link
Member

@duffn duffn commented Mar 25, 2023

This adds Swagger documentation and can replace #4.

  • Adds Swagger docs using the dist package
  • Updates splines to add the reticulated param for the docs

@duffn duffn force-pushed the duffn/add-swagger branch from 94e3fd3 to 1362e43 Compare March 25, 2023 00:47
@duffn duffn mentioned this pull request Mar 25, 2023
@dblock
Copy link
Member

dblock commented Mar 25, 2023

Looks good, add a rudimentary spec that the swagger documentation loads?

@duffn
Copy link
Member Author

duffn commented Mar 25, 2023

Add the spec.

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good. If you want to add a spec that swagger API actually works you could get inspired from https://github.com/dblock/grape-swagger-rails/blob/1c3d71a27e0c744f470fcb6835250de2a837aedf/spec/features/swagger_spec.rb#L4.

@dblock dblock merged commit c8f94f1 into ruby-grape:master Mar 26, 2023
@duffn
Copy link
Member Author

duffn commented Mar 26, 2023

I plan to update to use grape-swagger-rails after I can get that project updated in ruby-grape/grape-swagger-rails#106. I'll add some legitimate tests here when I do that.

@duffn duffn deleted the duffn/add-swagger branch March 26, 2023 18:55
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