Skip to content

Commit f247869

Browse files
yoshi-automationyoshi-automation
committed
feat(chromepolicy): update the api
#### chromepolicy:v1 The following keys were deleted: - schemas.GoogleChromePolicyV1AdditionalTargetKeyName (Total Keys: 3) - schemas.GoogleChromePolicyV1ListPolicySchemasResponse (Total Keys: 5) - schemas.GoogleChromePolicyV1PolicySchema (Total Keys: 33) The following keys were added: - resources.customers.resources.policies.resources.networks.methods.defineCertificate (Total Keys: 12) - resources.customers.resources.policies.resources.networks.methods.defineNetwork (Total Keys: 12) - resources.customers.resources.policies.resources.networks.methods.removeCertificate (Total Keys: 12) - resources.customers.resources.policies.resources.networks.methods.removeNetwork (Total Keys: 12) - schemas.GoogleChromePolicyV1DefineCertificateRequest (Total Keys: 7) - schemas.GoogleChromePolicyV1DefineCertificateResponse (Total Keys: 6) - schemas.GoogleChromePolicyV1DefineNetworkRequest (Total Keys: 6) - schemas.GoogleChromePolicyV1DefineNetworkResponse (Total Keys: 6) - schemas.GoogleChromePolicyV1NetworkSetting (Total Keys: 5) - schemas.GoogleChromePolicyV1PolicyModificationFieldError (Total Keys: 6) - schemas.GoogleChromePolicyV1RemoveCertificateRequest (Total Keys: 4) - schemas.GoogleChromePolicyV1RemoveCertificateResponse (Total Keys: 2) - schemas.GoogleChromePolicyV1RemoveNetworkRequest (Total Keys: 4) - schemas.GoogleChromePolicyV1RemoveNetworkResponse (Total Keys: 2) - schemas.GoogleChromePolicyVersionsV1AdditionalTargetKeyName (Total Keys: 3) - schemas.GoogleChromePolicyVersionsV1ListPolicySchemasResponse (Total Keys: 5) - schemas.GoogleChromePolicyVersionsV1PolicySchema (Total Keys: 33) The following keys were changed: - resources.customers.resources.policySchemas.methods.get.response.$ref (Total Keys: 1) - resources.customers.resources.policySchemas.methods.list.response.$ref (Total Keys: 1)
1 parent ec3508a commit f247869

File tree

5 files changed

+735
-199
lines changed

5 files changed

+735
-199
lines changed

‎docs/dyn/chromepolicy_v1.customers.policies.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the groups Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="chromepolicy_v1.customers.policies.networks.html">networks()</a></code>
84+
</p>
85+
<p class="firstline">Returns the networks Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="chromepolicy_v1.customers.policies.orgunits.html">orgunits()</a></code>
8489
</p>
@@ -111,7 +116,7 @@ <h3>Method Details</h3>
111116
{ # Request message for getting the resolved policy value for a specific target.
112117
&quot;pageSize&quot;: 42, # The maximum number of policies to return, defaults to 100 and has a maximum of 1000.
113118
&quot;pageToken&quot;: &quot;A String&quot;, # The page token used to retrieve a specific page of the request.
114-
&quot;policySchemaFilter&quot;: &quot;A String&quot;, # The schema filter to apply to the resolve request. Specify a schema name to view a particular schema, for example: chrome.users.ShowLogoutButton Wildcards are supported, but only in the leaf portion of the schema name. Wildcards cannot be used in namespace directly. Please read https://developers.google.com/chrome/policy/guides/policy-schemas for details on schema namepsaces. For example: Valid: &quot;chrome.users.*&quot;, &quot;chrome.users.apps.*&quot;, &quot;chrome.printers.*&quot; Invalid: &quot;*&quot;, &quot;*.users&quot;, &quot;chrome.*&quot;, &quot;chrome.*.apps.*&quot;
119+
&quot;policySchemaFilter&quot;: &quot;A String&quot;, # The schema filter to apply to the resolve request. Specify a schema name to view a particular schema, for example: chrome.users.ShowLogoutButton Wildcards are supported, but only in the leaf portion of the schema name. Wildcards cannot be used in namespace directly. Please read https://developers.google.com/chrome/policy/guides/policy-schemas for details on schema namespaces. For example: Valid: &quot;chrome.users.*&quot;, &quot;chrome.users.apps.*&quot;, &quot;chrome.printers.*&quot; Invalid: &quot;*&quot;, &quot;*.users&quot;, &quot;chrome.*&quot;, &quot;chrome.*.apps.*&quot;
115120
&quot;policyTargetKey&quot;: { # The key used to identify the target on which the policy will be applied. # Required. The key of the target resource on which the policies should be resolved. The target resource must point to an Org Unit.
116121
&quot;additionalTargetKeys&quot;: { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
117122
&quot;a_key&quot;: &quot;A String&quot;,

‎docs/dyn/chromepolicy_v1.customers.policies.networks.html

Lines changed: 239 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="chromepolicy_v1.html">Chrome Policy API</a> . <a href="chromepolicy_v1.customers.html">customers</a> . <a href="chromepolicy_v1.customers.policies.html">policies</a> . <a href="chromepolicy_v1.customers.policies.networks.html">networks</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#defineCertificate">defineCertificate(customer, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Creates a certificate at a specified OU for a customer.</p>
83+
<p class="toc_element">
84+
<code><a href="#defineNetwork">defineNetwork(customer, body=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Define a new network.</p>
86+
<p class="toc_element">
87+
<code><a href="#removeCertificate">removeCertificate(customer, body=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Remove an existing certificate by guid.</p>
89+
<p class="toc_element">
90+
<code><a href="#removeNetwork">removeNetwork(customer, body=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Remove an existing network by guid.</p>
92+
<h3>Method Details</h3>
93+
<div class="method">
94+
<code class="details" id="close">close()</code>
95+
<pre>Close httplib2 connections.</pre>
96+
</div>
97+
98+
<div class="method">
99+
<code class="details" id="defineCertificate">defineCertificate(customer, body=None, x__xgafv=None)</code>
100+
<pre>Creates a certificate at a specified OU for a customer.
101+
102+
Args:
103+
customer: string, Required. The customer for which the certificate will apply. (required)
104+
body: object, The request body.
105+
The object takes the form of:
106+
107+
{ # Request object for creating a certificate.
108+
&quot;ceritificateName&quot;: &quot;A String&quot;, # Optional. The optional name of the certificate. If not specified, the certificate issuer will be used as the name.
109+
&quot;certificate&quot;: &quot;A String&quot;, # Required. The raw contents of the .PEM, .CRT, or .CER file.
110+
&quot;settings&quot;: [ # Optional. Certificate settings within the chrome.networks.certificates namespace.
111+
{ # A network setting contains network configurations.
112+
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
113+
&quot;value&quot;: { # The value of the network setting.
114+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
115+
},
116+
},
117+
],
118+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this certificate is applied. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
119+
}
120+
121+
x__xgafv: string, V1 error format.
122+
Allowed values
123+
1 - v1 error format
124+
2 - v2 error format
125+
126+
Returns:
127+
An object of the form:
128+
129+
{ # Response object for creating a certificate.
130+
&quot;networkId&quot;: &quot;A String&quot;, # The guid of the certificate created by the action.
131+
&quot;settings&quot;: [ # the affiliated settings of the certificate (NOT IMPLEMENTED)
132+
{ # A network setting contains network configurations.
133+
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
134+
&quot;value&quot;: { # The value of the network setting.
135+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
136+
},
137+
},
138+
],
139+
&quot;targetResource&quot;: &quot;A String&quot;, # the resource at which the certificate is defined.
140+
}</pre>
141+
</div>
142+
143+
<div class="method">
144+
<code class="details" id="defineNetwork">defineNetwork(customer, body=None, x__xgafv=None)</code>
145+
<pre>Define a new network.
146+
147+
Args:
148+
customer: string, Required. The customer who will own this new network. (required)
149+
body: object, The request body.
150+
The object takes the form of:
151+
152+
{ # Request object for creating a new network.
153+
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the new created network.
154+
&quot;settings&quot;: [ # Required. Detailed network settings.
155+
{ # A network setting contains network configurations.
156+
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
157+
&quot;value&quot;: { # The value of the network setting.
158+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
159+
},
160+
},
161+
],
162+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this new network will be defined. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
163+
}
164+
165+
x__xgafv: string, V1 error format.
166+
Allowed values
167+
1 - v1 error format
168+
2 - v2 error format
169+
170+
Returns:
171+
An object of the form:
172+
173+
{ # Response object for creating a network.
174+
&quot;networkId&quot;: &quot;A String&quot;, # Network ID of the new created network.
175+
&quot;settings&quot;: [ # Detailed network settings of the new created network
176+
{ # A network setting contains network configurations.
177+
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
178+
&quot;value&quot;: { # The value of the network setting.
179+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
180+
},
181+
},
182+
],
183+
&quot;targetResource&quot;: &quot;A String&quot;, # The target resource on which this new network will be defined. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
184+
}</pre>
185+
</div>
186+
187+
<div class="method">
188+
<code class="details" id="removeCertificate">removeCertificate(customer, body=None, x__xgafv=None)</code>
189+
<pre>Remove an existing certificate by guid.
190+
191+
Args:
192+
customer: string, Required. The customer whose certificate will be removed. (required)
193+
body: object, The request body.
194+
The object takes the form of:
195+
196+
{ # Request object for removing a certificate.
197+
&quot;networkId&quot;: &quot;A String&quot;, # Required. The GUID of the certificate to remove.
198+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this certificate will be removed. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
199+
}
200+
201+
x__xgafv: string, V1 error format.
202+
Allowed values
203+
1 - v1 error format
204+
2 - v2 error format
205+
206+
Returns:
207+
An object of the form:
208+
209+
{ # Response object for removing a certificate.
210+
}</pre>
211+
</div>
212+
213+
<div class="method">
214+
<code class="details" id="removeNetwork">removeNetwork(customer, body=None, x__xgafv=None)</code>
215+
<pre>Remove an existing network by guid.
216+
217+
Args:
218+
customer: string, Required. The customer whose network will be removed. (required)
219+
body: object, The request body.
220+
The object takes the form of:
221+
222+
{ # Request object for removing a network
223+
&quot;networkId&quot;: &quot;A String&quot;, # Required. The GUID of the network to remove.
224+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this network will be removed. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
225+
}
226+
227+
x__xgafv: string, V1 error format.
228+
Allowed values
229+
1 - v1 error format
230+
2 - v2 error format
231+
232+
Returns:
233+
An object of the form:
234+
235+
{ # Response object for removing a network.
236+
}</pre>
237+
</div>
238+
239+
</body></html>

‎docs/dyn/chromepolicy_v1.customers.policySchemas.html

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ <h3>Method Details</h3>
106106
Returns:
107107
An object of the form:
108108

109-
{ # Resource representing a policy schema. Next ID: 14
109+
{ # Resource representing a policy schema.
110110
&quot;accessRestrictions&quot;: [ # Output only. Specific access restrictions related to this policy.
111111
&quot;A String&quot;,
112112
],
@@ -116,7 +116,7 @@ <h3>Method Details</h3>
116116
&quot;keyDescription&quot;: &quot;A String&quot;, # Key description.
117117
},
118118
],
119-
&quot;categoryTitle&quot;: &quot;A String&quot;, # Output only. Title of the category in which a setting belongs.
119+
&quot;categoryTitle&quot;: &quot;A String&quot;, # Title of the category in which a setting belongs.
120120
&quot;definition&quot;: { # Describes a complete .proto file. # Schema definition using proto descriptor.
121121
&quot;enumType&quot;: [
122122
{ # Describes an enum type.
@@ -172,6 +172,7 @@ <h3>Method Details</h3>
172172
},
173173
&quot;fieldDescriptions&quot;: [ # Output only. Detailed description of each field that is part of the schema.
174174
{ # Provides detailed information for a particular field that is part of a PolicySchema.
175+
&quot;defaultValue&quot;: &quot;&quot;, # Output only. Client default if the policy is unset.
175176
&quot;description&quot;: &quot;A String&quot;, # Deprecated. Use name and field_description instead. The description for the field.
176177
&quot;field&quot;: &quot;A String&quot;, # Output only. The name of the field for associated with this description.
177178
&quot;fieldDependencies&quot;: [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
@@ -190,7 +191,7 @@ <h3>Method Details</h3>
190191
],
191192
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the field.
192193
&quot;nestedFieldDescriptions&quot;: [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.
193-
# Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription
194+
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
194195
],
195196
&quot;requiredItems&quot;: [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
196197
{ # The fields that will become required based on the value of this field.
@@ -247,7 +248,7 @@ <h3>Method Details</h3>
247248
Args:
248249
parent: string, Required. The customer for which the listing request will apply. (required)
249250
filter: string, The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`.
250-
pageSize: integer, The maximum number of policy schemas to return.
251+
pageSize: integer, The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000.
251252
pageToken: string, The page token used to retrieve a specific page of the listing request.
252253
x__xgafv: string, V1 error format.
253254
Allowed values
@@ -260,7 +261,7 @@ <h3>Method Details</h3>
260261
{ # Response message for listing policy schemas that match a filter.
261262
&quot;nextPageToken&quot;: &quot;A String&quot;, # The page token used to get the next page of policy schemas.
262263
&quot;policySchemas&quot;: [ # The list of policy schemas that match the query.
263-
{ # Resource representing a policy schema. Next ID: 14
264+
{ # Resource representing a policy schema.
264265
&quot;accessRestrictions&quot;: [ # Output only. Specific access restrictions related to this policy.
265266
&quot;A String&quot;,
266267
],
@@ -270,7 +271,7 @@ <h3>Method Details</h3>
270271
&quot;keyDescription&quot;: &quot;A String&quot;, # Key description.
271272
},
272273
],
273-
&quot;categoryTitle&quot;: &quot;A String&quot;, # Output only. Title of the category in which a setting belongs.
274+
&quot;categoryTitle&quot;: &quot;A String&quot;, # Title of the category in which a setting belongs.
274275
&quot;definition&quot;: { # Describes a complete .proto file. # Schema definition using proto descriptor.
275276
&quot;enumType&quot;: [
276277
{ # Describes an enum type.
@@ -326,6 +327,7 @@ <h3>Method Details</h3>
326327
},
327328
&quot;fieldDescriptions&quot;: [ # Output only. Detailed description of each field that is part of the schema.
328329
{ # Provides detailed information for a particular field that is part of a PolicySchema.
330+
&quot;defaultValue&quot;: &quot;&quot;, # Output only. Client default if the policy is unset.
329331
&quot;description&quot;: &quot;A String&quot;, # Deprecated. Use name and field_description instead. The description for the field.
330332
&quot;field&quot;: &quot;A String&quot;, # Output only. The name of the field for associated with this description.
331333
&quot;fieldDependencies&quot;: [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
@@ -344,7 +346,7 @@ <h3>Method Details</h3>
344346
],
345347
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the field.
346348
&quot;nestedFieldDescriptions&quot;: [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.
347-
# Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription
349+
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
348350
],
349351
&quot;requiredItems&quot;: [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
350352
{ # The fields that will become required based on the value of this field.

‎docs/dyn/chromepolicy_v1.media.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h3>Method Details</h3>
9595
body: object, The request body.
9696
The object takes the form of:
9797

98-
{ # Request message for uploading a file for a policy. Next ID: 5
98+
{ # Request message for uploading a file for a policy.
9999
&quot;policyField&quot;: &quot;A String&quot;, # Required. The fully qualified policy schema and field name this file is uploaded for. This information will be used to validate the content type of the file.
100100
}
101101

@@ -109,7 +109,7 @@ <h3>Method Details</h3>
109109
Returns:
110110
An object of the form:
111111

112-
{ # Response message for downloading an uploaded file. Next ID: 2
112+
{ # Response message for downloading an uploaded file.
113113
&quot;downloadUri&quot;: &quot;A String&quot;, # The uri for end user to download the file.
114114
}</pre>
115115
</div>

0 commit comments

Comments
 (0)