feat: add delete CM property doc (#477)

* add delete api doc for CM properties * build docs
phrase · Dec 6, 2023 · fcd8cbe · fcd8cbe
1 parent d4b469d
commit fcd8cbe
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 0 deletions.
diff --git a/doc/compiled.json b/doc/compiled.json
@@ -6087,6 +6087,9 @@
           {
             "$ref": "#/components/parameters/X-PhraseApp-OTP"
           },
+          {
+            "$ref": "#/components/parameters/account_id"
+          },
           {
             "$ref": "#/components/parameters/data_type"
           },
@@ -6473,6 +6476,50 @@
           }
         ],
         "x-cli-version": "2.9"
+      },
+      "delete": {
+        "summary": "Destroy property",
+        "description": "Destroy a custom metadata property of an account.\n\nThis endpoint is only available to accounts with advanced plans or above.\n",
+        "operationId": "custom_metadata_properties/delete",
+        "tags": [
+          "Custom Metadata"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/X-PhraseApp-OTP"
+          },
+          {
+            "$ref": "#/components/parameters/account_id"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          }
+        ],
+        "responses": {
+          "204": {
+            "$ref": "#/components/responses/204"
+          },
+          "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 DELETE\n  -H 'Content-Type: application/json'"
+          },
+          {
+            "lang": "CLI v2",
+            "source": "phrase custom_metadata_properties delete \\\n--account_id <account_id> \\\n--id <id> \\\n--access_token <token>"
+          }
+        ],
+        "x-cli-version": "2.9"
       }
     },
     "/accounts/{account_id}/invitations": {

diff --git a/paths.yaml b/paths.yaml
@@ -57,6 +57,8 @@
     "$ref": "./paths/custom_metadata_properties/create.yaml"
   patch:
     "$ref": "./paths/custom_metadata_properties/update.yaml"
+  delete:
+    "$ref": "./paths/custom_metadata_properties/destroy.yaml"
 "/accounts/{account_id}/invitations":
   get:
     "$ref": "./paths/invitations/index.yaml"

diff --git a/paths/custom_metadata_properties/destroy.yaml b/paths/custom_metadata_properties/destroy.yaml
@@ -0,0 +1,36 @@
+---
+summary: Destroy property
+description: |
+  Destroy a custom metadata property of an account.
+
+  This endpoint is only available to accounts with advanced plans or above.
+operationId: custom_metadata_properties/delete
+tags:
+- Custom Metadata
+parameters:
+- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
+- "$ref": "../../parameters.yaml#/account_id"
+- "$ref": "../../parameters.yaml#/id"
+responses:
+  '204':
+    "$ref": "../../responses.yaml#/204"
+  '400':
+    "$ref": "../../responses.yaml#/400"
+  '404':
+    "$ref": "../../responses.yaml#/404"
+  '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 DELETE
+      -H 'Content-Type: application/json'
+- lang: CLI v2
+  source: |-
+    phrase custom_metadata_properties delete \
+    --account_id <account_id> \
+    --id <id> \
+    --access_token <token>
+x-cli-version: '2.9'
diff --git a/paths/custom_metadata_properties/index.yaml b/paths/custom_metadata_properties/index.yaml
@@ -9,6 +9,7 @@ tags:
 - Custom Metadata
 parameters:
 - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
+- "$ref": "../../parameters.yaml#/account_id"
 - "$ref": "../../parameters.yaml#/data_type"
 - description: id of project that the properties belong to
   example: