Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit d4e4e8a84aec · 2025-11-17T14:19:14.000Z
diff --git a/api-specs/api/examples/api-client-created.example.json b/api-specs/api/examples/api-client-created.example.json
diff --git a/api-specs/api/examples/api-client.example.json b/api-specs/api/examples/api-client.example.json
diff --git a/api-specs/api/examples/api-client/ApiClient.json b/api-specs/api/examples/api-client/ApiClient.json
@@ -0,0 +1,9 @@
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "name": "admin-client",
+  "scope": "manage_project:{projectKey}",
+  "secret": "{{client-secret}}",
+  "createdAt": "2025-10-20T14:30:00.000Z",
+  "accessTokenValiditySeconds": 3600,
+  "refreshTokenValiditySeconds": 31536000
+}
diff --git a/api-specs/api/examples/api-client/ApiClientDraft.json b/api-specs/api/examples/api-client/ApiClientDraft.json
@@ -1,6 +1,6 @@
 {
-  "name": "api-client-name",
-  "scope": "view_products:{projectKey}",
+  "name": "admin-client",
+  "scope": "manage_project:{projectKey}",
   "accessTokenValiditySeconds": 3600,
   "refreshTokenValiditySeconds": 31536000
 }
diff --git a/api-specs/api/examples/api-client/ApiClientNoSecret.json b/api-specs/api/examples/api-client/ApiClientNoSecret.json
@@ -0,0 +1,9 @@
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "name": "admin-client",
+  "scope": "manage_project:{projectKey}",
+  "createdAt": "2025-10-20T14:30:00.000Z",
+  "lastUsedAt": "2025-11-12",
+  "accessTokenValiditySeconds": 3600,
+  "refreshTokenValiditySeconds": 31536000
+}
diff --git a/api-specs/api/examples/api-client/ApiClientPagedQueryResponse.json b/api-specs/api/examples/api-client/ApiClientPagedQueryResponse.json
@@ -0,0 +1,17 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "count": 1,
+  "total": 1,
+  "results": [
+    {
+      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+      "name": "admin-client",
+      "scope": "manage_project:{projectKey}",
+      "createdAt": "2025-10-20T14:30:00.000Z",
+      "lastUsedAt": "2025-11-12",
+      "accessTokenValiditySeconds": 3600,
+      "refreshTokenValiditySeconds": 31536000
+    }
+  ]
+}
diff --git a/api-specs/api/examples/api-clients.example.json b/api-specs/api/examples/api-clients.example.json
diff --git a/api-specs/api/resources/api-clients.raml b/api-specs/api/resources/api-clients.raml
@@ -14,7 +14,7 @@ get:
     200:
       body:
         application/json:
-          example: !include ../examples/api-clients.example.json
+          example: !include ../examples/api-client/ApiClientPagedQueryResponse.json
 head:
   displayName: Check if ApiClient exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
@@ -32,12 +32,12 @@ post:
   securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
   body:
     application/json:
-      example: !include ../examples/api-client-create.example.json
+      example: !include ../examples/api-client/ApiClientDraft.json
   responses:
     201:
       body:
         application/json:
-          example: !include ../examples/api-client-created.example.json
+          example: !include ../examples/api-client/ApiClient.json
 
 /{ID}:
   (methodName): withId
@@ -53,7 +53,7 @@ post:
       200:
         body:
           application/json:
-            example: !include ../examples/api-client.example.json
+            example: !include ../examples/api-client/ApiClientNoSecret.json
             type: ApiClient
   head:
     displayName: Check if ApiClient exists by ID
@@ -66,5 +66,5 @@ post:
       200:
         body:
           application/json:
-            example: !include ../examples/api-client.example.json
+            example: !include ../examples/api-client/ApiClientNoSecret.json
             type: ApiClient
diff --git a/api-specs/api/types/api-client/ApiClient.raml b/api-specs/api/types/api-client/ApiClient.raml
@@ -2,6 +2,7 @@
 (package): ApiClient
 displayName: ApiClient
 type: object
+example: !include ../../examples/api-client/ApiClient.json
 properties:
   id:
     type: string
diff --git a/api-specs/api/types/api-client/ApiClientDraft.raml b/api-specs/api/types/api-client/ApiClientDraft.raml
@@ -2,6 +2,7 @@
 (package): ApiClient
 displayName: ApiClientDraft
 type: object
+example: !include ../../examples/api-client/ApiClientDraft.json
 properties:
   name:
     type: string
diff --git a/api-specs/api/types/api-client/ApiClientPagedQueryResponse.raml b/api-specs/api/types/api-client/ApiClientPagedQueryResponse.raml
@@ -4,6 +4,7 @@ displayName: ApiClientPagedQueryResponse
 type: object
 description: |
   [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [APIClient](ctp:api:type:ApiClient).
+example: !include ../../examples/api-client/ApiClientPagedQueryResponse.json
 properties:
   limit:
     type: number

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`		`- "name": "api-client-name",`
`3`		`- "scope": "view_products:{projectKey}",`
	`2`	`+ "name": "admin-client",`
	`3`	`+ "scope": "manage_project:{projectKey}",`
`4`	`4`	`"accessTokenValiditySeconds": 3600,`
`5`	`5`	`"refreshTokenValiditySeconds": 31536000`
`6`	`6`	`}`