From 959c74cf5de8218785b65ece003a93543ab95678 Mon Sep 17 00:00:00 2001 From: Jean Forget Date: Fri, 13 Sep 2024 13:03:44 +0200 Subject: [PATCH] Fix: YAML syntax in schema files. (#10783) ### What Some schema files have incorrect YAML syntax. When a key-value pair is split on two lines, the colon separating the value from the key should be followed by a pipe. While most YAML files contain the pipe chars when required, some of them miss one or two pipe chars. --- docs/api/ref/schemas/product_base.yaml | 4 ++-- docs/api/ref/schemas/product_images.yaml | 2 +- docs/api/ref/schemas/product_meta.yaml | 2 +- docs/api/ref/schemas/product_quality.yaml | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/ref/schemas/product_base.yaml b/docs/api/ref/schemas/product_base.yaml index 9f20c4d3b19f3..81a505def09d4 100644 --- a/docs/api/ref/schemas/product_base.yaml +++ b/docs/api/ref/schemas/product_base.yaml @@ -20,7 +20,7 @@ properties: and A series of mask for the barcode It helps retrieve barcodes starting by - example: + example: | ["code-13","3017620422xxx","301762042xxxx","30176204xxxxx","3017620xxxxxx","301762xxxxxxx","30176xxxxxxxx","3017xxxxxxxxx","301xxxxxxxxxx","30xxxxxxxxxxx","3xxxxxxxxxxxx"] generic_name: type: string @@ -47,7 +47,7 @@ properties: Main language is also used to decide which ingredients list to parse. nova_group: type: integer - description: + description: | Nova group as an integer from 1 to 4. See https://world.openfoodfacts.org/nova nova_groups: type: string diff --git a/docs/api/ref/schemas/product_images.yaml b/docs/api/ref/schemas/product_images.yaml index 81e8adf420df1..17ee25c857022 100644 --- a/docs/api/ref/schemas/product_images.yaml +++ b/docs/api/ref/schemas/product_images.yaml @@ -39,7 +39,7 @@ properties: This represents an image uploaded for this product. $ref: ./image.yaml front: - description: + description: | This represents an image (or part of it) selected for a specific role on this product. type: object $ref: ./image_role.yaml diff --git a/docs/api/ref/schemas/product_meta.yaml b/docs/api/ref/schemas/product_meta.yaml index 0cc972c56272f..6ff9c0d05e8db 100644 --- a/docs/api/ref/schemas/product_meta.yaml +++ b/docs/api/ref/schemas/product_meta.yaml @@ -8,7 +8,7 @@ properties: description: | Date when the product was added (UNIX timestamp format). See also `entry_dates_tags` - example: + example: | 1457680652 creator: type: string diff --git a/docs/api/ref/schemas/product_quality.yaml b/docs/api/ref/schemas/product_quality.yaml index cf3917392bfe3..ae13f208cc31b 100644 --- a/docs/api/ref/schemas/product_quality.yaml +++ b/docs/api/ref/schemas/product_quality.yaml @@ -52,7 +52,7 @@ properties: states_tags: type: array items: - description: + description: | Each state describe something that is completed or is to be done or improved on the product. Refer to [states taxonomy](https://static.openfoodfacts.net/data/taxonomies/states.json) @@ -63,4 +63,4 @@ properties: Information about different aspect of the product type: array items: - type: string \ No newline at end of file + type: string