API-401: add documentation on the update of a list of family variants

Author: ahocquard

content/swagger/resources/families/routes/families.yaml

@@ -138,7 +138,7 @@ patch:
           x-example-1:
             '{"code":"tshirt","attributes":["description","size"]}'
           x-example-2:
-            '{"code":"cap","attribute_as_label":"descripion"}'
+            '{"code":"cap","attribute_as_label":"description"}'
           x-example-3:
             '{"code":"mug","attributes":["description","short_description"]}'
   responses:
@@ -152,7 +152,7 @@ patch:
         x-example-1:
           '{"line":1,"code":"tshirt","status_code":201}'
         x-example-2:
-          '{"line":2,"code":"cap","status_code":422,"message":"Attribute "descripion" does not exist."}'
+          '{"line":2,"code":"cap","status_code":422,"message":"Attribute "description" does not exist."}'
         x-example-3:
           '{"line":3,"code":"mug","status_code":204}'
     401:

content/swagger/resources/families/routes/families_code_variants.yaml

@@ -79,3 +79,47 @@ post:
       $ref: "#/responses/415Error"
     422:
       $ref: "#/responses/422Error"
+patch:
+  summary: Update/create several family variants
+  operationId: "patch_families__family_code__variants"
+  tags:
+    - Families
+  x-versions:
+    - 2.0
+  description: This endpoint allows you to update and/or create several family variants at once, for a given family.
+  x-body-by-line: Contains several lines, each line is a family in JSON standard format
+  parameters:
+    - $ref: '#/parameters/family_code'
+    - name: body
+      in: body
+      schema:
+        $ref: "#/definitions/FamilyVariant"
+        x-examples:
+          x-example-1:
+            '{"code": "shoes_by_size", "variant_attribute_sets": [{"level": 1, "axes": ["size"], "attributes": ["color"]}]}'
+          x-example-2:
+            '{"code": "shoes_by_color","labels": {"en_US": "Shoes by color"}}'
+          x-example-3:
+            '{"code": "shoes_without_axes", "variant_attribute_sets": [{"level": 1, "axes": [], "attributes": ["color"]}]}'
+  responses:
+    200:
+      description: OK
+      x-details: Returns a plain text response whose lines are JSON containing the status of each update or creation
+      x-no-entity: true
+      schema:
+        $ref: "#/definitions/ErrorByLine"
+      examples:
+        x-example-1:
+          '{"line":1,"code":"shoes_by_size","status_code":201}'
+        x-example-2:
+          '{"line":2,"code":"shoes_by_color","status_code":204}'
+        x-example-3:
+          '{"line":3,"code":"mug","status_code":422, "message":"There should be at least one attribute defined as axis for the attribute set for level "1""}'
+    401:
+      $ref: "#/responses/401Error"
+    403:
+      $ref: "#/responses/403Error"
+    413:
+      $ref: "#/responses/413Error"
+    415:
+      $ref: "#/responses/415ErrorStream"