Skip to content

Commit

Permalink
add delete api doc for CM properties
Browse files Browse the repository at this point in the history
  • Loading branch information
@anthonyshchang
anthonyshchang committed Dec 5, 2023
1 parent d4b469d commit 2263b9d
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 275 deletions.
290 changes: 15 additions & 275 deletions doc/compiled.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -733,12 +733,6 @@
"$ref": "#/components/schemas/project_short"
}
},
"value_options": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "date-time"
Expand All @@ -750,9 +744,9 @@
},
"example": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "Nuts",
"description": "A healthy snack for all ages",
"data_type": "multi_select",
"name": "Character Age",
"description": "Age of character in seconds",
"data_type": "Text value",
"user": {
"id": "abcd1234cdef1234abcd1234cdef1234",
"username": "joe.doe",
Expand All @@ -768,11 +762,6 @@
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
}
],
"value_options": [
"apple",
"banana",
"coconut"
]
}
},
Expand Down Expand Up @@ -6087,6 +6076,9 @@
{
"$ref": "#/components/parameters/X-PhraseApp-OTP"
},
{
"$ref": "#/components/parameters/account_id"
},
{
"$ref": "#/components/parameters/data_type"
},
Expand Down Expand Up @@ -6177,193 +6169,11 @@
"x-cli-version": "2.9"
}
},
"/accounts/{account_id}/custom_metadata/labels/{id}": {
"get": {
"summary": "Get a single property",
"description": "Get details of a single custom property.",
"operationId": "custom_metadata_property/show",
"tags": [
"Custom Metadata"
],
"parameters": [
{
"$ref": "#/components/parameters/X-PhraseApp-OTP"
},
{
"$ref": "#/components/parameters/account_id"
},
{
"$ref": "#/components/parameters/id"
}
],
"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"
},
{
"lang": "CLI v2",
"source": "phrase custom_metadata_labels show \\\n--account_id <account_id> \\\n--id <id> \\\n--access_token <token>"
}
],
"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",
"/accounts/{account_id}/custom_metadata/labels/{:id}": {
"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"
],
Expand All @@ -6376,81 +6186,11 @@
},
{
"$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"
}
}
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
Expand All @@ -6465,11 +6205,11 @@
"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'"
"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 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>"
"source": "phrase custom_metadata_properties delete \\\n--account_id <account_id> \\\n--id <id> \\\n--access_token <token>"
}
],
"x-cli-version": "2.9"
Expand Down
3 changes: 3 additions & 0 deletions paths.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,16 @@
"/accounts/{account_id}/custom_metadata/labels":
get:
"$ref": "./paths/custom_metadata_properties/index.yaml"
<<<<<<< HEAD
"/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"
delete:
"$ref": "./paths/custom_metadata_properties/destroy.yaml"
"/accounts/{account_id}/invitations":
get:
"$ref": "./paths/invitations/index.yaml"
Expand Down
36 changes: 36 additions & 0 deletions paths/custom_metadata_properties/destroy.yaml
View file
Original file line number Diff line number Diff line change
@@ -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'
Loading

0 comments on commit 2263b9d

Please sign in to comment.