feat: add CM api update (#475)

* wip * add name and description * correct cli commands * add create api doc for CM properties (#476) * compile docs
phrase · Dec 5, 2023 · d4b469d · d4b469d
1 parent b56d328
commit d4b469d
Show file tree

Hide file tree

Showing 5 changed files with 427 additions and 6 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -733,6 +733,12 @@
               "$ref": "#/components/schemas/project_short"
             }
           },
+          "value_options": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "created_at": {
             "type": "string",
             "format": "date-time"
@@ -744,9 +750,9 @@
         },
         "example": {
           "id": "abcd1234cdef1234abcd1234cdef1234",
-          "name": "Character Age",
-          "description": "Age of character in seconds",
-          "data_type": "Text value",
+          "name": "Nuts",
+          "description": "A healthy snack for all ages",
+          "data_type": "multi_select",
           "user": {
             "id": "abcd1234cdef1234abcd1234cdef1234",
             "username": "joe.doe",
@@ -762,6 +768,11 @@
               "created_at": "2015-01-28T09:52:53Z",
               "updated_at": "2015-01-28T09:52:53Z"
             }
+          ],
+          "value_options": [
+            "apple",
+            "banana",
+            "coconut"
           ]
         }
       },
@@ -6228,6 +6239,240 @@
           }
         ],
         "x-cli-version": "2.9"
+      },
+      "post": {
+        "summary": "Create a property",
+        "description": "Create a new custom metadata property.",
+        "operationId": "custom_metadata_property/create",
+        "tags": [
+          "Custom Metadata"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/X-PhraseApp-OTP"
+          },
+          {
+            "$ref": "#/components/parameters/account_id"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          },
+          {
+            "description": "name of the property",
+            "example": [
+              "Fruit"
+            ],
+            "name": "name",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/data_type"
+          },
+          {
+            "description": "description of property",
+            "example": [
+              "A healthy snack for all ages"
+            ],
+            "name": "description",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "ids of projects that the property belongs to",
+            "example": [
+              "abcd1234cdef1234abcd1234cdef1234"
+            ],
+            "name": "project_ids",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "description": "value options of property (only applies to single or multi select properties)",
+            "example": [
+              "Apple",
+              "Banana",
+              "Coconut"
+            ],
+            "name": "value_options",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/custom_metadata_property"
+                }
+              }
+            },
+            "headers": {
+              "X-Rate-Limit-Limit": {
+                "$ref": "#/components/headers/X-Rate-Limit-Limit"
+              },
+              "X-Rate-Limit-Remaining": {
+                "$ref": "#/components/headers/X-Rate-Limit-Remaining"
+              },
+              "X-Rate-Limit-Reset": {
+                "$ref": "#/components/headers/X-Rate-Limit-Reset"
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/400"
+          },
+          "404": {
+            "$ref": "#/components/responses/404"
+          },
+          "422": {
+            "$ref": "#/components/responses/422"
+          },
+          "429": {
+            "$ref": "#/components/responses/429"
+          }
+        },
+        "x-code-samples": [
+          {
+            "lang": "Curl",
+            "source": "curl \"https://api.phrase.com/v2/accounts/:account_id/custom_metadata/labels/:id\" \\\n  -u USERNAME_OR_ACCESS_TOKEN \\\n  -X POST \\\n  -d '{\"name\":\"Fruit\",\"description\":\"A healthy snack for all ages\",\"project_ids\":[\"1\",\"2\",\"3\"],\"value_options\":[\"apple\",\"banana\",\"coconut\"]}' \\\n  -H 'Content-Type: application/json'"
+          },
+          {
+            "lang": "CLI v2",
+            "source": "phrase custom_metadata_properties create \\\n--account_id <account_id> \\\n--id <id> \\\n--data '{\"name\":\"Fruit\",\"description\":\"A healthy snack for all ages\",\"project_ids\":[\"1\",\"2\",\"3\"],\"value_options\":[\"apple\",\"banana\",\"coconut\"]}' \\\n--access_token <token>"
+          }
+        ],
+        "x-cli-version": "2.9"
+      },
+      "patch": {
+        "summary": "Update a property",
+        "description": "Update an existing custom metadata property.",
+        "operationId": "custom_metadata_property/update",
+        "tags": [
+          "Custom Metadata"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/X-PhraseApp-OTP"
+          },
+          {
+            "$ref": "#/components/parameters/account_id"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          },
+          {
+            "description": "name of the property",
+            "example": [
+              "Fruit"
+            ],
+            "name": "name",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "description of property",
+            "example": [
+              "A healthy snack for all ages"
+            ],
+            "name": "description",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "ids of projects that the property belongs to",
+            "example": [
+              "abcd1234cdef1234abcd1234cdef1234"
+            ],
+            "name": "project_ids",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "description": "value options of property (only applies to single or multi select properties)",
+            "example": [
+              "Apple",
+              "Banana",
+              "Coconut"
+            ],
+            "name": "value_options",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/custom_metadata_property"
+                }
+              }
+            },
+            "headers": {
+              "X-Rate-Limit-Limit": {
+                "$ref": "#/components/headers/X-Rate-Limit-Limit"
+              },
+              "X-Rate-Limit-Remaining": {
+                "$ref": "#/components/headers/X-Rate-Limit-Remaining"
+              },
+              "X-Rate-Limit-Reset": {
+                "$ref": "#/components/headers/X-Rate-Limit-Reset"
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/400"
+          },
+          "404": {
+            "$ref": "#/components/responses/404"
+          },
+          "429": {
+            "$ref": "#/components/responses/429"
+          }
+        },
+        "x-code-samples": [
+          {
+            "lang": "Curl",
+            "source": "curl \"https://api.phrase.com/v2/accounts/:account_id/custom_metadata/labels/:id\" \\\n  -u USERNAME_OR_ACCESS_TOKEN \\\n  -X PATCH \\\n  -d '{\"name\":\"Fruit\",\"description\":\"A healthy snack for all ages\",\"project_ids\":[\"1\",\"2\",\"3\"],\"value_options\":[\"apple\",\"banana\",\"coconut\"]}' \\\n  -H 'Content-Type: application/json'"
+          },
+          {
+            "lang": "CLI v2",
+            "source": "phrase custom_metadata_properties update \\\n--account_id <account_id> \\\n--id <id> \\\n--data '{\"name\":\"Fruit\",\"description\":\"A healthy snack for all ages\",\"project_ids\":[\"1\",\"2\",\"3\"],\"value_options\":[\"apple\",\"banana\",\"coconut\"]}' \\\n--access_token <token>"
+          }
+        ],
+        "x-cli-version": "2.9"
       }
     },
     "/accounts/{account_id}/invitations": {

diff --git a/paths.yaml b/paths.yaml
@@ -53,6 +53,10 @@
 "/accounts/{account_id}/custom_metadata/labels/{id}":
   get:
     "$ref": "./paths/custom_metadata_properties/show.yaml"
+  post:
+    "$ref": "./paths/custom_metadata_properties/create.yaml"
+  patch:
+    "$ref": "./paths/custom_metadata_properties/update.yaml"
 "/accounts/{account_id}/invitations":
   get:
     "$ref": "./paths/invitations/index.yaml"

diff --git a/paths/custom_metadata_properties/create.yaml b/paths/custom_metadata_properties/create.yaml
@@ -0,0 +1,83 @@
+---
+summary: Create a property
+description: Create a new custom metadata property.
+operationId: custom_metadata_property/create
+tags:
+- Custom Metadata
+parameters:
+- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
+- "$ref": "../../parameters.yaml#/account_id"
+- "$ref": "../../parameters.yaml#/id"
+- description: name of the property
+  example:
+  - Fruit
+  name: name
+  in: query
+  schema:
+    type: string
+- "$ref": "../../parameters.yaml#/data_type"
+- description: description of property
+  example:
+  - A healthy snack for all ages
+  name: description
+  in: query
+  schema:
+    type: string
+- description: ids of projects that the property belongs to
+  example:
+    - abcd1234cdef1234abcd1234cdef1234
+  name: project_ids
+  in: query
+  schema:
+    type: array
+    items:
+      type: string
+- description: value options of property (only applies to single or multi select properties)
+  example:
+    - Apple
+    - Banana
+    - Coconut
+  name: value_options
+  in: query
+  schema:
+    type: array
+    items:
+      type: string
+responses:
+  '200':
+    description: OK
+    content:
+      application/json:
+        schema:
+          "$ref": "../../schemas/custom_metadata_property.yaml#/custom_metadata_property"
+    headers:
+      X-Rate-Limit-Limit:
+        "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
+      X-Rate-Limit-Remaining:
+        "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
+      X-Rate-Limit-Reset:
+        "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
+  '400':
+    "$ref": "../../responses.yaml#/400"
+  '404':
+    "$ref": "../../responses.yaml#/404"
+  '422':
+    "$ref": "../../responses.yaml#/422"
+  '429':
+    "$ref": "../../responses.yaml#/429"
+x-code-samples:
+- lang: Curl
+  source: |-
+    curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/labels/:id" \
+      -u USERNAME_OR_ACCESS_TOKEN \
+      -X POST \
+      -d '{"name":"Fruit","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \
+      -H 'Content-Type: application/json'
+- lang: CLI v2
+  source: |-
+    phrase custom_metadata_properties create \
+    --account_id <account_id> \
+    --id <id> \
+    --data '{"name":"Fruit","description":"A healthy snack for all ages","project_ids":["1","2","3"],"value_options":["apple","banana","coconut"]}' \
+    --access_token <token>
+x-cli-version: '2.9'