-
-
Notifications
You must be signed in to change notification settings - Fork 37
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
docs: revise OAS #479
docs: revise OAS #479
Conversation
@inventarSarah I see it's marked as a draft, are you working on any more changes or should I review now? |
@MartinKolarik I needed to fix something but it's ready now! |
@inventarSarah thanks, I reviewed everything and made some additional modifications, mostly removing a few descriptions that would be repetitive in the rendered docs (which isn't entirely obvious when looking at the YAML version) and tweaking the wording in some cases, correcting some errors, etc... Can you please recheck for obvious errors like spelling, missing words, etc, but don't make any additional changes? If you find any, keep the diff as clean as possible so that I can review it easily, or use GitHub's suggestions feature here in the "Files changed" tab: |
61541bc
to
0598c16
Compare
I'm going to merge this. If you have any additional suggestions based on my previous comment, feel free to follow up in a new PR. |
This branch contains the edited API documentation (OAS).
I've used the openapitools/openapi-diff tool to test backward compatibility and make sure my changes to the OAS do not introduce breaking changes -> Test was successful, changes are backward compatible.
Note: I use a YAML tool in my IDE, which is why the format of the yaml is sometimes different than before.
So, when you review the changes directly in the file on GitHub, make sure to have "Ignore Whitespaces" activated in the top right corner. That way, you can compare changes per line instead of blocks.
A summary of the changes: