Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(753)

Side by Side Diff: discovery/googleapis/vault__v1.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/urlshortener__v1.json ('k') | discovery/googleapis/vision__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "basePath": "", 2 "basePath": "",
3 "baseUrl": "https://vault.googleapis.com/", 3 "baseUrl": "https://vault.googleapis.com/",
4 "batchPath": "batch", 4 "batchPath": "batch",
5 "canonicalName": "Vault", 5 "canonicalName": "Vault",
6 "description": "", 6 "description": "",
7 "discoveryVersion": "v1", 7 "discoveryVersion": "v1",
8 "documentationLink": "https://apps.google.com/products/vault/", 8 "documentationLink": "https://apps.google.com/products/vault/",
9 "icons": { 9 "icons": {
10 "x16": "http://www.google.com/images/icons/product/search-16.gif", 10 "x16": "http://www.google.com/images/icons/product/search-16.gif",
11 "x32": "http://www.google.com/images/icons/product/search-32.gif" 11 "x32": "http://www.google.com/images/icons/product/search-32.gif"
12 }, 12 },
13 "id": "vault:v1", 13 "id": "vault:v1",
14 "kind": "discovery#restDescription", 14 "kind": "discovery#restDescription",
15 "name": "vault", 15 "name": "vault",
16 "ownerDomain": "google.com", 16 "ownerDomain": "google.com",
17 "ownerName": "Google", 17 "ownerName": "Google",
18 "parameters": { 18 "parameters": {
19 "upload_protocol": {
20 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
21 "location": "query",
22 "type": "string"
23 },
24 "prettyPrint": {
25 "default": "true",
26 "description": "Returns response with indentations and line breaks." ,
27 "location": "query",
28 "type": "boolean"
29 },
30 "uploadType": {
31 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
32 "location": "query",
33 "type": "string"
34 },
35 "fields": {
36 "description": "Selector specifying which fields to include in a par tial response.",
37 "location": "query",
38 "type": "string"
39 },
19 "callback": { 40 "callback": {
20 "description": "JSONP", 41 "description": "JSONP",
21 "location": "query", 42 "location": "query",
22 "type": "string" 43 "type": "string"
23 }, 44 },
24 "$.xgafv": { 45 "$.xgafv": {
25 "description": "V1 error format.", 46 "description": "V1 error format.",
26 "enum": [ 47 "enum": [
27 "1", 48 "1",
28 "2" 49 "2"
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
64 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 85 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
65 "location": "query", 86 "location": "query",
66 "type": "string" 87 "type": "string"
67 }, 88 },
68 "pp": { 89 "pp": {
69 "default": "true", 90 "default": "true",
70 "description": "Pretty-print response.", 91 "description": "Pretty-print response.",
71 "location": "query", 92 "location": "query",
72 "type": "boolean" 93 "type": "boolean"
73 }, 94 },
74 "bearer_token": {
75 "description": "OAuth bearer token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": { 95 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.", 96 "description": "OAuth 2.0 token for the current user.",
81 "location": "query", 97 "location": "query",
82 "type": "string" 98 "type": "string"
83 }, 99 },
84 "upload_protocol": { 100 "bearer_token": {
85 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 101 "description": "OAuth bearer token.",
86 "location": "query",
87 "type": "string"
88 },
89 "prettyPrint": {
90 "default": "true",
91 "description": "Returns response with indentations and line breaks." ,
92 "location": "query",
93 "type": "boolean"
94 },
95 "fields": {
96 "description": "Selector specifying which fields to include in a par tial response.",
97 "location": "query",
98 "type": "string"
99 },
100 "uploadType": {
101 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
102 "location": "query", 102 "location": "query",
103 "type": "string" 103 "type": "string"
104 } 104 }
105 }, 105 },
106 "protocol": "rest", 106 "protocol": "rest",
107 "resources": { 107 "resources": {
108 "matters": { 108 "matters": {
109 "methods": { 109 "methods": {
110 "close": { 110 "close": {
111 "description": "Closes the specified matter. Returns matter with updated state.", 111 "description": "Closes the specified matter. Returns matter with updated state.",
(...skipping 11 matching lines...) Expand all
123 } 123 }
124 }, 124 },
125 "path": "v1/matters/{matterId}:close", 125 "path": "v1/matters/{matterId}:close",
126 "request": { 126 "request": {
127 "$ref": "CloseMatterRequest" 127 "$ref": "CloseMatterRequest"
128 }, 128 },
129 "response": { 129 "response": {
130 "$ref": "CloseMatterResponse" 130 "$ref": "CloseMatterResponse"
131 } 131 }
132 }, 132 },
133 "get": { 133 "undelete": {
134 "description": "Gets the specified matter.", 134 "description": "Undeletes the specified matter. Returns matt er with updated state.",
135 "httpMethod": "GET", 135 "httpMethod": "POST",
136 "id": "vault.matters.get", 136 "id": "vault.matters.undelete",
137 "parameterOrder": [ 137 "parameterOrder": [
138 "matterId" 138 "matterId"
139 ], 139 ],
140 "parameters": { 140 "parameters": {
141 "view": {
142 "description": "Specifies which parts of the Matter to return in the response.",
143 "enum": [
144 "VIEW_UNSPECIFIED",
145 "BASIC",
146 "FULL"
147 ],
148 "location": "query",
149 "type": "string"
150 },
151 "matterId": { 141 "matterId": {
152 "description": "The matter ID.", 142 "description": "The matter ID.",
153 "location": "path", 143 "location": "path",
154 "required": true, 144 "required": true,
155 "type": "string" 145 "type": "string"
156 } 146 }
157 }, 147 },
158 "path": "v1/matters/{matterId}", 148 "path": "v1/matters/{matterId}:undelete",
149 "request": {
150 "$ref": "UndeleteMatterRequest"
151 },
159 "response": { 152 "response": {
160 "$ref": "Matter" 153 "$ref": "Matter"
161 } 154 }
162 }, 155 },
163 "undelete": { 156 "get": {
164 "description": "Undeletes the specified matter. Returns matt er with updated state.", 157 "description": "Gets the specified matter.",
165 "httpMethod": "POST", 158 "httpMethod": "GET",
166 "id": "vault.matters.undelete", 159 "id": "vault.matters.get",
167 "parameterOrder": [ 160 "parameterOrder": [
168 "matterId" 161 "matterId"
169 ], 162 ],
170 "parameters": { 163 "parameters": {
164 "view": {
165 "description": "Specifies which parts of the Matter to return in the response.",
166 "enum": [
167 "VIEW_UNSPECIFIED",
168 "BASIC",
169 "FULL"
170 ],
171 "location": "query",
172 "type": "string"
173 },
171 "matterId": { 174 "matterId": {
172 "description": "The matter ID.", 175 "description": "The matter ID.",
173 "location": "path", 176 "location": "path",
174 "required": true, 177 "required": true,
175 "type": "string" 178 "type": "string"
176 } 179 }
177 }, 180 },
178 "path": "v1/matters/{matterId}:undelete", 181 "path": "v1/matters/{matterId}",
179 "request": {
180 "$ref": "UndeleteMatterRequest"
181 },
182 "response": { 182 "response": {
183 "$ref": "Matter" 183 "$ref": "Matter"
184 } 184 }
185 }, 185 },
186 "update": { 186 "update": {
187 "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes t o any other fields are ignored.\nReturns the default view of the matter.", 187 "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes t o any other fields are ignored.\nReturns the default view of the matter.",
188 "httpMethod": "PUT", 188 "httpMethod": "PUT",
189 "id": "vault.matters.update", 189 "id": "vault.matters.update",
190 "parameterOrder": [ 190 "parameterOrder": [
191 "matterId" 191 "matterId"
(...skipping 27 matching lines...) Expand all
219 "location": "path", 219 "location": "path",
220 "required": true, 220 "required": true,
221 "type": "string" 221 "type": "string"
222 } 222 }
223 }, 223 },
224 "path": "v1/matters/{matterId}", 224 "path": "v1/matters/{matterId}",
225 "response": { 225 "response": {
226 "$ref": "Matter" 226 "$ref": "Matter"
227 } 227 }
228 }, 228 },
229 "addPermissions": {
230 "description": "Adds an account as a matter collaborator.",
231 "httpMethod": "POST",
232 "id": "vault.matters.addPermissions",
233 "parameterOrder": [
234 "matterId"
235 ],
236 "parameters": {
237 "matterId": {
238 "description": "The matter ID.",
239 "location": "path",
240 "required": true,
241 "type": "string"
242 }
243 },
244 "path": "v1/matters/{matterId}:addPermissions",
245 "request": {
246 "$ref": "AddMatterPermissionsRequest"
247 },
248 "response": {
249 "$ref": "MatterPermission"
250 }
251 },
252 "list": { 229 "list": {
253 "description": "Lists matters the user has access to.", 230 "description": "Lists matters the user has access to.",
254 "httpMethod": "GET", 231 "httpMethod": "GET",
255 "id": "vault.matters.list", 232 "id": "vault.matters.list",
256 "parameterOrder": [], 233 "parameterOrder": [],
257 "parameters": { 234 "parameters": {
258 "pageToken": { 235 "pageToken": {
259 "description": "The pagination token as returned in the response.", 236 "description": "The pagination token as returned in the response.",
260 "location": "query", 237 "location": "query",
261 "type": "string" 238 "type": "string"
(...skipping 13 matching lines...) Expand all
275 ], 252 ],
276 "location": "query", 253 "location": "query",
277 "type": "string" 254 "type": "string"
278 } 255 }
279 }, 256 },
280 "path": "v1/matters", 257 "path": "v1/matters",
281 "response": { 258 "response": {
282 "$ref": "ListMattersResponse" 259 "$ref": "ListMattersResponse"
283 } 260 }
284 }, 261 },
262 "addPermissions": {
263 "description": "Adds an account as a matter collaborator.",
264 "httpMethod": "POST",
265 "id": "vault.matters.addPermissions",
266 "parameterOrder": [
267 "matterId"
268 ],
269 "parameters": {
270 "matterId": {
271 "description": "The matter ID.",
272 "location": "path",
273 "required": true,
274 "type": "string"
275 }
276 },
277 "path": "v1/matters/{matterId}:addPermissions",
278 "request": {
279 "$ref": "AddMatterPermissionsRequest"
280 },
281 "response": {
282 "$ref": "MatterPermission"
283 }
284 },
285 "create": { 285 "create": {
286 "description": "Creates a new matter. Returns created matter with default view.", 286 "description": "Creates a new matter. Returns created matter with default view.",
287 "httpMethod": "POST", 287 "httpMethod": "POST",
288 "id": "vault.matters.create", 288 "id": "vault.matters.create",
289 "parameterOrder": [], 289 "parameterOrder": [],
290 "parameters": {}, 290 "parameters": {},
291 "path": "v1/matters", 291 "path": "v1/matters",
292 "request": { 292 "request": {
293 "$ref": "Matter" 293 "$ref": "Matter"
294 }, 294 },
295 "response": { 295 "response": {
296 "$ref": "Matter" 296 "$ref": "Matter"
297 } 297 }
298 }, 298 },
299 "reopen": { 299 "removePermissions": {
300 "description": "Reopens the specified matter. Returns matter with updated state.", 300 "description": "Removes an account as a matter collaborator. ",
301 "httpMethod": "POST", 301 "httpMethod": "POST",
302 "id": "vault.matters.reopen", 302 "id": "vault.matters.removePermissions",
303 "parameterOrder": [ 303 "parameterOrder": [
304 "matterId" 304 "matterId"
305 ], 305 ],
306 "parameters": { 306 "parameters": {
307 "matterId": { 307 "matterId": {
308 "description": "The matter ID.", 308 "description": "The matter ID.",
309 "location": "path", 309 "location": "path",
310 "required": true, 310 "required": true,
311 "type": "string" 311 "type": "string"
312 } 312 }
313 }, 313 },
314 "path": "v1/matters/{matterId}:reopen", 314 "path": "v1/matters/{matterId}:removePermissions",
315 "request": { 315 "request": {
316 "$ref": "ReopenMatterRequest" 316 "$ref": "RemoveMatterPermissionsRequest"
317 }, 317 },
318 "response": { 318 "response": {
319 "$ref": "ReopenMatterResponse" 319 "$ref": "Empty"
320 } 320 }
321 }, 321 },
322 "removePermissions": { 322 "reopen": {
323 "description": "Removes an account as a matter collaborator. ", 323 "description": "Reopens the specified matter. Returns matter with updated state.",
324 "httpMethod": "POST", 324 "httpMethod": "POST",
325 "id": "vault.matters.removePermissions", 325 "id": "vault.matters.reopen",
326 "parameterOrder": [ 326 "parameterOrder": [
327 "matterId" 327 "matterId"
328 ], 328 ],
329 "parameters": { 329 "parameters": {
330 "matterId": { 330 "matterId": {
331 "description": "The matter ID.", 331 "description": "The matter ID.",
332 "location": "path", 332 "location": "path",
333 "required": true, 333 "required": true,
334 "type": "string" 334 "type": "string"
335 } 335 }
336 }, 336 },
337 "path": "v1/matters/{matterId}:removePermissions", 337 "path": "v1/matters/{matterId}:reopen",
338 "request": { 338 "request": {
339 "$ref": "RemoveMatterPermissionsRequest" 339 "$ref": "ReopenMatterRequest"
340 }, 340 },
341 "response": { 341 "response": {
342 "$ref": "Empty" 342 "$ref": "ReopenMatterResponse"
343 } 343 }
344 } 344 }
345 }, 345 },
346 "resources": { 346 "resources": {
347 "holds": { 347 "holds": {
348 "methods": { 348 "methods": {
349 "delete": { 349 "delete": {
350 "description": "Removes a hold by ID. This will rele ase any HeldAccounts on this Hold.", 350 "description": "Removes a hold by ID. This will rele ase any HeldAccounts on this Hold.",
351 "httpMethod": "DELETE", 351 "httpMethod": "DELETE",
352 "id": "vault.matters.holds.delete", 352 "id": "vault.matters.holds.delete",
(...skipping 21 matching lines...) Expand all
374 } 374 }
375 }, 375 },
376 "list": { 376 "list": {
377 "description": "Lists holds within a matter. An empt y page token in ListHoldsResponse\ndenotes no more holds to list.", 377 "description": "Lists holds within a matter. An empt y page token in ListHoldsResponse\ndenotes no more holds to list.",
378 "httpMethod": "GET", 378 "httpMethod": "GET",
379 "id": "vault.matters.holds.list", 379 "id": "vault.matters.holds.list",
380 "parameterOrder": [ 380 "parameterOrder": [
381 "matterId" 381 "matterId"
382 ], 382 ],
383 "parameters": { 383 "parameters": {
384 "matterId": {
385 "description": "The matter ID.",
386 "location": "path",
387 "required": true,
388 "type": "string"
389 },
390 "pageToken": { 384 "pageToken": {
391 "description": "The pagination token as retu rned in the response.\nAn empty token means start from the beginning.", 385 "description": "The pagination token as retu rned in the response.\nAn empty token means start from the beginning.",
392 "location": "query", 386 "location": "query",
393 "type": "string" 387 "type": "string"
394 }, 388 },
395 "pageSize": { 389 "pageSize": {
396 "description": "The number of holds to retur n in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.", 390 "description": "The number of holds to retur n in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.",
397 "format": "int32", 391 "format": "int32",
398 "location": "query", 392 "location": "query",
399 "type": "integer" 393 "type": "integer"
394 },
395 "matterId": {
396 "description": "The matter ID.",
397 "location": "path",
398 "required": true,
399 "type": "string"
400 } 400 }
401 }, 401 },
402 "path": "v1/matters/{matterId}/holds", 402 "path": "v1/matters/{matterId}/holds",
403 "response": { 403 "response": {
404 "$ref": "ListHoldsResponse" 404 "$ref": "ListHoldsResponse"
405 } 405 }
406 }, 406 },
407 "get": { 407 "get": {
408 "description": "Gets a hold by ID.", 408 "description": "Gets a hold by ID.",
409 "httpMethod": "GET", 409 "httpMethod": "GET",
(...skipping 23 matching lines...) Expand all
433 }, 433 },
434 "update": { 434 "update": {
435 "description": "Updates the OU and/or query paramete rs of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.", 435 "description": "Updates the OU and/or query paramete rs of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.",
436 "httpMethod": "PUT", 436 "httpMethod": "PUT",
437 "id": "vault.matters.holds.update", 437 "id": "vault.matters.holds.update",
438 "parameterOrder": [ 438 "parameterOrder": [
439 "matterId", 439 "matterId",
440 "holdId" 440 "holdId"
441 ], 441 ],
442 "parameters": { 442 "parameters": {
443 "matterId": {
444 "description": "The matter ID.",
445 "location": "path",
446 "required": true,
447 "type": "string"
448 },
443 "holdId": { 449 "holdId": {
444 "description": "The ID of the hold.", 450 "description": "The ID of the hold.",
445 "location": "path", 451 "location": "path",
446 "required": true, 452 "required": true,
447 "type": "string" 453 "type": "string"
448 },
449 "matterId": {
450 "description": "The matter ID.",
451 "location": "path",
452 "required": true,
453 "type": "string"
454 } 454 }
455 }, 455 },
456 "path": "v1/matters/{matterId}/holds/{holdId}", 456 "path": "v1/matters/{matterId}/holds/{holdId}",
457 "request": { 457 "request": {
458 "$ref": "Hold" 458 "$ref": "Hold"
459 }, 459 },
460 "response": { 460 "response": {
461 "$ref": "Hold" 461 "$ref": "Hold"
462 } 462 }
463 }, 463 },
(...skipping 115 matching lines...) Expand 10 before | Expand all | Expand 10 after
579 "$ref": "HeldAccount" 579 "$ref": "HeldAccount"
580 } 580 }
581 } 581 }
582 } 582 }
583 } 583 }
584 } 584 }
585 } 585 }
586 } 586 }
587 } 587 }
588 }, 588 },
589 "revision": "20170719", 589 "revision": "20170828",
590 "rootUrl": "https://vault.googleapis.com/", 590 "rootUrl": "https://vault.googleapis.com/",
591 "schemas": { 591 "schemas": {
592 "RemoveMatterPermissionsRequest": {
593 "description": "Remove an account as a matter collaborator.",
594 "id": "RemoveMatterPermissionsRequest",
595 "properties": {
596 "accountId": {
597 "description": "The account ID.",
598 "type": "string"
599 }
600 },
601 "type": "object"
602 },
603 "MatterPermission": {
604 "description": "Currently each matter only has one owner, and all ot hers are collaborators.\nWhen an account is purged, its corresponding MatterPerm ission resources\ncease to exist.",
605 "id": "MatterPermission",
606 "properties": {
607 "accountId": {
608 "description": "The account id, as provided by <a href=\"htt ps://developers.google.com/admin-sdk/\">Admin SDK</a>.",
609 "type": "string"
610 },
611 "role": {
612 "description": "The user's role in this matter.",
613 "enum": [
614 "ROLE_UNSPECIFIED",
615 "COLLABORATOR",
616 "OWNER"
617 ],
618 "enumDescriptions": [
619 "No role assigned.",
620 "A collaborator to the matter.",
621 "The owner of the matter."
622 ],
623 "type": "string"
624 }
625 },
626 "type": "object"
627 },
628 "ListMattersResponse": {
629 "description": "Provides the list of matters.",
630 "id": "ListMattersResponse",
631 "properties": {
632 "nextPageToken": {
633 "description": "Page token to retrieve the next page of resu lts in the list.",
634 "type": "string"
635 },
636 "matters": {
637 "description": "List of matters.",
638 "items": {
639 "$ref": "Matter"
640 },
641 "type": "array"
642 }
643 },
644 "type": "object"
645 },
646 "HeldMailQuery": {
647 "description": "Query options for mail holds.",
648 "id": "HeldMailQuery",
649 "properties": {
650 "endTime": {
651 "description": "The end date range for the search query. The se timestamps are in GMT and\nrounded down to the start of the given date.",
652 "format": "google-datetime",
653 "type": "string"
654 },
655 "startTime": {
656 "description": "The start date range for the search query. T hese timestamps are in GMT and\nrounded down to the start of the given date.",
657 "format": "google-datetime",
658 "type": "string"
659 },
660 "terms": {
661 "description": "The search terms for the hold.",
662 "type": "string"
663 }
664 },
665 "type": "object"
666 },
667 "CloseMatterResponse": {
668 "description": "Response to a CloseMatterRequest.",
669 "id": "CloseMatterResponse",
670 "properties": {
671 "matter": {
672 "$ref": "Matter",
673 "description": "The updated matter, with state CLOSED."
674 }
675 },
676 "type": "object"
677 },
678 "HeldGroupsQuery": {
679 "description": "Query options for group holds.",
680 "id": "HeldGroupsQuery",
681 "properties": {
682 "startTime": {
683 "description": "The start date range for the search query. T hese timestamps are in GMT and\nrounded down to the start of the given date.",
684 "format": "google-datetime",
685 "type": "string"
686 },
687 "terms": {
688 "description": "The search terms for the hold.",
689 "type": "string"
690 },
691 "endTime": {
692 "description": "The end date range for the search query. The se timestamps are in GMT and\nrounded down to the start of the given date.",
693 "format": "google-datetime",
694 "type": "string"
695 }
696 },
697 "type": "object"
698 },
699 "HeldDriveQuery": {
700 "description": "Query options for drive holds.",
701 "id": "HeldDriveQuery",
702 "properties": {
703 "includeTeamDriveFiles": {
704 "description": "If true, include files in Team Drives in the hold.",
705 "type": "boolean"
706 }
707 },
708 "type": "object"
709 },
710 "HeldOrgUnit": { 592 "HeldOrgUnit": {
711 "description": "A organizational unit being held in a particular hol d.\nThis structure is immutable.", 593 "description": "A organizational unit being held in a particular hol d.\nThis structure is immutable.",
712 "id": "HeldOrgUnit", 594 "id": "HeldOrgUnit",
713 "properties": { 595 "properties": {
714 "orgUnitId": { 596 "orgUnitId": {
715 "description": "The org unit's immutable ID as provided by t he admin SDK.", 597 "description": "The org unit's immutable ID as provided by t he admin SDK.",
716 "type": "string" 598 "type": "string"
717 }, 599 },
718 "holdTime": { 600 "holdTime": {
719 "description": "When the org unit was put on hold. This prop erty is immutable.", 601 "description": "When the org unit was put on hold. This prop erty is immutable.",
720 "format": "google-datetime", 602 "format": "google-datetime",
721 "type": "string" 603 "type": "string"
722 } 604 }
723 }, 605 },
724 "type": "object" 606 "type": "object"
725 }, 607 },
726 "AddMatterPermissionsRequest": { 608 "AddMatterPermissionsRequest": {
727 "description": "Add an account with the permission specified. The ro le cannot be owner.\nIf an account already has a role in the matter, it will be\ noverwritten.", 609 "description": "Add an account with the permission specified. The ro le cannot be owner.\nIf an account already has a role in the matter, it will be\ noverwritten.",
728 "id": "AddMatterPermissionsRequest", 610 "id": "AddMatterPermissionsRequest",
729 "properties": { 611 "properties": {
730 "ccMe": {
731 "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
732 "type": "boolean"
733 },
734 "sendEmails": { 612 "sendEmails": {
735 "description": "True to send notification email to the added account.\nFalse to not send notification email.", 613 "description": "True to send notification email to the added account.\nFalse to not send notification email.",
736 "type": "boolean" 614 "type": "boolean"
737 }, 615 },
738 "matterPermission": { 616 "matterPermission": {
739 "$ref": "MatterPermission", 617 "$ref": "MatterPermission",
740 "description": "The MatterPermission to add." 618 "description": "The MatterPermission to add."
619 },
620 "ccMe": {
621 "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
622 "type": "boolean"
741 } 623 }
742 }, 624 },
743 "type": "object" 625 "type": "object"
744 }, 626 },
745 "Matter": { 627 "Matter": {
746 "description": "Represents a matter.", 628 "description": "Represents a matter.",
747 "id": "Matter", 629 "id": "Matter",
748 "properties": { 630 "properties": {
631 "state": {
632 "description": "The state of the matter.",
633 "enum": [
634 "STATE_UNSPECIFIED",
635 "OPEN",
636 "CLOSED",
637 "DELETED"
638 ],
639 "enumDescriptions": [
640 "The matter has no specified state.",
641 "This matter is open.",
642 "This matter is closed.",
643 "This matter is deleted."
644 ],
645 "type": "string"
646 },
749 "matterPermissions": { 647 "matterPermissions": {
750 "description": "List of users and access to the matter. Curr ently there is no programmer\ndefined limit on the number of permissions a matte r can have.", 648 "description": "List of users and access to the matter. Curr ently there is no programmer\ndefined limit on the number of permissions a matte r can have.",
751 "items": { 649 "items": {
752 "$ref": "MatterPermission" 650 "$ref": "MatterPermission"
753 }, 651 },
754 "type": "array" 652 "type": "array"
755 }, 653 },
756 "name": { 654 "name": {
757 "description": "The name of the matter.", 655 "description": "The name of the matter.",
758 "type": "string" 656 "type": "string"
759 }, 657 },
760 "description": { 658 "description": {
761 "description": "The description of the matter.", 659 "description": "The description of the matter.",
762 "type": "string" 660 "type": "string"
763 }, 661 },
764 "matterId": { 662 "matterId": {
765 "description": "The matter ID which is generated by the serv er.\nShould be blank when creating a new matter.", 663 "description": "The matter ID which is generated by the serv er.\nShould be blank when creating a new matter.",
766 "type": "string" 664 "type": "string"
767 },
768 "state": {
769 "description": "The state of the matter.",
770 "enum": [
771 "STATE_UNSPECIFIED",
772 "OPEN",
773 "CLOSED",
774 "DELETED"
775 ],
776 "enumDescriptions": [
777 "The matter has no specified state.",
778 "This matter is open.",
779 "This matter is closed.",
780 "This matter is deleted."
781 ],
782 "type": "string"
783 } 665 }
784 }, 666 },
785 "type": "object" 667 "type": "object"
786 }, 668 },
787 "HeldAccount": { 669 "HeldAccount": {
788 "description": "An account being held in a particular hold. This str ucture is immutable.\nThis can be either a single user or a google group, depend ing on the corpus.", 670 "description": "An account being held in a particular hold. This str ucture is immutable.\nThis can be either a single user or a google group, depend ing on the corpus.",
789 "id": "HeldAccount", 671 "id": "HeldAccount",
790 "properties": { 672 "properties": {
673 "accountId": {
674 "description": "The account's ID as provided by the\n<a href =\"https://developers.google.com/admin-sdk/\">Admin SDK</a>.",
675 "type": "string"
676 },
791 "holdTime": { 677 "holdTime": {
792 "description": "When the account was put on hold.", 678 "description": "When the account was put on hold.",
793 "format": "google-datetime", 679 "format": "google-datetime",
794 "type": "string" 680 "type": "string"
795 },
796 "accountId": {
797 "description": "The account's ID as provided by the\n<a href =\"https://developers.google.com/admin-sdk/\">Admin SDK</a>.",
798 "type": "string"
799 } 681 }
800 }, 682 },
801 "type": "object" 683 "type": "object"
802 }, 684 },
803 "ReopenMatterResponse": { 685 "ReopenMatterResponse": {
804 "description": "Response to a ReopenMatterRequest.", 686 "description": "Response to a ReopenMatterRequest.",
805 "id": "ReopenMatterResponse", 687 "id": "ReopenMatterResponse",
806 "properties": { 688 "properties": {
807 "matter": { 689 "matter": {
808 "$ref": "Matter", 690 "$ref": "Matter",
809 "description": "The updated matter, with state OPEN." 691 "description": "The updated matter, with state OPEN."
810 } 692 }
811 }, 693 },
812 "type": "object" 694 "type": "object"
813 }, 695 },
814 "CorpusQuery": { 696 "CorpusQuery": {
815 "description": "Corpus specific queries.", 697 "description": "Corpus specific queries.",
816 "id": "CorpusQuery", 698 "id": "CorpusQuery",
817 "properties": { 699 "properties": {
818 "driveQuery": {
819 "$ref": "HeldDriveQuery",
820 "description": "Details pertaining to Drive holds. If set, c orpus must be Drive."
821 },
822 "groupsQuery": { 700 "groupsQuery": {
823 "$ref": "HeldGroupsQuery", 701 "$ref": "HeldGroupsQuery",
824 "description": "Details pertaining to Groups holds. If set, corpus must be Groups." 702 "description": "Details pertaining to Groups holds. If set, corpus must be Groups."
825 }, 703 },
826 "mailQuery": { 704 "mailQuery": {
827 "$ref": "HeldMailQuery", 705 "$ref": "HeldMailQuery",
828 "description": "Details pertaining to mail holds. If set, co rpus must be mail." 706 "description": "Details pertaining to mail holds. If set, co rpus must be mail."
707 },
708 "driveQuery": {
709 "$ref": "HeldDriveQuery",
710 "description": "Details pertaining to Drive holds. If set, c orpus must be Drive."
829 } 711 }
830 }, 712 },
831 "type": "object" 713 "type": "object"
832 }, 714 },
833 "Hold": { 715 "Hold": {
834 "description": "Represents a hold within Vault. A hold restricts pur ging of\nartifacts based on the combination of the query and accounts restrictio ns.\nA hold can be configured to either apply to an explicitly configured set\no f accounts, or can be applied to all members of an organizational unit.", 716 "description": "Represents a hold within Vault. A hold restricts pur ging of\nartifacts based on the combination of the query and accounts restrictio ns.\nA hold can be configured to either apply to an explicitly configured set\no f accounts, or can be applied to all members of an organizational unit.",
835 "id": "Hold", 717 "id": "Hold",
836 "properties": { 718 "properties": {
837 "accounts": { 719 "accounts": {
838 "description": "If set, the hold applies to the enumerated a ccounts and org_unit must be\nempty.", 720 "description": "If set, the hold applies to the enumerated a ccounts and org_unit must be\nempty.",
839 "items": { 721 "items": {
840 "$ref": "HeldAccount" 722 "$ref": "HeldAccount"
841 }, 723 },
842 "type": "array" 724 "type": "array"
843 }, 725 },
726 "orgUnit": {
727 "$ref": "HeldOrgUnit",
728 "description": "If set, the hold applies to all members of t he organizational unit and\naccounts must be empty. This property is mutable. Fo r groups holds,\nset the accounts field."
729 },
844 "query": { 730 "query": {
845 "$ref": "CorpusQuery", 731 "$ref": "CorpusQuery",
846 "description": "The corpus-specific query. If set, the corpu sQuery must match corpus\ntype." 732 "description": "The corpus-specific query. If set, the corpu sQuery must match corpus\ntype."
847 }, 733 },
848 "orgUnit": {
849 "$ref": "HeldOrgUnit",
850 "description": "If set, the hold applies to all members of t he organizational unit and\naccounts must be empty. This property is mutable. Fo r groups holds,\nset the accounts field."
851 },
852 "corpus": { 734 "corpus": {
853 "description": "The corpus to be searched.", 735 "description": "The corpus to be searched.",
854 "enum": [ 736 "enum": [
855 "CORPUS_TYPE_UNSPECIFIED", 737 "CORPUS_TYPE_UNSPECIFIED",
856 "DRIVE", 738 "DRIVE",
857 "MAIL", 739 "MAIL",
858 "GROUPS" 740 "GROUPS"
859 ], 741 ],
860 "enumDescriptions": [ 742 "enumDescriptions": [
861 "No corpus specified.", 743 "No corpus specified.",
862 "Drive.", 744 "Drive.",
863 "Mail.", 745 "Mail.",
864 "Groups." 746 "Groups."
865 ], 747 ],
866 "type": "string" 748 "type": "string"
867 }, 749 },
868 "updateTime": { 750 "updateTime": {
869 "description": "The last time this hold was modified.", 751 "description": "The last time this hold was modified.",
870 "format": "google-datetime", 752 "format": "google-datetime",
871 "type": "string" 753 "type": "string"
872 }, 754 },
755 "name": {
756 "description": "The name of the hold.",
757 "type": "string"
758 },
873 "holdId": { 759 "holdId": {
874 "description": "The unique immutable ID of the hold. Assigne d during creation.", 760 "description": "The unique immutable ID of the hold. Assigne d during creation.",
875 "type": "string" 761 "type": "string"
876 },
877 "name": {
878 "description": "The name of the hold.",
879 "type": "string"
880 } 762 }
881 }, 763 },
882 "type": "object" 764 "type": "object"
883 }, 765 },
884 "ListHoldsResponse": { 766 "ListHoldsResponse": {
885 "description": "The holds for a matter.", 767 "description": "The holds for a matter.",
886 "id": "ListHoldsResponse", 768 "id": "ListHoldsResponse",
887 "properties": { 769 "properties": {
888 "nextPageToken": { 770 "nextPageToken": {
889 "description": "Page token to retrieve the next page of resu lts in the list.\nIf this is empty, then there are no more holds to list.", 771 "description": "Page token to retrieve the next page of resu lts in the list.\nIf this is empty, then there are no more holds to list.",
(...skipping 28 matching lines...) Expand all
918 } 800 }
919 }, 801 },
920 "type": "object" 802 "type": "object"
921 }, 803 },
922 "Empty": { 804 "Empty": {
923 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", 805 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
924 "id": "Empty", 806 "id": "Empty",
925 "properties": {}, 807 "properties": {},
926 "type": "object" 808 "type": "object"
927 }, 809 },
810 "ReopenMatterRequest": {
811 "description": "Reopen a matter by ID.",
812 "id": "ReopenMatterRequest",
813 "properties": {},
814 "type": "object"
815 },
928 "CloseMatterRequest": { 816 "CloseMatterRequest": {
929 "description": "Close a matter by ID.", 817 "description": "Close a matter by ID.",
930 "id": "CloseMatterRequest", 818 "id": "CloseMatterRequest",
931 "properties": {}, 819 "properties": {},
932 "type": "object" 820 "type": "object"
933 }, 821 },
934 "ReopenMatterRequest": { 822 "RemoveMatterPermissionsRequest": {
935 "description": "Reopen a matter by ID.", 823 "description": "Remove an account as a matter collaborator.",
936 "id": "ReopenMatterRequest", 824 "id": "RemoveMatterPermissionsRequest",
937 "properties": {}, 825 "properties": {
826 "accountId": {
827 "description": "The account ID.",
828 "type": "string"
829 }
830 },
831 "type": "object"
832 },
833 "MatterPermission": {
834 "description": "Currently each matter only has one owner, and all ot hers are collaborators.\nWhen an account is purged, its corresponding MatterPerm ission resources\ncease to exist.",
835 "id": "MatterPermission",
836 "properties": {
837 "role": {
838 "description": "The user's role in this matter.",
839 "enum": [
840 "ROLE_UNSPECIFIED",
841 "COLLABORATOR",
842 "OWNER"
843 ],
844 "enumDescriptions": [
845 "No role assigned.",
846 "A collaborator to the matter.",
847 "The owner of the matter."
848 ],
849 "type": "string"
850 },
851 "accountId": {
852 "description": "The account id, as provided by <a href=\"htt ps://developers.google.com/admin-sdk/\">Admin SDK</a>.",
853 "type": "string"
854 }
855 },
856 "type": "object"
857 },
858 "ListMattersResponse": {
859 "description": "Provides the list of matters.",
860 "id": "ListMattersResponse",
861 "properties": {
862 "matters": {
863 "description": "List of matters.",
864 "items": {
865 "$ref": "Matter"
866 },
867 "type": "array"
868 },
869 "nextPageToken": {
870 "description": "Page token to retrieve the next page of resu lts in the list.",
871 "type": "string"
872 }
873 },
874 "type": "object"
875 },
876 "HeldMailQuery": {
877 "description": "Query options for mail holds.",
878 "id": "HeldMailQuery",
879 "properties": {
880 "endTime": {
881 "description": "The end date range for the search query. The se timestamps are in GMT and\nrounded down to the start of the given date.",
882 "format": "google-datetime",
883 "type": "string"
884 },
885 "startTime": {
886 "description": "The start date range for the search query. T hese timestamps are in GMT and\nrounded down to the start of the given date.",
887 "format": "google-datetime",
888 "type": "string"
889 },
890 "terms": {
891 "description": "The search terms for the hold.",
892 "type": "string"
893 }
894 },
895 "type": "object"
896 },
897 "CloseMatterResponse": {
898 "description": "Response to a CloseMatterRequest.",
899 "id": "CloseMatterResponse",
900 "properties": {
901 "matter": {
902 "$ref": "Matter",
903 "description": "The updated matter, with state CLOSED."
904 }
905 },
906 "type": "object"
907 },
908 "HeldGroupsQuery": {
909 "description": "Query options for group holds.",
910 "id": "HeldGroupsQuery",
911 "properties": {
912 "endTime": {
913 "description": "The end date range for the search query. The se timestamps are in GMT and\nrounded down to the start of the given date.",
914 "format": "google-datetime",
915 "type": "string"
916 },
917 "startTime": {
918 "description": "The start date range for the search query. T hese timestamps are in GMT and\nrounded down to the start of the given date.",
919 "format": "google-datetime",
920 "type": "string"
921 },
922 "terms": {
923 "description": "The search terms for the hold.",
924 "type": "string"
925 }
926 },
927 "type": "object"
928 },
929 "HeldDriveQuery": {
930 "description": "Query options for drive holds.",
931 "id": "HeldDriveQuery",
932 "properties": {
933 "includeTeamDriveFiles": {
934 "description": "If true, include files in Team Drives in the hold.",
935 "type": "boolean"
936 }
937 },
938 "type": "object" 938 "type": "object"
939 } 939 }
940 }, 940 },
941 "servicePath": "", 941 "servicePath": "",
942 "title": "Google Vault API", 942 "title": "Google Vault API",
943 "version": "v1" 943 "version": "v1"
944 } 944 }
OLDNEW
« no previous file with comments | « discovery/googleapis/urlshortener__v1.json ('k') | discovery/googleapis/vision__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698