Skip to content

Commit

Permalink
fix(homegraph): update the API
Browse files Browse the repository at this point in the history 
#### homegraph:v1

The following keys were changed:
- documentationLink
- resources.agentUsers.methods.delete.description
- resources.devices.methods.reportStateAndNotification.description
- resources.devices.methods.requestSync.description
- schemas.Device.description
- schemas.Device.properties.customData.description
- schemas.Device.properties.otherDeviceIds.description
- schemas.Device.properties.traits.description
- schemas.Device.properties.type.description
- schemas.QueryResponse.description
- schemas.ReportStateAndNotificationDevice.properties.notifications.description
- schemas.ReportStateAndNotificationDevice.properties.states.description
- schemas.ReportStateAndNotificationRequest.description
- schemas.SyncResponse.description
  • Loading branch information
@yoshi-automation @sofisl
yoshi-automation authored and sofisl committed Feb 2, 2023
1 parent fa9914f commit 2b517eb
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
30 changes: 15 additions & 15 deletions discovery/homegraph-v1.json
View file
Expand Up @@ -14,7 +14,7 @@
"canonicalName": "Home Graph Service",
"description": "",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/actions/smarthome/create-app#request-sync",
"documentationLink": "https://developers.home.google.com/cloud-to-cloud/get-started",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
Expand Down Expand Up @@ -108,7 +108,7 @@
"agentUsers": {
"methods": {
"delete": {
"description": "Unlinks the given third-party user from your smart home Action. All data related to this user will be deleted. For more details on how users link their accounts, see [fulfillment and authentication](https://developers.google.com/assistant/smarthome/concepts/fulfillment-authentication). The third-party user's identity is passed in via the `agent_user_id` (see DeleteAgentUserRequest). This request must be authorized using service account credentials from your Actions console project.",
"description": "Unlinks the given third-party user from your smart home Action. All data related to this user will be deleted. For more details on how users link their accounts, see [fulfillment and authentication](https://developers.home.google.com/cloud-to-cloud/primer/fulfillment). The third-party user's identity is passed in via the `agent_user_id` (see DeleteAgentUserRequest). This request must be authorized using service account credentials from your Actions console project.",
"flatPath": "v1/agentUsers/{agentUsersId}",
"httpMethod": "DELETE",
"id": "homegraph.agentUsers.delete",
Expand Down Expand Up @@ -160,7 +160,7 @@
]
},
"reportStateAndNotification": {
"description": "Reports device state and optionally sends device notifications. Called by your smart home Action when the state of a third-party device changes or you need to send a notification about the device. See [Implement Report State](https://developers.google.com/assistant/smarthome/develop/report-state) for more information. This method updates the device state according to its declared [traits](https://developers.google.com/assistant/smarthome/concepts/devices-traits). Publishing a new state value outside of these traits will result in an `INVALID_ARGUMENT` error response. The third-party user's identity is passed in via the `agent_user_id` (see ReportStateAndNotificationRequest). This request must be authorized using service account credentials from your Actions console project.",
"description": "Reports device state and optionally sends device notifications. Called by your smart home Action when the state of a third-party device changes or you need to send a notification about the device. See [Implement Report State](https://developers.home.google.com/cloud-to-cloud/integration/report-state) for more information. This method updates the device state according to its declared [traits](https://developers.home.google.com/cloud-to-cloud/primer/device-types-and-traits). Publishing a new state value outside of these traits will result in an `INVALID_ARGUMENT` error response. The third-party user's identity is passed in via the `agent_user_id` (see ReportStateAndNotificationRequest). This request must be authorized using service account credentials from your Actions console project.",
"flatPath": "v1/devices:reportStateAndNotification",
"httpMethod": "POST",
"id": "homegraph.devices.reportStateAndNotification",
Expand All @@ -178,7 +178,7 @@
]
},
"requestSync": {
"description": "Requests Google to send an `action.devices.SYNC` [intent](https://developers.google.com/assistant/smarthome/reference/intent/sync) to your smart home Action to update device metadata for the given user. The third-party user's identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project.",
"description": "Requests Google to send an `action.devices.SYNC` [intent](https://developers.home.google.com/cloud-to-cloud/intents/sync) to your smart home Action to update device metadata for the given user. The third-party user's identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). This request must be authorized using service account credentials from your Actions console project.",
"flatPath": "v1/devices:requestSync",
"httpMethod": "POST",
"id": "homegraph.devices.requestSync",
Expand Down Expand Up @@ -216,7 +216,7 @@
}
}
},
"revision": "20220325",
"revision": "20230127",
"rootUrl": "https://homegraph.googleapis.com/",
"schemas": {
"AgentDeviceId": {
Expand Down Expand Up @@ -246,7 +246,7 @@
"type": "object"
},
"Device": {
"description": "Third-party device definition. Next ID = 14",
"description": "Third-party device definition.",
"id": "Device",
"properties": {
"attributes": {
Expand All @@ -262,7 +262,7 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute) intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.",
"description": "Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.home.google.com/cloud-to-cloud/intents/query) and [EXECUTE](https://developers.home.google.com/cloud-to-cloud/intents/execute) intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.",
"type": "object"
},
"deviceInfo": {
Expand All @@ -282,7 +282,7 @@
"type": "boolean"
},
"otherDeviceIds": {
"description": "Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.google.com/assistant/smarthome/concepts/local).",
"description": "Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.home.google.com/local-home/overview).",
"items": {
"$ref": "AgentOtherDeviceId"
},
Expand All @@ -297,14 +297,14 @@
"type": "string"
},
"traits": {
"description": "Traits supported by the device. See [device traits](https://developers.google.com/assistant/smarthome/traits).",
"description": "Traits supported by the device. See [device traits](https://developers.home.google.com/cloud-to-cloud/traits).",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Hardware type of the device. See [device types](https://developers.google.com/assistant/smarthome/guides).",
"description": "Hardware type of the device. See [device types](https://developers.home.google.com/cloud-to-cloud/guides).",
"type": "string"
},
"willReportState": {
Expand Down Expand Up @@ -416,7 +416,7 @@
"type": "object"
},
"QueryResponse": {
"description": "Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should follow the same format as the Google smart home `action.devices.QUERY` [response](https://developers.google.com/assistant/smarthome/reference/intent/query). # Example ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"payload\": { \"devices\": { \"123\": { \"on\": true, \"online\": true }, \"456\": { \"on\": true, \"online\": true, \"brightness\": 80, \"color\": { \"name\": \"cerulean\", \"spectrumRGB\": 31655 } } } } } ```",
"description": "Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should follow the same format as the Google smart home `action.devices.QUERY` [response](https://developers.home.google.com/cloud-to-cloud/intents/query). Example: ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"payload\": { \"devices\": { \"123\": { \"on\": true, \"online\": true }, \"456\": { \"on\": true, \"online\": true, \"brightness\": 80, \"color\": { \"name\": \"cerulean\", \"spectrumRGB\": 31655 } } } } } ```",
"id": "QueryResponse",
"properties": {
"payload": {
Expand Down Expand Up @@ -457,22 +457,22 @@
"description": "Properties of the object.",
"type": "any"
},
"description": "Notifications metadata for devices. See the **Device NOTIFICATIONS** section of the individual trait [reference guides](https://developers.google.com/assistant/smarthome/traits).",
"description": "Notifications metadata for devices. See the **Device NOTIFICATIONS** section of the individual trait [reference guides](https://developers.home.google.com/cloud-to-cloud/traits).",
"type": "object"
},
"states": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "States of devices to update. See the **Device STATES** section of the individual trait [reference guides](https://developers.google.com/assistant/smarthome/traits).",
"description": "States of devices to update. See the **Device STATES** section of the individual trait [reference guides](https://developers.home.google.com/cloud-to-cloud/traits).",
"type": "object"
}
},
"type": "object"
},
"ReportStateAndNotificationRequest": {
"description": "Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, \"123\" and \"456\" in the following example). # Example ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"agentUserId\": \"1234\", \"payload\": { \"devices\": { \"states\": { \"123\": { \"on\": true }, \"456\": { \"on\": true, \"brightness\": 10 } }, } } } ```",
"description": "Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.ReportStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, \"123\" and \"456\" in the following example). Example: ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"agentUserId\": \"1234\", \"payload\": { \"devices\": { \"states\": { \"123\": { \"on\": true }, \"456\": { \"on\": true, \"brightness\": 10 } }, } } } ```",
"id": "ReportStateAndNotificationRequest",
"properties": {
"agentUserId": {
Expand Down Expand Up @@ -557,7 +557,7 @@
"type": "object"
},
"SyncResponse": {
"description": "Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should follow the same format as the Google smart home `action.devices.SYNC` [response](https://developers.google.com/assistant/smarthome/reference/intent/sync). # Example ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"payload\": { \"agentUserId\": \"1836.15267389\", \"devices\": [{ \"id\": \"123\", \"type\": \"action.devices.types.OUTLET\", \"traits\": [ \"action.devices.traits.OnOff\" ], \"name\": { \"defaultNames\": [\"My Outlet 1234\"], \"name\": \"Night light\", \"nicknames\": [\"wall plug\"] }, \"willReportState\": false, \"deviceInfo\": { \"manufacturer\": \"lights-out-inc\", \"model\": \"hs1234\", \"hwVersion\": \"3.2\", \"swVersion\": \"11.4\" }, \"customData\": { \"fooValue\": 74, \"barValue\": true, \"bazValue\": \"foo\" } }] } } ```",
"description": "Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should follow the same format as the Google smart home `action.devices.SYNC` [response](https://developers.home.google.com/cloud-to-cloud/intents/sync). Example: ```json { \"requestId\": \"ff36a3cc-ec34-11e6-b1a0-64510650abcf\", \"payload\": { \"agentUserId\": \"1836.15267389\", \"devices\": [{ \"id\": \"123\", \"type\": \"action.devices.types.OUTLET\", \"traits\": [ \"action.devices.traits.OnOff\" ], \"name\": { \"defaultNames\": [\"My Outlet 1234\"], \"name\": \"Night light\", \"nicknames\": [\"wall plug\"] }, \"willReportState\": false, \"deviceInfo\": { \"manufacturer\": \"lights-out-inc\", \"model\": \"hs1234\", \"hwVersion\": \"3.2\", \"swVersion\": \"11.4\" }, \"customData\": { \"fooValue\": 74, \"barValue\": true, \"bazValue\": \"foo\" } }] } } ```",
"id": "SyncResponse",
"properties": {
"payload": {
Expand Down

0 comments on commit 2b517eb

Please sign in to comment.