-
Notifications
You must be signed in to change notification settings - Fork 50
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
Document API with OpenAPI spec (API 1.1) #420
base: next
Are you sure you want to change the base?
Conversation
57b2ec2
to
9e770fd
Compare
a8b8cb4
to
c1933bb
Compare
This was done to make it more clear, what the value actually is
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #420 +/- ##
===========================================
+ Coverage 53.49% 80.83% +27.33%
===========================================
Files 33 33
Lines 4621 3047 -1574
Branches 274 255 -19
===========================================
- Hits 2472 2463 -9
+ Misses 2097 545 -1552
+ Partials 52 39 -13 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks mostly good. I suggest using the sample instance of Swagger UI to check that it's right. Perhaps we could publish that on a docs site of our own? That's out of scope for this PR though.
…emet into openapi-spec
In order to make the use of the API more welcoming, the API should be formally described as an OpenAPI specification.
Endpoints: