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

WIP: Use specs to write an openapi3 spec #3896

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

segiddins
Copy link
Member

Please do not review this.

Just sharing the code I'm using to slowly write an openapi3 doc for the v1 API.

Workflow has been:

Run a single controllers tests. Add missing paths / operations. Ensure that request / response bodies match the spec.

Will look into better tooling for this sort of test that will work for both system & functional tests, and also doesn't require rspec. Stay tuned.

@codecov
Copy link

codecov bot commented Jul 1, 2023

Codecov Report

Merging #3896 (a9ed0b5) into master (5ec5af4) will decrease coverage by 4.61%.
The diff coverage is 67.85%.

@@            Coverage Diff             @@
##           master    #3896      +/-   ##
==========================================
- Coverage   98.79%   94.18%   -4.61%     
==========================================
  Files         216      217       +1     
  Lines        5391     5419      +28     
==========================================
- Hits         5326     5104     -222     
- Misses         65      315     +250     
Impacted Files Coverage Δ
app/controllers/api/v1/schema_controller.rb 0.00% <0.00%> (ø)
app/controllers/api/base_controller.rb 92.30% <100.00%> (-7.70%) ⬇️

... and 18 files with indirect coverage changes

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.

None yet

1 participant