Merge branch '21934-python36-compat'
[arvados.git] / sdk / python / arvados-v1-discovery.json
1 {
2   "auth": {
3     "oauth2": {
4       "scopes": {
5         "https://api.arvados.org/auth/arvados": {
6           "description": "View and manage objects"
7         },
8         "https://api.arvados.org/auth/arvados.readonly": {
9           "description": "View objects"
10         }
11       }
12     }
13   },
14   "basePath": "/arvados/v1/",
15   "batchPath": "batch",
16   "description": "The API to interact with Arvados.",
17   "discoveryVersion": "v1",
18   "documentationLink": "http://doc.arvados.org/api/index.html",
19   "id": "arvados:v1",
20   "kind": "discovery#restDescription",
21   "name": "arvados",
22   "parameters": {
23     "alt": {
24       "type": "string",
25       "description": "Data format for the response.",
26       "default": "json",
27       "enum": [
28         "json"
29       ],
30       "enumDescriptions": [
31         "Responses with Content-Type of application/json"
32       ],
33       "location": "query"
34     },
35     "fields": {
36       "type": "string",
37       "description": "Selector specifying which fields to include in a partial response.",
38       "location": "query"
39     },
40     "key": {
41       "type": "string",
42       "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
43       "location": "query"
44     },
45     "oauth_token": {
46       "type": "string",
47       "description": "OAuth 2.0 token for the current user.",
48       "location": "query"
49     }
50   },
51   "protocol": "rest",
52   "resources": {
53     "api_clients": {
54       "methods": {
55         "get": {
56           "id": "arvados.api_clients.get",
57           "path": "api_clients/{uuid}",
58           "httpMethod": "GET",
59           "description": "Gets a ApiClient's metadata by UUID.",
60           "parameters": {
61             "uuid": {
62               "type": "string",
63               "description": "The UUID of the ApiClient in question.",
64               "required": true,
65               "location": "path"
66             },
67             "select": {
68               "type": "array",
69               "description": "Attributes of the object to return in the response.",
70               "required": false,
71               "location": "query"
72             }
73           },
74           "parameterOrder": [
75             "uuid"
76           ],
77           "response": {
78             "$ref": "ApiClient"
79           },
80           "scopes": [
81             "https://api.arvados.org/auth/arvados",
82             "https://api.arvados.org/auth/arvados.readonly"
83           ]
84         },
85         "list": {
86           "id": "arvados.api_clients.list",
87           "path": "api_clients",
88           "httpMethod": "GET",
89           "description": "List ApiClients.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching ApiClients. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#apiClientList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
90           "parameters": {
91             "filters": {
92               "type": "array",
93               "required": false,
94               "description": "",
95               "location": "query"
96             },
97             "where": {
98               "type": "object",
99               "required": false,
100               "description": "",
101               "location": "query"
102             },
103             "order": {
104               "type": "array",
105               "required": false,
106               "description": "",
107               "location": "query"
108             },
109             "select": {
110               "type": "array",
111               "description": "Attributes of each object to return in the response.",
112               "required": false,
113               "location": "query"
114             },
115             "distinct": {
116               "type": "boolean",
117               "required": false,
118               "default": "false",
119               "description": "",
120               "location": "query"
121             },
122             "limit": {
123               "type": "integer",
124               "required": false,
125               "default": "100",
126               "description": "",
127               "location": "query"
128             },
129             "offset": {
130               "type": "integer",
131               "required": false,
132               "default": "0",
133               "description": "",
134               "location": "query"
135             },
136             "count": {
137               "type": "string",
138               "required": false,
139               "default": "exact",
140               "description": "",
141               "location": "query"
142             },
143             "cluster_id": {
144               "type": "string",
145               "description": "List objects on a remote federated cluster instead of the current one.",
146               "location": "query",
147               "required": false
148             },
149             "bypass_federation": {
150               "type": "boolean",
151               "required": false,
152               "description": "bypass federation behavior, list items from local instance database only",
153               "location": "query"
154             }
155           },
156           "response": {
157             "$ref": "ApiClientList"
158           },
159           "scopes": [
160             "https://api.arvados.org/auth/arvados",
161             "https://api.arvados.org/auth/arvados.readonly"
162           ]
163         },
164         "create": {
165           "id": "arvados.api_clients.create",
166           "path": "api_clients",
167           "httpMethod": "POST",
168           "description": "Create a new ApiClient.",
169           "parameters": {
170             "select": {
171               "type": "array",
172               "description": "Attributes of the new object to return in the response.",
173               "required": false,
174               "location": "query"
175             },
176             "ensure_unique_name": {
177               "type": "boolean",
178               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
179               "location": "query",
180               "required": false,
181               "default": "false"
182             },
183             "cluster_id": {
184               "type": "string",
185               "description": "Create object on a remote federated cluster instead of the current one.",
186               "location": "query",
187               "required": false
188             }
189           },
190           "request": {
191             "required": true,
192             "properties": {
193               "api_client": {
194                 "$ref": "ApiClient"
195               }
196             }
197           },
198           "response": {
199             "$ref": "ApiClient"
200           },
201           "scopes": [
202             "https://api.arvados.org/auth/arvados"
203           ]
204         },
205         "update": {
206           "id": "arvados.api_clients.update",
207           "path": "api_clients/{uuid}",
208           "httpMethod": "PUT",
209           "description": "Update attributes of an existing ApiClient.",
210           "parameters": {
211             "uuid": {
212               "type": "string",
213               "description": "The UUID of the ApiClient in question.",
214               "required": true,
215               "location": "path"
216             },
217             "select": {
218               "type": "array",
219               "description": "Attributes of the updated object to return in the response.",
220               "required": false,
221               "location": "query"
222             }
223           },
224           "request": {
225             "required": true,
226             "properties": {
227               "api_client": {
228                 "$ref": "ApiClient"
229               }
230             }
231           },
232           "response": {
233             "$ref": "ApiClient"
234           },
235           "scopes": [
236             "https://api.arvados.org/auth/arvados"
237           ]
238         },
239         "delete": {
240           "id": "arvados.api_clients.delete",
241           "path": "api_clients/{uuid}",
242           "httpMethod": "DELETE",
243           "description": "Delete an existing ApiClient.",
244           "parameters": {
245             "uuid": {
246               "type": "string",
247               "description": "The UUID of the ApiClient in question.",
248               "required": true,
249               "location": "path"
250             }
251           },
252           "response": {
253             "$ref": "ApiClient"
254           },
255           "scopes": [
256             "https://api.arvados.org/auth/arvados"
257           ]
258         }
259       }
260     },
261     "api_client_authorizations": {
262       "methods": {
263         "get": {
264           "id": "arvados.api_client_authorizations.get",
265           "path": "api_client_authorizations/{uuid}",
266           "httpMethod": "GET",
267           "description": "Gets a ApiClientAuthorization's metadata by UUID.",
268           "parameters": {
269             "uuid": {
270               "type": "string",
271               "description": "The UUID of the ApiClientAuthorization in question.",
272               "required": true,
273               "location": "path"
274             },
275             "select": {
276               "type": "array",
277               "description": "Attributes of the object to return in the response.",
278               "required": false,
279               "location": "query"
280             }
281           },
282           "parameterOrder": [
283             "uuid"
284           ],
285           "response": {
286             "$ref": "ApiClientAuthorization"
287           },
288           "scopes": [
289             "https://api.arvados.org/auth/arvados",
290             "https://api.arvados.org/auth/arvados.readonly"
291           ]
292         },
293         "list": {
294           "id": "arvados.api_client_authorizations.list",
295           "path": "api_client_authorizations",
296           "httpMethod": "GET",
297           "description": "List ApiClientAuthorizations.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching ApiClientAuthorizations. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#apiClientAuthorizationList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
298           "parameters": {
299             "filters": {
300               "type": "array",
301               "required": false,
302               "description": "",
303               "location": "query"
304             },
305             "where": {
306               "type": "object",
307               "required": false,
308               "description": "",
309               "location": "query"
310             },
311             "order": {
312               "type": "array",
313               "required": false,
314               "description": "",
315               "location": "query"
316             },
317             "select": {
318               "type": "array",
319               "description": "Attributes of each object to return in the response.",
320               "required": false,
321               "location": "query"
322             },
323             "distinct": {
324               "type": "boolean",
325               "required": false,
326               "default": "false",
327               "description": "",
328               "location": "query"
329             },
330             "limit": {
331               "type": "integer",
332               "required": false,
333               "default": "100",
334               "description": "",
335               "location": "query"
336             },
337             "offset": {
338               "type": "integer",
339               "required": false,
340               "default": "0",
341               "description": "",
342               "location": "query"
343             },
344             "count": {
345               "type": "string",
346               "required": false,
347               "default": "exact",
348               "description": "",
349               "location": "query"
350             },
351             "cluster_id": {
352               "type": "string",
353               "description": "List objects on a remote federated cluster instead of the current one.",
354               "location": "query",
355               "required": false
356             },
357             "bypass_federation": {
358               "type": "boolean",
359               "required": false,
360               "description": "bypass federation behavior, list items from local instance database only",
361               "location": "query"
362             }
363           },
364           "response": {
365             "$ref": "ApiClientAuthorizationList"
366           },
367           "scopes": [
368             "https://api.arvados.org/auth/arvados",
369             "https://api.arvados.org/auth/arvados.readonly"
370           ]
371         },
372         "create": {
373           "id": "arvados.api_client_authorizations.create",
374           "path": "api_client_authorizations",
375           "httpMethod": "POST",
376           "description": "Create a new ApiClientAuthorization.",
377           "parameters": {
378             "select": {
379               "type": "array",
380               "description": "Attributes of the new object to return in the response.",
381               "required": false,
382               "location": "query"
383             },
384             "ensure_unique_name": {
385               "type": "boolean",
386               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
387               "location": "query",
388               "required": false,
389               "default": "false"
390             },
391             "cluster_id": {
392               "type": "string",
393               "description": "Create object on a remote federated cluster instead of the current one.",
394               "location": "query",
395               "required": false
396             }
397           },
398           "request": {
399             "required": true,
400             "properties": {
401               "api_client_authorization": {
402                 "$ref": "ApiClientAuthorization"
403               }
404             }
405           },
406           "response": {
407             "$ref": "ApiClientAuthorization"
408           },
409           "scopes": [
410             "https://api.arvados.org/auth/arvados"
411           ]
412         },
413         "update": {
414           "id": "arvados.api_client_authorizations.update",
415           "path": "api_client_authorizations/{uuid}",
416           "httpMethod": "PUT",
417           "description": "Update attributes of an existing ApiClientAuthorization.",
418           "parameters": {
419             "uuid": {
420               "type": "string",
421               "description": "The UUID of the ApiClientAuthorization in question.",
422               "required": true,
423               "location": "path"
424             },
425             "select": {
426               "type": "array",
427               "description": "Attributes of the updated object to return in the response.",
428               "required": false,
429               "location": "query"
430             }
431           },
432           "request": {
433             "required": true,
434             "properties": {
435               "api_client_authorization": {
436                 "$ref": "ApiClientAuthorization"
437               }
438             }
439           },
440           "response": {
441             "$ref": "ApiClientAuthorization"
442           },
443           "scopes": [
444             "https://api.arvados.org/auth/arvados"
445           ]
446         },
447         "delete": {
448           "id": "arvados.api_client_authorizations.delete",
449           "path": "api_client_authorizations/{uuid}",
450           "httpMethod": "DELETE",
451           "description": "Delete an existing ApiClientAuthorization.",
452           "parameters": {
453             "uuid": {
454               "type": "string",
455               "description": "The UUID of the ApiClientAuthorization in question.",
456               "required": true,
457               "location": "path"
458             }
459           },
460           "response": {
461             "$ref": "ApiClientAuthorization"
462           },
463           "scopes": [
464             "https://api.arvados.org/auth/arvados"
465           ]
466         },
467         "create_system_auth": {
468           "id": "arvados.api_client_authorizations.create_system_auth",
469           "path": "api_client_authorizations/create_system_auth",
470           "httpMethod": "POST",
471           "description": "create_system_auth api_client_authorizations",
472           "parameters": {
473             "api_client_id": {
474               "type": "integer",
475               "required": false,
476               "description": "",
477               "location": "query"
478             },
479             "scopes": {
480               "type": "array",
481               "required": false,
482               "description": "",
483               "location": "query"
484             }
485           },
486           "response": {
487             "$ref": "ApiClientAuthorization"
488           },
489           "scopes": [
490             "https://api.arvados.org/auth/arvados"
491           ]
492         },
493         "current": {
494           "id": "arvados.api_client_authorizations.current",
495           "path": "api_client_authorizations/current",
496           "httpMethod": "GET",
497           "description": "current api_client_authorizations",
498           "parameters": {},
499           "response": {
500             "$ref": "ApiClientAuthorization"
501           },
502           "scopes": [
503             "https://api.arvados.org/auth/arvados"
504           ]
505         }
506       }
507     },
508     "authorized_keys": {
509       "methods": {
510         "get": {
511           "id": "arvados.authorized_keys.get",
512           "path": "authorized_keys/{uuid}",
513           "httpMethod": "GET",
514           "description": "Gets a AuthorizedKey's metadata by UUID.",
515           "parameters": {
516             "uuid": {
517               "type": "string",
518               "description": "The UUID of the AuthorizedKey in question.",
519               "required": true,
520               "location": "path"
521             },
522             "select": {
523               "type": "array",
524               "description": "Attributes of the object to return in the response.",
525               "required": false,
526               "location": "query"
527             }
528           },
529           "parameterOrder": [
530             "uuid"
531           ],
532           "response": {
533             "$ref": "AuthorizedKey"
534           },
535           "scopes": [
536             "https://api.arvados.org/auth/arvados",
537             "https://api.arvados.org/auth/arvados.readonly"
538           ]
539         },
540         "list": {
541           "id": "arvados.authorized_keys.list",
542           "path": "authorized_keys",
543           "httpMethod": "GET",
544           "description": "List AuthorizedKeys.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching AuthorizedKeys. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#authorizedKeyList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
545           "parameters": {
546             "filters": {
547               "type": "array",
548               "required": false,
549               "description": "",
550               "location": "query"
551             },
552             "where": {
553               "type": "object",
554               "required": false,
555               "description": "",
556               "location": "query"
557             },
558             "order": {
559               "type": "array",
560               "required": false,
561               "description": "",
562               "location": "query"
563             },
564             "select": {
565               "type": "array",
566               "description": "Attributes of each object to return in the response.",
567               "required": false,
568               "location": "query"
569             },
570             "distinct": {
571               "type": "boolean",
572               "required": false,
573               "default": "false",
574               "description": "",
575               "location": "query"
576             },
577             "limit": {
578               "type": "integer",
579               "required": false,
580               "default": "100",
581               "description": "",
582               "location": "query"
583             },
584             "offset": {
585               "type": "integer",
586               "required": false,
587               "default": "0",
588               "description": "",
589               "location": "query"
590             },
591             "count": {
592               "type": "string",
593               "required": false,
594               "default": "exact",
595               "description": "",
596               "location": "query"
597             },
598             "cluster_id": {
599               "type": "string",
600               "description": "List objects on a remote federated cluster instead of the current one.",
601               "location": "query",
602               "required": false
603             },
604             "bypass_federation": {
605               "type": "boolean",
606               "required": false,
607               "description": "bypass federation behavior, list items from local instance database only",
608               "location": "query"
609             }
610           },
611           "response": {
612             "$ref": "AuthorizedKeyList"
613           },
614           "scopes": [
615             "https://api.arvados.org/auth/arvados",
616             "https://api.arvados.org/auth/arvados.readonly"
617           ]
618         },
619         "create": {
620           "id": "arvados.authorized_keys.create",
621           "path": "authorized_keys",
622           "httpMethod": "POST",
623           "description": "Create a new AuthorizedKey.",
624           "parameters": {
625             "select": {
626               "type": "array",
627               "description": "Attributes of the new object to return in the response.",
628               "required": false,
629               "location": "query"
630             },
631             "ensure_unique_name": {
632               "type": "boolean",
633               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
634               "location": "query",
635               "required": false,
636               "default": "false"
637             },
638             "cluster_id": {
639               "type": "string",
640               "description": "Create object on a remote federated cluster instead of the current one.",
641               "location": "query",
642               "required": false
643             }
644           },
645           "request": {
646             "required": true,
647             "properties": {
648               "authorized_key": {
649                 "$ref": "AuthorizedKey"
650               }
651             }
652           },
653           "response": {
654             "$ref": "AuthorizedKey"
655           },
656           "scopes": [
657             "https://api.arvados.org/auth/arvados"
658           ]
659         },
660         "update": {
661           "id": "arvados.authorized_keys.update",
662           "path": "authorized_keys/{uuid}",
663           "httpMethod": "PUT",
664           "description": "Update attributes of an existing AuthorizedKey.",
665           "parameters": {
666             "uuid": {
667               "type": "string",
668               "description": "The UUID of the AuthorizedKey in question.",
669               "required": true,
670               "location": "path"
671             },
672             "select": {
673               "type": "array",
674               "description": "Attributes of the updated object to return in the response.",
675               "required": false,
676               "location": "query"
677             }
678           },
679           "request": {
680             "required": true,
681             "properties": {
682               "authorized_key": {
683                 "$ref": "AuthorizedKey"
684               }
685             }
686           },
687           "response": {
688             "$ref": "AuthorizedKey"
689           },
690           "scopes": [
691             "https://api.arvados.org/auth/arvados"
692           ]
693         },
694         "delete": {
695           "id": "arvados.authorized_keys.delete",
696           "path": "authorized_keys/{uuid}",
697           "httpMethod": "DELETE",
698           "description": "Delete an existing AuthorizedKey.",
699           "parameters": {
700             "uuid": {
701               "type": "string",
702               "description": "The UUID of the AuthorizedKey in question.",
703               "required": true,
704               "location": "path"
705             }
706           },
707           "response": {
708             "$ref": "AuthorizedKey"
709           },
710           "scopes": [
711             "https://api.arvados.org/auth/arvados"
712           ]
713         }
714       }
715     },
716     "collections": {
717       "methods": {
718         "get": {
719           "id": "arvados.collections.get",
720           "path": "collections/{uuid}",
721           "httpMethod": "GET",
722           "description": "Gets a Collection's metadata by UUID.",
723           "parameters": {
724             "uuid": {
725               "type": "string",
726               "description": "The UUID of the Collection in question.",
727               "required": true,
728               "location": "path"
729             },
730             "select": {
731               "type": "array",
732               "description": "Attributes of the object to return in the response.",
733               "required": false,
734               "location": "query"
735             },
736             "include_trash": {
737               "type": "boolean",
738               "required": false,
739               "default": "false",
740               "description": "Show collection even if its is_trashed attribute is true.",
741               "location": "query"
742             },
743             "include_old_versions": {
744               "type": "boolean",
745               "required": false,
746               "default": "true",
747               "description": "Include past collection versions.",
748               "location": "query"
749             }
750           },
751           "parameterOrder": [
752             "uuid"
753           ],
754           "response": {
755             "$ref": "Collection"
756           },
757           "scopes": [
758             "https://api.arvados.org/auth/arvados",
759             "https://api.arvados.org/auth/arvados.readonly"
760           ]
761         },
762         "list": {
763           "id": "arvados.collections.list",
764           "path": "collections",
765           "httpMethod": "GET",
766           "description": "List Collections.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Collections. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#collectionList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
767           "parameters": {
768             "filters": {
769               "type": "array",
770               "required": false,
771               "description": "",
772               "location": "query"
773             },
774             "where": {
775               "type": "object",
776               "required": false,
777               "description": "",
778               "location": "query"
779             },
780             "order": {
781               "type": "array",
782               "required": false,
783               "description": "",
784               "location": "query"
785             },
786             "select": {
787               "type": "array",
788               "description": "Attributes of each object to return in the response.",
789               "required": false,
790               "location": "query"
791             },
792             "distinct": {
793               "type": "boolean",
794               "required": false,
795               "default": "false",
796               "description": "",
797               "location": "query"
798             },
799             "limit": {
800               "type": "integer",
801               "required": false,
802               "default": "100",
803               "description": "",
804               "location": "query"
805             },
806             "offset": {
807               "type": "integer",
808               "required": false,
809               "default": "0",
810               "description": "",
811               "location": "query"
812             },
813             "count": {
814               "type": "string",
815               "required": false,
816               "default": "exact",
817               "description": "",
818               "location": "query"
819             },
820             "cluster_id": {
821               "type": "string",
822               "description": "List objects on a remote federated cluster instead of the current one.",
823               "location": "query",
824               "required": false
825             },
826             "bypass_federation": {
827               "type": "boolean",
828               "required": false,
829               "description": "bypass federation behavior, list items from local instance database only",
830               "location": "query"
831             },
832             "include_trash": {
833               "type": "boolean",
834               "required": false,
835               "default": "false",
836               "description": "Include collections whose is_trashed attribute is true.",
837               "location": "query"
838             },
839             "include_old_versions": {
840               "type": "boolean",
841               "required": false,
842               "default": "false",
843               "description": "Include past collection versions.",
844               "location": "query"
845             }
846           },
847           "response": {
848             "$ref": "CollectionList"
849           },
850           "scopes": [
851             "https://api.arvados.org/auth/arvados",
852             "https://api.arvados.org/auth/arvados.readonly"
853           ]
854         },
855         "create": {
856           "id": "arvados.collections.create",
857           "path": "collections",
858           "httpMethod": "POST",
859           "description": "Create a new Collection.",
860           "parameters": {
861             "select": {
862               "type": "array",
863               "description": "Attributes of the new object to return in the response.",
864               "required": false,
865               "location": "query"
866             },
867             "ensure_unique_name": {
868               "type": "boolean",
869               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
870               "location": "query",
871               "required": false,
872               "default": "false"
873             },
874             "cluster_id": {
875               "type": "string",
876               "description": "Create object on a remote federated cluster instead of the current one.",
877               "location": "query",
878               "required": false
879             },
880             "replace_files": {
881               "type": "object",
882               "description": "Files and directories to initialize/replace with content from other collections.",
883               "required": false,
884               "location": "query",
885               "properties": {},
886               "additionalProperties": {
887                 "type": "string"
888               }
889             }
890           },
891           "request": {
892             "required": true,
893             "properties": {
894               "collection": {
895                 "$ref": "Collection"
896               }
897             }
898           },
899           "response": {
900             "$ref": "Collection"
901           },
902           "scopes": [
903             "https://api.arvados.org/auth/arvados"
904           ]
905         },
906         "update": {
907           "id": "arvados.collections.update",
908           "path": "collections/{uuid}",
909           "httpMethod": "PUT",
910           "description": "Update attributes of an existing Collection.",
911           "parameters": {
912             "uuid": {
913               "type": "string",
914               "description": "The UUID of the Collection in question.",
915               "required": true,
916               "location": "path"
917             },
918             "select": {
919               "type": "array",
920               "description": "Attributes of the updated object to return in the response.",
921               "required": false,
922               "location": "query"
923             },
924             "replace_files": {
925               "type": "object",
926               "description": "Files and directories to initialize/replace with content from other collections.",
927               "required": false,
928               "location": "query",
929               "properties": {},
930               "additionalProperties": {
931                 "type": "string"
932               }
933             }
934           },
935           "request": {
936             "required": true,
937             "properties": {
938               "collection": {
939                 "$ref": "Collection"
940               }
941             }
942           },
943           "response": {
944             "$ref": "Collection"
945           },
946           "scopes": [
947             "https://api.arvados.org/auth/arvados"
948           ]
949         },
950         "delete": {
951           "id": "arvados.collections.delete",
952           "path": "collections/{uuid}",
953           "httpMethod": "DELETE",
954           "description": "Delete an existing Collection.",
955           "parameters": {
956             "uuid": {
957               "type": "string",
958               "description": "The UUID of the Collection in question.",
959               "required": true,
960               "location": "path"
961             }
962           },
963           "response": {
964             "$ref": "Collection"
965           },
966           "scopes": [
967             "https://api.arvados.org/auth/arvados"
968           ]
969         },
970         "provenance": {
971           "id": "arvados.collections.provenance",
972           "path": "collections/{uuid}/provenance",
973           "httpMethod": "GET",
974           "description": "provenance collections",
975           "parameters": {
976             "uuid": {
977               "type": "string",
978               "description": "",
979               "required": true,
980               "location": "path"
981             }
982           },
983           "response": {
984             "$ref": "Collection"
985           },
986           "scopes": [
987             "https://api.arvados.org/auth/arvados"
988           ]
989         },
990         "used_by": {
991           "id": "arvados.collections.used_by",
992           "path": "collections/{uuid}/used_by",
993           "httpMethod": "GET",
994           "description": "used_by collections",
995           "parameters": {
996             "uuid": {
997               "type": "string",
998               "description": "",
999               "required": true,
1000               "location": "path"
1001             }
1002           },
1003           "response": {
1004             "$ref": "Collection"
1005           },
1006           "scopes": [
1007             "https://api.arvados.org/auth/arvados"
1008           ]
1009         },
1010         "trash": {
1011           "id": "arvados.collections.trash",
1012           "path": "collections/{uuid}/trash",
1013           "httpMethod": "POST",
1014           "description": "trash collections",
1015           "parameters": {
1016             "uuid": {
1017               "type": "string",
1018               "description": "",
1019               "required": true,
1020               "location": "path"
1021             }
1022           },
1023           "response": {
1024             "$ref": "Collection"
1025           },
1026           "scopes": [
1027             "https://api.arvados.org/auth/arvados"
1028           ]
1029         },
1030         "untrash": {
1031           "id": "arvados.collections.untrash",
1032           "path": "collections/{uuid}/untrash",
1033           "httpMethod": "POST",
1034           "description": "untrash collections",
1035           "parameters": {
1036             "uuid": {
1037               "type": "string",
1038               "description": "",
1039               "required": true,
1040               "location": "path"
1041             }
1042           },
1043           "response": {
1044             "$ref": "Collection"
1045           },
1046           "scopes": [
1047             "https://api.arvados.org/auth/arvados"
1048           ]
1049         }
1050       }
1051     },
1052     "computed_permissions": {
1053       "methods": {
1054         "list": {
1055           "id": "arvados.computed_permissions.list",
1056           "path": "computed_permissions",
1057           "httpMethod": "GET",
1058           "description": "List ComputedPermissions.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching ComputedPermissions. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#computedPermissionList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
1059           "parameters": {
1060             "filters": {
1061               "type": "array",
1062               "required": false,
1063               "description": "",
1064               "location": "query"
1065             },
1066             "where": {
1067               "type": "object",
1068               "required": false,
1069               "description": "",
1070               "location": "query"
1071             },
1072             "order": {
1073               "type": "array",
1074               "required": false,
1075               "description": "",
1076               "location": "query"
1077             },
1078             "select": {
1079               "type": "array",
1080               "description": "Attributes of each object to return in the response.",
1081               "required": false,
1082               "location": "query"
1083             },
1084             "distinct": {
1085               "type": "boolean",
1086               "required": false,
1087               "default": "false",
1088               "description": "",
1089               "location": "query"
1090             },
1091             "limit": {
1092               "type": "integer",
1093               "required": false,
1094               "default": "100",
1095               "description": "",
1096               "location": "query"
1097             },
1098             "count": {
1099               "type": "string",
1100               "required": false,
1101               "default": "exact",
1102               "description": "",
1103               "location": "query"
1104             }
1105           },
1106           "response": {
1107             "$ref": "ComputedPermissionList"
1108           },
1109           "scopes": [
1110             "https://api.arvados.org/auth/arvados",
1111             "https://api.arvados.org/auth/arvados.readonly"
1112           ]
1113         }
1114       }
1115     },
1116     "containers": {
1117       "methods": {
1118         "get": {
1119           "id": "arvados.containers.get",
1120           "path": "containers/{uuid}",
1121           "httpMethod": "GET",
1122           "description": "Gets a Container's metadata by UUID.",
1123           "parameters": {
1124             "uuid": {
1125               "type": "string",
1126               "description": "The UUID of the Container in question.",
1127               "required": true,
1128               "location": "path"
1129             },
1130             "select": {
1131               "type": "array",
1132               "description": "Attributes of the object to return in the response.",
1133               "required": false,
1134               "location": "query"
1135             }
1136           },
1137           "parameterOrder": [
1138             "uuid"
1139           ],
1140           "response": {
1141             "$ref": "Container"
1142           },
1143           "scopes": [
1144             "https://api.arvados.org/auth/arvados",
1145             "https://api.arvados.org/auth/arvados.readonly"
1146           ]
1147         },
1148         "list": {
1149           "id": "arvados.containers.list",
1150           "path": "containers",
1151           "httpMethod": "GET",
1152           "description": "List Containers.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Containers. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#containerList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
1153           "parameters": {
1154             "filters": {
1155               "type": "array",
1156               "required": false,
1157               "description": "",
1158               "location": "query"
1159             },
1160             "where": {
1161               "type": "object",
1162               "required": false,
1163               "description": "",
1164               "location": "query"
1165             },
1166             "order": {
1167               "type": "array",
1168               "required": false,
1169               "description": "",
1170               "location": "query"
1171             },
1172             "select": {
1173               "type": "array",
1174               "description": "Attributes of each object to return in the response.",
1175               "required": false,
1176               "location": "query"
1177             },
1178             "distinct": {
1179               "type": "boolean",
1180               "required": false,
1181               "default": "false",
1182               "description": "",
1183               "location": "query"
1184             },
1185             "limit": {
1186               "type": "integer",
1187               "required": false,
1188               "default": "100",
1189               "description": "",
1190               "location": "query"
1191             },
1192             "offset": {
1193               "type": "integer",
1194               "required": false,
1195               "default": "0",
1196               "description": "",
1197               "location": "query"
1198             },
1199             "count": {
1200               "type": "string",
1201               "required": false,
1202               "default": "exact",
1203               "description": "",
1204               "location": "query"
1205             },
1206             "cluster_id": {
1207               "type": "string",
1208               "description": "List objects on a remote federated cluster instead of the current one.",
1209               "location": "query",
1210               "required": false
1211             },
1212             "bypass_federation": {
1213               "type": "boolean",
1214               "required": false,
1215               "description": "bypass federation behavior, list items from local instance database only",
1216               "location": "query"
1217             }
1218           },
1219           "response": {
1220             "$ref": "ContainerList"
1221           },
1222           "scopes": [
1223             "https://api.arvados.org/auth/arvados",
1224             "https://api.arvados.org/auth/arvados.readonly"
1225           ]
1226         },
1227         "create": {
1228           "id": "arvados.containers.create",
1229           "path": "containers",
1230           "httpMethod": "POST",
1231           "description": "Create a new Container.",
1232           "parameters": {
1233             "select": {
1234               "type": "array",
1235               "description": "Attributes of the new object to return in the response.",
1236               "required": false,
1237               "location": "query"
1238             },
1239             "ensure_unique_name": {
1240               "type": "boolean",
1241               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
1242               "location": "query",
1243               "required": false,
1244               "default": "false"
1245             },
1246             "cluster_id": {
1247               "type": "string",
1248               "description": "Create object on a remote federated cluster instead of the current one.",
1249               "location": "query",
1250               "required": false
1251             }
1252           },
1253           "request": {
1254             "required": true,
1255             "properties": {
1256               "container": {
1257                 "$ref": "Container"
1258               }
1259             }
1260           },
1261           "response": {
1262             "$ref": "Container"
1263           },
1264           "scopes": [
1265             "https://api.arvados.org/auth/arvados"
1266           ]
1267         },
1268         "update": {
1269           "id": "arvados.containers.update",
1270           "path": "containers/{uuid}",
1271           "httpMethod": "PUT",
1272           "description": "Update attributes of an existing Container.",
1273           "parameters": {
1274             "uuid": {
1275               "type": "string",
1276               "description": "The UUID of the Container in question.",
1277               "required": true,
1278               "location": "path"
1279             },
1280             "select": {
1281               "type": "array",
1282               "description": "Attributes of the updated object to return in the response.",
1283               "required": false,
1284               "location": "query"
1285             }
1286           },
1287           "request": {
1288             "required": true,
1289             "properties": {
1290               "container": {
1291                 "$ref": "Container"
1292               }
1293             }
1294           },
1295           "response": {
1296             "$ref": "Container"
1297           },
1298           "scopes": [
1299             "https://api.arvados.org/auth/arvados"
1300           ]
1301         },
1302         "delete": {
1303           "id": "arvados.containers.delete",
1304           "path": "containers/{uuid}",
1305           "httpMethod": "DELETE",
1306           "description": "Delete an existing Container.",
1307           "parameters": {
1308             "uuid": {
1309               "type": "string",
1310               "description": "The UUID of the Container in question.",
1311               "required": true,
1312               "location": "path"
1313             }
1314           },
1315           "response": {
1316             "$ref": "Container"
1317           },
1318           "scopes": [
1319             "https://api.arvados.org/auth/arvados"
1320           ]
1321         },
1322         "auth": {
1323           "id": "arvados.containers.auth",
1324           "path": "containers/{uuid}/auth",
1325           "httpMethod": "GET",
1326           "description": "auth containers",
1327           "parameters": {
1328             "uuid": {
1329               "type": "string",
1330               "description": "",
1331               "required": true,
1332               "location": "path"
1333             }
1334           },
1335           "response": {
1336             "$ref": "Container"
1337           },
1338           "scopes": [
1339             "https://api.arvados.org/auth/arvados"
1340           ]
1341         },
1342         "lock": {
1343           "id": "arvados.containers.lock",
1344           "path": "containers/{uuid}/lock",
1345           "httpMethod": "POST",
1346           "description": "lock containers",
1347           "parameters": {
1348             "uuid": {
1349               "type": "string",
1350               "description": "",
1351               "required": true,
1352               "location": "path"
1353             }
1354           },
1355           "response": {
1356             "$ref": "Container"
1357           },
1358           "scopes": [
1359             "https://api.arvados.org/auth/arvados"
1360           ]
1361         },
1362         "unlock": {
1363           "id": "arvados.containers.unlock",
1364           "path": "containers/{uuid}/unlock",
1365           "httpMethod": "POST",
1366           "description": "unlock containers",
1367           "parameters": {
1368             "uuid": {
1369               "type": "string",
1370               "description": "",
1371               "required": true,
1372               "location": "path"
1373             }
1374           },
1375           "response": {
1376             "$ref": "Container"
1377           },
1378           "scopes": [
1379             "https://api.arvados.org/auth/arvados"
1380           ]
1381         },
1382         "update_priority": {
1383           "id": "arvados.containers.update_priority",
1384           "path": "containers/{uuid}/update_priority",
1385           "httpMethod": "POST",
1386           "description": "update_priority containers",
1387           "parameters": {
1388             "uuid": {
1389               "type": "string",
1390               "description": "",
1391               "required": true,
1392               "location": "path"
1393             }
1394           },
1395           "response": {
1396             "$ref": "Container"
1397           },
1398           "scopes": [
1399             "https://api.arvados.org/auth/arvados"
1400           ]
1401         },
1402         "secret_mounts": {
1403           "id": "arvados.containers.secret_mounts",
1404           "path": "containers/{uuid}/secret_mounts",
1405           "httpMethod": "GET",
1406           "description": "secret_mounts containers",
1407           "parameters": {
1408             "uuid": {
1409               "type": "string",
1410               "description": "",
1411               "required": true,
1412               "location": "path"
1413             }
1414           },
1415           "response": {
1416             "$ref": "Container"
1417           },
1418           "scopes": [
1419             "https://api.arvados.org/auth/arvados"
1420           ]
1421         },
1422         "current": {
1423           "id": "arvados.containers.current",
1424           "path": "containers/current",
1425           "httpMethod": "GET",
1426           "description": "current containers",
1427           "parameters": {},
1428           "response": {
1429             "$ref": "Container"
1430           },
1431           "scopes": [
1432             "https://api.arvados.org/auth/arvados"
1433           ]
1434         }
1435       }
1436     },
1437     "container_requests": {
1438       "methods": {
1439         "get": {
1440           "id": "arvados.container_requests.get",
1441           "path": "container_requests/{uuid}",
1442           "httpMethod": "GET",
1443           "description": "Gets a ContainerRequest's metadata by UUID.",
1444           "parameters": {
1445             "uuid": {
1446               "type": "string",
1447               "description": "The UUID of the ContainerRequest in question.",
1448               "required": true,
1449               "location": "path"
1450             },
1451             "select": {
1452               "type": "array",
1453               "description": "Attributes of the object to return in the response.",
1454               "required": false,
1455               "location": "query"
1456             },
1457             "include_trash": {
1458               "type": "boolean",
1459               "required": false,
1460               "default": "false",
1461               "description": "Show container request even if its owner project is trashed.",
1462               "location": "query"
1463             }
1464           },
1465           "parameterOrder": [
1466             "uuid"
1467           ],
1468           "response": {
1469             "$ref": "ContainerRequest"
1470           },
1471           "scopes": [
1472             "https://api.arvados.org/auth/arvados",
1473             "https://api.arvados.org/auth/arvados.readonly"
1474           ]
1475         },
1476         "list": {
1477           "id": "arvados.container_requests.list",
1478           "path": "container_requests",
1479           "httpMethod": "GET",
1480           "description": "List ContainerRequests.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching ContainerRequests. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#containerRequestList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
1481           "parameters": {
1482             "filters": {
1483               "type": "array",
1484               "required": false,
1485               "description": "",
1486               "location": "query"
1487             },
1488             "where": {
1489               "type": "object",
1490               "required": false,
1491               "description": "",
1492               "location": "query"
1493             },
1494             "order": {
1495               "type": "array",
1496               "required": false,
1497               "description": "",
1498               "location": "query"
1499             },
1500             "select": {
1501               "type": "array",
1502               "description": "Attributes of each object to return in the response.",
1503               "required": false,
1504               "location": "query"
1505             },
1506             "distinct": {
1507               "type": "boolean",
1508               "required": false,
1509               "default": "false",
1510               "description": "",
1511               "location": "query"
1512             },
1513             "limit": {
1514               "type": "integer",
1515               "required": false,
1516               "default": "100",
1517               "description": "",
1518               "location": "query"
1519             },
1520             "offset": {
1521               "type": "integer",
1522               "required": false,
1523               "default": "0",
1524               "description": "",
1525               "location": "query"
1526             },
1527             "count": {
1528               "type": "string",
1529               "required": false,
1530               "default": "exact",
1531               "description": "",
1532               "location": "query"
1533             },
1534             "cluster_id": {
1535               "type": "string",
1536               "description": "List objects on a remote federated cluster instead of the current one.",
1537               "location": "query",
1538               "required": false
1539             },
1540             "bypass_federation": {
1541               "type": "boolean",
1542               "required": false,
1543               "description": "bypass federation behavior, list items from local instance database only",
1544               "location": "query"
1545             },
1546             "include_trash": {
1547               "type": "boolean",
1548               "required": false,
1549               "default": "false",
1550               "description": "Include container requests whose owner project is trashed.",
1551               "location": "query"
1552             }
1553           },
1554           "response": {
1555             "$ref": "ContainerRequestList"
1556           },
1557           "scopes": [
1558             "https://api.arvados.org/auth/arvados",
1559             "https://api.arvados.org/auth/arvados.readonly"
1560           ]
1561         },
1562         "create": {
1563           "id": "arvados.container_requests.create",
1564           "path": "container_requests",
1565           "httpMethod": "POST",
1566           "description": "Create a new ContainerRequest.",
1567           "parameters": {
1568             "select": {
1569               "type": "array",
1570               "description": "Attributes of the new object to return in the response.",
1571               "required": false,
1572               "location": "query"
1573             },
1574             "ensure_unique_name": {
1575               "type": "boolean",
1576               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
1577               "location": "query",
1578               "required": false,
1579               "default": "false"
1580             },
1581             "cluster_id": {
1582               "type": "string",
1583               "description": "Create object on a remote federated cluster instead of the current one.",
1584               "location": "query",
1585               "required": false
1586             }
1587           },
1588           "request": {
1589             "required": true,
1590             "properties": {
1591               "container_request": {
1592                 "$ref": "ContainerRequest"
1593               }
1594             }
1595           },
1596           "response": {
1597             "$ref": "ContainerRequest"
1598           },
1599           "scopes": [
1600             "https://api.arvados.org/auth/arvados"
1601           ]
1602         },
1603         "update": {
1604           "id": "arvados.container_requests.update",
1605           "path": "container_requests/{uuid}",
1606           "httpMethod": "PUT",
1607           "description": "Update attributes of an existing ContainerRequest.",
1608           "parameters": {
1609             "uuid": {
1610               "type": "string",
1611               "description": "The UUID of the ContainerRequest in question.",
1612               "required": true,
1613               "location": "path"
1614             },
1615             "select": {
1616               "type": "array",
1617               "description": "Attributes of the updated object to return in the response.",
1618               "required": false,
1619               "location": "query"
1620             }
1621           },
1622           "request": {
1623             "required": true,
1624             "properties": {
1625               "container_request": {
1626                 "$ref": "ContainerRequest"
1627               }
1628             }
1629           },
1630           "response": {
1631             "$ref": "ContainerRequest"
1632           },
1633           "scopes": [
1634             "https://api.arvados.org/auth/arvados"
1635           ]
1636         },
1637         "delete": {
1638           "id": "arvados.container_requests.delete",
1639           "path": "container_requests/{uuid}",
1640           "httpMethod": "DELETE",
1641           "description": "Delete an existing ContainerRequest.",
1642           "parameters": {
1643             "uuid": {
1644               "type": "string",
1645               "description": "The UUID of the ContainerRequest in question.",
1646               "required": true,
1647               "location": "path"
1648             }
1649           },
1650           "response": {
1651             "$ref": "ContainerRequest"
1652           },
1653           "scopes": [
1654             "https://api.arvados.org/auth/arvados"
1655           ]
1656         },
1657         "container_status": {
1658           "id": "arvados.container_requests.container_status",
1659           "path": "container_requests/{uuid}/container_status",
1660           "httpMethod": "GET",
1661           "description": "container_status container_requests",
1662           "parameters": {
1663             "uuid": {
1664               "type": "string",
1665               "required": true,
1666               "description": "The UUID of the ContainerRequest in question.",
1667               "location": "query"
1668             }
1669           },
1670           "response": {
1671             "$ref": "ContainerRequest"
1672           },
1673           "scopes": [
1674             "https://api.arvados.org/auth/arvados"
1675           ]
1676         }
1677       }
1678     },
1679     "groups": {
1680       "methods": {
1681         "get": {
1682           "id": "arvados.groups.get",
1683           "path": "groups/{uuid}",
1684           "httpMethod": "GET",
1685           "description": "Gets a Group's metadata by UUID.",
1686           "parameters": {
1687             "uuid": {
1688               "type": "string",
1689               "description": "The UUID of the Group in question.",
1690               "required": true,
1691               "location": "path"
1692             },
1693             "select": {
1694               "type": "array",
1695               "description": "Attributes of the object to return in the response.",
1696               "required": false,
1697               "location": "query"
1698             },
1699             "include_trash": {
1700               "type": "boolean",
1701               "required": false,
1702               "default": "false",
1703               "description": "Show group/project even if its is_trashed attribute is true.",
1704               "location": "query"
1705             }
1706           },
1707           "parameterOrder": [
1708             "uuid"
1709           ],
1710           "response": {
1711             "$ref": "Group"
1712           },
1713           "scopes": [
1714             "https://api.arvados.org/auth/arvados",
1715             "https://api.arvados.org/auth/arvados.readonly"
1716           ]
1717         },
1718         "list": {
1719           "id": "arvados.groups.list",
1720           "path": "groups",
1721           "httpMethod": "GET",
1722           "description": "List Groups.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Groups. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#groupList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
1723           "parameters": {
1724             "filters": {
1725               "type": "array",
1726               "required": false,
1727               "description": "",
1728               "location": "query"
1729             },
1730             "where": {
1731               "type": "object",
1732               "required": false,
1733               "description": "",
1734               "location": "query"
1735             },
1736             "order": {
1737               "type": "array",
1738               "required": false,
1739               "description": "",
1740               "location": "query"
1741             },
1742             "select": {
1743               "type": "array",
1744               "description": "Attributes of each object to return in the response.",
1745               "required": false,
1746               "location": "query"
1747             },
1748             "distinct": {
1749               "type": "boolean",
1750               "required": false,
1751               "default": "false",
1752               "description": "",
1753               "location": "query"
1754             },
1755             "limit": {
1756               "type": "integer",
1757               "required": false,
1758               "default": "100",
1759               "description": "",
1760               "location": "query"
1761             },
1762             "offset": {
1763               "type": "integer",
1764               "required": false,
1765               "default": "0",
1766               "description": "",
1767               "location": "query"
1768             },
1769             "count": {
1770               "type": "string",
1771               "required": false,
1772               "default": "exact",
1773               "description": "",
1774               "location": "query"
1775             },
1776             "cluster_id": {
1777               "type": "string",
1778               "description": "List objects on a remote federated cluster instead of the current one.",
1779               "location": "query",
1780               "required": false
1781             },
1782             "bypass_federation": {
1783               "type": "boolean",
1784               "required": false,
1785               "description": "bypass federation behavior, list items from local instance database only",
1786               "location": "query"
1787             },
1788             "include_trash": {
1789               "type": "boolean",
1790               "required": false,
1791               "default": "false",
1792               "description": "Include items whose is_trashed attribute is true.",
1793               "location": "query"
1794             }
1795           },
1796           "response": {
1797             "$ref": "GroupList"
1798           },
1799           "scopes": [
1800             "https://api.arvados.org/auth/arvados",
1801             "https://api.arvados.org/auth/arvados.readonly"
1802           ]
1803         },
1804         "create": {
1805           "id": "arvados.groups.create",
1806           "path": "groups",
1807           "httpMethod": "POST",
1808           "description": "Create a new Group.",
1809           "parameters": {
1810             "select": {
1811               "type": "array",
1812               "description": "Attributes of the new object to return in the response.",
1813               "required": false,
1814               "location": "query"
1815             },
1816             "ensure_unique_name": {
1817               "type": "boolean",
1818               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
1819               "location": "query",
1820               "required": false,
1821               "default": "false"
1822             },
1823             "cluster_id": {
1824               "type": "string",
1825               "description": "Create object on a remote federated cluster instead of the current one.",
1826               "location": "query",
1827               "required": false
1828             },
1829             "async": {
1830               "required": false,
1831               "type": "boolean",
1832               "location": "query",
1833               "default": "false",
1834               "description": "defer permissions update"
1835             }
1836           },
1837           "request": {
1838             "required": true,
1839             "properties": {
1840               "group": {
1841                 "$ref": "Group"
1842               }
1843             }
1844           },
1845           "response": {
1846             "$ref": "Group"
1847           },
1848           "scopes": [
1849             "https://api.arvados.org/auth/arvados"
1850           ]
1851         },
1852         "update": {
1853           "id": "arvados.groups.update",
1854           "path": "groups/{uuid}",
1855           "httpMethod": "PUT",
1856           "description": "Update attributes of an existing Group.",
1857           "parameters": {
1858             "uuid": {
1859               "type": "string",
1860               "description": "The UUID of the Group in question.",
1861               "required": true,
1862               "location": "path"
1863             },
1864             "select": {
1865               "type": "array",
1866               "description": "Attributes of the updated object to return in the response.",
1867               "required": false,
1868               "location": "query"
1869             },
1870             "async": {
1871               "required": false,
1872               "type": "boolean",
1873               "location": "query",
1874               "default": "false",
1875               "description": "defer permissions update"
1876             }
1877           },
1878           "request": {
1879             "required": true,
1880             "properties": {
1881               "group": {
1882                 "$ref": "Group"
1883               }
1884             }
1885           },
1886           "response": {
1887             "$ref": "Group"
1888           },
1889           "scopes": [
1890             "https://api.arvados.org/auth/arvados"
1891           ]
1892         },
1893         "delete": {
1894           "id": "arvados.groups.delete",
1895           "path": "groups/{uuid}",
1896           "httpMethod": "DELETE",
1897           "description": "Delete an existing Group.",
1898           "parameters": {
1899             "uuid": {
1900               "type": "string",
1901               "description": "The UUID of the Group in question.",
1902               "required": true,
1903               "location": "path"
1904             }
1905           },
1906           "response": {
1907             "$ref": "Group"
1908           },
1909           "scopes": [
1910             "https://api.arvados.org/auth/arvados"
1911           ]
1912         },
1913         "contents": {
1914           "id": "arvados.groups.contents",
1915           "path": "groups/contents",
1916           "httpMethod": "GET",
1917           "description": "contents groups",
1918           "parameters": {
1919             "filters": {
1920               "type": "array",
1921               "required": false,
1922               "description": "",
1923               "location": "query"
1924             },
1925             "where": {
1926               "type": "object",
1927               "required": false,
1928               "description": "",
1929               "location": "query"
1930             },
1931             "order": {
1932               "type": "array",
1933               "required": false,
1934               "description": "",
1935               "location": "query"
1936             },
1937             "select": {
1938               "type": "array",
1939               "description": "Attributes of each object to return in the response.",
1940               "required": false,
1941               "location": "query"
1942             },
1943             "distinct": {
1944               "type": "boolean",
1945               "required": false,
1946               "default": "false",
1947               "description": "",
1948               "location": "query"
1949             },
1950             "limit": {
1951               "type": "integer",
1952               "required": false,
1953               "default": "100",
1954               "description": "",
1955               "location": "query"
1956             },
1957             "offset": {
1958               "type": "integer",
1959               "required": false,
1960               "default": "0",
1961               "description": "",
1962               "location": "query"
1963             },
1964             "count": {
1965               "type": "string",
1966               "required": false,
1967               "default": "exact",
1968               "description": "",
1969               "location": "query"
1970             },
1971             "cluster_id": {
1972               "type": "string",
1973               "description": "List objects on a remote federated cluster instead of the current one.",
1974               "location": "query",
1975               "required": false
1976             },
1977             "bypass_federation": {
1978               "type": "boolean",
1979               "required": false,
1980               "description": "bypass federation behavior, list items from local instance database only",
1981               "location": "query"
1982             },
1983             "include_trash": {
1984               "type": "boolean",
1985               "required": false,
1986               "default": "false",
1987               "description": "Include items whose is_trashed attribute is true.",
1988               "location": "query"
1989             },
1990             "uuid": {
1991               "type": "string",
1992               "required": false,
1993               "default": "",
1994               "description": "",
1995               "location": "query"
1996             },
1997             "recursive": {
1998               "type": "boolean",
1999               "required": false,
2000               "default": "false",
2001               "description": "Include contents from child groups recursively.",
2002               "location": "query"
2003             },
2004             "include": {
2005               "type": "array",
2006               "required": false,
2007               "description": "Include objects referred to by listed fields in \"included\" response field. Subsets of [\"owner_uuid\", \"container_uuid\"] are supported.",
2008               "location": "query"
2009             },
2010             "include_old_versions": {
2011               "type": "boolean",
2012               "required": false,
2013               "default": "false",
2014               "description": "Include past collection versions.",
2015               "location": "query"
2016             }
2017           },
2018           "response": {
2019             "$ref": "Group"
2020           },
2021           "scopes": [
2022             "https://api.arvados.org/auth/arvados"
2023           ]
2024         },
2025         "shared": {
2026           "id": "arvados.groups.shared",
2027           "path": "groups/shared",
2028           "httpMethod": "GET",
2029           "description": "shared groups",
2030           "parameters": {
2031             "filters": {
2032               "type": "array",
2033               "required": false,
2034               "description": "",
2035               "location": "query"
2036             },
2037             "where": {
2038               "type": "object",
2039               "required": false,
2040               "description": "",
2041               "location": "query"
2042             },
2043             "order": {
2044               "type": "array",
2045               "required": false,
2046               "description": "",
2047               "location": "query"
2048             },
2049             "select": {
2050               "type": "array",
2051               "description": "Attributes of each object to return in the response.",
2052               "required": false,
2053               "location": "query"
2054             },
2055             "distinct": {
2056               "type": "boolean",
2057               "required": false,
2058               "default": "false",
2059               "description": "",
2060               "location": "query"
2061             },
2062             "limit": {
2063               "type": "integer",
2064               "required": false,
2065               "default": "100",
2066               "description": "",
2067               "location": "query"
2068             },
2069             "offset": {
2070               "type": "integer",
2071               "required": false,
2072               "default": "0",
2073               "description": "",
2074               "location": "query"
2075             },
2076             "count": {
2077               "type": "string",
2078               "required": false,
2079               "default": "exact",
2080               "description": "",
2081               "location": "query"
2082             },
2083             "cluster_id": {
2084               "type": "string",
2085               "description": "List objects on a remote federated cluster instead of the current one.",
2086               "location": "query",
2087               "required": false
2088             },
2089             "bypass_federation": {
2090               "type": "boolean",
2091               "required": false,
2092               "description": "bypass federation behavior, list items from local instance database only",
2093               "location": "query"
2094             },
2095             "include_trash": {
2096               "type": "boolean",
2097               "required": false,
2098               "default": "false",
2099               "description": "Include items whose is_trashed attribute is true.",
2100               "location": "query"
2101             },
2102             "include": {
2103               "type": "string",
2104               "required": false,
2105               "description": "",
2106               "location": "query"
2107             }
2108           },
2109           "response": {
2110             "$ref": "Group"
2111           },
2112           "scopes": [
2113             "https://api.arvados.org/auth/arvados"
2114           ]
2115         },
2116         "trash": {
2117           "id": "arvados.groups.trash",
2118           "path": "groups/{uuid}/trash",
2119           "httpMethod": "POST",
2120           "description": "trash groups",
2121           "parameters": {
2122             "uuid": {
2123               "type": "string",
2124               "description": "",
2125               "required": true,
2126               "location": "path"
2127             }
2128           },
2129           "response": {
2130             "$ref": "Group"
2131           },
2132           "scopes": [
2133             "https://api.arvados.org/auth/arvados"
2134           ]
2135         },
2136         "untrash": {
2137           "id": "arvados.groups.untrash",
2138           "path": "groups/{uuid}/untrash",
2139           "httpMethod": "POST",
2140           "description": "untrash groups",
2141           "parameters": {
2142             "uuid": {
2143               "type": "string",
2144               "description": "",
2145               "required": true,
2146               "location": "path"
2147             }
2148           },
2149           "response": {
2150             "$ref": "Group"
2151           },
2152           "scopes": [
2153             "https://api.arvados.org/auth/arvados"
2154           ]
2155         }
2156       }
2157     },
2158     "keep_services": {
2159       "methods": {
2160         "get": {
2161           "id": "arvados.keep_services.get",
2162           "path": "keep_services/{uuid}",
2163           "httpMethod": "GET",
2164           "description": "Gets a KeepService's metadata by UUID.",
2165           "parameters": {
2166             "uuid": {
2167               "type": "string",
2168               "description": "The UUID of the KeepService in question.",
2169               "required": true,
2170               "location": "path"
2171             },
2172             "select": {
2173               "type": "array",
2174               "description": "Attributes of the object to return in the response.",
2175               "required": false,
2176               "location": "query"
2177             }
2178           },
2179           "parameterOrder": [
2180             "uuid"
2181           ],
2182           "response": {
2183             "$ref": "KeepService"
2184           },
2185           "scopes": [
2186             "https://api.arvados.org/auth/arvados",
2187             "https://api.arvados.org/auth/arvados.readonly"
2188           ]
2189         },
2190         "list": {
2191           "id": "arvados.keep_services.list",
2192           "path": "keep_services",
2193           "httpMethod": "GET",
2194           "description": "List KeepServices.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching KeepServices. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#keepServiceList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
2195           "parameters": {
2196             "filters": {
2197               "type": "array",
2198               "required": false,
2199               "description": "",
2200               "location": "query"
2201             },
2202             "where": {
2203               "type": "object",
2204               "required": false,
2205               "description": "",
2206               "location": "query"
2207             },
2208             "order": {
2209               "type": "array",
2210               "required": false,
2211               "description": "",
2212               "location": "query"
2213             },
2214             "select": {
2215               "type": "array",
2216               "description": "Attributes of each object to return in the response.",
2217               "required": false,
2218               "location": "query"
2219             },
2220             "distinct": {
2221               "type": "boolean",
2222               "required": false,
2223               "default": "false",
2224               "description": "",
2225               "location": "query"
2226             },
2227             "limit": {
2228               "type": "integer",
2229               "required": false,
2230               "default": "100",
2231               "description": "",
2232               "location": "query"
2233             },
2234             "offset": {
2235               "type": "integer",
2236               "required": false,
2237               "default": "0",
2238               "description": "",
2239               "location": "query"
2240             },
2241             "count": {
2242               "type": "string",
2243               "required": false,
2244               "default": "exact",
2245               "description": "",
2246               "location": "query"
2247             },
2248             "cluster_id": {
2249               "type": "string",
2250               "description": "List objects on a remote federated cluster instead of the current one.",
2251               "location": "query",
2252               "required": false
2253             },
2254             "bypass_federation": {
2255               "type": "boolean",
2256               "required": false,
2257               "description": "bypass federation behavior, list items from local instance database only",
2258               "location": "query"
2259             }
2260           },
2261           "response": {
2262             "$ref": "KeepServiceList"
2263           },
2264           "scopes": [
2265             "https://api.arvados.org/auth/arvados",
2266             "https://api.arvados.org/auth/arvados.readonly"
2267           ]
2268         },
2269         "create": {
2270           "id": "arvados.keep_services.create",
2271           "path": "keep_services",
2272           "httpMethod": "POST",
2273           "description": "Create a new KeepService.",
2274           "parameters": {
2275             "select": {
2276               "type": "array",
2277               "description": "Attributes of the new object to return in the response.",
2278               "required": false,
2279               "location": "query"
2280             },
2281             "ensure_unique_name": {
2282               "type": "boolean",
2283               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
2284               "location": "query",
2285               "required": false,
2286               "default": "false"
2287             },
2288             "cluster_id": {
2289               "type": "string",
2290               "description": "Create object on a remote federated cluster instead of the current one.",
2291               "location": "query",
2292               "required": false
2293             }
2294           },
2295           "request": {
2296             "required": true,
2297             "properties": {
2298               "keep_service": {
2299                 "$ref": "KeepService"
2300               }
2301             }
2302           },
2303           "response": {
2304             "$ref": "KeepService"
2305           },
2306           "scopes": [
2307             "https://api.arvados.org/auth/arvados"
2308           ]
2309         },
2310         "update": {
2311           "id": "arvados.keep_services.update",
2312           "path": "keep_services/{uuid}",
2313           "httpMethod": "PUT",
2314           "description": "Update attributes of an existing KeepService.",
2315           "parameters": {
2316             "uuid": {
2317               "type": "string",
2318               "description": "The UUID of the KeepService in question.",
2319               "required": true,
2320               "location": "path"
2321             },
2322             "select": {
2323               "type": "array",
2324               "description": "Attributes of the updated object to return in the response.",
2325               "required": false,
2326               "location": "query"
2327             }
2328           },
2329           "request": {
2330             "required": true,
2331             "properties": {
2332               "keep_service": {
2333                 "$ref": "KeepService"
2334               }
2335             }
2336           },
2337           "response": {
2338             "$ref": "KeepService"
2339           },
2340           "scopes": [
2341             "https://api.arvados.org/auth/arvados"
2342           ]
2343         },
2344         "delete": {
2345           "id": "arvados.keep_services.delete",
2346           "path": "keep_services/{uuid}",
2347           "httpMethod": "DELETE",
2348           "description": "Delete an existing KeepService.",
2349           "parameters": {
2350             "uuid": {
2351               "type": "string",
2352               "description": "The UUID of the KeepService in question.",
2353               "required": true,
2354               "location": "path"
2355             }
2356           },
2357           "response": {
2358             "$ref": "KeepService"
2359           },
2360           "scopes": [
2361             "https://api.arvados.org/auth/arvados"
2362           ]
2363         },
2364         "accessible": {
2365           "id": "arvados.keep_services.accessible",
2366           "path": "keep_services/accessible",
2367           "httpMethod": "GET",
2368           "description": "accessible keep_services",
2369           "parameters": {},
2370           "response": {
2371             "$ref": "KeepService"
2372           },
2373           "scopes": [
2374             "https://api.arvados.org/auth/arvados"
2375           ]
2376         }
2377       }
2378     },
2379     "links": {
2380       "methods": {
2381         "get": {
2382           "id": "arvados.links.get",
2383           "path": "links/{uuid}",
2384           "httpMethod": "GET",
2385           "description": "Gets a Link's metadata by UUID.",
2386           "parameters": {
2387             "uuid": {
2388               "type": "string",
2389               "description": "The UUID of the Link in question.",
2390               "required": true,
2391               "location": "path"
2392             },
2393             "select": {
2394               "type": "array",
2395               "description": "Attributes of the object to return in the response.",
2396               "required": false,
2397               "location": "query"
2398             }
2399           },
2400           "parameterOrder": [
2401             "uuid"
2402           ],
2403           "response": {
2404             "$ref": "Link"
2405           },
2406           "scopes": [
2407             "https://api.arvados.org/auth/arvados",
2408             "https://api.arvados.org/auth/arvados.readonly"
2409           ]
2410         },
2411         "list": {
2412           "id": "arvados.links.list",
2413           "path": "links",
2414           "httpMethod": "GET",
2415           "description": "List Links.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Links. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#linkList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
2416           "parameters": {
2417             "filters": {
2418               "type": "array",
2419               "required": false,
2420               "description": "",
2421               "location": "query"
2422             },
2423             "where": {
2424               "type": "object",
2425               "required": false,
2426               "description": "",
2427               "location": "query"
2428             },
2429             "order": {
2430               "type": "array",
2431               "required": false,
2432               "description": "",
2433               "location": "query"
2434             },
2435             "select": {
2436               "type": "array",
2437               "description": "Attributes of each object to return in the response.",
2438               "required": false,
2439               "location": "query"
2440             },
2441             "distinct": {
2442               "type": "boolean",
2443               "required": false,
2444               "default": "false",
2445               "description": "",
2446               "location": "query"
2447             },
2448             "limit": {
2449               "type": "integer",
2450               "required": false,
2451               "default": "100",
2452               "description": "",
2453               "location": "query"
2454             },
2455             "offset": {
2456               "type": "integer",
2457               "required": false,
2458               "default": "0",
2459               "description": "",
2460               "location": "query"
2461             },
2462             "count": {
2463               "type": "string",
2464               "required": false,
2465               "default": "exact",
2466               "description": "",
2467               "location": "query"
2468             },
2469             "cluster_id": {
2470               "type": "string",
2471               "description": "List objects on a remote federated cluster instead of the current one.",
2472               "location": "query",
2473               "required": false
2474             },
2475             "bypass_federation": {
2476               "type": "boolean",
2477               "required": false,
2478               "description": "bypass federation behavior, list items from local instance database only",
2479               "location": "query"
2480             }
2481           },
2482           "response": {
2483             "$ref": "LinkList"
2484           },
2485           "scopes": [
2486             "https://api.arvados.org/auth/arvados",
2487             "https://api.arvados.org/auth/arvados.readonly"
2488           ]
2489         },
2490         "create": {
2491           "id": "arvados.links.create",
2492           "path": "links",
2493           "httpMethod": "POST",
2494           "description": "Create a new Link.",
2495           "parameters": {
2496             "select": {
2497               "type": "array",
2498               "description": "Attributes of the new object to return in the response.",
2499               "required": false,
2500               "location": "query"
2501             },
2502             "ensure_unique_name": {
2503               "type": "boolean",
2504               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
2505               "location": "query",
2506               "required": false,
2507               "default": "false"
2508             },
2509             "cluster_id": {
2510               "type": "string",
2511               "description": "Create object on a remote federated cluster instead of the current one.",
2512               "location": "query",
2513               "required": false
2514             }
2515           },
2516           "request": {
2517             "required": true,
2518             "properties": {
2519               "link": {
2520                 "$ref": "Link"
2521               }
2522             }
2523           },
2524           "response": {
2525             "$ref": "Link"
2526           },
2527           "scopes": [
2528             "https://api.arvados.org/auth/arvados"
2529           ]
2530         },
2531         "update": {
2532           "id": "arvados.links.update",
2533           "path": "links/{uuid}",
2534           "httpMethod": "PUT",
2535           "description": "Update attributes of an existing Link.",
2536           "parameters": {
2537             "uuid": {
2538               "type": "string",
2539               "description": "The UUID of the Link in question.",
2540               "required": true,
2541               "location": "path"
2542             },
2543             "select": {
2544               "type": "array",
2545               "description": "Attributes of the updated object to return in the response.",
2546               "required": false,
2547               "location": "query"
2548             }
2549           },
2550           "request": {
2551             "required": true,
2552             "properties": {
2553               "link": {
2554                 "$ref": "Link"
2555               }
2556             }
2557           },
2558           "response": {
2559             "$ref": "Link"
2560           },
2561           "scopes": [
2562             "https://api.arvados.org/auth/arvados"
2563           ]
2564         },
2565         "delete": {
2566           "id": "arvados.links.delete",
2567           "path": "links/{uuid}",
2568           "httpMethod": "DELETE",
2569           "description": "Delete an existing Link.",
2570           "parameters": {
2571             "uuid": {
2572               "type": "string",
2573               "description": "The UUID of the Link in question.",
2574               "required": true,
2575               "location": "path"
2576             }
2577           },
2578           "response": {
2579             "$ref": "Link"
2580           },
2581           "scopes": [
2582             "https://api.arvados.org/auth/arvados"
2583           ]
2584         },
2585         "get_permissions": {
2586           "id": "arvados.links.get_permissions",
2587           "path": "permissions/{uuid}",
2588           "httpMethod": "GET",
2589           "description": "get_permissions links",
2590           "parameters": {
2591             "uuid": {
2592               "type": "string",
2593               "description": "",
2594               "required": true,
2595               "location": "path"
2596             }
2597           },
2598           "response": {
2599             "$ref": "Link"
2600           },
2601           "scopes": [
2602             "https://api.arvados.org/auth/arvados"
2603           ]
2604         }
2605       }
2606     },
2607     "logs": {
2608       "methods": {
2609         "get": {
2610           "id": "arvados.logs.get",
2611           "path": "logs/{uuid}",
2612           "httpMethod": "GET",
2613           "description": "Gets a Log's metadata by UUID.",
2614           "parameters": {
2615             "uuid": {
2616               "type": "string",
2617               "description": "The UUID of the Log in question.",
2618               "required": true,
2619               "location": "path"
2620             },
2621             "select": {
2622               "type": "array",
2623               "description": "Attributes of the object to return in the response.",
2624               "required": false,
2625               "location": "query"
2626             }
2627           },
2628           "parameterOrder": [
2629             "uuid"
2630           ],
2631           "response": {
2632             "$ref": "Log"
2633           },
2634           "scopes": [
2635             "https://api.arvados.org/auth/arvados",
2636             "https://api.arvados.org/auth/arvados.readonly"
2637           ]
2638         },
2639         "list": {
2640           "id": "arvados.logs.list",
2641           "path": "logs",
2642           "httpMethod": "GET",
2643           "description": "List Logs.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Logs. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#logList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
2644           "parameters": {
2645             "filters": {
2646               "type": "array",
2647               "required": false,
2648               "description": "",
2649               "location": "query"
2650             },
2651             "where": {
2652               "type": "object",
2653               "required": false,
2654               "description": "",
2655               "location": "query"
2656             },
2657             "order": {
2658               "type": "array",
2659               "required": false,
2660               "description": "",
2661               "location": "query"
2662             },
2663             "select": {
2664               "type": "array",
2665               "description": "Attributes of each object to return in the response.",
2666               "required": false,
2667               "location": "query"
2668             },
2669             "distinct": {
2670               "type": "boolean",
2671               "required": false,
2672               "default": "false",
2673               "description": "",
2674               "location": "query"
2675             },
2676             "limit": {
2677               "type": "integer",
2678               "required": false,
2679               "default": "100",
2680               "description": "",
2681               "location": "query"
2682             },
2683             "offset": {
2684               "type": "integer",
2685               "required": false,
2686               "default": "0",
2687               "description": "",
2688               "location": "query"
2689             },
2690             "count": {
2691               "type": "string",
2692               "required": false,
2693               "default": "exact",
2694               "description": "",
2695               "location": "query"
2696             },
2697             "cluster_id": {
2698               "type": "string",
2699               "description": "List objects on a remote federated cluster instead of the current one.",
2700               "location": "query",
2701               "required": false
2702             },
2703             "bypass_federation": {
2704               "type": "boolean",
2705               "required": false,
2706               "description": "bypass federation behavior, list items from local instance database only",
2707               "location": "query"
2708             }
2709           },
2710           "response": {
2711             "$ref": "LogList"
2712           },
2713           "scopes": [
2714             "https://api.arvados.org/auth/arvados",
2715             "https://api.arvados.org/auth/arvados.readonly"
2716           ]
2717         },
2718         "create": {
2719           "id": "arvados.logs.create",
2720           "path": "logs",
2721           "httpMethod": "POST",
2722           "description": "Create a new Log.",
2723           "parameters": {
2724             "select": {
2725               "type": "array",
2726               "description": "Attributes of the new object to return in the response.",
2727               "required": false,
2728               "location": "query"
2729             },
2730             "ensure_unique_name": {
2731               "type": "boolean",
2732               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
2733               "location": "query",
2734               "required": false,
2735               "default": "false"
2736             },
2737             "cluster_id": {
2738               "type": "string",
2739               "description": "Create object on a remote federated cluster instead of the current one.",
2740               "location": "query",
2741               "required": false
2742             }
2743           },
2744           "request": {
2745             "required": true,
2746             "properties": {
2747               "log": {
2748                 "$ref": "Log"
2749               }
2750             }
2751           },
2752           "response": {
2753             "$ref": "Log"
2754           },
2755           "scopes": [
2756             "https://api.arvados.org/auth/arvados"
2757           ]
2758         },
2759         "update": {
2760           "id": "arvados.logs.update",
2761           "path": "logs/{uuid}",
2762           "httpMethod": "PUT",
2763           "description": "Update attributes of an existing Log.",
2764           "parameters": {
2765             "uuid": {
2766               "type": "string",
2767               "description": "The UUID of the Log in question.",
2768               "required": true,
2769               "location": "path"
2770             },
2771             "select": {
2772               "type": "array",
2773               "description": "Attributes of the updated object to return in the response.",
2774               "required": false,
2775               "location": "query"
2776             }
2777           },
2778           "request": {
2779             "required": true,
2780             "properties": {
2781               "log": {
2782                 "$ref": "Log"
2783               }
2784             }
2785           },
2786           "response": {
2787             "$ref": "Log"
2788           },
2789           "scopes": [
2790             "https://api.arvados.org/auth/arvados"
2791           ]
2792         },
2793         "delete": {
2794           "id": "arvados.logs.delete",
2795           "path": "logs/{uuid}",
2796           "httpMethod": "DELETE",
2797           "description": "Delete an existing Log.",
2798           "parameters": {
2799             "uuid": {
2800               "type": "string",
2801               "description": "The UUID of the Log in question.",
2802               "required": true,
2803               "location": "path"
2804             }
2805           },
2806           "response": {
2807             "$ref": "Log"
2808           },
2809           "scopes": [
2810             "https://api.arvados.org/auth/arvados"
2811           ]
2812         }
2813       }
2814     },
2815     "users": {
2816       "methods": {
2817         "get": {
2818           "id": "arvados.users.get",
2819           "path": "users/{uuid}",
2820           "httpMethod": "GET",
2821           "description": "Gets a User's metadata by UUID.",
2822           "parameters": {
2823             "uuid": {
2824               "type": "string",
2825               "description": "The UUID of the User in question.",
2826               "required": true,
2827               "location": "path"
2828             },
2829             "select": {
2830               "type": "array",
2831               "description": "Attributes of the object to return in the response.",
2832               "required": false,
2833               "location": "query"
2834             }
2835           },
2836           "parameterOrder": [
2837             "uuid"
2838           ],
2839           "response": {
2840             "$ref": "User"
2841           },
2842           "scopes": [
2843             "https://api.arvados.org/auth/arvados",
2844             "https://api.arvados.org/auth/arvados.readonly"
2845           ]
2846         },
2847         "list": {
2848           "id": "arvados.users.list",
2849           "path": "users",
2850           "httpMethod": "GET",
2851           "description": "List Users.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Users. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#userList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
2852           "parameters": {
2853             "filters": {
2854               "type": "array",
2855               "required": false,
2856               "description": "",
2857               "location": "query"
2858             },
2859             "where": {
2860               "type": "object",
2861               "required": false,
2862               "description": "",
2863               "location": "query"
2864             },
2865             "order": {
2866               "type": "array",
2867               "required": false,
2868               "description": "",
2869               "location": "query"
2870             },
2871             "select": {
2872               "type": "array",
2873               "description": "Attributes of each object to return in the response.",
2874               "required": false,
2875               "location": "query"
2876             },
2877             "distinct": {
2878               "type": "boolean",
2879               "required": false,
2880               "default": "false",
2881               "description": "",
2882               "location": "query"
2883             },
2884             "limit": {
2885               "type": "integer",
2886               "required": false,
2887               "default": "100",
2888               "description": "",
2889               "location": "query"
2890             },
2891             "offset": {
2892               "type": "integer",
2893               "required": false,
2894               "default": "0",
2895               "description": "",
2896               "location": "query"
2897             },
2898             "count": {
2899               "type": "string",
2900               "required": false,
2901               "default": "exact",
2902               "description": "",
2903               "location": "query"
2904             },
2905             "cluster_id": {
2906               "type": "string",
2907               "description": "List objects on a remote federated cluster instead of the current one.",
2908               "location": "query",
2909               "required": false
2910             },
2911             "bypass_federation": {
2912               "type": "boolean",
2913               "required": false,
2914               "description": "bypass federation behavior, list items from local instance database only",
2915               "location": "query"
2916             }
2917           },
2918           "response": {
2919             "$ref": "UserList"
2920           },
2921           "scopes": [
2922             "https://api.arvados.org/auth/arvados",
2923             "https://api.arvados.org/auth/arvados.readonly"
2924           ]
2925         },
2926         "create": {
2927           "id": "arvados.users.create",
2928           "path": "users",
2929           "httpMethod": "POST",
2930           "description": "Create a new User.",
2931           "parameters": {
2932             "select": {
2933               "type": "array",
2934               "description": "Attributes of the new object to return in the response.",
2935               "required": false,
2936               "location": "query"
2937             },
2938             "ensure_unique_name": {
2939               "type": "boolean",
2940               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
2941               "location": "query",
2942               "required": false,
2943               "default": "false"
2944             },
2945             "cluster_id": {
2946               "type": "string",
2947               "description": "Create object on a remote federated cluster instead of the current one.",
2948               "location": "query",
2949               "required": false
2950             }
2951           },
2952           "request": {
2953             "required": true,
2954             "properties": {
2955               "user": {
2956                 "$ref": "User"
2957               }
2958             }
2959           },
2960           "response": {
2961             "$ref": "User"
2962           },
2963           "scopes": [
2964             "https://api.arvados.org/auth/arvados"
2965           ]
2966         },
2967         "update": {
2968           "id": "arvados.users.update",
2969           "path": "users/{uuid}",
2970           "httpMethod": "PUT",
2971           "description": "Update attributes of an existing User.",
2972           "parameters": {
2973             "uuid": {
2974               "type": "string",
2975               "description": "The UUID of the User in question.",
2976               "required": true,
2977               "location": "path"
2978             },
2979             "select": {
2980               "type": "array",
2981               "description": "Attributes of the updated object to return in the response.",
2982               "required": false,
2983               "location": "query"
2984             },
2985             "bypass_federation": {
2986               "type": "boolean",
2987               "required": false,
2988               "default": "false",
2989               "description": "",
2990               "location": "query"
2991             }
2992           },
2993           "request": {
2994             "required": true,
2995             "properties": {
2996               "user": {
2997                 "$ref": "User"
2998               }
2999             }
3000           },
3001           "response": {
3002             "$ref": "User"
3003           },
3004           "scopes": [
3005             "https://api.arvados.org/auth/arvados"
3006           ]
3007         },
3008         "delete": {
3009           "id": "arvados.users.delete",
3010           "path": "users/{uuid}",
3011           "httpMethod": "DELETE",
3012           "description": "Delete an existing User.",
3013           "parameters": {
3014             "uuid": {
3015               "type": "string",
3016               "description": "The UUID of the User in question.",
3017               "required": true,
3018               "location": "path"
3019             }
3020           },
3021           "response": {
3022             "$ref": "User"
3023           },
3024           "scopes": [
3025             "https://api.arvados.org/auth/arvados"
3026           ]
3027         },
3028         "current": {
3029           "id": "arvados.users.current",
3030           "path": "users/current",
3031           "httpMethod": "GET",
3032           "description": "current users",
3033           "parameters": {},
3034           "response": {
3035             "$ref": "User"
3036           },
3037           "scopes": [
3038             "https://api.arvados.org/auth/arvados"
3039           ]
3040         },
3041         "system": {
3042           "id": "arvados.users.system",
3043           "path": "users/system",
3044           "httpMethod": "GET",
3045           "description": "system users",
3046           "parameters": {},
3047           "response": {
3048             "$ref": "User"
3049           },
3050           "scopes": [
3051             "https://api.arvados.org/auth/arvados"
3052           ]
3053         },
3054         "activate": {
3055           "id": "arvados.users.activate",
3056           "path": "users/{uuid}/activate",
3057           "httpMethod": "POST",
3058           "description": "activate users",
3059           "parameters": {
3060             "uuid": {
3061               "type": "string",
3062               "description": "",
3063               "required": true,
3064               "location": "path"
3065             }
3066           },
3067           "response": {
3068             "$ref": "User"
3069           },
3070           "scopes": [
3071             "https://api.arvados.org/auth/arvados"
3072           ]
3073         },
3074         "setup": {
3075           "id": "arvados.users.setup",
3076           "path": "users/setup",
3077           "httpMethod": "POST",
3078           "description": "setup users",
3079           "parameters": {
3080             "uuid": {
3081               "type": "string",
3082               "required": false,
3083               "description": "",
3084               "location": "query"
3085             },
3086             "user": {
3087               "type": "object",
3088               "required": false,
3089               "description": "",
3090               "location": "query"
3091             },
3092             "repo_name": {
3093               "type": "string",
3094               "required": false,
3095               "description": "",
3096               "location": "query"
3097             },
3098             "vm_uuid": {
3099               "type": "string",
3100               "required": false,
3101               "description": "",
3102               "location": "query"
3103             },
3104             "send_notification_email": {
3105               "type": "boolean",
3106               "required": false,
3107               "default": "false",
3108               "description": "",
3109               "location": "query"
3110             }
3111           },
3112           "response": {
3113             "$ref": "User"
3114           },
3115           "scopes": [
3116             "https://api.arvados.org/auth/arvados"
3117           ]
3118         },
3119         "unsetup": {
3120           "id": "arvados.users.unsetup",
3121           "path": "users/{uuid}/unsetup",
3122           "httpMethod": "POST",
3123           "description": "unsetup users",
3124           "parameters": {
3125             "uuid": {
3126               "type": "string",
3127               "description": "",
3128               "required": true,
3129               "location": "path"
3130             }
3131           },
3132           "response": {
3133             "$ref": "User"
3134           },
3135           "scopes": [
3136             "https://api.arvados.org/auth/arvados"
3137           ]
3138         },
3139         "merge": {
3140           "id": "arvados.users.merge",
3141           "path": "users/merge",
3142           "httpMethod": "POST",
3143           "description": "merge users",
3144           "parameters": {
3145             "new_owner_uuid": {
3146               "type": "string",
3147               "required": true,
3148               "description": "",
3149               "location": "query"
3150             },
3151             "new_user_token": {
3152               "type": "string",
3153               "required": false,
3154               "description": "",
3155               "location": "query"
3156             },
3157             "redirect_to_new_user": {
3158               "type": "boolean",
3159               "required": false,
3160               "default": "false",
3161               "description": "",
3162               "location": "query"
3163             },
3164             "old_user_uuid": {
3165               "type": "string",
3166               "required": false,
3167               "description": "",
3168               "location": "query"
3169             },
3170             "new_user_uuid": {
3171               "type": "string",
3172               "required": false,
3173               "description": "",
3174               "location": "query"
3175             }
3176           },
3177           "response": {
3178             "$ref": "User"
3179           },
3180           "scopes": [
3181             "https://api.arvados.org/auth/arvados"
3182           ]
3183         }
3184       }
3185     },
3186     "user_agreements": {
3187       "methods": {
3188         "get": {
3189           "id": "arvados.user_agreements.get",
3190           "path": "user_agreements/{uuid}",
3191           "httpMethod": "GET",
3192           "description": "Gets a UserAgreement's metadata by UUID.",
3193           "parameters": {
3194             "uuid": {
3195               "type": "string",
3196               "description": "The UUID of the UserAgreement in question.",
3197               "required": true,
3198               "location": "path"
3199             },
3200             "select": {
3201               "type": "array",
3202               "description": "Attributes of the object to return in the response.",
3203               "required": false,
3204               "location": "query"
3205             }
3206           },
3207           "parameterOrder": [
3208             "uuid"
3209           ],
3210           "response": {
3211             "$ref": "UserAgreement"
3212           },
3213           "scopes": [
3214             "https://api.arvados.org/auth/arvados",
3215             "https://api.arvados.org/auth/arvados.readonly"
3216           ]
3217         },
3218         "list": {
3219           "id": "arvados.user_agreements.list",
3220           "path": "user_agreements",
3221           "httpMethod": "GET",
3222           "description": "List UserAgreements.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching UserAgreements. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#userAgreementList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
3223           "parameters": {
3224             "filters": {
3225               "type": "array",
3226               "required": false,
3227               "description": "",
3228               "location": "query"
3229             },
3230             "where": {
3231               "type": "object",
3232               "required": false,
3233               "description": "",
3234               "location": "query"
3235             },
3236             "order": {
3237               "type": "array",
3238               "required": false,
3239               "description": "",
3240               "location": "query"
3241             },
3242             "select": {
3243               "type": "array",
3244               "description": "Attributes of each object to return in the response.",
3245               "required": false,
3246               "location": "query"
3247             },
3248             "distinct": {
3249               "type": "boolean",
3250               "required": false,
3251               "default": "false",
3252               "description": "",
3253               "location": "query"
3254             },
3255             "limit": {
3256               "type": "integer",
3257               "required": false,
3258               "default": "100",
3259               "description": "",
3260               "location": "query"
3261             },
3262             "offset": {
3263               "type": "integer",
3264               "required": false,
3265               "default": "0",
3266               "description": "",
3267               "location": "query"
3268             },
3269             "count": {
3270               "type": "string",
3271               "required": false,
3272               "default": "exact",
3273               "description": "",
3274               "location": "query"
3275             },
3276             "cluster_id": {
3277               "type": "string",
3278               "description": "List objects on a remote federated cluster instead of the current one.",
3279               "location": "query",
3280               "required": false
3281             },
3282             "bypass_federation": {
3283               "type": "boolean",
3284               "required": false,
3285               "description": "bypass federation behavior, list items from local instance database only",
3286               "location": "query"
3287             }
3288           },
3289           "response": {
3290             "$ref": "UserAgreementList"
3291           },
3292           "scopes": [
3293             "https://api.arvados.org/auth/arvados",
3294             "https://api.arvados.org/auth/arvados.readonly"
3295           ]
3296         },
3297         "create": {
3298           "id": "arvados.user_agreements.create",
3299           "path": "user_agreements",
3300           "httpMethod": "POST",
3301           "description": "Create a new UserAgreement.",
3302           "parameters": {
3303             "select": {
3304               "type": "array",
3305               "description": "Attributes of the new object to return in the response.",
3306               "required": false,
3307               "location": "query"
3308             },
3309             "ensure_unique_name": {
3310               "type": "boolean",
3311               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
3312               "location": "query",
3313               "required": false,
3314               "default": "false"
3315             },
3316             "cluster_id": {
3317               "type": "string",
3318               "description": "Create object on a remote federated cluster instead of the current one.",
3319               "location": "query",
3320               "required": false
3321             }
3322           },
3323           "request": {
3324             "required": true,
3325             "properties": {
3326               "user_agreement": {
3327                 "$ref": "UserAgreement"
3328               }
3329             }
3330           },
3331           "response": {
3332             "$ref": "UserAgreement"
3333           },
3334           "scopes": [
3335             "https://api.arvados.org/auth/arvados"
3336           ]
3337         },
3338         "update": {
3339           "id": "arvados.user_agreements.update",
3340           "path": "user_agreements/{uuid}",
3341           "httpMethod": "PUT",
3342           "description": "Update attributes of an existing UserAgreement.",
3343           "parameters": {
3344             "uuid": {
3345               "type": "string",
3346               "description": "The UUID of the UserAgreement in question.",
3347               "required": true,
3348               "location": "path"
3349             },
3350             "select": {
3351               "type": "array",
3352               "description": "Attributes of the updated object to return in the response.",
3353               "required": false,
3354               "location": "query"
3355             }
3356           },
3357           "request": {
3358             "required": true,
3359             "properties": {
3360               "user_agreement": {
3361                 "$ref": "UserAgreement"
3362               }
3363             }
3364           },
3365           "response": {
3366             "$ref": "UserAgreement"
3367           },
3368           "scopes": [
3369             "https://api.arvados.org/auth/arvados"
3370           ]
3371         },
3372         "delete": {
3373           "id": "arvados.user_agreements.delete",
3374           "path": "user_agreements/{uuid}",
3375           "httpMethod": "DELETE",
3376           "description": "Delete an existing UserAgreement.",
3377           "parameters": {
3378             "uuid": {
3379               "type": "string",
3380               "description": "The UUID of the UserAgreement in question.",
3381               "required": true,
3382               "location": "path"
3383             }
3384           },
3385           "response": {
3386             "$ref": "UserAgreement"
3387           },
3388           "scopes": [
3389             "https://api.arvados.org/auth/arvados"
3390           ]
3391         },
3392         "signatures": {
3393           "id": "arvados.user_agreements.signatures",
3394           "path": "user_agreements/signatures",
3395           "httpMethod": "GET",
3396           "description": "signatures user_agreements",
3397           "parameters": {},
3398           "response": {
3399             "$ref": "UserAgreement"
3400           },
3401           "scopes": [
3402             "https://api.arvados.org/auth/arvados"
3403           ]
3404         },
3405         "sign": {
3406           "id": "arvados.user_agreements.sign",
3407           "path": "user_agreements/sign",
3408           "httpMethod": "POST",
3409           "description": "sign user_agreements",
3410           "parameters": {},
3411           "response": {
3412             "$ref": "UserAgreement"
3413           },
3414           "scopes": [
3415             "https://api.arvados.org/auth/arvados"
3416           ]
3417         },
3418         "new": {
3419           "id": "arvados.user_agreements.new",
3420           "path": "user_agreements/new",
3421           "httpMethod": "GET",
3422           "description": "new user_agreements",
3423           "parameters": {},
3424           "response": {
3425             "$ref": "UserAgreement"
3426           },
3427           "scopes": [
3428             "https://api.arvados.org/auth/arvados"
3429           ]
3430         }
3431       }
3432     },
3433     "virtual_machines": {
3434       "methods": {
3435         "get": {
3436           "id": "arvados.virtual_machines.get",
3437           "path": "virtual_machines/{uuid}",
3438           "httpMethod": "GET",
3439           "description": "Gets a VirtualMachine's metadata by UUID.",
3440           "parameters": {
3441             "uuid": {
3442               "type": "string",
3443               "description": "The UUID of the VirtualMachine in question.",
3444               "required": true,
3445               "location": "path"
3446             },
3447             "select": {
3448               "type": "array",
3449               "description": "Attributes of the object to return in the response.",
3450               "required": false,
3451               "location": "query"
3452             }
3453           },
3454           "parameterOrder": [
3455             "uuid"
3456           ],
3457           "response": {
3458             "$ref": "VirtualMachine"
3459           },
3460           "scopes": [
3461             "https://api.arvados.org/auth/arvados",
3462             "https://api.arvados.org/auth/arvados.readonly"
3463           ]
3464         },
3465         "list": {
3466           "id": "arvados.virtual_machines.list",
3467           "path": "virtual_machines",
3468           "httpMethod": "GET",
3469           "description": "List VirtualMachines.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching VirtualMachines. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#virtualMachineList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
3470           "parameters": {
3471             "filters": {
3472               "type": "array",
3473               "required": false,
3474               "description": "",
3475               "location": "query"
3476             },
3477             "where": {
3478               "type": "object",
3479               "required": false,
3480               "description": "",
3481               "location": "query"
3482             },
3483             "order": {
3484               "type": "array",
3485               "required": false,
3486               "description": "",
3487               "location": "query"
3488             },
3489             "select": {
3490               "type": "array",
3491               "description": "Attributes of each object to return in the response.",
3492               "required": false,
3493               "location": "query"
3494             },
3495             "distinct": {
3496               "type": "boolean",
3497               "required": false,
3498               "default": "false",
3499               "description": "",
3500               "location": "query"
3501             },
3502             "limit": {
3503               "type": "integer",
3504               "required": false,
3505               "default": "100",
3506               "description": "",
3507               "location": "query"
3508             },
3509             "offset": {
3510               "type": "integer",
3511               "required": false,
3512               "default": "0",
3513               "description": "",
3514               "location": "query"
3515             },
3516             "count": {
3517               "type": "string",
3518               "required": false,
3519               "default": "exact",
3520               "description": "",
3521               "location": "query"
3522             },
3523             "cluster_id": {
3524               "type": "string",
3525               "description": "List objects on a remote federated cluster instead of the current one.",
3526               "location": "query",
3527               "required": false
3528             },
3529             "bypass_federation": {
3530               "type": "boolean",
3531               "required": false,
3532               "description": "bypass federation behavior, list items from local instance database only",
3533               "location": "query"
3534             }
3535           },
3536           "response": {
3537             "$ref": "VirtualMachineList"
3538           },
3539           "scopes": [
3540             "https://api.arvados.org/auth/arvados",
3541             "https://api.arvados.org/auth/arvados.readonly"
3542           ]
3543         },
3544         "create": {
3545           "id": "arvados.virtual_machines.create",
3546           "path": "virtual_machines",
3547           "httpMethod": "POST",
3548           "description": "Create a new VirtualMachine.",
3549           "parameters": {
3550             "select": {
3551               "type": "array",
3552               "description": "Attributes of the new object to return in the response.",
3553               "required": false,
3554               "location": "query"
3555             },
3556             "ensure_unique_name": {
3557               "type": "boolean",
3558               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
3559               "location": "query",
3560               "required": false,
3561               "default": "false"
3562             },
3563             "cluster_id": {
3564               "type": "string",
3565               "description": "Create object on a remote federated cluster instead of the current one.",
3566               "location": "query",
3567               "required": false
3568             }
3569           },
3570           "request": {
3571             "required": true,
3572             "properties": {
3573               "virtual_machine": {
3574                 "$ref": "VirtualMachine"
3575               }
3576             }
3577           },
3578           "response": {
3579             "$ref": "VirtualMachine"
3580           },
3581           "scopes": [
3582             "https://api.arvados.org/auth/arvados"
3583           ]
3584         },
3585         "update": {
3586           "id": "arvados.virtual_machines.update",
3587           "path": "virtual_machines/{uuid}",
3588           "httpMethod": "PUT",
3589           "description": "Update attributes of an existing VirtualMachine.",
3590           "parameters": {
3591             "uuid": {
3592               "type": "string",
3593               "description": "The UUID of the VirtualMachine in question.",
3594               "required": true,
3595               "location": "path"
3596             },
3597             "select": {
3598               "type": "array",
3599               "description": "Attributes of the updated object to return in the response.",
3600               "required": false,
3601               "location": "query"
3602             }
3603           },
3604           "request": {
3605             "required": true,
3606             "properties": {
3607               "virtual_machine": {
3608                 "$ref": "VirtualMachine"
3609               }
3610             }
3611           },
3612           "response": {
3613             "$ref": "VirtualMachine"
3614           },
3615           "scopes": [
3616             "https://api.arvados.org/auth/arvados"
3617           ]
3618         },
3619         "delete": {
3620           "id": "arvados.virtual_machines.delete",
3621           "path": "virtual_machines/{uuid}",
3622           "httpMethod": "DELETE",
3623           "description": "Delete an existing VirtualMachine.",
3624           "parameters": {
3625             "uuid": {
3626               "type": "string",
3627               "description": "The UUID of the VirtualMachine in question.",
3628               "required": true,
3629               "location": "path"
3630             }
3631           },
3632           "response": {
3633             "$ref": "VirtualMachine"
3634           },
3635           "scopes": [
3636             "https://api.arvados.org/auth/arvados"
3637           ]
3638         },
3639         "logins": {
3640           "id": "arvados.virtual_machines.logins",
3641           "path": "virtual_machines/{uuid}/logins",
3642           "httpMethod": "GET",
3643           "description": "logins virtual_machines",
3644           "parameters": {
3645             "uuid": {
3646               "type": "string",
3647               "description": "",
3648               "required": true,
3649               "location": "path"
3650             }
3651           },
3652           "response": {
3653             "$ref": "VirtualMachine"
3654           },
3655           "scopes": [
3656             "https://api.arvados.org/auth/arvados"
3657           ]
3658         },
3659         "get_all_logins": {
3660           "id": "arvados.virtual_machines.get_all_logins",
3661           "path": "virtual_machines/get_all_logins",
3662           "httpMethod": "GET",
3663           "description": "get_all_logins virtual_machines",
3664           "parameters": {},
3665           "response": {
3666             "$ref": "VirtualMachine"
3667           },
3668           "scopes": [
3669             "https://api.arvados.org/auth/arvados"
3670           ]
3671         }
3672       }
3673     },
3674     "workflows": {
3675       "methods": {
3676         "get": {
3677           "id": "arvados.workflows.get",
3678           "path": "workflows/{uuid}",
3679           "httpMethod": "GET",
3680           "description": "Gets a Workflow's metadata by UUID.",
3681           "parameters": {
3682             "uuid": {
3683               "type": "string",
3684               "description": "The UUID of the Workflow in question.",
3685               "required": true,
3686               "location": "path"
3687             },
3688             "select": {
3689               "type": "array",
3690               "description": "Attributes of the object to return in the response.",
3691               "required": false,
3692               "location": "query"
3693             }
3694           },
3695           "parameterOrder": [
3696             "uuid"
3697           ],
3698           "response": {
3699             "$ref": "Workflow"
3700           },
3701           "scopes": [
3702             "https://api.arvados.org/auth/arvados",
3703             "https://api.arvados.org/auth/arvados.readonly"
3704           ]
3705         },
3706         "list": {
3707           "id": "arvados.workflows.list",
3708           "path": "workflows",
3709           "httpMethod": "GET",
3710           "description": "List Workflows.\n\n                   The <code>list</code> method returns a\n                   <a href=\"/api/resources.html\">resource list</a> of\n                   matching Workflows. For example:\n\n                   <pre>\n                   {\n                    \"kind\":\"arvados#workflowList\",\n                    \"etag\":\"\",\n                    \"self_link\":\"\",\n                    \"next_page_token\":\"\",\n                    \"next_link\":\"\",\n                    \"items\":[\n                       ...\n                    ],\n                    \"items_available\":745,\n                    \"_profile\":{\n                     \"request_time\":0.157236317\n                    }\n                    </pre>",
3711           "parameters": {
3712             "filters": {
3713               "type": "array",
3714               "required": false,
3715               "description": "",
3716               "location": "query"
3717             },
3718             "where": {
3719               "type": "object",
3720               "required": false,
3721               "description": "",
3722               "location": "query"
3723             },
3724             "order": {
3725               "type": "array",
3726               "required": false,
3727               "description": "",
3728               "location": "query"
3729             },
3730             "select": {
3731               "type": "array",
3732               "description": "Attributes of each object to return in the response.",
3733               "required": false,
3734               "location": "query"
3735             },
3736             "distinct": {
3737               "type": "boolean",
3738               "required": false,
3739               "default": "false",
3740               "description": "",
3741               "location": "query"
3742             },
3743             "limit": {
3744               "type": "integer",
3745               "required": false,
3746               "default": "100",
3747               "description": "",
3748               "location": "query"
3749             },
3750             "offset": {
3751               "type": "integer",
3752               "required": false,
3753               "default": "0",
3754               "description": "",
3755               "location": "query"
3756             },
3757             "count": {
3758               "type": "string",
3759               "required": false,
3760               "default": "exact",
3761               "description": "",
3762               "location": "query"
3763             },
3764             "cluster_id": {
3765               "type": "string",
3766               "description": "List objects on a remote federated cluster instead of the current one.",
3767               "location": "query",
3768               "required": false
3769             },
3770             "bypass_federation": {
3771               "type": "boolean",
3772               "required": false,
3773               "description": "bypass federation behavior, list items from local instance database only",
3774               "location": "query"
3775             }
3776           },
3777           "response": {
3778             "$ref": "WorkflowList"
3779           },
3780           "scopes": [
3781             "https://api.arvados.org/auth/arvados",
3782             "https://api.arvados.org/auth/arvados.readonly"
3783           ]
3784         },
3785         "create": {
3786           "id": "arvados.workflows.create",
3787           "path": "workflows",
3788           "httpMethod": "POST",
3789           "description": "Create a new Workflow.",
3790           "parameters": {
3791             "select": {
3792               "type": "array",
3793               "description": "Attributes of the new object to return in the response.",
3794               "required": false,
3795               "location": "query"
3796             },
3797             "ensure_unique_name": {
3798               "type": "boolean",
3799               "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
3800               "location": "query",
3801               "required": false,
3802               "default": "false"
3803             },
3804             "cluster_id": {
3805               "type": "string",
3806               "description": "Create object on a remote federated cluster instead of the current one.",
3807               "location": "query",
3808               "required": false
3809             }
3810           },
3811           "request": {
3812             "required": true,
3813             "properties": {
3814               "workflow": {
3815                 "$ref": "Workflow"
3816               }
3817             }
3818           },
3819           "response": {
3820             "$ref": "Workflow"
3821           },
3822           "scopes": [
3823             "https://api.arvados.org/auth/arvados"
3824           ]
3825         },
3826         "update": {
3827           "id": "arvados.workflows.update",
3828           "path": "workflows/{uuid}",
3829           "httpMethod": "PUT",
3830           "description": "Update attributes of an existing Workflow.",
3831           "parameters": {
3832             "uuid": {
3833               "type": "string",
3834               "description": "The UUID of the Workflow in question.",
3835               "required": true,
3836               "location": "path"
3837             },
3838             "select": {
3839               "type": "array",
3840               "description": "Attributes of the updated object to return in the response.",
3841               "required": false,
3842               "location": "query"
3843             }
3844           },
3845           "request": {
3846             "required": true,
3847             "properties": {
3848               "workflow": {
3849                 "$ref": "Workflow"
3850               }
3851             }
3852           },
3853           "response": {
3854             "$ref": "Workflow"
3855           },
3856           "scopes": [
3857             "https://api.arvados.org/auth/arvados"
3858           ]
3859         },
3860         "delete": {
3861           "id": "arvados.workflows.delete",
3862           "path": "workflows/{uuid}",
3863           "httpMethod": "DELETE",
3864           "description": "Delete an existing Workflow.",
3865           "parameters": {
3866             "uuid": {
3867               "type": "string",
3868               "description": "The UUID of the Workflow in question.",
3869               "required": true,
3870               "location": "path"
3871             }
3872           },
3873           "response": {
3874             "$ref": "Workflow"
3875           },
3876           "scopes": [
3877             "https://api.arvados.org/auth/arvados"
3878           ]
3879         }
3880       }
3881     },
3882     "configs": {
3883       "methods": {
3884         "get": {
3885           "id": "arvados.configs.get",
3886           "path": "config",
3887           "httpMethod": "GET",
3888           "description": "Get public config",
3889           "parameters": {},
3890           "parameterOrder": [],
3891           "response": {},
3892           "scopes": [
3893             "https://api.arvados.org/auth/arvados",
3894             "https://api.arvados.org/auth/arvados.readonly"
3895           ]
3896         }
3897       }
3898     },
3899     "vocabularies": {
3900       "methods": {
3901         "get": {
3902           "id": "arvados.vocabularies.get",
3903           "path": "vocabulary",
3904           "httpMethod": "GET",
3905           "description": "Get vocabulary definition",
3906           "parameters": {},
3907           "parameterOrder": [],
3908           "response": {},
3909           "scopes": [
3910             "https://api.arvados.org/auth/arvados",
3911             "https://api.arvados.org/auth/arvados.readonly"
3912           ]
3913         }
3914       }
3915     },
3916     "sys": {
3917       "methods": {
3918         "get": {
3919           "id": "arvados.sys.trash_sweep",
3920           "path": "sys/trash_sweep",
3921           "httpMethod": "POST",
3922           "description": "apply scheduled trash and delete operations",
3923           "parameters": {},
3924           "parameterOrder": [],
3925           "response": {},
3926           "scopes": [
3927             "https://api.arvados.org/auth/arvados",
3928             "https://api.arvados.org/auth/arvados.readonly"
3929           ]
3930         }
3931       }
3932     }
3933   },
3934   "revision": "20240502",
3935   "schemas": {
3936     "ApiClientList": {
3937       "id": "ApiClientList",
3938       "description": "ApiClient list",
3939       "type": "object",
3940       "properties": {
3941         "kind": {
3942           "type": "string",
3943           "description": "Object type. Always arvados#apiClientList.",
3944           "default": "arvados#apiClientList"
3945         },
3946         "etag": {
3947           "type": "string",
3948           "description": "List version."
3949         },
3950         "items": {
3951           "type": "array",
3952           "description": "The list of ApiClients.",
3953           "items": {
3954             "$ref": "ApiClient"
3955           }
3956         },
3957         "next_link": {
3958           "type": "string",
3959           "description": "A link to the next page of ApiClients."
3960         },
3961         "next_page_token": {
3962           "type": "string",
3963           "description": "The page token for the next page of ApiClients."
3964         },
3965         "selfLink": {
3966           "type": "string",
3967           "description": "A link back to this list."
3968         }
3969       }
3970     },
3971     "ApiClient": {
3972       "id": "ApiClient",
3973       "description": "ApiClient",
3974       "type": "object",
3975       "uuidPrefix": "ozdt8",
3976       "properties": {
3977         "uuid": {
3978           "type": "string"
3979         },
3980         "etag": {
3981           "type": "string",
3982           "description": "Object version."
3983         },
3984         "owner_uuid": {
3985           "type": "string"
3986         },
3987         "modified_by_client_uuid": {
3988           "type": "string"
3989         },
3990         "modified_by_user_uuid": {
3991           "type": "string"
3992         },
3993         "modified_at": {
3994           "type": "datetime"
3995         },
3996         "name": {
3997           "type": "string"
3998         },
3999         "url_prefix": {
4000           "type": "string"
4001         },
4002         "created_at": {
4003           "type": "datetime"
4004         },
4005         "is_trusted": {
4006           "type": "boolean"
4007         }
4008       }
4009     },
4010     "ApiClientAuthorizationList": {
4011       "id": "ApiClientAuthorizationList",
4012       "description": "ApiClientAuthorization list",
4013       "type": "object",
4014       "properties": {
4015         "kind": {
4016           "type": "string",
4017           "description": "Object type. Always arvados#apiClientAuthorizationList.",
4018           "default": "arvados#apiClientAuthorizationList"
4019         },
4020         "etag": {
4021           "type": "string",
4022           "description": "List version."
4023         },
4024         "items": {
4025           "type": "array",
4026           "description": "The list of ApiClientAuthorizations.",
4027           "items": {
4028             "$ref": "ApiClientAuthorization"
4029           }
4030         },
4031         "next_link": {
4032           "type": "string",
4033           "description": "A link to the next page of ApiClientAuthorizations."
4034         },
4035         "next_page_token": {
4036           "type": "string",
4037           "description": "The page token for the next page of ApiClientAuthorizations."
4038         },
4039         "selfLink": {
4040           "type": "string",
4041           "description": "A link back to this list."
4042         }
4043       }
4044     },
4045     "ApiClientAuthorization": {
4046       "id": "ApiClientAuthorization",
4047       "description": "ApiClientAuthorization",
4048       "type": "object",
4049       "uuidPrefix": "gj3su",
4050       "properties": {
4051         "uuid": {
4052           "type": "string"
4053         },
4054         "etag": {
4055           "type": "string",
4056           "description": "Object version."
4057         },
4058         "api_token": {
4059           "type": "string"
4060         },
4061         "api_client_id": {
4062           "type": "integer"
4063         },
4064         "created_by_ip_address": {
4065           "type": "string"
4066         },
4067         "last_used_by_ip_address": {
4068           "type": "string"
4069         },
4070         "last_used_at": {
4071           "type": "datetime"
4072         },
4073         "expires_at": {
4074           "type": "datetime"
4075         },
4076         "created_at": {
4077           "type": "datetime"
4078         },
4079         "scopes": {
4080           "type": "Array"
4081         }
4082       }
4083     },
4084     "AuthorizedKeyList": {
4085       "id": "AuthorizedKeyList",
4086       "description": "AuthorizedKey list",
4087       "type": "object",
4088       "properties": {
4089         "kind": {
4090           "type": "string",
4091           "description": "Object type. Always arvados#authorizedKeyList.",
4092           "default": "arvados#authorizedKeyList"
4093         },
4094         "etag": {
4095           "type": "string",
4096           "description": "List version."
4097         },
4098         "items": {
4099           "type": "array",
4100           "description": "The list of AuthorizedKeys.",
4101           "items": {
4102             "$ref": "AuthorizedKey"
4103           }
4104         },
4105         "next_link": {
4106           "type": "string",
4107           "description": "A link to the next page of AuthorizedKeys."
4108         },
4109         "next_page_token": {
4110           "type": "string",
4111           "description": "The page token for the next page of AuthorizedKeys."
4112         },
4113         "selfLink": {
4114           "type": "string",
4115           "description": "A link back to this list."
4116         }
4117       }
4118     },
4119     "AuthorizedKey": {
4120       "id": "AuthorizedKey",
4121       "description": "AuthorizedKey",
4122       "type": "object",
4123       "uuidPrefix": "fngyi",
4124       "properties": {
4125         "uuid": {
4126           "type": "string"
4127         },
4128         "etag": {
4129           "type": "string",
4130           "description": "Object version."
4131         },
4132         "owner_uuid": {
4133           "type": "string"
4134         },
4135         "modified_by_client_uuid": {
4136           "type": "string"
4137         },
4138         "modified_by_user_uuid": {
4139           "type": "string"
4140         },
4141         "modified_at": {
4142           "type": "datetime"
4143         },
4144         "name": {
4145           "type": "string"
4146         },
4147         "key_type": {
4148           "type": "string"
4149         },
4150         "authorized_user_uuid": {
4151           "type": "string"
4152         },
4153         "public_key": {
4154           "type": "text"
4155         },
4156         "expires_at": {
4157           "type": "datetime"
4158         },
4159         "created_at": {
4160           "type": "datetime"
4161         }
4162       }
4163     },
4164     "CollectionList": {
4165       "id": "CollectionList",
4166       "description": "Collection list",
4167       "type": "object",
4168       "properties": {
4169         "kind": {
4170           "type": "string",
4171           "description": "Object type. Always arvados#collectionList.",
4172           "default": "arvados#collectionList"
4173         },
4174         "etag": {
4175           "type": "string",
4176           "description": "List version."
4177         },
4178         "items": {
4179           "type": "array",
4180           "description": "The list of Collections.",
4181           "items": {
4182             "$ref": "Collection"
4183           }
4184         },
4185         "next_link": {
4186           "type": "string",
4187           "description": "A link to the next page of Collections."
4188         },
4189         "next_page_token": {
4190           "type": "string",
4191           "description": "The page token for the next page of Collections."
4192         },
4193         "selfLink": {
4194           "type": "string",
4195           "description": "A link back to this list."
4196         }
4197       }
4198     },
4199     "Collection": {
4200       "id": "Collection",
4201       "description": "Collection",
4202       "type": "object",
4203       "uuidPrefix": "4zz18",
4204       "properties": {
4205         "uuid": {
4206           "type": "string"
4207         },
4208         "etag": {
4209           "type": "string",
4210           "description": "Object version."
4211         },
4212         "owner_uuid": {
4213           "type": "string"
4214         },
4215         "created_at": {
4216           "type": "datetime"
4217         },
4218         "modified_by_client_uuid": {
4219           "type": "string"
4220         },
4221         "modified_by_user_uuid": {
4222           "type": "string"
4223         },
4224         "modified_at": {
4225           "type": "datetime"
4226         },
4227         "portable_data_hash": {
4228           "type": "string"
4229         },
4230         "replication_desired": {
4231           "type": "integer"
4232         },
4233         "replication_confirmed_at": {
4234           "type": "datetime"
4235         },
4236         "replication_confirmed": {
4237           "type": "integer"
4238         },
4239         "manifest_text": {
4240           "type": "text"
4241         },
4242         "name": {
4243           "type": "string"
4244         },
4245         "description": {
4246           "type": "string"
4247         },
4248         "properties": {
4249           "type": "Hash"
4250         },
4251         "delete_at": {
4252           "type": "datetime"
4253         },
4254         "trash_at": {
4255           "type": "datetime"
4256         },
4257         "is_trashed": {
4258           "type": "boolean"
4259         },
4260         "storage_classes_desired": {
4261           "type": "Array"
4262         },
4263         "storage_classes_confirmed": {
4264           "type": "Array"
4265         },
4266         "storage_classes_confirmed_at": {
4267           "type": "datetime"
4268         },
4269         "current_version_uuid": {
4270           "type": "string"
4271         },
4272         "version": {
4273           "type": "integer"
4274         },
4275         "preserve_version": {
4276           "type": "boolean"
4277         },
4278         "file_count": {
4279           "type": "integer"
4280         },
4281         "file_size_total": {
4282           "type": "integer"
4283         }
4284       }
4285     },
4286     "ComputedPermissionList": {
4287       "id": "ComputedPermissionList",
4288       "description": "ComputedPermission list",
4289       "type": "object",
4290       "properties": {
4291         "kind": {
4292           "type": "string",
4293           "description": "Object type. Always arvados#computedPermissionList.",
4294           "default": "arvados#computedPermissionList"
4295         },
4296         "etag": {
4297           "type": "string",
4298           "description": "List version."
4299         },
4300         "items": {
4301           "type": "array",
4302           "description": "The list of ComputedPermissions.",
4303           "items": {
4304             "$ref": "ComputedPermission"
4305           }
4306         },
4307         "next_link": {
4308           "type": "string",
4309           "description": "A link to the next page of ComputedPermissions."
4310         },
4311         "next_page_token": {
4312           "type": "string",
4313           "description": "The page token for the next page of ComputedPermissions."
4314         },
4315         "selfLink": {
4316           "type": "string",
4317           "description": "A link back to this list."
4318         }
4319       }
4320     },
4321     "ComputedPermission": {
4322       "id": "ComputedPermission",
4323       "description": "ComputedPermission",
4324       "type": "object",
4325       "properties": {
4326         "user_uuid": {
4327           "type": "string"
4328         },
4329         "target_uuid": {
4330           "type": "string"
4331         },
4332         "perm_level": {
4333           "type": "integer"
4334         }
4335       }
4336     },
4337     "ContainerList": {
4338       "id": "ContainerList",
4339       "description": "Container list",
4340       "type": "object",
4341       "properties": {
4342         "kind": {
4343           "type": "string",
4344           "description": "Object type. Always arvados#containerList.",
4345           "default": "arvados#containerList"
4346         },
4347         "etag": {
4348           "type": "string",
4349           "description": "List version."
4350         },
4351         "items": {
4352           "type": "array",
4353           "description": "The list of Containers.",
4354           "items": {
4355             "$ref": "Container"
4356           }
4357         },
4358         "next_link": {
4359           "type": "string",
4360           "description": "A link to the next page of Containers."
4361         },
4362         "next_page_token": {
4363           "type": "string",
4364           "description": "The page token for the next page of Containers."
4365         },
4366         "selfLink": {
4367           "type": "string",
4368           "description": "A link back to this list."
4369         }
4370       }
4371     },
4372     "Container": {
4373       "id": "Container",
4374       "description": "Container",
4375       "type": "object",
4376       "uuidPrefix": "dz642",
4377       "properties": {
4378         "uuid": {
4379           "type": "string"
4380         },
4381         "etag": {
4382           "type": "string",
4383           "description": "Object version."
4384         },
4385         "owner_uuid": {
4386           "type": "string"
4387         },
4388         "created_at": {
4389           "type": "datetime"
4390         },
4391         "modified_at": {
4392           "type": "datetime"
4393         },
4394         "modified_by_client_uuid": {
4395           "type": "string"
4396         },
4397         "modified_by_user_uuid": {
4398           "type": "string"
4399         },
4400         "state": {
4401           "type": "string"
4402         },
4403         "started_at": {
4404           "type": "datetime"
4405         },
4406         "finished_at": {
4407           "type": "datetime"
4408         },
4409         "log": {
4410           "type": "string"
4411         },
4412         "environment": {
4413           "type": "Hash"
4414         },
4415         "cwd": {
4416           "type": "string"
4417         },
4418         "command": {
4419           "type": "Array"
4420         },
4421         "output_path": {
4422           "type": "string"
4423         },
4424         "mounts": {
4425           "type": "Hash"
4426         },
4427         "runtime_constraints": {
4428           "type": "Hash"
4429         },
4430         "output": {
4431           "type": "string"
4432         },
4433         "container_image": {
4434           "type": "string"
4435         },
4436         "progress": {
4437           "type": "float"
4438         },
4439         "priority": {
4440           "type": "integer"
4441         },
4442         "exit_code": {
4443           "type": "integer"
4444         },
4445         "auth_uuid": {
4446           "type": "string"
4447         },
4448         "locked_by_uuid": {
4449           "type": "string"
4450         },
4451         "scheduling_parameters": {
4452           "type": "Hash"
4453         },
4454         "runtime_status": {
4455           "type": "Hash"
4456         },
4457         "runtime_user_uuid": {
4458           "type": "text"
4459         },
4460         "runtime_auth_scopes": {
4461           "type": "Array"
4462         },
4463         "lock_count": {
4464           "type": "integer"
4465         },
4466         "gateway_address": {
4467           "type": "string"
4468         },
4469         "interactive_session_started": {
4470           "type": "boolean"
4471         },
4472         "output_storage_classes": {
4473           "type": "Array"
4474         },
4475         "output_properties": {
4476           "type": "Hash"
4477         },
4478         "cost": {
4479           "type": "float"
4480         },
4481         "subrequests_cost": {
4482           "type": "float"
4483         },
4484         "output_glob": {
4485           "type": "Array"
4486         }
4487       }
4488     },
4489     "ContainerRequestList": {
4490       "id": "ContainerRequestList",
4491       "description": "ContainerRequest list",
4492       "type": "object",
4493       "properties": {
4494         "kind": {
4495           "type": "string",
4496           "description": "Object type. Always arvados#containerRequestList.",
4497           "default": "arvados#containerRequestList"
4498         },
4499         "etag": {
4500           "type": "string",
4501           "description": "List version."
4502         },
4503         "items": {
4504           "type": "array",
4505           "description": "The list of ContainerRequests.",
4506           "items": {
4507             "$ref": "ContainerRequest"
4508           }
4509         },
4510         "next_link": {
4511           "type": "string",
4512           "description": "A link to the next page of ContainerRequests."
4513         },
4514         "next_page_token": {
4515           "type": "string",
4516           "description": "The page token for the next page of ContainerRequests."
4517         },
4518         "selfLink": {
4519           "type": "string",
4520           "description": "A link back to this list."
4521         }
4522       }
4523     },
4524     "ContainerRequest": {
4525       "id": "ContainerRequest",
4526       "description": "ContainerRequest",
4527       "type": "object",
4528       "uuidPrefix": "xvhdp",
4529       "properties": {
4530         "uuid": {
4531           "type": "string"
4532         },
4533         "etag": {
4534           "type": "string",
4535           "description": "Object version."
4536         },
4537         "owner_uuid": {
4538           "type": "string"
4539         },
4540         "created_at": {
4541           "type": "datetime"
4542         },
4543         "modified_at": {
4544           "type": "datetime"
4545         },
4546         "modified_by_client_uuid": {
4547           "type": "string"
4548         },
4549         "modified_by_user_uuid": {
4550           "type": "string"
4551         },
4552         "name": {
4553           "type": "string"
4554         },
4555         "description": {
4556           "type": "text"
4557         },
4558         "properties": {
4559           "type": "Hash"
4560         },
4561         "state": {
4562           "type": "string"
4563         },
4564         "requesting_container_uuid": {
4565           "type": "string"
4566         },
4567         "container_uuid": {
4568           "type": "string"
4569         },
4570         "container_count_max": {
4571           "type": "integer"
4572         },
4573         "mounts": {
4574           "type": "Hash"
4575         },
4576         "runtime_constraints": {
4577           "type": "Hash"
4578         },
4579         "container_image": {
4580           "type": "string"
4581         },
4582         "environment": {
4583           "type": "Hash"
4584         },
4585         "cwd": {
4586           "type": "string"
4587         },
4588         "command": {
4589           "type": "Array"
4590         },
4591         "output_path": {
4592           "type": "string"
4593         },
4594         "priority": {
4595           "type": "integer"
4596         },
4597         "expires_at": {
4598           "type": "datetime"
4599         },
4600         "filters": {
4601           "type": "text"
4602         },
4603         "container_count": {
4604           "type": "integer"
4605         },
4606         "use_existing": {
4607           "type": "boolean"
4608         },
4609         "scheduling_parameters": {
4610           "type": "Hash"
4611         },
4612         "output_uuid": {
4613           "type": "string"
4614         },
4615         "log_uuid": {
4616           "type": "string"
4617         },
4618         "output_name": {
4619           "type": "string"
4620         },
4621         "output_ttl": {
4622           "type": "integer"
4623         },
4624         "output_storage_classes": {
4625           "type": "Array"
4626         },
4627         "output_properties": {
4628           "type": "Hash"
4629         },
4630         "cumulative_cost": {
4631           "type": "float"
4632         },
4633         "output_glob": {
4634           "type": "Array"
4635         }
4636       }
4637     },
4638     "GroupList": {
4639       "id": "GroupList",
4640       "description": "Group list",
4641       "type": "object",
4642       "properties": {
4643         "kind": {
4644           "type": "string",
4645           "description": "Object type. Always arvados#groupList.",
4646           "default": "arvados#groupList"
4647         },
4648         "etag": {
4649           "type": "string",
4650           "description": "List version."
4651         },
4652         "items": {
4653           "type": "array",
4654           "description": "The list of Groups.",
4655           "items": {
4656             "$ref": "Group"
4657           }
4658         },
4659         "next_link": {
4660           "type": "string",
4661           "description": "A link to the next page of Groups."
4662         },
4663         "next_page_token": {
4664           "type": "string",
4665           "description": "The page token for the next page of Groups."
4666         },
4667         "selfLink": {
4668           "type": "string",
4669           "description": "A link back to this list."
4670         }
4671       }
4672     },
4673     "Group": {
4674       "id": "Group",
4675       "description": "Group",
4676       "type": "object",
4677       "uuidPrefix": "j7d0g",
4678       "properties": {
4679         "uuid": {
4680           "type": "string"
4681         },
4682         "etag": {
4683           "type": "string",
4684           "description": "Object version."
4685         },
4686         "owner_uuid": {
4687           "type": "string"
4688         },
4689         "created_at": {
4690           "type": "datetime"
4691         },
4692         "modified_by_client_uuid": {
4693           "type": "string"
4694         },
4695         "modified_by_user_uuid": {
4696           "type": "string"
4697         },
4698         "modified_at": {
4699           "type": "datetime"
4700         },
4701         "name": {
4702           "type": "string"
4703         },
4704         "description": {
4705           "type": "string"
4706         },
4707         "group_class": {
4708           "type": "string"
4709         },
4710         "trash_at": {
4711           "type": "datetime"
4712         },
4713         "is_trashed": {
4714           "type": "boolean"
4715         },
4716         "delete_at": {
4717           "type": "datetime"
4718         },
4719         "properties": {
4720           "type": "Hash"
4721         },
4722         "frozen_by_uuid": {
4723           "type": "string"
4724         }
4725       }
4726     },
4727     "KeepServiceList": {
4728       "id": "KeepServiceList",
4729       "description": "KeepService list",
4730       "type": "object",
4731       "properties": {
4732         "kind": {
4733           "type": "string",
4734           "description": "Object type. Always arvados#keepServiceList.",
4735           "default": "arvados#keepServiceList"
4736         },
4737         "etag": {
4738           "type": "string",
4739           "description": "List version."
4740         },
4741         "items": {
4742           "type": "array",
4743           "description": "The list of KeepServices.",
4744           "items": {
4745             "$ref": "KeepService"
4746           }
4747         },
4748         "next_link": {
4749           "type": "string",
4750           "description": "A link to the next page of KeepServices."
4751         },
4752         "next_page_token": {
4753           "type": "string",
4754           "description": "The page token for the next page of KeepServices."
4755         },
4756         "selfLink": {
4757           "type": "string",
4758           "description": "A link back to this list."
4759         }
4760       }
4761     },
4762     "KeepService": {
4763       "id": "KeepService",
4764       "description": "KeepService",
4765       "type": "object",
4766       "uuidPrefix": "bi6l4",
4767       "properties": {
4768         "uuid": {
4769           "type": "string"
4770         },
4771         "etag": {
4772           "type": "string",
4773           "description": "Object version."
4774         },
4775         "owner_uuid": {
4776           "type": "string"
4777         },
4778         "modified_by_client_uuid": {
4779           "type": "string"
4780         },
4781         "modified_by_user_uuid": {
4782           "type": "string"
4783         },
4784         "modified_at": {
4785           "type": "datetime"
4786         },
4787         "service_host": {
4788           "type": "string"
4789         },
4790         "service_port": {
4791           "type": "integer"
4792         },
4793         "service_ssl_flag": {
4794           "type": "boolean"
4795         },
4796         "service_type": {
4797           "type": "string"
4798         },
4799         "created_at": {
4800           "type": "datetime"
4801         },
4802         "read_only": {
4803           "type": "boolean"
4804         }
4805       }
4806     },
4807     "LinkList": {
4808       "id": "LinkList",
4809       "description": "Link list",
4810       "type": "object",
4811       "properties": {
4812         "kind": {
4813           "type": "string",
4814           "description": "Object type. Always arvados#linkList.",
4815           "default": "arvados#linkList"
4816         },
4817         "etag": {
4818           "type": "string",
4819           "description": "List version."
4820         },
4821         "items": {
4822           "type": "array",
4823           "description": "The list of Links.",
4824           "items": {
4825             "$ref": "Link"
4826           }
4827         },
4828         "next_link": {
4829           "type": "string",
4830           "description": "A link to the next page of Links."
4831         },
4832         "next_page_token": {
4833           "type": "string",
4834           "description": "The page token for the next page of Links."
4835         },
4836         "selfLink": {
4837           "type": "string",
4838           "description": "A link back to this list."
4839         }
4840       }
4841     },
4842     "Link": {
4843       "id": "Link",
4844       "description": "Link",
4845       "type": "object",
4846       "uuidPrefix": "o0j2j",
4847       "properties": {
4848         "uuid": {
4849           "type": "string"
4850         },
4851         "etag": {
4852           "type": "string",
4853           "description": "Object version."
4854         },
4855         "owner_uuid": {
4856           "type": "string"
4857         },
4858         "created_at": {
4859           "type": "datetime"
4860         },
4861         "modified_by_client_uuid": {
4862           "type": "string"
4863         },
4864         "modified_by_user_uuid": {
4865           "type": "string"
4866         },
4867         "modified_at": {
4868           "type": "datetime"
4869         },
4870         "tail_uuid": {
4871           "type": "string"
4872         },
4873         "link_class": {
4874           "type": "string"
4875         },
4876         "name": {
4877           "type": "string"
4878         },
4879         "head_uuid": {
4880           "type": "string"
4881         },
4882         "properties": {
4883           "type": "Hash"
4884         }
4885       }
4886     },
4887     "LogList": {
4888       "id": "LogList",
4889       "description": "Log list",
4890       "type": "object",
4891       "properties": {
4892         "kind": {
4893           "type": "string",
4894           "description": "Object type. Always arvados#logList.",
4895           "default": "arvados#logList"
4896         },
4897         "etag": {
4898           "type": "string",
4899           "description": "List version."
4900         },
4901         "items": {
4902           "type": "array",
4903           "description": "The list of Logs.",
4904           "items": {
4905             "$ref": "Log"
4906           }
4907         },
4908         "next_link": {
4909           "type": "string",
4910           "description": "A link to the next page of Logs."
4911         },
4912         "next_page_token": {
4913           "type": "string",
4914           "description": "The page token for the next page of Logs."
4915         },
4916         "selfLink": {
4917           "type": "string",
4918           "description": "A link back to this list."
4919         }
4920       }
4921     },
4922     "Log": {
4923       "id": "Log",
4924       "description": "Log",
4925       "type": "object",
4926       "uuidPrefix": "57u5n",
4927       "properties": {
4928         "uuid": {
4929           "type": "string"
4930         },
4931         "etag": {
4932           "type": "string",
4933           "description": "Object version."
4934         },
4935         "id": {
4936           "type": "integer"
4937         },
4938         "owner_uuid": {
4939           "type": "string"
4940         },
4941         "modified_by_client_uuid": {
4942           "type": "string"
4943         },
4944         "modified_by_user_uuid": {
4945           "type": "string"
4946         },
4947         "object_uuid": {
4948           "type": "string"
4949         },
4950         "event_at": {
4951           "type": "datetime"
4952         },
4953         "event_type": {
4954           "type": "string"
4955         },
4956         "summary": {
4957           "type": "text"
4958         },
4959         "properties": {
4960           "type": "Hash"
4961         },
4962         "created_at": {
4963           "type": "datetime"
4964         },
4965         "modified_at": {
4966           "type": "datetime"
4967         },
4968         "object_owner_uuid": {
4969           "type": "string"
4970         }
4971       }
4972     },
4973     "UserList": {
4974       "id": "UserList",
4975       "description": "User list",
4976       "type": "object",
4977       "properties": {
4978         "kind": {
4979           "type": "string",
4980           "description": "Object type. Always arvados#userList.",
4981           "default": "arvados#userList"
4982         },
4983         "etag": {
4984           "type": "string",
4985           "description": "List version."
4986         },
4987         "items": {
4988           "type": "array",
4989           "description": "The list of Users.",
4990           "items": {
4991             "$ref": "User"
4992           }
4993         },
4994         "next_link": {
4995           "type": "string",
4996           "description": "A link to the next page of Users."
4997         },
4998         "next_page_token": {
4999           "type": "string",
5000           "description": "The page token for the next page of Users."
5001         },
5002         "selfLink": {
5003           "type": "string",
5004           "description": "A link back to this list."
5005         }
5006       }
5007     },
5008     "User": {
5009       "id": "User",
5010       "description": "User",
5011       "type": "object",
5012       "uuidPrefix": "tpzed",
5013       "properties": {
5014         "uuid": {
5015           "type": "string"
5016         },
5017         "etag": {
5018           "type": "string",
5019           "description": "Object version."
5020         },
5021         "owner_uuid": {
5022           "type": "string"
5023         },
5024         "created_at": {
5025           "type": "datetime"
5026         },
5027         "modified_by_client_uuid": {
5028           "type": "string"
5029         },
5030         "modified_by_user_uuid": {
5031           "type": "string"
5032         },
5033         "modified_at": {
5034           "type": "datetime"
5035         },
5036         "email": {
5037           "type": "string"
5038         },
5039         "first_name": {
5040           "type": "string"
5041         },
5042         "last_name": {
5043           "type": "string"
5044         },
5045         "identity_url": {
5046           "type": "string"
5047         },
5048         "is_admin": {
5049           "type": "boolean"
5050         },
5051         "prefs": {
5052           "type": "Hash"
5053         },
5054         "is_active": {
5055           "type": "boolean"
5056         },
5057         "username": {
5058           "type": "string"
5059         }
5060       }
5061     },
5062     "UserAgreementList": {
5063       "id": "UserAgreementList",
5064       "description": "UserAgreement list",
5065       "type": "object",
5066       "properties": {
5067         "kind": {
5068           "type": "string",
5069           "description": "Object type. Always arvados#userAgreementList.",
5070           "default": "arvados#userAgreementList"
5071         },
5072         "etag": {
5073           "type": "string",
5074           "description": "List version."
5075         },
5076         "items": {
5077           "type": "array",
5078           "description": "The list of UserAgreements.",
5079           "items": {
5080             "$ref": "UserAgreement"
5081           }
5082         },
5083         "next_link": {
5084           "type": "string",
5085           "description": "A link to the next page of UserAgreements."
5086         },
5087         "next_page_token": {
5088           "type": "string",
5089           "description": "The page token for the next page of UserAgreements."
5090         },
5091         "selfLink": {
5092           "type": "string",
5093           "description": "A link back to this list."
5094         }
5095       }
5096     },
5097     "UserAgreement": {
5098       "id": "UserAgreement",
5099       "description": "UserAgreement",
5100       "type": "object",
5101       "uuidPrefix": "gv0sa",
5102       "properties": {
5103         "uuid": {
5104           "type": "string"
5105         },
5106         "etag": {
5107           "type": "string",
5108           "description": "Object version."
5109         },
5110         "owner_uuid": {
5111           "type": "string"
5112         },
5113         "created_at": {
5114           "type": "datetime"
5115         },
5116         "modified_by_client_uuid": {
5117           "type": "string"
5118         },
5119         "modified_by_user_uuid": {
5120           "type": "string"
5121         },
5122         "modified_at": {
5123           "type": "datetime"
5124         },
5125         "portable_data_hash": {
5126           "type": "string"
5127         },
5128         "replication_desired": {
5129           "type": "integer"
5130         },
5131         "replication_confirmed_at": {
5132           "type": "datetime"
5133         },
5134         "replication_confirmed": {
5135           "type": "integer"
5136         },
5137         "manifest_text": {
5138           "type": "text"
5139         },
5140         "name": {
5141           "type": "string"
5142         },
5143         "description": {
5144           "type": "string"
5145         },
5146         "properties": {
5147           "type": "Hash"
5148         },
5149         "delete_at": {
5150           "type": "datetime"
5151         },
5152         "trash_at": {
5153           "type": "datetime"
5154         },
5155         "is_trashed": {
5156           "type": "boolean"
5157         },
5158         "storage_classes_desired": {
5159           "type": "Array"
5160         },
5161         "storage_classes_confirmed": {
5162           "type": "Array"
5163         },
5164         "storage_classes_confirmed_at": {
5165           "type": "datetime"
5166         },
5167         "current_version_uuid": {
5168           "type": "string"
5169         },
5170         "version": {
5171           "type": "integer"
5172         },
5173         "preserve_version": {
5174           "type": "boolean"
5175         },
5176         "file_count": {
5177           "type": "integer"
5178         },
5179         "file_size_total": {
5180           "type": "integer"
5181         }
5182       }
5183     },
5184     "VirtualMachineList": {
5185       "id": "VirtualMachineList",
5186       "description": "VirtualMachine list",
5187       "type": "object",
5188       "properties": {
5189         "kind": {
5190           "type": "string",
5191           "description": "Object type. Always arvados#virtualMachineList.",
5192           "default": "arvados#virtualMachineList"
5193         },
5194         "etag": {
5195           "type": "string",
5196           "description": "List version."
5197         },
5198         "items": {
5199           "type": "array",
5200           "description": "The list of VirtualMachines.",
5201           "items": {
5202             "$ref": "VirtualMachine"
5203           }
5204         },
5205         "next_link": {
5206           "type": "string",
5207           "description": "A link to the next page of VirtualMachines."
5208         },
5209         "next_page_token": {
5210           "type": "string",
5211           "description": "The page token for the next page of VirtualMachines."
5212         },
5213         "selfLink": {
5214           "type": "string",
5215           "description": "A link back to this list."
5216         }
5217       }
5218     },
5219     "VirtualMachine": {
5220       "id": "VirtualMachine",
5221       "description": "VirtualMachine",
5222       "type": "object",
5223       "uuidPrefix": "2x53u",
5224       "properties": {
5225         "uuid": {
5226           "type": "string"
5227         },
5228         "etag": {
5229           "type": "string",
5230           "description": "Object version."
5231         },
5232         "owner_uuid": {
5233           "type": "string"
5234         },
5235         "modified_by_client_uuid": {
5236           "type": "string"
5237         },
5238         "modified_by_user_uuid": {
5239           "type": "string"
5240         },
5241         "modified_at": {
5242           "type": "datetime"
5243         },
5244         "hostname": {
5245           "type": "string"
5246         },
5247         "created_at": {
5248           "type": "datetime"
5249         }
5250       }
5251     },
5252     "WorkflowList": {
5253       "id": "WorkflowList",
5254       "description": "Workflow list",
5255       "type": "object",
5256       "properties": {
5257         "kind": {
5258           "type": "string",
5259           "description": "Object type. Always arvados#workflowList.",
5260           "default": "arvados#workflowList"
5261         },
5262         "etag": {
5263           "type": "string",
5264           "description": "List version."
5265         },
5266         "items": {
5267           "type": "array",
5268           "description": "The list of Workflows.",
5269           "items": {
5270             "$ref": "Workflow"
5271           }
5272         },
5273         "next_link": {
5274           "type": "string",
5275           "description": "A link to the next page of Workflows."
5276         },
5277         "next_page_token": {
5278           "type": "string",
5279           "description": "The page token for the next page of Workflows."
5280         },
5281         "selfLink": {
5282           "type": "string",
5283           "description": "A link back to this list."
5284         }
5285       }
5286     },
5287     "Workflow": {
5288       "id": "Workflow",
5289       "description": "Workflow",
5290       "type": "object",
5291       "uuidPrefix": "7fd4e",
5292       "properties": {
5293         "uuid": {
5294           "type": "string"
5295         },
5296         "etag": {
5297           "type": "string",
5298           "description": "Object version."
5299         },
5300         "owner_uuid": {
5301           "type": "string"
5302         },
5303         "created_at": {
5304           "type": "datetime"
5305         },
5306         "modified_at": {
5307           "type": "datetime"
5308         },
5309         "modified_by_client_uuid": {
5310           "type": "string"
5311         },
5312         "modified_by_user_uuid": {
5313           "type": "string"
5314         },
5315         "name": {
5316           "type": "string"
5317         },
5318         "description": {
5319           "type": "text"
5320         },
5321         "definition": {
5322           "type": "text"
5323         }
5324       }
5325     }
5326   },
5327   "servicePath": "arvados/v1/",
5328   "title": "Arvados API",
5329   "version": "v1"
5330 }