PIM-7808-7809: Upsert one or several ref entity attribute options

Author: NolwennP

content/rest-api/overview.md

@@ -123,6 +123,7 @@ In 2.3, we added in the API the following entity:
 To finish, in 3.0, we added in the API the following entities:
  - [Reference entity](/documentation/resources.html#reference-entity-3x-and-ee-only) (Enterprise edition only),
  - [Reference entity attribute](/documentation/resources.html#reference-entity-attribute-3x-and-ee-only) (Enterprise edition only),
+ - [Reference entity attribute option](/documentation/resources.html#reference-entity-attribute-option-3x-and-ee-only) (Enterprise edition only),
  - [Reference entity record](/documentation/resources.html#reference-entity-record-3x-and-ee-only) (Enterprise edition only),
  - [Record media file](/documentation/resources.html#record-media-file-3x-and-ee-only) (Enterprise edition only).
 

content/swagger/resources/reference_entity_attributes/definitions/reference_entity_attribute_options.yaml

@@ -0,0 +1,26 @@
+type: array
+items:
+  $ref: ../definitions/reference_entity_attribute_option.yaml
+example: [
+  {
+    "code": "woodland_retreat",
+    "labels": {
+      "en_US": "Woodland Retreat",
+      "fr_FR": "Retraite dans les Bois"
+    }
+  },
+  {
+    "code": "new_nordic",
+    "labels": {
+      "en_US": "New Nordic",
+      "fr_FR": "Renouveau Scandinave"
+    }
+  },
+  {
+    "code": "global_nomad",
+    "labels": {
+      "en_US": "Global Nomad",
+      "fr_FR": "Nomade du Monde"
+    }
+  }
+]

content/swagger/resources/reference_entity_attributes/routes/reference_entity_attributes_code_options.yaml

@@ -84,3 +84,50 @@ get:
       $ref: "#/responses/401Error"
     406:
       $ref: "#/responses/406Error"
+patch:
+  summary: Update/create several reference entity attribute options
+  operationId: "patch_reference_entity_attributes__attribute_code__options"
+  tags:
+    - Reference entity attribute option
+  x-versions:
+    - "3.0"
+  x-ee: true
+  description: This endpoint allows you to update several options for a given attribute and a given reference entity at once.
+  x-body-by-line: Contains several lines, each line is a reference entity attribute option in JSON standard format
+  parameters:
+    - $ref: '#/parameters/reference_entity_code'
+    - $ref: '#/parameters/attribute_code'
+    - name: body
+      in: body
+      schema:
+        $ref: ../definitions/reference_entity_attribute_options.yaml
+  responses:
+    200:
+      description: OK
+      x-details: Returns an JSON array in which each object gives you the status of each reference entity attribute option creation or update
+      x-no-entity: true
+      schema:
+        $ref: '#/definitions/ErrorByObject'
+      x-examples: [
+        {
+          "code": "woodland_retreat",
+          "status_code": 204
+        },
+        {
+          "code": "new_nordic",
+          "status_code": 422,
+          "message": "Property 'group' does not exist."
+        },
+        {
+          "code": "global_nomad",
+          "status_code": 201
+        }
+      ]
+    401:
+      $ref: "#/responses/401Error"
+    403:
+      $ref: "#/responses/403Error"
+    413:
+      $ref: "#/responses/413Error"
+    415:
+      $ref: "#/responses/415ErrorStream"

content/swagger/resources/reference_entity_attributes/routes/reference_entity_attributes_code_options_code.yaml

@@ -23,3 +23,32 @@ get:
       $ref: "#/responses/404Error"
     406:
       $ref: "#/responses/406Error"
+patch:
+  summary: Update/create a reference entity attribute option
+  operationId: "patch_reference_entity_attributes__attribute_code__options__code_"
+  tags:
+    - Reference entity attribute option
+  x-versions:
+    - "3.0"
+  x-ee: true
+  description: This endpoint allows you to update a given option of a given attribute for a given reference entity. Learn more about <a href="/documentation/update.html#patch-reference-entity-record-values">Update behavior</a>. Note that if the option does not already exist for the given attribute of the given reference entity, it creates it.
+  parameters:
+    - $ref: '#/parameters/reference_entity_code'
+    - $ref: '#/parameters/attribute_code'
+    - $ref: '#/parameters/code'
+    - name: body
+      in: body
+      required: true
+      schema:
+        $ref: ../definitions/reference_entity_attribute_option.yaml
+  responses:
+    201:
+      $ref: "#/responses/Created"
+    204:
+      $ref: "#/responses/NoContent"
+    401:
+      $ref: "#/responses/401Error"
+    415:
+      $ref: "#/responses/415Error"
+    422:
+      $ref: "#/responses/422Error"