docs: Updated the descriptions of a few APIs

PiperOrigin-RevId: 499946482
pull/765/head
Google APIs 2 years ago committed by Copybara-Service
parent 71b5bbcb2e
commit 2c7756f622
  1. 4
      google/home/enterprise/sdm/v1/device.proto
  2. 2
      google/home/enterprise/sdm/v1/site.proto
  3. 15
      google/home/enterprise/sdm/v1/smart_device_management_service.proto
  4. 10
      google/home/enterprise/sdm/v1/smartdevicemanagement_v1.yaml

@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -53,7 +53,7 @@ message Device {
}
// Represents device relationships, for instance, structure/room to which the
// device is assigned to. For now this is only filled in the enterprise flow.
// device is assigned to.
message ParentRelation {
// Output only. The name of the relation -- e.g., structure/room where the
// device is assigned to. For example: "enterprises/XYZ/structures/ABC" or

@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.

@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -18,6 +18,8 @@ package google.home.enterprise.sdm.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/home/enterprise/sdm/v1/device.proto";
import "google/home/enterprise/sdm/v1/site.proto";
import "google/protobuf/struct.proto";
@ -38,7 +40,8 @@ option php_namespace = "Google\\Home\\Enterprise\\Sdm\\V1";
// Home structures and devices for enterprise use cases.
service SmartDeviceManagementService {
option (google.api.default_host) = "smartdevicemanagement.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/sdm.service";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/sdm.service";
// Gets a device managed by the enterprise.
rpc GetDevice(GetDeviceRequest) returns (Device) {
@ -55,7 +58,8 @@ service SmartDeviceManagementService {
}
// Executes a command to device managed by the enterprise.
rpc ExecuteDeviceCommand(ExecuteDeviceCommandRequest) returns (ExecuteDeviceCommandResponse) {
rpc ExecuteDeviceCommand(ExecuteDeviceCommandRequest)
returns (ExecuteDeviceCommandResponse) {
option (google.api.http) = {
post: "/v1/{name=enterprises/*/devices/*}:executeCommand"
body: "*"
@ -112,9 +116,8 @@ message ListDevicesRequest {
// Optional filter to list devices.
//
// Filters can match the exact parent (could be a structure or a room):
// 'parent=enterprises/XYZ/structures/jkl'
// or filter by device custom name (substring match):
// Filters can be done on:
// Device custom name (substring match):
// 'customName=wing'
string filter = 4;
}

@ -17,3 +17,13 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/sdm.service
publishing:
organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
new_issue_uri: ''
documentation_uri: ''
api_short_name: ''
github_label: ''
doc_tag_prefix: ''
codeowner_github_teams:
library_settings:

Loading…
Cancel
Save