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

Invalid Swagger/OpenAPI Definition for API v2 and v3 #10659

Closed
teleboas opened this issue Aug 8, 2024 · 0 comments · Fixed by #10664
Closed

Invalid Swagger/OpenAPI Definition for API v2 and v3 #10659

teleboas opened this issue Aug 8, 2024 · 0 comments · Fixed by #10664
Labels
🐛 bug This is a bug, not a feature request. 📚 Documentation Documentation issues improve the project for everyone. OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. 🎯 P1

Comments

@teleboas
Copy link
Member

teleboas commented Aug 8, 2024

Description:

The current Swagger/OpenAPI definitions for API v2 and v3 are invalid.

Steps to Reproduce:

  1. Visit the Swagger Parser for API v2 to see the error in the API v2 definition.
  2. Visit the Swagger Parser for API v3 to see the error in the API v3 definition.

Expected Behavior:

The Swagger/OpenAPI definitions for both API v2 and v3 should be valid.

Origin of the Issue:

The breaking change appears to be introduced in commit 6370cc3.
@teleboas teleboas added 🐛 bug This is a bug, not a feature request. 📚 Documentation Documentation issues improve the project for everyone. OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. labels Aug 8, 2024
teleboas added a commit that referenced this issue Aug 9, 2024
@teleboas
fix(docs): correct OpenAPI definition by fixing missing reference (#1…
ddd88a6 
…0659)

The `api.yaml` file contained a reference to a non-existent `./responses/change_ref_properties.yaml` file, causing validation to fail.
This commit adds the missing file to ensure the OpenAPI definition is valid.
@teleboas teleboas mentioned this issue Aug 9, 2024
Merged
teleboas added a commit that referenced this issue Aug 9, 2024
@teleboas
fix(docs): correct OpenAPI definition by fixing missing reference (#1…
308f6ae 
…0659)

The `api.yaml` file contained a reference to a non-existent `./responses/change_ref_properties.yaml` file, causing validation to fail.
This commit adds the missing file to ensure the OpenAPI definition is valid.
teleboas added a commit that referenced this issue Aug 10, 2024
@teleboas
fix(docs): correct OpenAPI definition by fixing missing reference (#1…
4f0f10e 
…0659)

The `api.yaml` file contained a reference to a non-existent `./responses/change_ref_properties.yaml` file, causing validation to fail.
This commit adds the missing file to ensure the OpenAPI definition is valid.
@openfoodfacts-bot openfoodfacts-bot mentioned this issue Aug 10, 2024
Merged
stephanegigandet pushed a commit that referenced this issue Aug 13, 2024
@openfoodfacts-bot
chore(main): release 2.41.0 (#10672)
eaa9539 
🤖 I have created a release *beep* *boop*
---


##
[2.41.0](v2.40.0...v2.41.0)
(2024-08-13)


### Features

* generate historical events from product revisions
([#10523](#10523))
([42508e1](42508e1))
* sync number of product public/pro in CRM
([#10684](#10684))
([026ff6a](026ff6a))


### Bug Fixes

* 3 fixes to make /products/[code1],[code2] work again
([#10669](#10669))
([7fc07fc](7fc07fc))
* Automatically unselect images when source image is deleted
([#10692](#10692))
([588897a](588897a))
* **docs:** correct OpenAPI definition by fixing missing reference
([#10659](#10659))
([4f0f10e](4f0f10e))
* gen_users_emails.pl
([#10686](#10686))
([00e4c26](00e4c26))
* Show missing nutrients in Nutri-Score panel
([#10655](#10655))
([a1b11eb](a1b11eb))
* UTM mobile
([#10665](#10665))
([965041d](965041d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🐛 bug This is a bug, not a feature request. 📚 Documentation Documentation issues improve the project for everyone. OpenAPI OpenAPI documentation of Open Food Facts. Still incomplete, and needs help. 🎯 P1
Projects
🍊 Open Food Facts Server issues
Archived in project
📚 Document Open Food Facts
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(docs): Correct OpenAPI definition by fixing missing reference openfoodfacts/openfoodfacts-server
2 participants
@teolemon @teleboas