From 534ebb9309d6190b3d2ec5cef499066e1a9653db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Bournhonesque?= Date: Tue, 21 Nov 2023 19:03:35 +0100 Subject: [PATCH 1/4] docs: improve OpenAPI documentation --- docs/api/ref/schemas/product_base.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/ref/schemas/product_base.yaml b/docs/api/ref/schemas/product_base.yaml index 3be26b56bbbd9..fd89c01434b61 100644 --- a/docs/api/ref/schemas/product_base.yaml +++ b/docs/api/ref/schemas/product_base.yaml @@ -70,6 +70,10 @@ properties: product_name_fr (for french). product_quantity: type: string + description: | + The size in g or ml for the whole product. + It's a normalized version of the quantity field. + example: "500" quantity: type: string description: | From a1963139947d310fa624d2839f8fa0ec2ba340f4 Mon Sep 17 00:00:00 2001 From: Pierre Slamich Date: Wed, 22 Nov 2023 10:30:01 +0100 Subject: [PATCH 2/4] Update labeler.yml --- .github/labeler.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/labeler.yml b/.github/labeler.yml index fcb557d39d9fa..ab17ceb57454d 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -188,6 +188,7 @@ footer: OpenAPI: - docs/assets/api-rapidoc.html +- docs/api/ref/schemas/product_base.yaml 🐋 Docker: - docker/**/* From 5ceccfbdf06122bf80cf3e9f1cd46012cbd5445e Mon Sep 17 00:00:00 2001 From: Pierre Slamich Date: Wed, 22 Nov 2023 10:34:21 +0100 Subject: [PATCH 3/4] Update product_base.yaml --- docs/api/ref/schemas/product_base.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/ref/schemas/product_base.yaml b/docs/api/ref/schemas/product_base.yaml index fd89c01434b61..856821e7b523c 100644 --- a/docs/api/ref/schemas/product_base.yaml +++ b/docs/api/ref/schemas/product_base.yaml @@ -67,7 +67,7 @@ properties: description: | The name of the product can also be in many other languages like - product_name_fr (for french). + product_name_fr (for French). product_quantity: type: string description: | @@ -88,4 +88,4 @@ patternProperties: type: string description: | This can be returned in many other languages - like generic_name_fr (for french). \ No newline at end of file + like generic_name_fr (for french). From ffb0798b66a0a44e52822a0af281ca59bd7e17f2 Mon Sep 17 00:00:00 2001 From: Pierre Slamich Date: Wed, 22 Nov 2023 10:34:51 +0100 Subject: [PATCH 4/4] Update product_base.yaml --- docs/api/ref/schemas/product_base.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/ref/schemas/product_base.yaml b/docs/api/ref/schemas/product_base.yaml index 856821e7b523c..c8eb719c01904 100644 --- a/docs/api/ref/schemas/product_base.yaml +++ b/docs/api/ref/schemas/product_base.yaml @@ -88,4 +88,4 @@ patternProperties: type: string description: | This can be returned in many other languages - like generic_name_fr (for french). + like generic_name_fr (for French).