Update blueprint and fix endpoint deprecation message (#970)

* Update blueprint

* ci: Generate docs

* Pass though deprecationMessage and isDeprecated to endpoint

* ci: Generate docs

* Add deprecated-warning to api-endpoint

* Remove extra newline

* ci: Generate docs

---------

Co-authored-by: Seam Bot <[email protected]>

Author: razor-x

codegen/layouts/api-endpoint.hbs

@@ -9,6 +9,10 @@
 - [Examples](#examples)
 {{/if}}
 
+{{#if this.isDeprecated}}
+{{> deprecated-warning}}
+
+{{/if}}
 {{{description}}}
 
 {{#with primaryCodeSample}}

codegen/lib/layout/api-endpoint.ts

@@ -40,6 +40,8 @@ export interface ApiEndpointLayoutContext {
   workspaceScope: SeamWorkspaceScope
   isAlpha: boolean
   alphaMessage: string | undefined
+  isDeprecated: boolean
+  deprecationMessage: string
   request: {
     preferredMethod: string
     parameters: ApiEndpointParameter[]
@@ -124,6 +126,8 @@ export function setEndpointLayoutContext(
   file.workspaceScope = endpoint.workspaceScope
   file.isAlpha = (metadata.alpha ?? '').length > 0
   file.alphaMessage = metadata.alpha
+  file.isDeprecated = endpoint.isDeprecated
+  file.deprecationMessage = endpoint.deprecationMessage
 
   file.authMethods = endpoint.authMethods
     .filter(

docs/api/_blueprint.json

@@ -9414,7 +9414,7 @@
           "path": "/acs/credential_pools/list",
           "parentPath": "/acs/credential_pools",
           "description": "Returns a list of all credential pools.",
-          "isDeprecated": false,
+          "isDeprecated": true,
           "deprecationMessage": "Use `/user_identities/enrollment_automations/list` instead.",
           "isUndocumented": true,
           "undocumentedMessage": "Replaced by enrollment automations.",
@@ -9462,7 +9462,7 @@
       ],
       "parentPath": "/acs",
       "isUndocumented": true,
-      "isDeprecated": false,
+      "isDeprecated": true,
       "isDraft": false
     },
     {
@@ -9476,7 +9476,7 @@
           "path": "/acs/credential_provisioning_automations/launch",
           "parentPath": "/acs/credential_provisioning_automations",
           "description": "Launches a credential provisioning automation.",
-          "isDeprecated": false,
+          "isDeprecated": true,
           "deprecationMessage": "Use `/user_identities/enrollment_automations/launch` instead.",
           "isUndocumented": true,
           "undocumentedMessage": "Replaced by enrollment automations.",
@@ -9579,7 +9579,7 @@
       ],
       "parentPath": "/acs",
       "isUndocumented": true,
-      "isDeprecated": false,
+      "isDeprecated": true,
       "isDraft": false
     },
     {
@@ -31770,7 +31770,7 @@
           "path": "/devices/delete",
           "parentPath": "/devices",
           "description": "Deletes a specified [device](../core-concepts/devices/README.md).",
-          "isDeprecated": false,
+          "isDeprecated": true,
           "deprecationMessage": "Deleting a device is no longer supported and will be removed.",
           "isUndocumented": true,
           "undocumentedMessage": "Deleting a device is no longer supported and will be removed.",
@@ -44320,7 +44320,7 @@
           "path": "/locks/get",
           "parentPath": "/locks",
           "description": "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks).",
-          "isDeprecated": false,
+          "isDeprecated": true,
           "deprecationMessage": "Use `/devices/get` instead.",
           "isUndocumented": false,
           "undocumentedMessage": "",
@@ -58528,7 +58528,7 @@
           "path": "/thermostats/get",
           "parentPath": "/thermostats",
           "description": "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.",
-          "isDeprecated": false,
+          "isDeprecated": true,
           "deprecationMessage": "Use `/devices/get` instead.",
           "isUndocumented": true,
           "undocumentedMessage": "Will be removed.",

docs/api/_report.md

@@ -517,6 +517,11 @@ These items have been marked as draft.
 
 These items are deprecated.
 
+### Routes
+
+- `/acs/credential_pools`: No deprecated message provided
+- `/acs/credential_provisioning_automations`: No deprecated message provided
+
 ### Resources
 
 - `acs_credential_pool`: Not used.
@@ -539,6 +544,14 @@ These items are deprecated.
 - `unmanaged_acs_user.email`: use email_address.
 - `workspace.connect_partner_name`: Use `company_name` instead.
 
+### Endpoints
+
+- `/acs/credential_pools/list`: Use `/user_identities/enrollment_automations/list` instead.
+- `/acs/credential_provisioning_automations/launch`: Use `/user_identities/enrollment_automations/launch` instead.
+- `/devices/delete`: Deleting a device is no longer supported and will be removed.
+- `/locks/get`: Use `/devices/get` instead.
+- `/thermostats/get`: Use `/devices/get` instead.
+
 ### Endpoint parameters
 
 - `/access_codes/create`