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: try rapidoc #8011

Merged
merged 4 commits into from
Jan 20, 2023
Merged

docs: try rapidoc #8011

merged 4 commits into from
Jan 20, 2023

Conversation

alexgarel
Copy link
Member

@alexgarel alexgarel requested a review from a team as a code owner January 19, 2023 17:48
@github-actions github-actions bot added 📚 Documentation Documentation issues improve the project for everyone. GitHub Actions Pull requests that update Github_actions code labels Jan 19, 2023
@@ -0,0 +1,55 @@
<!doctype html> <!-- Important: must specify -->
Copy link
Member Author

Choose a reason for hiding this comment

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

Note to reviewer: download this file to try it locally it would work (appart the added menu urls)

@stephanegigandet
Copy link
Contributor

Looks good. So this page would replace https://openfoodfacts.github.io/openfoodfacts-server/reference/api/ ?

image

@stephanegigandet
Copy link
Contributor

The "parameters" list at the end is interesting, but it doesn't tell which path uses which parameter, so it's a bit weird.

@stephanegigandet
Copy link
Contributor

Could you generate the api-v3 doc as well? I would like to see if it has the same issues as https://openfoodfacts.github.io/openfoodfacts-server/reference/api-v3/#tag/Write-Requests which does not show the product->packagings input field.

@alexgarel
Copy link
Member Author

@stephanegigandet

  • at the moment it does not replace the old doc (but I will do it, as reverting is very easy as @teolemon made me notice)

  • for the parameters, it's because I added the option to add the schema because I wanted to display "products" as an independent page (it could be handy for example to refer to that for csv export fields)

  • I will add api-v3

@alexgarel
Copy link
Member Author

@stephanegigandet do you want to validate (it's easy to roll-back if needed).

@sonarcloud
Copy link

sonarcloud bot commented Jan 20, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Contributor

@stephanegigandet stephanegigandet left a comment

Choose a reason for hiding this comment

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

Looks good!

@alexgarel alexgarel merged commit 6e21895 into main Jan 20, 2023
@alexgarel alexgarel deleted the docs-rapidoc branch January 20, 2023 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 Documentation Documentation issues improve the project for everyone. GitHub Actions Pull requests that update Github_actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants