17
edits
Changes
Jump to navigation
Jump to search
mLine 1:
Line 1: − + Line 74:
Line 74: − +
no edit summary
== Overview ==
== Overview ==
This document serves as a technical proposal for a new search API.
This document serves as a technical proposal for a new search API - V3 ([[Open Food Facts Search API Version 2|see V2 here]]).
=== Goals ===
=== Goals ===
* [https://openfoodfacts.github.io/api-documentation/#3SEARCHRequests Require documentation]
* [https://openfoodfacts.github.io/api-documentation/#3SEARCHRequests Require documentation]
* [https://github.com/openfoodfacts/openfoodfacts-server/tree/111e0afdbac3c20ea34652b0b413be58be6dfae5/conf/nginx Need to be exposed in the Nginx configuration]
* [https://github.com/openfoodfacts/openfoodfacts-server/tree/111e0afdbac3c20ea34652b0b413be58be6dfae5/conf/nginx Need to be exposed in the Nginx configuration]
* Be prefixed with ''/v3'' (redirecting at the Nginx layer)
* Be prefixed with ''/v3'' (redirecting at the Nginx layer, but not using the v3 prefix at the Search Service layer)
The proposed API definition is below. Note that the requests are represented as Python objects as used in FastAPI - in reality, this is a JSON payload:
The proposed API definition is below. Note that the requests are represented as Python objects as used in FastAPI - in reality, this is a JSON payload: