Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions codegen/layouts/api-endpoint.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
- [Examples](#examples)
{{/if}}

{{#if this.isDeprecated}}
{{> deprecated-warning}}

{{/if}}
{{{description}}}

{{#with primaryCodeSample}}
Expand Down
4 changes: 4 additions & 0 deletions codegen/lib/layout/api-endpoint.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ export interface ApiEndpointLayoutContext {
workspaceScope: SeamWorkspaceScope
isAlpha: boolean
alphaMessage: string | undefined
isDeprecated: boolean
deprecationMessage: string
request: {
preferredMethod: string
parameters: ApiEndpointParameter[]
Expand Down Expand Up @@ -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(
Expand Down
14 changes: 7 additions & 7 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -9462,7 +9462,7 @@
],
"parentPath": "/acs",
"isUndocumented": true,
"isDeprecated": false,
"isDeprecated": true,
"isDraft": false
},
{
Expand All @@ -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.",
Expand Down Expand Up @@ -9579,7 +9579,7 @@
],
"parentPath": "/acs",
"isUndocumented": true,
"isDeprecated": false,
"isDeprecated": true,
"isDraft": false
},
{
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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.",
Expand Down
13 changes: 13 additions & 0 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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`
Expand Down
Loading
Loading