docs: fix OpenAPI Product schema file, extract agribalyze.yaml (#8450)

* docs: fix OpenAPI `Product` schema file * fix: typo in agribalise
openfoodfacts · May 25, 2023 · f970234 · f970234
1 parent 7953dbc
commit f970234
Show file tree

Hide file tree

Showing 4 changed files with 2,048 additions and 2,046 deletions.
diff --git a/docs/api/ref/requestBodies/crop_a_photo.yaml b/docs/api/ref/requestBodies/crop_a_photo.yaml
@@ -6,11 +6,13 @@ properties:
   code:
     type: string
     description: Barcode of the product.
-    example: '04963406'
+    example: "04963406"
+    required: true
   imgid:
     type: integer
     description: identifier of the image to select, it should be a number
     example: 2
+    required: true
   id:
     type: string
     description: |
@@ -23,6 +25,7 @@ properties:
       displayed on Product Opener for all languages (ex: on
       `https://fr.openfoodfacts.org`, unless `ingredients_fr` exists).
     example: front_en
+    required: true
   x1:
     type: integer
     example: 0
@@ -60,8 +63,4 @@ properties:
       ImageMagick.
     enum:
       - "true"
-      - "false"
-  required:
-    - code
-    - imgid
-    - id
+      - "false"
diff --git a/docs/api/ref/responses/get_product_by_barcode.yaml b/docs/api/ref/responses/get_product_by_barcode.yaml
@@ -8,7 +8,7 @@ allOf:
       product:
         type: object
         allOf:
-          - $ref: ../schemas/product.yaml#/Product
+          - $ref: ../schemas/product.yaml
 x-examples:
   example-1:
     code: '3017620422003'

diff --git a/docs/api/ref/schemas/agribalyse.yaml b/docs/api/ref/schemas/agribalyse.yaml
@@ -0,0 +1,47 @@
+type: object
+properties:
+  agribalyse_food_code:
+    type: string
+  co2_agriculture:
+    type: number
+  co2_consumption:
+    type: integer
+  co2_distribution:
+    type: number
+  co2_packaging:
+    type: number
+  co2_processing:
+    type: number
+  co2_total:
+    type: number
+  co2_transportation:
+    type: number
+  code:
+    type: string
+  dqr:
+    type: string
+  ef_agriculture:
+    type: number
+  ef_consumption:
+    type: integer
+  ef_distribution:
+    type: number
+  ef_packaging:
+    type: number
+  ef_processing:
+    type: number
+  ef_total:
+    type: number
+  ef_transportation:
+    type: number
+  is_beverage:
+    type: integer
+  name_en:
+    type: string
+    description: |
+      This can be returned in many other languages
+      like name_fr (for french).
+  score:
+    type: integer
+  version:
+    type: string