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

Document the output of the facet and its response #20

Closed
Tracked by #14
sumit-158 opened this issue Aug 24, 2022 · 3 comments · Fixed by #24
Closed
Tracked by #14

Document the output of the facet and its response #20

sumit-158 opened this issue Aug 24, 2022 · 3 comments · Fixed by #24
Assignees
@sumit-158
Labels
📚 Documentation Improvements or additions to documentation

Comments

@sumit-158
Copy link
Member

sumit-158 commented Aug 24, 2022 •
edited
Loading

Story

  • Document knowledge-panel response so user could understand the project easily
  • with OpenApi
@sumit-158 sumit-158 self-assigned this Aug 24, 2022
@sumit-158 sumit-158 moved this to 🏗 In progress in Knowledge Panels for Facets Aug 25, 2022
@sumit-158 sumit-158 mentioned this issue Aug 28, 2022
Merged
@sumit-158 sumit-158 linked a pull request Aug 28, 2022 that will close this issue
docs: Added OpenAPI documentation #24
Merged
@teolemon teolemon added the 📚 Documentation Improvements or additions to documentation label Aug 28, 2022
@teolemon teolemon mentioned this issue Aug 28, 2022
Open
@alexgarel
Copy link
Member

@sumit-158 while documenting you might also review you knowledge panels for many of them are not compatible with current informal spec.
Look at https://world.openfoodfacts.org/api/v2/product/3017620422003/nutella-ferrero-nutella?fields=knowledge_panels to see what exists.

@sumit-158
Copy link
Member Author

@alexgarel This is different Kp, I'm confuse do you mean I have to make current kp spec something like https://world.openfoodfacts.org/api/v2/product/3017620422003/nutella-ferrero-nutella?fields=knowledge_panels this kp

@alexgarel
Copy link
Member

Not like this, but just use same structure, do not add inexisting properties. Do not hesitate to ask question if you are in doubt.

alexgarel pushed a commit that referenced this issue Sep 28, 2022
@sumit-158
docs: Added OpenAPI documentation (#24)
3181936 
* Documented the API based on OpenAPI
*  Added metadata and response Model
* Unify API response

fixes #20 #21
@sumit-158 sumit-158 moved this from 🏗 In progress to ✅ Done in Knowledge Panels for Facets Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sumit-158 sumit-158

Labels
📚 Documentation Improvements or additions to documentation
Projects
Knowledge Panels for Facets
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Added OpenAPI documentation openfoodfacts/facets-knowledge-panels
3 participants
@alexgarel @teolemon @sumit-158