From 09c0178743e2a32d40f3c08de685fdfa92bc9378 Mon Sep 17 00:00:00 2001 From: Jayan Ratna Date: Wed, 13 Nov 2024 11:57:40 +1300 Subject: [PATCH 1/8] feat: Add Cassette resource API --- package-lock.json | 17 ++--- package.json | 4 +- .../api/console/cassette-response-list.md | 28 ++++++++ .../console/cassette-response-parameters.md | 31 +++++++++ .../partials/api/console/cassette-response.md | 12 ++++ src/navigation/api/console.ts | 36 +++++++++++ .../api-reference/console/cassettes/create.md | 63 ++++++++++++++++++ .../console/cassettes/duplicate.md | 64 +++++++++++++++++++ .../api-reference/console/cassettes/remove.md | 62 ++++++++++++++++++ .../console/cassettes/retrieve.md | 52 +++++++++++++++ .../api-reference/console/cassettes/update.md | 57 +++++++++++++++++ .../console/projects/cassettes.md | 56 ++++++++++++++++ 12 files changed, 472 insertions(+), 10 deletions(-) create mode 100644 src/markdoc/partials/api/console/cassette-response-list.md create mode 100644 src/markdoc/partials/api/console/cassette-response-parameters.md create mode 100644 src/markdoc/partials/api/console/cassette-response.md create mode 100644 src/pages/api-reference/console/cassettes/create.md create mode 100644 src/pages/api-reference/console/cassettes/duplicate.md create mode 100644 src/pages/api-reference/console/cassettes/remove.md create mode 100644 src/pages/api-reference/console/cassettes/retrieve.md create mode 100644 src/pages/api-reference/console/cassettes/update.md create mode 100644 src/pages/api-reference/console/projects/cassettes.md diff --git a/package-lock.json b/package-lock.json index 7d00a731..97edb6ed 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,7 +23,7 @@ "@tailwindcss/forms": "^0.5.9", "@tailwindcss/typography": "^0.5.15", "@types/js-cookie": "^3.0.6", - "@types/node": "^20.17.6", + "@types/node": "^22.9.0", "@types/prismjs": "^1.26.5", "@types/react": "^18.3.12", "@types/react-dom": "^18.3.1", @@ -1223,12 +1223,13 @@ "optional": true }, "node_modules/@types/node": { - "version": "20.17.6", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.6.tgz", - "integrity": "sha512-VEI7OdvK2wP7XHnsuXbAJnEpEkF6NjSN45QJlL4VGqZSXsnicpesdTWsg9RISeSdYd3yeRj/y3k5KGjUXYnFwQ==", + "version": "22.9.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.0.tgz", + "integrity": "sha512-vuyHg81vvWA1Z1ELfvLko2c8f34gyA0zaic0+Rllc5lbCnbSyuvb2Oxpm6TAUAC/2xZN3QGqxBNggD1nNR2AfQ==", "dev": true, + "license": "MIT", "dependencies": { - "undici-types": "~6.19.2" + "undici-types": "~6.19.8" } }, "node_modules/@types/prismjs": { @@ -4143,9 +4144,9 @@ } }, "node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 323fba90..3d8fefbe 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "@tailwindcss/forms": "^0.5.9", "@tailwindcss/typography": "^0.5.15", "@types/js-cookie": "^3.0.6", - "@types/node": "^20.17.6", + "@types/node": "^22.9.0", "@types/prismjs": "^1.26.5", "@types/react": "^18.3.12", "@types/react-dom": "^18.3.1", @@ -41,6 +41,6 @@ "typescript": "^5.6.3" }, "volta": { - "node": "20.16.0" + "node": "22.11.0" } } diff --git a/src/markdoc/partials/api/console/cassette-response-list.md b/src/markdoc/partials/api/console/cassette-response-list.md new file mode 100644 index 00000000..5875ac7b --- /dev/null +++ b/src/markdoc/partials/api/console/cassette-response-list.md @@ -0,0 +1,28 @@ +```json {% process=false filename="Response" %} +{ + "object": "list", + "data": [ + { + "id": "9d759f5a-7a1f-443e-a466-6471da1d367b", + "object": "cassette", + "handle": "default", + "name": "Default", + "project": "9c17d63b-96c0-4315-b4dd-e55373ce4ffd", + "parent": null, + "created_at": 1711305486, + "updated_at": 1711305486 + }, + {...}, + {...} + ], + "meta": { + "has_more": false, + "current_page": 1, + "from": 1, + "to": 3, + "total": 3, + "per_page": 10, + "last_page": 1 + } +} +``` diff --git a/src/markdoc/partials/api/console/cassette-response-parameters.md b/src/markdoc/partials/api/console/cassette-response-parameters.md new file mode 100644 index 00000000..65ff8f0b --- /dev/null +++ b/src/markdoc/partials/api/console/cassette-response-parameters.md @@ -0,0 +1,31 @@ +{% parameter name="id" type="string" %} +The unique identifier for this domain. +{% /parameter %} + +{% parameter name="object" type="string" %} +This will always contain `cassette` for this endpoint. +{% /parameter %} + +{% parameter name="handle" type="string" %} +The unique handle of the Cassette. The handle is unique to every project. +{% /parameter %} + +{% parameter name="name" type="string" %} +The Cassette name. +{% /parameter %} + +{% parameter name="project" type="string | object" %} +The ID of the project this Cassette belongs to. +{% /parameter %} + +{% parameter name="parent" type="string | object | null" %} +The parent Cassette, if this Cassette is duplicated. +{% /parameter %} + +{% parameter name="created_at" type="timestamp" %} +The Cassette's created at timestamp. +{% /parameter %} + +{% parameter name="updated_at" type="timestamp" %} +The Cassette's updated at timestamp. +{% /parameter %} diff --git a/src/markdoc/partials/api/console/cassette-response.md b/src/markdoc/partials/api/console/cassette-response.md new file mode 100644 index 00000000..ebfa83e3 --- /dev/null +++ b/src/markdoc/partials/api/console/cassette-response.md @@ -0,0 +1,12 @@ +```json {% process=false filename="Response" %} +{ + "id": "9d759f5a-7a1f-443e-a466-6471da1d367b", + "object": "cassette", + "handle": "default", + "name": "Default", + "project": "9c17d63b-96c0-4315-b4dd-e55373ce4ffd", + "parent": null, + "created_at": 1711305486, + "updated_at": 1711305486 +} +``` diff --git a/src/navigation/api/console.ts b/src/navigation/api/console.ts index 0fb6292d..18e9f270 100644 --- a/src/navigation/api/console.ts +++ b/src/navigation/api/console.ts @@ -41,6 +41,37 @@ export const consoleAPINavigation: APINavigationItem[] = [ }, ], }, + { + title: 'Cassettes', + expandable: false, + items: [ + { + title: 'Create Cassette', + url: '/api/console/cassettes/create', + method: 'POST', + }, + { + title: 'Update Cassette', + url: '/api/console/cassettes/update', + method: 'PATCH', + }, + { + title: 'Retrieve Cassette', + url: '/api/console/cassettes/retrieve', + method: 'GET', + }, + { + title: 'Remove Cassette', + url: '/api/console/cassettes/remove', + method: 'DELETE', + }, + { + title: 'Duplicate Cassette', + url: '/api/console/cassettes/duplicate', + method: 'POST', + }, + ], + }, { title: 'Domains', expandable: false, @@ -157,6 +188,11 @@ export const consoleAPINavigation: APINavigationItem[] = [ url: '/api/console/projects/domains', method: 'GET', }, + { + title: 'List all project Cassettes', + url: '/api/console/projects/cassettes', + method: 'GET', + }, { title: 'Search projects', url: '/api/console/projects/search', diff --git a/src/pages/api-reference/console/cassettes/create.md b/src/pages/api-reference/console/cassettes/create.md new file mode 100644 index 00000000..0831a3e4 --- /dev/null +++ b/src/pages/api-reference/console/cassettes/create.md @@ -0,0 +1,63 @@ +--- +title: 'Create Cassette' +description: 'Create a Cassette to your agency.' +api: 'POST /v1/agencies/{username}/cassettes' +--- + +{% row %} + +{% column %} +### Body parameters + +{% parameter name="name" type="string" required=true %} +The name of the Cassette. +{% /parameter %} + +{% parameter name="project" type="string" required=true %} +The ID of the project this Cassette will belong to. +{% /parameter %} + +{% parameter name="handle" type="array" required=true %} +The unique handle for the Cassette. +{% /parameter %} + +### Response + +{% partial file="api/console/cassette-response-parameters.md" /%} + +{% /column %} + +{% column sticky="true" %} + +{% code-group %} + +```ts {% process=false filename="Node.js" %} +import Blutui from 'blutui' + +const blutui = new Blutui('ey....') + +blutui.agency('studio').cassettes.create({ + name: 'Default', + project: '99bc147e-966c-4dd0-8def-de817c63cf41', + handle: 'default', +}) +``` + +```bash {% process=false filename="cURL" %} +curl -X POST 'https://api.blutui.com/v1/agencies/studio/cassettes' \ + -H 'Authorization: Bearer ey....' \ + -H 'Content-Type: application/json' + -d $'{ + "name": "Default", + "project": "99bc147e-966c-4dd0-8def-de817c63cf41", + "handle": "default", +}' +``` + +{% /code-group %} + +{% partial file="api/console/cassette-response.md" /%} + +{% /column %} + +{% /row %} diff --git a/src/pages/api-reference/console/cassettes/duplicate.md b/src/pages/api-reference/console/cassettes/duplicate.md new file mode 100644 index 00000000..9363509b --- /dev/null +++ b/src/pages/api-reference/console/cassettes/duplicate.md @@ -0,0 +1,64 @@ +--- +title: 'Duplicate Cassette' +description: 'Duplicate a Cassette to your agency.' +api: 'POST /v1/agencies/{username}/cassettes/{id}/duplicate' +--- + +{% row %} + +{% column %} +### Path parameters + +{% parameter name="id" type="string" required="true" %} +The ID of the Cassette to duplicate. +{% /parameter %} + +### Body parameters + +{% parameter name="name" type="string" required=true %} +The name of the Cassette. +{% /parameter %} + +{% parameter name="handle" type="array" required=true %} +The unique handle for the Cassette. +{% /parameter %} + +### Response + +{% partial file="api/console/cassette-response-parameters.md" /%} + +{% /column %} + +{% column sticky="true" %} + +{% code-group %} + +```ts {% process=false filename="Node.js" %} +import Blutui from 'blutui' + +const blutui = new Blutui('ey....') + +blutui.agency('studio').cassettes.duplicate('9d759f5a-7a1f-443e-a466-6471da1d367b', { + name: 'Default', + handle: 'default', +}) +``` + +```bash {% process=false filename="cURL" %} +curl -X POST 'https://api.blutui.com/v1/agencies/studio/cassettes' \ + -H 'Authorization: Bearer ey....' \ + -H 'Content-Type: application/json' + -d $'{ + "name": "Default", + "project": "99bc147e-966c-4dd0-8def-de817c63cf41", + "handle": "default", +}' +``` + +{% /code-group %} + +{% partial file="api/console/cassette-response.md" /%} + +{% /column %} + +{% /row %} diff --git a/src/pages/api-reference/console/cassettes/remove.md b/src/pages/api-reference/console/cassettes/remove.md new file mode 100644 index 00000000..cf2b7a52 --- /dev/null +++ b/src/pages/api-reference/console/cassettes/remove.md @@ -0,0 +1,62 @@ +--- +title: 'Remove Cassette' +description: 'Remove a Cassette in your agency.' +api: 'DELETE /v1/agencies/{username}/cassettes/{id}' +--- + +{% row %} + +{% column %} +### Path parameters + +{% parameter name="id" type="string" required="true" %} +The ID of the Cassette to remove. +{% /parameter %} + +### Response + +{% parameter name="id" type="string" %} +The unique identifier for this Cassette. +{% /parameter %} + +{% parameter name="object" type="string" %} +This will always contain `cassette` for this endpoint. +{% /parameter %} + +{% parameter name="deleted" type="boolean" %} +Determine if the object was successfully deleted. +{% /parameter %} + +{% /column %} + +{% column sticky="true" %} + +{% code-group %} + +```ts {% process=false filename="Node.js" %} +import Blutui from 'blutui' + +const blutui = new Blutui('ey....') + +blutui.agency('studio').cassettes.remove('9d759f5a-7a1f-443e-a466-6471da1d367b') +``` + +```bash {% process=false filename="cURL" %} +curl -X DELETE 'https://api.blutui.com/v1/agencies/studio/cassettes/9d759f5a-7a1f-443e-a466-6471da1d367b' \ + -H 'Authorization: Bearer ey....' \ + -H 'Content-Type: application/json' +``` + +{% /code-group %} + +```json {% process=false filename="Response" %} +{ + "id": "9d759f5a-7a1f-443e-a466-6471da1d367b", + "object": "cassette", + "deleted": true +} +``` + +{% /column %} + +{% /row %} diff --git a/src/pages/api-reference/console/cassettes/retrieve.md b/src/pages/api-reference/console/cassettes/retrieve.md new file mode 100644 index 00000000..2ae7c38f --- /dev/null +++ b/src/pages/api-reference/console/cassettes/retrieve.md @@ -0,0 +1,52 @@ +--- +title: 'Retrieve Cassette' +description: 'Retrieve a Cassette in your agency.' +api: 'GET /v1/agencies/{username}/cassettes/{id}' +--- + +{% row %} + +{% column %} +### Path parameters + +{% parameter name="id" type="string" required="true" %} +The ID of the Cassette to retrieve. +{% /parameter %} + +### Query parameters + +{% parameter name="expand" type="string[]" %} +Expand the response for the given items. Expand array accepts `project`. +{% /parameter %} + +### Response + +{% partial file="api/console/cassette-response-parameters.md" /%} + +{% /column %} + +{% column sticky="true" %} + +{% code-group %} + +```ts {% process=false filename="Node.js" %} +import Blutui from 'blutui' + +const blutui = new Blutui('ey....') + +blutui.agency('studio').cassettes.get('9d759f5a-7a1f-443e-a466-6471da1d367b') +``` + +```bash {% process=false filename="cURL" %} +curl -X GET 'https://api.blutui.com/v1/agencies/studio/cassettes/9d759f5a-7a1f-443e-a466-6471da1d367b' \ + -H 'Authorization: Bearer ey....' \ + -H 'Content-Type: application/json' +``` + +{% /code-group %} + +{% partial file="api/console/cassette-response.md" /%} + +{% /column %} + +{% /row %} diff --git a/src/pages/api-reference/console/cassettes/update.md b/src/pages/api-reference/console/cassettes/update.md new file mode 100644 index 00000000..cbb0dce4 --- /dev/null +++ b/src/pages/api-reference/console/cassettes/update.md @@ -0,0 +1,57 @@ +--- +title: 'Update Cassette' +description: 'Update a Cassette in your agency.' +api: 'PATCH /v1/agencies/{username}/cassettes/{id}' +--- + +{% row %} + +{% column %} +### Path parameters + +{% parameter name="id" type="string" required="true" %} +The ID of the Cassette to update. +{% /parameter %} + +### Body parameters + +{% parameter name="name" type="string" required="true" %} +The name of the Cassette. +{% /parameter %} + +### Response + +{% partial file="api/console/cassette-response-parameters.md" /%} + +{% /column %} + +{% column sticky="true" %} + +{% code-group %} + +```ts {% process=false filename="Node.js" %} +import Blutui from 'blutui' + +const blutui = new Blutui('ey....') + +blutui.agency('studio').cassettes.update('9d759f5a-7a1f-443e-a466-6471da1d367b', { + name: 'Development' +}) +``` + +```bash {% process=false filename="cURL" %} +curl -X PATCH 'https://api.blutui.com/v1/agencies/studio/cassettes/9d759f5a-7a1f-443e-a466-6471da1d367b' \ + -H 'Authorization: Bearer ey....' \ + -H 'Content-Type: application/json' + -d $'{ + "name": "Development" +}' +``` + +{% /code-group %} + +{% partial file="api/console/cassette-response.md" /%} + +{% /column %} + +{% /row %} diff --git a/src/pages/api-reference/console/projects/cassettes.md b/src/pages/api-reference/console/projects/cassettes.md new file mode 100644 index 00000000..f3f53d7d --- /dev/null +++ b/src/pages/api-reference/console/projects/cassettes.md @@ -0,0 +1,56 @@ +--- +title: 'List all project Cassettes' +description: 'List all Cassettes for a project in your agency.' +api: 'GET /v1/agencies/{username}/projects/{id}/cassettes' +--- + +{% row %} + +{% column %} +### Path parameters + +{% parameter name="id" type="string" required="true" %} +The ID of the project to retrieve. +{% /parameter %} + +### Query parameters + +{% parameter name="limit" type="integer | default: 10" %} +Limit the number of objects to return, ranging between 1 and 20. +{% /parameter %} + +{% parameter name="page" type="integer | default: 1" %} +The current page used to display the pagination results. +{% /parameter %} + +### Response + +{% partial file="api/console/cassette-response-parameters.md" /%} + +{% /column %} + +{% column sticky="true" %} + +{% code-group %} + +```ts {% process=false filename="Node.js" %} +import Blutui from 'blutui' + +const blutui = new Blutui('ey....') + +blutui.agency('studio').projects.cassettes('9d759f5a-7a1f-443e-a466-6471da1d367b') +``` + +```bash {% process=false filename="cURL" %} +curl -X GET 'https://api.blutui.com/v1/agencies/studio/projects/9d759f5a-7a1f-443e-a466-6471da1d367b/cassettes' \ + -H 'Authorization: Bearer ey....' \ + -H 'Content-Type: application/json' +``` + +{% /code-group %} + +{% partial file="api/console/cassette-response-list.md" /%} + +{% /column %} + +{% /row %} From 45fc4938bd7b4b879661e0d42e2a346c9067e0cd Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:20:03 +1300 Subject: [PATCH 2/8] Update src/pages/api-reference/console/cassettes/create.md --- src/pages/api-reference/console/cassettes/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/api-reference/console/cassettes/create.md b/src/pages/api-reference/console/cassettes/create.md index 0831a3e4..e7da630e 100644 --- a/src/pages/api-reference/console/cassettes/create.md +++ b/src/pages/api-reference/console/cassettes/create.md @@ -1,6 +1,6 @@ --- title: 'Create Cassette' -description: 'Create a Cassette to your agency.' +description: 'Create a Cassette for a project in your agency.' api: 'POST /v1/agencies/{username}/cassettes' --- From 54e11a7a48ea05dcd931055c61a1e782cb24cb86 Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:20:09 +1300 Subject: [PATCH 3/8] Update src/pages/api-reference/console/cassettes/duplicate.md --- src/pages/api-reference/console/cassettes/duplicate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/api-reference/console/cassettes/duplicate.md b/src/pages/api-reference/console/cassettes/duplicate.md index 9363509b..8805b2f1 100644 --- a/src/pages/api-reference/console/cassettes/duplicate.md +++ b/src/pages/api-reference/console/cassettes/duplicate.md @@ -1,6 +1,6 @@ --- title: 'Duplicate Cassette' -description: 'Duplicate a Cassette to your agency.' +description: 'Duplicate a Cassette for a project your agency.' api: 'POST /v1/agencies/{username}/cassettes/{id}/duplicate' --- From 8aa8efc4428e448840b89b3bb5adb44b709922c3 Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:20:15 +1300 Subject: [PATCH 4/8] Update src/pages/api-reference/console/cassettes/remove.md --- src/pages/api-reference/console/cassettes/remove.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/api-reference/console/cassettes/remove.md b/src/pages/api-reference/console/cassettes/remove.md index cf2b7a52..0f93a9aa 100644 --- a/src/pages/api-reference/console/cassettes/remove.md +++ b/src/pages/api-reference/console/cassettes/remove.md @@ -1,6 +1,6 @@ --- title: 'Remove Cassette' -description: 'Remove a Cassette in your agency.' +description: 'Remove a Cassette from a project your agency.' api: 'DELETE /v1/agencies/{username}/cassettes/{id}' --- From b34adda5cb12ff5667afbc032c45e0ea58c4bd47 Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:20:20 +1300 Subject: [PATCH 5/8] Update src/pages/api-reference/console/cassettes/retrieve.md --- src/pages/api-reference/console/cassettes/retrieve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/api-reference/console/cassettes/retrieve.md b/src/pages/api-reference/console/cassettes/retrieve.md index 2ae7c38f..91055090 100644 --- a/src/pages/api-reference/console/cassettes/retrieve.md +++ b/src/pages/api-reference/console/cassettes/retrieve.md @@ -1,6 +1,6 @@ --- title: 'Retrieve Cassette' -description: 'Retrieve a Cassette in your agency.' +description: 'Retrieve a Cassette for a project your agency.' api: 'GET /v1/agencies/{username}/cassettes/{id}' --- From 8f42f46e88aa85b8e8af7757869ae12dde2f5237 Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:20:26 +1300 Subject: [PATCH 6/8] Update src/pages/api-reference/console/cassettes/update.md --- src/pages/api-reference/console/cassettes/update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/api-reference/console/cassettes/update.md b/src/pages/api-reference/console/cassettes/update.md index cbb0dce4..ae6c3f56 100644 --- a/src/pages/api-reference/console/cassettes/update.md +++ b/src/pages/api-reference/console/cassettes/update.md @@ -1,6 +1,6 @@ --- title: 'Update Cassette' -description: 'Update a Cassette in your agency.' +description: 'Update a Cassette for a project your agency.' api: 'PATCH /v1/agencies/{username}/cassettes/{id}' --- From 0256d135c2e0a3b6ab5653579006a0eb971429c9 Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Mon, 2 Dec 2024 10:32:30 +1300 Subject: [PATCH 7/8] Update src/markdoc/partials/api/console/cassette-response-parameters.md Co-authored-by: Michael Liu <162056370+chengfang-blutui@users.noreply.github.com> --- .../partials/api/console/cassette-response-parameters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdoc/partials/api/console/cassette-response-parameters.md b/src/markdoc/partials/api/console/cassette-response-parameters.md index 65ff8f0b..b38a2043 100644 --- a/src/markdoc/partials/api/console/cassette-response-parameters.md +++ b/src/markdoc/partials/api/console/cassette-response-parameters.md @@ -1,5 +1,5 @@ {% parameter name="id" type="string" %} -The unique identifier for this domain. +The unique identifier for this Cassette. {% /parameter %} {% parameter name="object" type="string" %} From 31c092549b588364e503fe5f423f0f84809acff7 Mon Sep 17 00:00:00 2001 From: Jayan Ratna <30396013+jayan-blutui@users.noreply.github.com> Date: Mon, 2 Dec 2024 13:45:17 +1300 Subject: [PATCH 8/8] Update src/markdoc/partials/api/console/cassette-response-parameters.md Co-authored-by: Michael Liu <162056370+chengfang-blutui@users.noreply.github.com> --- .../partials/api/console/cassette-response-parameters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdoc/partials/api/console/cassette-response-parameters.md b/src/markdoc/partials/api/console/cassette-response-parameters.md index b38a2043..73557051 100644 --- a/src/markdoc/partials/api/console/cassette-response-parameters.md +++ b/src/markdoc/partials/api/console/cassette-response-parameters.md @@ -7,7 +7,7 @@ This will always contain `cassette` for this endpoint. {% /parameter %} {% parameter name="handle" type="string" %} -The unique handle of the Cassette. The handle is unique to every project. +The unique handle of the Cassette. The handle is only unique to every Cassette within a project. {% /parameter %} {% parameter name="name" type="string" %}