GSOC/2023 ideas list: Difference between revisions
(Created page with "Ideas for GSOC 2023 will be posted here. There are just ideas, and are non limitative.") |
No edit summary |
||
| Line 1: | Line 1: | ||
Ideas for GSOC 2023 will be posted here. There are just ideas, and are non limitative. | Ideas for GSOC 2023 will be posted here. There are just ideas, and are non limitative. | ||
= Server-side = | |||
<span id="a-new-api-simplify-and-unify-the-open-food-facts-api-used-by-200-apps"></span> | |||
=== A New API: Simplify and unify the Open Food Facts API used by 200+ apps === | |||
<span id="description"></span> | |||
==== Description ==== | |||
Open Food Facts provides a free and open API to read, search and write products data and photos. This API powers more than 200 apps developed by 3rd parties, and is also used by many tools like our AI platform Robotoff and our power contribution tool Hunger Games. Our API is unfortunately very difficult to understand and use as it evolved organically in the last 10 years. It's not 1 API in fact, it's several APIs to do different things, and we have multiple versions of those APIs, each with a different state of features and documentation. This project aims to bring "A New API" to our many reusers. An API that is simple, unified, easy to understand and use, well documented (with OpenAPI) and well tested. | |||
<span id="expected-outcomes"></span> | |||
==== Expected outcomes ==== | |||
We started to build [https://openfoodfacts.github.io/openfoodfacts-server/reference/api-v3/ <u>a new API v3</u>] to provide a clean, generic and unified way to query all API features of Open Food Facts. This new API v3 is currently available for only a very small subsets of our existing APIs: product read, a very small subset of product write, and taxonomy suggestions. | |||
This project is about revisiting one by one all existing APIs to: | |||
<ol style="list-style-type: decimal;"> | |||
<li><blockquote><p>Decide which feature should be added, changed (or maybe even removed)</p></blockquote></li> | |||
<li><blockquote><p>Define the API for each feature (e.g. method, path, parameters, query and response headers and bodies etc.) and document it using OpenAPI.<br /> | |||
This step is critical to ensure that the API will be both useful and used, and will need to be done in coordination with existing users of the API.</p></blockquote></li> | |||
<li><blockquote><p>Implement the API for the feature and add integration tests for it</p></blockquote></li></ol> | |||
APIs that needs to be converted to API v3: | |||
<ul> | |||
<li><blockquote><p>Product image upload, selection and crop</p></blockquote></li> | |||
<li><blockquote><p>Full support for product write (should be done incrementally)</p></blockquote></li> | |||
<li><blockquote><p>Search</p></blockquote></li> | |||
<li><blockquote><p>Taxonomy read</p></blockquote></li> | |||
<li><blockquote><p>User creation and profile edition</p></blockquote></li> | |||
<li><blockquote><p>Authentification</p></blockquote></li></ul> | |||
<span id="project-information"></span> | |||
==== Project information ==== | |||
<ul> | |||
<li><blockquote><p>repository: [https://github.com/openfoodfacts/openfoodfacts-server <u>https://github.com/openfoodfacts/openfoodfacts-server</u>]</p></blockquote></li> | |||
<li><blockquote><p>Slack channels: #product-opener</p></blockquote></li> | |||
<li><blockquote><p>Potential mentors: Stéphane, Alex</p></blockquote></li> | |||
<li><blockquote><p>Project duration: 350 hours</p></blockquote></li> | |||
<li><blockquote><p>Skills required: Perl</p></blockquote></li> | |||
<li><blockquote><p>Difficulty rating: Medium</p></blockquote></li></ul> | |||
<span id="bring-taxonomy-editor-to-a-fully-usable-tool"></span> | |||
=== Bring Taxonomy editor to a fully usable tool === | |||
Revision as of 10:59, 7 February 2023
Ideas for GSOC 2023 will be posted here. There are just ideas, and are non limitative.
Server-side
A New API: Simplify and unify the Open Food Facts API used by 200+ apps
Description
Open Food Facts provides a free and open API to read, search and write products data and photos. This API powers more than 200 apps developed by 3rd parties, and is also used by many tools like our AI platform Robotoff and our power contribution tool Hunger Games. Our API is unfortunately very difficult to understand and use as it evolved organically in the last 10 years. It's not 1 API in fact, it's several APIs to do different things, and we have multiple versions of those APIs, each with a different state of features and documentation. This project aims to bring "A New API" to our many reusers. An API that is simple, unified, easy to understand and use, well documented (with OpenAPI) and well tested.
Expected outcomes
We started to build a new API v3 to provide a clean, generic and unified way to query all API features of Open Food Facts. This new API v3 is currently available for only a very small subsets of our existing APIs: product read, a very small subset of product write, and taxonomy suggestions.
This project is about revisiting one by one all existing APIs to:
Decide which feature should be added, changed (or maybe even removed)
Define the API for each feature (e.g. method, path, parameters, query and response headers and bodies etc.) and document it using OpenAPI.
This step is critical to ensure that the API will be both useful and used, and will need to be done in coordination with existing users of the API.Implement the API for the feature and add integration tests for it
APIs that needs to be converted to API v3:
Product image upload, selection and crop
Full support for product write (should be done incrementally)
Search
Taxonomy read
User creation and profile edition
Authentification
Project information
repository: https://github.com/openfoodfacts/openfoodfacts-server
Slack channels: #product-opener
Potential mentors: Stéphane, Alex
Project duration: 350 hours
Skills required: Perl
Difficulty rating: Medium