From 160d64df3339704a1c1b2f1485babc7b1017cee6 Mon Sep 17 00:00:00 2001
From: Shinjigi <shinjigi@gmail.com>
Date: Tue, 12 Nov 2024 11:46:20 +0100
Subject: [PATCH] docs: openapi nutriscore definition (#11005)

<!-- IMPORTANT CHECKLIST
Make sure you've done all the following (You can delete the checklist
before submitting)
- [X] PR title is prefixed by one of the following: feat, fix, docs,
style, refactor, test, build, ci, chore, revert, l10n, taxonomy
- [ ] Code is well documented
- [ ] Include unit tests for new functionality
- [X] Code passes GitHub workflow checks in your branch
- [X] If you have multiple commits please combine them into one commit
by squashing them.
- [X] Read and understood the [contribution
guidelines](https://github.com/openfoodfacts/openfoodfacts-server/blob/main/CONTRIBUTING.md)
-->
### What
Nutriscore definition proposal to reference unmapped properties

### Screenshot

![image](https://github.com/user-attachments/assets/c156b274-cce8-4b5f-9bd3-3f61d58249e3)


### Related issue(s) and discussion
#9114
---
 docs/api/ref/api.yml                         |   2 +
 docs/api/ref/schemas/product.yaml            |   1 +
 docs/api/ref/schemas/product_nutriscore.yaml | 320 +++++++++++++++++++
 3 files changed, 323 insertions(+)
 create mode 100644 docs/api/ref/schemas/product_nutriscore.yaml

diff --git a/docs/api/ref/api.yml b/docs/api/ref/api.yml
index 1ef9b4868123d..37faea8ae0f92 100644
--- a/docs/api/ref/api.yml
+++ b/docs/api/ref/api.yml
@@ -516,6 +516,8 @@ components:
       $ref: ./schemas/product_ingredients.yaml
     "Product-Nutrition":
       $ref: ./schemas/product_nutrition.yaml
+    "Product-Nutriscore":
+      $ref: "./schemas/product_nutriscore.yaml#/components/schemas/NutriscoreAll"
     "Product-Quality":
       $ref: ./schemas/product_quality.yaml
     "Product-Data-Quality":
diff --git a/docs/api/ref/schemas/product.yaml b/docs/api/ref/schemas/product.yaml
index 65a28fb0665e9..3e87ce768fdc4 100644
--- a/docs/api/ref/schemas/product.yaml
+++ b/docs/api/ref/schemas/product.yaml
@@ -26,6 +26,7 @@ allOf:
   - $ref: "../api.yml#/components/schemas/Product-Eco-Score"
   - $ref: "../api.yml#/components/schemas/Product-Ingredients"
   - $ref: "../api.yml#/components/schemas/Product-Nutrition"
+  - $ref: "../api.yml#/components/schemas/Product-Nutriscore"
   - $ref: "../api.yml#/components/schemas/Product-Data-Quality"
   - $ref: "../api.yml#/components/schemas/Product-Extended"
   - $ref: "../api.yml#/components/schemas/Product-Metadata"
diff --git a/docs/api/ref/schemas/product_nutriscore.yaml b/docs/api/ref/schemas/product_nutriscore.yaml
new file mode 100644
index 0000000000000..8b265d1b3eb78
--- /dev/null
+++ b/docs/api/ref/schemas/product_nutriscore.yaml
@@ -0,0 +1,320 @@
+openapi: 3.1.0
+components:
+  schemas:
+    # Reusable base definitions
+    NutriscoreGrade:
+      type: string
+      enum: ["a", "b", "c", "d", "e"]
+
+    NutriscoreGradeTags:
+      type: array
+      items:
+        $ref: "#/components/schemas/NutriscoreGrade"
+      examples: [["d"]]
+
+    BaseNutrientData:
+      type: object
+      properties:
+        value:
+          type: number
+          format: float
+        points:
+          type: integer
+        points_max:
+          type: integer
+
+    ProductType:
+      type: object
+      properties:
+        is_beverage:
+          type: integer
+          enum: [0, 1]
+          examples: [0]
+        is_cheese:
+          type: integer
+          enum: [0, 1]
+          examples: [0]
+        is_water:
+          type: integer
+          enum: [0, 1]
+          examples: [0]
+
+    NutrientSet:
+      type: object
+      properties:
+        value:
+          type: number
+          format: float
+        points:
+          type: integer
+
+    # 2021 Schema
+    Nutriscore2021InnerData:
+      title: Nutriscore2021InnerData
+      allOf:
+        - $ref: "#/components/schemas/ProductType"
+        - properties:
+            is_fat:
+              type: integer
+              enum: [0, 1]
+              examples: [0]
+            # Energy
+            energy:
+              type: integer
+              examples: [1996]
+            energy_points:
+              type: integer
+              examples: [5]
+            energy_value:
+              type: integer
+              examples: [1996]
+            # Fiber
+            fiber:
+              type: number
+              format: float
+              examples: [3.8]
+            fiber_points:
+              type: integer
+              examples: [4]
+            fiber_value:
+              type: number
+              format: float
+              examples: [3.8]
+            # Fruits, vegetables, nuts, etc.
+            fruits_vegetables_nuts_colza_walnut_olive_oils:
+              type: number
+              format: float
+              examples: [0]
+            fruits_vegetables_nuts_colza_walnut_olive_oils_points:
+              type: integer
+              examples: [0]
+            fruits_vegetables_nuts_colza_walnut_olive_oils_value:
+              type: number
+              format: float
+              examples: [0]
+            # Proteins
+            proteins:
+              type: number
+              format: float
+              examples: [6.6]
+            proteins_points:
+              type: integer
+              examples: [4]
+            proteins_value:
+              type: number
+              format: float
+              examples: [6.6]
+            # Saturated fats
+            saturated_fat:
+              type: number
+              format: float
+              examples: [6.2]
+            saturated_fat_points:
+              type: integer
+              examples: [6]
+            saturated_fat_value:
+              type: number
+              format: float
+              examples: [6.2]
+            # Sodium
+            sodium:
+              type: number
+              format: float
+              examples: [210]
+            sodium_points:
+              type: integer
+              examples: [2]
+            sodium_value:
+              type: number
+              format: float
+              examples: [210]
+            # Sugars
+            sugars:
+              type: number
+              format: float
+              examples: [21.5]
+            sugars_points:
+              type: integer
+              examples: [4]
+            sugars_value:
+              type: number
+              format: float
+              examples: [21.5]
+            # Total points
+            negative_points:
+              type: integer
+              examples: [17]
+            positive_points:
+              type: integer
+              examples: [4]
+
+    Nutriscore2021Data:
+      title: Nutriscore2021Data
+      allOf:
+        - $ref: "#/components/schemas/Nutriscore2021InnerData"
+        - type: object
+          properties:
+            grade:
+              $ref: "#/components/schemas/NutriscoreGrade"
+              examples: ["d"]
+            score:
+              type: integer
+              examples: [13]
+
+    # Component Schema
+    NutriscoreComponent:
+      title: NutriscoreComponent
+      type: object
+      properties:
+        id:
+          type: string
+          examples:
+            [
+              "energy",
+              "sugars",
+              "saturated_fat",
+              "salt",
+              "fiber",
+              "fruits_vegetables_legumes",
+            ]
+        points:
+          type: integer
+          examples: [5, 6, 7, 2, 1, 0]
+        points_max:
+          type: integer
+          examples: [10, 15, 20, 25, 5, 5]
+        unit:
+          type: string
+          examples: ["kJ", "g", "%"]
+        value:
+          type:
+            - "null"
+            - "number"
+          format: float
+          examples: [21.5, 6.2, 0.53, 3.8, 0]
+
+    # 2023 Schema
+    Nutriscore2023Data:
+      title: Nutriscore2023Data
+      allOf:
+        - $ref: "#/components/schemas/ProductType"
+        - properties:
+            is_fat_oil_nuts_seeds:
+              type: integer
+              enum: [0, 1]
+              examples: [0]
+            is_red_meat_product:
+              type: integer
+              enum: [0, 1]
+              examples: [0]
+            components:
+              title: Nutriscore2023DataComponents
+              type: object
+              properties:
+                negative:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/NutriscoreComponent"
+                positive:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/NutriscoreComponent"
+            count_proteins:
+              type: number
+              format: float
+              examples: [0]
+            count_proteins_reason:
+              type: string
+              examples: ["negative_points_greater_than_or_equal_to_11"]
+            negative_points:
+              type: integer
+              examples: [19]
+            positive_points:
+              type: integer
+              examples: [1]
+            negative_points_max:
+              type: integer
+              examples: [55]
+            positive_points_max:
+              type: integer
+              examples: [10]
+            positive_nutrients:
+              type: array
+              items:
+                type: string
+              examples: [["fiber", "fruits_vegetables_legumes"]]
+
+    # Common Year Data
+    NutriscoreYearData:
+      type: object
+      properties:
+        category_available:
+          type: integer
+          enum: [0, 1]
+          examples: [1]
+        grade:
+          $ref: "#/components/schemas/NutriscoreGrade"
+          examples: ["d"]
+        nutrients_available:
+          type: integer
+          enum: [0, 1]
+          examples: [1]
+        nutriscore_applicable:
+          type: integer
+          enum: [0, 1]
+          examples: [1]
+        nutriscore_computed:
+          type: integer
+          enum: [0, 1]
+          examples: [1]
+        score:
+          type: integer
+          examples: [13, 18]
+
+    Nutriscores:
+      title: Nutriscores
+      type: object
+      properties:
+        "2021":
+          title: Nutriscore2021
+          allOf:
+            - $ref: "#/components/schemas/NutriscoreYearData"
+            - type: object
+              properties:
+                data:
+                  $ref: "#/components/schemas/Nutriscore2021Data"
+        "2023":
+          title: Nutriscore2023
+          allOf:
+            - $ref: "#/components/schemas/NutriscoreYearData"
+            - type: object
+              properties:
+                data:
+                  $ref: "#/components/schemas/Nutriscore2023Data"
+
+    # Final Structure
+    NutriscoreAll:
+      title: ProductNutriscore
+      type: object
+      properties:
+        nutriscore:
+          $ref: "#/components/schemas/Nutriscores"
+        nutriscore_2021_tags:
+          $ref: "#/components/schemas/NutriscoreGradeTags"
+        nutriscore_2023_tags:
+          $ref: "#/components/schemas/NutriscoreGradeTags"
+        nutriscore_data:
+          $ref: "#/components/schemas/Nutriscore2021Data"
+        nutriscore_grade:
+          $ref: "#/components/schemas/NutriscoreGrade"
+          examples: ["d"]
+        nutriscore_score:
+          type: integer
+          examples: [13]
+        nutriscore_score_opposite:
+          type: integer
+          examples: [-13]
+        nutriscore_tags:
+          $ref: "#/components/schemas/NutriscoreGradeTags"
+        nutriscore_version:
+          type: string