docs: add documentation about unselecting photo (#8237)

openfoodfacts · Mar 21, 2023 · b989be3 · b989be3
1 parent bda3722
commit b989be3
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/docs/api/ref/api.yml b/docs/api/ref/api.yml
@@ -175,6 +175,36 @@ paths:
         - $ref: '#/components/parameters/angle'
       tags:
         - Write Requests
+  /cgi/product_image_unselect.pl:
+    post:
+      summary: Unselect A Photo
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              $ref: ./requestBodies/unselect_a_photo.yaml
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    description: status of the unselect operation
+                    example: status ok
+                  status_code:
+                    type: number
+                    description: status code of the operation
+                    example: 0
+                  imagefield:
+                    type: string
+                    example: front_fr
+                    description: image field that was unselected
+
+
   /cgi/product_jqm2.pl:
     post:
       summary: Add or Edit A Product

diff --git a/docs/api/ref/requestBodies/unselect_a_photo.yaml b/docs/api/ref/requestBodies/unselect_a_photo.yaml
@@ -0,0 +1,10 @@
+type: object
+properties:
+  code:
+    type: string
+    description: code of the product
+    example: '4251105501381'
+  id:
+    type: string
+    description: image field (image id) of the photo to unselect
+    example: front_fr