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.

Sign up for GitHub

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

Jump to bottom

docs: cleaning and dispatching product schema #8672

Merged
merged 8 commits into from
Jul 25, 2023
Merged

docs: cleaning and dispatching product schema #8672

merged 8 commits into from
Jul 25, 2023

Conversation

alexgarel
Copy link
Member

@alexgarel alexgarel commented Jul 7, 2023 •
edited
Loading

The product schema is in bad shape… this PR:

  • improves a lot the product schema
  • fix rendering with rapidoc (by having a correct schema)
  • split the product schema into coherent and readable parts, and expose them
  • restores the OpenAPI check with swagger

@github-actions github-actions bot added the 📚 Documentation Documentation issues improve the project for everyone. label Jul 7, 2023
@alexgarel alexgarel mentioned this pull request Jul 10, 2023
Closed
@github-actions github-actions bot added API WRITE WRITE API to allow sending product info and image Food.pm GitHub Actions Pull requests that update Github_actions code API v3 labels Jul 11, 2023
@alexgarel alexgarel force-pushed the docs-openapi-product-dispatch branch from 234523e to 5e0e5e9 Compare July 12, 2023 15:29
@alexgarel alexgarel added the OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. label Jul 12, 2023
@alexgarel alexgarel marked this pull request as ready for review July 12, 2023 15:31
@alexgarel alexgarel requested a review from a team as a code owner July 12, 2023 15:31
@codecov-commenter
Copy link

codecov-commenter commented Jul 12, 2023 •
edited
Loading

Codecov Report

Merging #8672 (78e24dd) into main (c8570c1) will not change coverage.
The diff coverage is n/a.

❗ Current head 78e24dd differs from pull request most recent head fcf7554. Consider uploading reports for the commit fcf7554 to get more accurate results

@@           Coverage Diff           @@
##             main    #8672   +/-   ##
=======================================
  Coverage   48.76%   48.76%           
=======================================
  Files         117      117           
  Lines       21819    21819           
  Branches     4860     4860           
=======================================
  Hits        10639    10639           
  Misses       9882     9882           
  Partials     1298     1298
Files Changed Coverage Δ
lib/ProductOpener/Food.pm 63.59% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@alexgarel alexgarel changed the title docs: WIP on cleaning and dispatching product schema docs: cleaning and dispatching product schema Jul 17, 2023
stephanegigandet
stephanegigandet reviewed Jul 18, 2023
View reviewed changes
docs/api/ref/schemas/product_base.yaml Outdated
lang:
type: string
description: |
**TODO** explain difference with `lc`
Copy link
Contributor

Choose a reason for hiding this comment

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

There's no difference (or rather there should not be a difference), we have 2 fields for historical reasons.

stephanegigandet
stephanegigandet approved these changes Jul 18, 2023
View reviewed changes
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.

Awesome, thank you!

A few minor precisions in comments.

@stephanegigandet
Copy link
Contributor

@alexgarel can we merge? (and possibly make changes later). As it's a big change, I'd like to merge it before doing further changes / additions to the API doc.

@alexgarel alexgarel enabled auto-merge (squash) July 24, 2023 15:36
@sonarcloud
Copy link

sonarcloud bot commented Jul 24, 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

@alexgarel alexgarel merged commit 39560c8 into main Jul 25, 2023
12 of 14 checks passed
@alexgarel alexgarel deleted the docs-openapi-product-dispatch branch July 25, 2023 00:39
@openfoodfacts-bot openfoodfacts-bot mentioned this pull request Jul 25, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stephanegigandet stephanegigandet stephanegigandet approved these changes

Assignees

@alexgarel alexgarel

Labels
API v3 API WRITE WRITE API to allow sending product info and image 📚 Documentation Documentation issues improve the project for everyone. Food.pm GitHub Actions Pull requests that update Github_actions code OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@alexgarel @codecov-commenter @stephanegigandet