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

API (Tracker) #5523

Open
Tracked by #4884
teolemon opened this issue Aug 21, 2021 · 1 comment
Open
Tracked by #4884

API (Tracker) #5523

teolemon opened this issue Aug 21, 2021 · 1 comment
Labels
🧽 API - Quality 🔐 API auth The API requires auth in order to perform editing.There is a common mechanism & a Robotoff mechanism API READ All READ APIs include Product, Search… API WRITE WRITE API to allow sending product info and image API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it.

Comments

@teolemon
Copy link
Member

teolemon commented Aug 21, 2021 •
edited
Loading

OpenAPI / Swagger
Beta Give feedback
  1. docs: Open API specification | Get A product By Barcode #7148

Tasks
Beta Give feedback
No tasks being tracked yet.

API Auth
Beta Give feedback
  1. Document user-agent headers for browsers (Safari, Chrome, Mozilla) #5264
  2. Add hashed user id field to API, for apps that have an app user id #5195
  3. Lite version of session.pl #1882
  4. Implement a central User Service for auth - keycloak #1596
  5. Enable a token based auth for the mobile app #1204
  6. Add an optional parameter to the API calls to tell who you are #741

auth to be labelled
Beta Give feedback
  1. Improve write API's authentication failure response #525

API READ
Beta Give feedback
  1. Allow to search only by name or generic name #485
  2. Remove product-dependent keys in read json #459
  3. Do not use non-predefined keys in json #280
  4. Check search works with language specific fields #235
  5. Add standard field value when the information is not specified on the packaging #214
  6. Document user-agent headers for browsers (Safari, Chrome, Mozilla) #5264
  7. API does not return product name and nutrient for barcode 3175681123014 #5097
  8. API brings back different results to web search #4884
  9. The API sends back nutrition_data_per: "100.0 g" instead of nutrition_data_per: "100g" #4733
  10. Knowledge panel - Personal impact #4503
  11. Unable to find new packager codes with API #4405
  12. Honor queries with codes like zh_CN or pt_BR #4091
  13. Add an API field for calorie burn equivalences #2462
  14. Barcode json search url does not always work #2435
  15. Better API support for protected products #2012
  16. " escaped double quotes in JSON/CSV #1769
  17. Create an HTML field that's returned in the API for product recalls and announcements #1676
  18. Invalid barcodes return random products #1649
  19. Open Beauty Facts - Nutriscore are still computed with Open Beauty Facts #1214
  20. Expose recalled products through the API #1087
  21. Expose product recalls warnings in the API #1035
  22. Expose all images in read api #723
  23. Add an optional parameter to the API calls to tell who you are #741
  24. feat: experimental branch that tries to re-implement the API as REST API with HAL+JSON and HATEOAS in mind #1687
  25. Compatibility mode: add back empty "" values for _serving and _100g for Android app #1763
  26. Wrong URL redirection #1219
  27. (Proposal) Improving the Product JSON API #1056
  28. Create an API for all supported nutrients #704

XML output
Beta Give feedback
  1. Broken XML API for Read/Product - Namespace prefix en for cocoa on likeliest_recipe is not defined #6184

API WRITE
Beta Give feedback
  1. Add hashed user id field to API, for apps that have an app user id #5195
  2. Allow setting prepared nutrition data through API #4773
  3. Uploaded images via the API does not appear on the site #4174
  4. Remove non-significant digits from nutrition values passed to the API #3483
  5. Add new fields no_serving_size and no_ingredients #2817
  6. Unrelated API calls remove no nutrition facts #2477
  7. Do not use ip to initialize country for products created through the API but not directly by the client #1706
  8. feat: experimental branch that tries to re-implement the API as REST API with HAL+JSON and HATEOAS in mind #1687
  9. Images are silently discarded when the lang code is wrong #1631
  10. Consider creating an API for moving products with history #1597
  11. Prevention - Nutrition - Reject edits where all entered nutrition values are 0 #1564
  12. Add a flag button/API to put up a product for review when you're in a hurry #1408
  13. Add app name and version to the WRITE API fields #1206
  14. API - &ocr=true on image upload should send back a success message with OCR results #1021
  15. API fail? #881
  16. POST product image consistency #517

Unsorted API issues
Beta Give feedback
No tasks being tracked yet.

Packaging
Beta Give feedback
  1. Return image_packaging_url in API #4442

Consistent types
Beta Give feedback
  1. Return numbers as numbers (and not strings) in the API, store them as numbers in MongoDB, add tests #4389

Checked Products
Beta Give feedback
  1. Introduce more granular checked data checkbox along with an API #2062

Lighter payloads
Beta Give feedback
  1. Remove debug fields in product JSON in MongoDB and API #1797

Erratic behaviours
Beta Give feedback
  1. Querying with a NULL value returns “Heinz Sauce Barbecue” #945

To be sorted
Beta Give feedback
  1. Understanding JSON taxonomy fields #892
  2. Providing a data package through the API #793

Contributor API
Beta Give feedback
  1. Creator search API #884

Additives API
Beta Give feedback
  1. Simplified API for additives #845

Period after Opening API
Beta Give feedback
  1. Support "period after opening" #815

Devops
Beta Give feedback
  1. Add a field to see which 'server' the product is on #797

Open Beauty Facts
Beta Give feedback
  1. Display ingredient analysis in the API for the Open Beauty Facts app #789
  2. Create placeholder response if the product is present on Open (Beauty/PetFood/Products) Facts #497

Multilingual products
Beta Give feedback
  1. Main language dependency #780

Image upload API
Beta Give feedback
  1. Image upload API: return the imgid when a picture is already uploaded #778
  2. Improve the image POST API #722

Nutrients
Beta Give feedback
  1. nutriment_ph_unit is submmitted as g when editing products #770
  2. Add "no unit" option #768
  3. No nutriments #646
  4. Expose nutriment hierarchy in API #643
  5. API nutriments inconsistency #639
  6. Nutriment value support in write api for per serving AND per 100 g #638

Origins
Beta Give feedback
  1. Origin field structure support #761
  2. Origin field language support #760
  3. The json field "no_nutrition_data" is not a bool #276

Categories
Beta Give feedback
  1. Add the ability to retrieve category nutritional averages #636

Packager codes
Beta Give feedback
  1. Write API emb_codes #608
  2. Add Address/GPS coordinates in Packager codes API #551

WRITE - General
Beta Give feedback
  1. Ensure empty value cannot override existing value #601
  2. It would be more restful and more useful to be able to API POST add product with a JSON body #510

Labels
Beta Give feedback
  1. The label API doesn't contains links between labels, like in the website #559

Ingredients
Beta Give feedback
  1. Add option to return the JSON files in ingredients.pl #532

Brands & Brands owners
Beta Give feedback
  1. Provide an API to give a company using the GS1 manufacturer code included in the barcode #508

Geolocation
Beta Give feedback
  1. Provide an API to give languages and countries supported, given an IP #507
  2. Add an API for country detection using GS1 Barcode prefixes #409

Languages
Beta Give feedback
  1. Provide an API list of all languages supported by Product Opener #506
  2. Add relation language and languageCode in api #462
  3. Offer a list of possible languages based on location of pictures #384

?
Beta Give feedback
  1. Include product in result JSON #501
  2. Offer a READ/WRITE API to add languages present on packaging #385
  3. XMLHttpRequest Search with Method OPTIONS #248

Category-specific editing
Beta Give feedback
  1. Category-specific editing - Display a special warning when a user adds the "egg" category #482

Last edit dates
Beta Give feedback
  1. Edit dates not available in the json. #445

Barcode-less product creation
Beta Give feedback
  1. Add an API to create a barcode-less product #443

Locations
Beta Give feedback
  1. Expose City, Country and Departement in Cities API #392
  2. [multilingual products] Return fields and images for a specific language in the API #270
  3. Add "en:" to Nutri(m)ents keys in json #261

Expiration dates
Beta Give feedback
  1. Normalize expiration date #257

API Documentation
Beta Give feedback
  1. Describe the new API with Swagger file to generate documentation #187
  2. docs: Document API fields #2810
  3. Clarify the meaning of the various fields in the JSON output #655

New API formats
Beta Give feedback
  1. Create RSS feeds #138

Dogfood the API for the Web
Beta Give feedback
  1. Client/Server structure using API #80
  2. Split Display.pm into API.pm and Frontend.pm, make frontend use the API #5205

Advanced search
Beta Give feedback
  1. Add "criteria" in the "Products search" page #18

Part of
@teolemon teolemon mentioned this issue Aug 21, 2021
Open
1 task
@teolemon teolemon changed the title API API (Tracker) Aug 21, 2021
@teolemon teolemon added API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) 🔐 API auth The API requires auth in order to perform editing.There is a common mechanism & a Robotoff mechanism 🧽 API - Quality API READ All READ APIs include Product, Search… API WRITE WRITE API to allow sending product info and image labels Aug 21, 2021
@teolemon teolemon mentioned this issue Aug 22, 2021
Open
This was referenced Sep 27, 2021
Closed
Open
@github-actions github-actions bot added the ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. label Nov 20, 2021
@teolemon teolemon mentioned this issue Dec 28, 2021
Open
@teolemon teolemon mentioned this issue Mar 31, 2022
Open
@teolemon teolemon mentioned this issue Jul 8, 2022
Open
@openfoodfacts openfoodfacts deleted a comment from github-actions bot Jul 27, 2022
@VaiTon VaiTon removed the ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. label Jul 27, 2022
This was referenced Oct 12, 2022
Open
Open
Open
Open
Open
@teolemon teolemon mentioned this issue Oct 27, 2022
Open
This was referenced Jun 14, 2023
Open
Closed
@teolemon teolemon mentioned this issue Jul 31, 2023
Open
@teolemon teolemon mentioned this issue Aug 8, 2023
Open
@github-actions GitHub Actions
Copy link
Contributor

This issue has been open 90 days with no activity. Can you give it a little love by linking it to a parent issue, adding relevant labels and projets, creating a mockup if applicable, adding code pointers from https://github.com/openfoodfacts/openfoodfacts-server/blob/main/.github/labeler.yml, giving it a priority, editing the original issue to have a more comprehensive description… Thank you very much for your contribution to 🍊 Open Food Facts

@github-actions github-actions bot added the ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. label Jan 24, 2024
@teolemon teolemon mentioned this issue Jan 29, 2024
Open
@teolemon teolemon mentioned this issue Mar 24, 2024
Open
@teolemon teolemon mentioned this issue Apr 1, 2024
Closed
@teolemon teolemon mentioned this issue May 27, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🧽 API - Quality 🔐 API auth The API requires auth in order to perform editing.There is a common mechanism & a Robotoff mechanism API READ All READ APIs include Product, Search… API WRITE WRITE API to allow sending product info and image API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it.
Projects
🍊 Open Food Facts Server issues
Status: To discuss and validate
🛠️ - Server - API
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@teolemon @VaiTon