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

docs: revise OAS #479

Merged
merged 13 commits into from
Feb 16, 2024
Merged

docs: revise OAS #479

merged 13 commits into from
Feb 16, 2024

Conversation

inventarSarah
Copy link
Contributor

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:

  • fix spelling mistakes and the likes
  • check consistency
  • make sure we favor present tense and active voice
  • add links to external documentation where it makes sense (eg. ISO naming standards for locations)
  • simplify some sentences while ensuring to not lose information
  • add missing Schema descriptions for consistency
  • add short example descriptions to Create Measurement endpoint examples

@MartinKolarik
Copy link
Member

@inventarSarah I see it's marked as a draft, are you working on any more changes or should I review now?

@inventarSarah inventarSarah marked this pull request as ready for review January 22, 2024 14:37
@inventarSarah
Copy link
Contributor Author

@MartinKolarik I needed to fix something but it's ready now!

@MartinKolarik
Copy link
Member

MartinKolarik commented Jan 30, 2024

@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:
https://dl.dropboxusercontent.com/scl/fi/6t40uipia5p0hngl94t50/2024-01-30_18-12-09.png?rlkey=g8utd668x6crtsci7ufs6zdt2&dl=0

@MartinKolarik MartinKolarik force-pushed the master branch 4 times, most recently from 61541bc to 0598c16 Compare February 12, 2024 20:13
@MartinKolarik
Copy link
Member

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.

@MartinKolarik MartinKolarik merged commit a3babe2 into jsdelivr:master Feb 16, 2024
3 checks passed
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