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
Preview Give feedback
  1. docs: Open API specification | Get A product By Barcode #7148
    export 📚 Documentation
    Roxie-32

Tasks
Preview Give feedback
No tasks being tracked yet.

API Auth
Preview Give feedback
  1. Document user-agent headers for browsers (Safari, Chrome, Mozilla) #5264
    API API READ ⏰ Stale 🔐 API auth
  2. Add hashed user id field to API, for apps that have an app user id #5195
    API API WRITE ✏️ Editing - anonymous edits ✨ Feature 🔐 API auth
  3. Lite version of session.pl #1882
    API ✨ Feature 🎯 P1 candidate 🔐 API auth
  4. Implement a central User Service for auth - keycloak #1596
    API 🔐 API auth
    hangy
  5. Enable a token based auth for the mobile app #1204
    API help wanted security 🎯 P1 🔐 API auth
    hangy
  6. Add an optional parameter to the API calls to tell who you are #741
    API API READ 🔐 API auth

auth to be labelled
Preview Give feedback
  1. Improve write API's authentication failure response #525
    API API Refactor P3 🔐 API auth

API READ
Preview Give feedback
  1. Allow to search only by name or generic name #485
    API API READ P3 🔎 Search
  2. Remove product-dependent keys in read json #459
    API API READ API Refactor
  3. Do not use non-predefined keys in json #280
    API API READ Nutrients
  4. Check search works with language specific fields #235
    API API READ Fixed ? 🌍 Multilingual products 🔎 Search
  5. Add standard field value when the information is not specified on the packaging #214
    API API READ Product Page
  6. Document user-agent headers for browsers (Safari, Chrome, Mozilla) #5264
    API API READ ⏰ Stale 🔐 API auth
  7. API does not return product name and nutrient for barcode 3175681123014 #5097
    API API READ ⏰ Stale
  8. API brings back different results to web search #4884
    API API READ ⏰ Stale 🔎 Search
  9. The API sends back nutrition_data_per: "100.0 g" instead of nutrition_data_per: "100g" #4733
    API API READ ⏰ Stale
    stephanegigandet
  10. Knowledge panel - Personal impact #4503
    API API READ ⏰ Stale 🌱 Green-Score 📖 Knowledge Panels
  11. Unable to find new packager codes with API #4405
    API API READ ⏰ Stale 📍🏭 Packager codes
  12. Honor queries with codes like zh_CN or pt_BR #4091
    API API READ ⏰ Stale 🎯 P1 🤳🥫 blocking mobile apps
  13. Add an API field for calorie burn equivalences #2462
    API API READ Nutrients Nutrition facts no-issue-activity 📖 Knowledge Panels
  14. Barcode json search url does not always work #2435
    API API READ no-issue-activity
  15. Better API support for protected products #2012
    API API READ protected data 🧽 API - Quality 🧽 Data quality
  16. " escaped double quotes in JSON/CSV #1769
    API API READ Data export
    CharlesNepote hangy
    stephanegigandet teolemon
  17. Create an HTML field that's returned in the API for product recalls and announcements #1676
    API API READ Products Recalls
    stephanegigandet
  18. Invalid barcodes return random products #1649
    API API READ
  19. Open Beauty Facts - Nutriscore are still computed with Open Beauty Facts #1214
    API API READ 🐛 bug 🚦 Nutri-Score 🧴 Open Beauty Facts
  20. Expose recalled products through the API #1087
    API API READ Products Recalls
  21. Expose product recalls warnings in the API #1035
    API API READ Knowledge panels - infoboxes Products Recalls 📖 Knowledge Panels
  22. Expose all images in read api #723
    API API READ ✨ Feature 🖼️ Images
  23. Add an optional parameter to the API calls to tell who you are #741
    API API READ 🔐 API auth
  24. feat: experimental branch that tries to re-implement the API as REST API with HAL+JSON and HATEOAS in mind #1687
    API API READ API Refactor API WRITE 💥 Merge Conflicts
    hangy
  25. Compatibility mode: add back empty "" values for _serving and _100g for Android app #1763
    API API READ 🤳🥫 blocking mobile apps
  26. Wrong URL redirection #1219
    API API READ
  27. (Proposal) Improving the Product JSON API #1056
    API API READ API Refactor
  28. Create an API for all supported nutrients #704
    API API READ Nutrients

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

API WRITE
Preview Give feedback
  1. Add hashed user id field to API, for apps that have an app user id #5195
    API API WRITE ✏️ Editing - anonymous edits ✨ Feature 🔐 API auth
  2. Allow setting prepared nutrition data through API #4773
    API WRITE Nutrition facts ⏰ Stale
  3. Uploaded images via the API does not appear on the site #4174
    API WRITE ⏰ Stale 🖼️ Image upload
  4. Remove non-significant digits from nutrition values passed to the API #3483
    API WRITE Nutrition facts typing ⏰ Stale
    stephanegigandet
  5. Add new fields no_serving_size and no_ingredients #2817
    API API WRITE status system 📦 Packaging 🖼️ Images 🥗 Ingredients
  6. Unrelated API calls remove no nutrition facts #2477
    API API WRITE Data destroying issue 🎯 P1
  7. Do not use ip to initialize country for products created through the API but not directly by the client #1706
    API API WRITE
  8. feat: experimental branch that tries to re-implement the API as REST API with HAL+JSON and HATEOAS in mind #1687
    API API READ API Refactor API WRITE 💥 Merge Conflicts
    hangy
  9. Images are silently discarded when the lang code is wrong #1631
    API API WRITE 🎯 P1 candidate
  10. Consider creating an API for moving products with history #1597
    API WRITE
  11. Prevention - Nutrition - Reject edits where all entered nutrition values are 0 #1564
    API WRITE Nutrition facts 🎯 Big Bang for Your Time 🎯 P1 candidate 🧽 Data quality - Nutrition 🧽 Data quality 🧽 Data quality - Prevention - Edit rules
    benbenben2
  12. Add a flag button/API to put up a product for review when you're in a hurry #1408
    API WRITE Admin tools Fixable via Userscript P2 🎨 Mockup available 👮 Moderation 🧽 Data quality
  13. Add app name and version to the WRITE API fields #1206
    API WRITE 🔐 API auth 🤳🥫 blocking mobile apps 🤳🥫 mobile apps
  14. API - &ocr=true on image upload should send back a success message with OCR results #1021
    API API WRITE OCR
  15. API fail? #881
    API API WRITE Data destroying issue P2
  16. POST product image consistency #517
    API API Refactor API WRITE

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

Packaging
Preview Give feedback
  1. Return image_packaging_url in API #4442
    API ⏰ Stale 🖼️ Images

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

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

Lighter payloads
Preview Give feedback
  1. Remove debug fields in product JSON in MongoDB and API #1797
    API needs reprocessing 🚅 Performance

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

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

Contributor API
Preview Give feedback
  1. Creator search API #884
    API API Refactor 🔎 Search

Additives API
Preview Give feedback
  1. Simplified API for additives #845
    API API Refactor 🧪 additives

Period after Opening API
Preview Give feedback
  1. Support "period after opening" #815
    API question 🧴 Open Beauty Facts

Devops
Preview Give feedback
  1. Add a field to see which 'server' the product is on #797
    API Fixed ? 🎯 P1 🐾 Open Pet Food Facts 📸 Open Products Facts 🧴 Open Beauty Facts
    stephanegigandet

Open Beauty Facts
Preview Give feedback
  1. Display ingredient analysis in the API for the Open Beauty Facts app #789
    API 🎯 P0 📖 Knowledge Panels 📖 Knowledge Panels - OBF 🤳🥫 blocking mobile apps 🥗 Ingredients 🧴 Open Beauty Facts
  2. Create placeholder response if the product is present on Open (Beauty/PetFood/Products) Facts #497
    API API READ API Read - Product API Refactor Fixed ? 🎯 P1 🧴 Open Beauty Facts

Multilingual products
Preview Give feedback
  1. Main language dependency #780
    API 🌍 Multilingual products

Image upload API
Preview Give feedback
  1. Image upload API: return the imgid when a picture is already uploaded #778
    API ⏲️ 5 minute fix
  2. Improve the image POST API #722
    API API Refactor API WRITE 🖼️ Image upload

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

Origins
Preview Give feedback
  1. Origin field structure support #761
    API 📍 Origins
  2. Origin field language support #760
    API 📍 Origins
  3. The json field "no_nutrition_data" is not a bool #276
    API ✏️ Editing - Nutrition 🧽 Data quality

Categories
Preview Give feedback
  1. Add the ability to retrieve category nutritional averages #636
    API API READ P3 averages by categories

Packager codes
Preview Give feedback
  1. Write API emb_codes #608
    API Fixed ? 📍🏭 Packager codes
  2. Add Address/GPS coordinates in Packager codes API #551
    API 📍🏭 Packager codes

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

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

Ingredients
Preview Give feedback
  1. Add option to return the JSON files in ingredients.pl #532
    API API READ Fixed ? OCR 🥗 Ingredients 🥗🔍 Ingredients analysis

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

Geolocation
Preview Give feedback
  1. Provide an API to give languages and countries supported, given an IP #507
    API API Refactor Fixed ? 🤳🥫 blocking mobile apps
  2. Add an API for country detection using GS1 Barcode prefixes #409
    API P2 automatic-data-augmentation barcodes 🧬 Taxonomies

Languages
Preview Give feedback
  1. Provide an API list of all languages supported by Product Opener #506
    API Fixed ? P3
  2. Add relation language and languageCode in api #462
    API
  3. Offer a list of possible languages based on location of pictures #384
    API 🌍 Multilingual products 🖼️ Images

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

Category-specific editing
Preview Give feedback
  1. Category-specific editing - Display a special warning when a user adds the "egg" category #482
    API ✏️ Editing ✏️ Editing - drip editing 🥚 eggs

Last edit dates
Preview Give feedback
  1. Edit dates not available in the json. #445
    API API READ

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

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

Expiration dates
Preview Give feedback
  1. Normalize expiration date #257
    API P3 🌍 Multilingual products

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

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

Dogfood the API for the Web
Preview Give feedback
  1. Client/Server structure using API #80
    API API Refactor refactor
  2. Split Display.pm into API.pm and Frontend.pm, make frontend use the API #5205
    ⭐ top issue API API Refactor refactor 🎯 P1

Advanced search
Preview Give feedback
  1. Add "criteria" in the "Products search" page #18
    API 🔎 Search

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
Closed
Closed
Closed
@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 moved this from Ready for Dev to To discuss and validate in 🍊 Open Food Facts Server issues Apr 19, 2024
@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