},
"protocol": "rest",
"resources": {
- "jobs": {
+ "api_clients": {
"methods": {
"get": {
- "id": "arvados.jobs.get",
- "path": "jobs/{uuid}",
+ "id": "arvados.api_clients.get",
+ "path": "api_clients/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Job's metadata by UUID.",
+ "description": "Gets a ApiClient's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Job in question.",
+ "description": "The UUID of the ApiClient in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Job"
+ "$ref": "ApiClient"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.jobs.list",
- "path": "jobs",
+ "id": "arvados.api_clients.list",
+ "path": "api_clients",
"httpMethod": "GET",
- "description": "List Jobs.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Jobs. For example:\n\n <pre>\n {\n \"kind\":\"arvados#jobList\",\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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "JobList"
+ "$ref": "ApiClientList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.jobs.create",
- "path": "jobs",
+ "id": "arvados.api_clients.create",
+ "path": "api_clients",
"httpMethod": "POST",
- "description": "Create a new Job.",
+ "description": "Create a new ApiClient.",
"parameters": {
"select": {
"type": "array",
"description": "Create object on a remote federated cluster instead of the current one.",
"location": "query",
"required": false
- },
- "find_or_create": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "",
- "location": "query"
- },
- "filters": {
- "type": "array",
- "required": false,
- "description": "",
- "location": "query"
- },
- "minimum_script_version": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- },
- "exclude_script_versions": {
- "type": "array",
- "required": false,
- "description": "",
- "location": "query"
}
},
"request": {
"required": true,
"properties": {
- "job": {
- "$ref": "Job"
+ "api_client": {
+ "$ref": "ApiClient"
}
}
},
"response": {
- "$ref": "Job"
+ "$ref": "ApiClient"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.jobs.update",
- "path": "jobs/{uuid}",
+ "id": "arvados.api_clients.update",
+ "path": "api_clients/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Job.",
+ "description": "Update attributes of an existing ApiClient.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Job in question.",
+ "description": "The UUID of the ApiClient in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "job": {
- "$ref": "Job"
+ "api_client": {
+ "$ref": "ApiClient"
}
}
},
"response": {
- "$ref": "Job"
+ "$ref": "ApiClient"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.jobs.delete",
- "path": "jobs/{uuid}",
+ "id": "arvados.api_clients.delete",
+ "path": "api_clients/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Job.",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "The UUID of the Job in question.",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "queue": {
- "id": "arvados.jobs.queue",
- "path": "jobs/queue",
- "httpMethod": "GET",
- "description": "queue jobs",
- "parameters": {
- "filters": {
- "type": "array",
- "required": false,
- "description": "",
- "location": "query"
- },
- "where": {
- "type": "object",
- "required": false,
- "description": "",
- "location": "query"
- },
- "order": {
- "type": "array",
- "required": false,
- "description": "",
- "location": "query"
- },
- "select": {
- "type": "array",
- "description": "Attributes of each object to return in the response.",
- "required": false,
- "location": "query"
- },
- "distinct": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "",
- "location": "query"
- },
- "limit": {
- "type": "integer",
- "required": false,
- "default": "100",
- "description": "",
- "location": "query"
- },
- "offset": {
- "type": "integer",
- "required": false,
- "default": "0",
- "description": "",
- "location": "query"
- },
- "count": {
- "type": "string",
- "required": false,
- "default": "exact",
- "description": "",
- "location": "query"
- },
- "cluster_id": {
- "type": "string",
- "description": "List objects on a remote federated cluster instead of the current one.",
- "location": "query",
- "required": false
- },
- "bypass_federation": {
- "type": "boolean",
- "required": false,
- "description": "bypass federation behavior, list items from local instance database only",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "queue_size": {
- "id": "arvados.jobs.queue_size",
- "path": "jobs/queue_size",
- "httpMethod": "GET",
- "description": "queue_size jobs",
- "parameters": {},
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "cancel": {
- "id": "arvados.jobs.cancel",
- "path": "jobs/{uuid}/cancel",
- "httpMethod": "POST",
- "description": "cancel jobs",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "lock": {
- "id": "arvados.jobs.lock",
- "path": "jobs/{uuid}/lock",
- "httpMethod": "POST",
- "description": "lock jobs",
+ "description": "Delete an existing ApiClient.",
"parameters": {
"uuid": {
"type": "string",
- "description": "",
+ "description": "The UUID of the ApiClient in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Job"
+ "$ref": "ApiClient"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.jobs.list",
- "path": "jobs",
+ "id": "arvados.api_clients.list",
+ "path": "api_clients",
"httpMethod": "GET",
- "description": "List Jobs.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Jobs. For example:\n\n <pre>\n {\n \"kind\":\"arvados#jobList\",\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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "JobList"
+ "$ref": "ApiClientList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.jobs.show",
- "path": "jobs/{uuid}",
+ "id": "arvados.api_clients.show",
+ "path": "api_clients/{uuid}",
"httpMethod": "GET",
- "description": "show jobs",
+ "description": "show api_clients",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Job"
+ "$ref": "ApiClient"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.jobs.destroy",
- "path": "jobs/{uuid}",
+ "id": "arvados.api_clients.destroy",
+ "path": "api_clients/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy jobs",
+ "description": "destroy api_clients",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Job"
+ "$ref": "ApiClient"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "api_clients": {
+ "api_client_authorizations": {
"methods": {
"get": {
- "id": "arvados.api_clients.get",
- "path": "api_clients/{uuid}",
+ "id": "arvados.api_client_authorizations.get",
+ "path": "api_client_authorizations/{uuid}",
"httpMethod": "GET",
- "description": "Gets a ApiClient's metadata by UUID.",
+ "description": "Gets a ApiClientAuthorization's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ApiClient in question.",
+ "description": "The UUID of the ApiClientAuthorization in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "ApiClient"
+ "$ref": "ApiClientAuthorization"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.api_clients.list",
- "path": "api_clients",
+ "id": "arvados.api_client_authorizations.list",
+ "path": "api_client_authorizations",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "ApiClientList"
+ "$ref": "ApiClientAuthorizationList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.api_clients.create",
- "path": "api_clients",
+ "id": "arvados.api_client_authorizations.create",
+ "path": "api_client_authorizations",
"httpMethod": "POST",
- "description": "Create a new ApiClient.",
+ "description": "Create a new ApiClientAuthorization.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "api_client": {
- "$ref": "ApiClient"
+ "api_client_authorization": {
+ "$ref": "ApiClientAuthorization"
}
}
},
"response": {
- "$ref": "ApiClient"
+ "$ref": "ApiClientAuthorization"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.api_clients.update",
- "path": "api_clients/{uuid}",
+ "id": "arvados.api_client_authorizations.update",
+ "path": "api_client_authorizations/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing ApiClient.",
+ "description": "Update attributes of an existing ApiClientAuthorization.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ApiClient in question.",
+ "description": "The UUID of the ApiClientAuthorization in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "api_client": {
- "$ref": "ApiClient"
+ "api_client_authorization": {
+ "$ref": "ApiClientAuthorization"
}
}
},
"response": {
- "$ref": "ApiClient"
+ "$ref": "ApiClientAuthorization"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.api_clients.delete",
- "path": "api_clients/{uuid}",
+ "id": "arvados.api_client_authorizations.delete",
+ "path": "api_client_authorizations/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing ApiClient.",
+ "description": "Delete an existing ApiClientAuthorization.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ApiClient in question.",
+ "description": "The UUID of the ApiClientAuthorization in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "ApiClient"
+ "$ref": "ApiClientAuthorization"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "create_system_auth": {
+ "id": "arvados.api_client_authorizations.create_system_auth",
+ "path": "api_client_authorizations/create_system_auth",
+ "httpMethod": "POST",
+ "description": "create_system_auth api_client_authorizations",
+ "parameters": {
+ "api_client_id": {
+ "type": "integer",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "scopes": {
+ "type": "array",
+ "required": false,
+ "description": "",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "ApiClientAuthorization"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "current": {
+ "id": "arvados.api_client_authorizations.current",
+ "path": "api_client_authorizations/current",
+ "httpMethod": "GET",
+ "description": "current api_client_authorizations",
+ "parameters": {},
+ "response": {
+ "$ref": "ApiClientAuthorization"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.api_clients.list",
- "path": "api_clients",
+ "id": "arvados.api_client_authorizations.list",
+ "path": "api_client_authorizations",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "ApiClientList"
+ "$ref": "ApiClientAuthorizationList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.api_clients.show",
- "path": "api_clients/{uuid}",
+ "id": "arvados.api_client_authorizations.show",
+ "path": "api_client_authorizations/{uuid}",
"httpMethod": "GET",
- "description": "show api_clients",
+ "description": "show api_client_authorizations",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "ApiClient"
+ "$ref": "ApiClientAuthorization"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.api_clients.destroy",
- "path": "api_clients/{uuid}",
+ "id": "arvados.api_client_authorizations.destroy",
+ "path": "api_client_authorizations/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy api_clients",
+ "description": "destroy api_client_authorizations",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "ApiClient"
+ "$ref": "ApiClientAuthorization"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "api_client_authorizations": {
+ "authorized_keys": {
"methods": {
"get": {
- "id": "arvados.api_client_authorizations.get",
- "path": "api_client_authorizations/{uuid}",
+ "id": "arvados.authorized_keys.get",
+ "path": "authorized_keys/{uuid}",
"httpMethod": "GET",
- "description": "Gets a ApiClientAuthorization's metadata by UUID.",
+ "description": "Gets a AuthorizedKey's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ApiClientAuthorization in question.",
+ "description": "The UUID of the AuthorizedKey in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "ApiClientAuthorization"
+ "$ref": "AuthorizedKey"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.api_client_authorizations.list",
- "path": "api_client_authorizations",
+ "id": "arvados.authorized_keys.list",
+ "path": "authorized_keys",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "ApiClientAuthorizationList"
+ "$ref": "AuthorizedKeyList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.api_client_authorizations.create",
- "path": "api_client_authorizations",
+ "id": "arvados.authorized_keys.create",
+ "path": "authorized_keys",
"httpMethod": "POST",
- "description": "Create a new ApiClientAuthorization.",
+ "description": "Create a new AuthorizedKey.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "api_client_authorization": {
- "$ref": "ApiClientAuthorization"
+ "authorized_key": {
+ "$ref": "AuthorizedKey"
}
}
},
"response": {
- "$ref": "ApiClientAuthorization"
+ "$ref": "AuthorizedKey"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.api_client_authorizations.update",
- "path": "api_client_authorizations/{uuid}",
+ "id": "arvados.authorized_keys.update",
+ "path": "authorized_keys/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing ApiClientAuthorization.",
+ "description": "Update attributes of an existing AuthorizedKey.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ApiClientAuthorization in question.",
+ "description": "The UUID of the AuthorizedKey in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "api_client_authorization": {
- "$ref": "ApiClientAuthorization"
+ "authorized_key": {
+ "$ref": "AuthorizedKey"
}
}
},
"response": {
- "$ref": "ApiClientAuthorization"
+ "$ref": "AuthorizedKey"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.api_client_authorizations.delete",
- "path": "api_client_authorizations/{uuid}",
+ "id": "arvados.authorized_keys.delete",
+ "path": "authorized_keys/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing ApiClientAuthorization.",
+ "description": "Delete an existing AuthorizedKey.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ApiClientAuthorization in question.",
+ "description": "The UUID of the AuthorizedKey in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "ApiClientAuthorization"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "create_system_auth": {
- "id": "arvados.api_client_authorizations.create_system_auth",
- "path": "api_client_authorizations/create_system_auth",
- "httpMethod": "POST",
- "description": "create_system_auth api_client_authorizations",
- "parameters": {
- "api_client_id": {
- "type": "integer",
- "required": false,
- "description": "",
- "location": "query"
- },
- "scopes": {
- "type": "array",
- "required": false,
- "description": "",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ApiClientAuthorization"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "current": {
- "id": "arvados.api_client_authorizations.current",
- "path": "api_client_authorizations/current",
- "httpMethod": "GET",
- "description": "current api_client_authorizations",
- "parameters": {},
- "response": {
- "$ref": "ApiClientAuthorization"
+ "$ref": "AuthorizedKey"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.api_client_authorizations.list",
- "path": "api_client_authorizations",
+ "id": "arvados.authorized_keys.list",
+ "path": "authorized_keys",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "ApiClientAuthorizationList"
+ "$ref": "AuthorizedKeyList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.api_client_authorizations.show",
- "path": "api_client_authorizations/{uuid}",
+ "id": "arvados.authorized_keys.show",
+ "path": "authorized_keys/{uuid}",
"httpMethod": "GET",
- "description": "show api_client_authorizations",
+ "description": "show authorized_keys",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "ApiClientAuthorization"
+ "$ref": "AuthorizedKey"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.api_client_authorizations.destroy",
- "path": "api_client_authorizations/{uuid}",
+ "id": "arvados.authorized_keys.destroy",
+ "path": "authorized_keys/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy api_client_authorizations",
+ "description": "destroy authorized_keys",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "ApiClientAuthorization"
+ "$ref": "AuthorizedKey"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "authorized_keys": {
+ "collections": {
"methods": {
"get": {
- "id": "arvados.authorized_keys.get",
- "path": "authorized_keys/{uuid}",
+ "id": "arvados.collections.get",
+ "path": "collections/{uuid}",
"httpMethod": "GET",
- "description": "Gets a AuthorizedKey's metadata by UUID.",
+ "description": "Gets a Collection's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the AuthorizedKey in question.",
+ "description": "The UUID of the Collection in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "AuthorizedKey"
+ "$ref": "Collection"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.authorized_keys.list",
- "path": "authorized_keys",
+ "id": "arvados.collections.list",
+ "path": "collections",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
+ },
+ "include_trash": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include collections whose is_trashed attribute is true.",
+ "location": "query"
+ },
+ "include_old_versions": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include past collection versions.",
+ "location": "query"
}
},
"response": {
- "$ref": "AuthorizedKeyList"
+ "$ref": "CollectionList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.authorized_keys.create",
- "path": "authorized_keys",
+ "id": "arvados.collections.create",
+ "path": "collections",
"httpMethod": "POST",
- "description": "Create a new AuthorizedKey.",
+ "description": "Create a new Collection.",
"parameters": {
"select": {
"type": "array",
"description": "Create object on a remote federated cluster instead of the current one.",
"location": "query",
"required": false
+ },
+ "replace_files": {
+ "type": "object",
+ "description": "Files and directories to initialize/replace with content from other collections.",
+ "required": false,
+ "location": "query",
+ "properties": {},
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"request": {
"required": true,
"properties": {
- "authorized_key": {
- "$ref": "AuthorizedKey"
+ "collection": {
+ "$ref": "Collection"
}
}
},
"response": {
- "$ref": "AuthorizedKey"
+ "$ref": "Collection"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.authorized_keys.update",
- "path": "authorized_keys/{uuid}",
+ "id": "arvados.collections.update",
+ "path": "collections/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing AuthorizedKey.",
+ "description": "Update attributes of an existing Collection.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the AuthorizedKey in question.",
+ "description": "The UUID of the Collection in question.",
"required": true,
"location": "path"
},
"description": "Attributes of the updated object to return in the response.",
"required": false,
"location": "query"
+ },
+ "replace_files": {
+ "type": "object",
+ "description": "Files and directories to initialize/replace with content from other collections.",
+ "required": false,
+ "location": "query",
+ "properties": {},
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"request": {
"required": true,
"properties": {
- "authorized_key": {
- "$ref": "AuthorizedKey"
+ "collection": {
+ "$ref": "Collection"
}
}
},
"response": {
- "$ref": "AuthorizedKey"
+ "$ref": "Collection"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.authorized_keys.delete",
- "path": "authorized_keys/{uuid}",
+ "id": "arvados.collections.delete",
+ "path": "collections/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing AuthorizedKey.",
+ "description": "Delete an existing Collection.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the AuthorizedKey in question.",
+ "description": "The UUID of the Collection in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "AuthorizedKey"
+ "$ref": "Collection"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "provenance": {
+ "id": "arvados.collections.provenance",
+ "path": "collections/{uuid}/provenance",
+ "httpMethod": "GET",
+ "description": "provenance collections",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Collection"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "used_by": {
+ "id": "arvados.collections.used_by",
+ "path": "collections/{uuid}/used_by",
+ "httpMethod": "GET",
+ "description": "used_by collections",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Collection"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "trash": {
+ "id": "arvados.collections.trash",
+ "path": "collections/{uuid}/trash",
+ "httpMethod": "POST",
+ "description": "trash collections",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Collection"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "untrash": {
+ "id": "arvados.collections.untrash",
+ "path": "collections/{uuid}/untrash",
+ "httpMethod": "POST",
+ "description": "untrash collections",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Collection"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.authorized_keys.list",
- "path": "authorized_keys",
+ "id": "arvados.collections.list",
+ "path": "collections",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
+ },
+ "include_trash": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include collections whose is_trashed attribute is true.",
+ "location": "query"
+ },
+ "include_old_versions": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include past collection versions.",
+ "location": "query"
}
},
"response": {
- "$ref": "AuthorizedKeyList"
+ "$ref": "CollectionList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.authorized_keys.show",
- "path": "authorized_keys/{uuid}",
+ "id": "arvados.collections.show",
+ "path": "collections/{uuid}",
"httpMethod": "GET",
- "description": "show authorized_keys",
+ "description": "show collections",
"parameters": {
"uuid": {
"type": "string",
"description": "Attributes of the object to return in the response.",
"required": false,
"location": "query"
+ },
+ "include_trash": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Show collection even if its is_trashed attribute is true.",
+ "location": "query"
+ },
+ "include_old_versions": {
+ "type": "boolean",
+ "required": false,
+ "default": "true",
+ "description": "Include past collection versions.",
+ "location": "query"
}
},
"response": {
- "$ref": "AuthorizedKey"
+ "$ref": "Collection"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.authorized_keys.destroy",
- "path": "authorized_keys/{uuid}",
+ "id": "arvados.collections.destroy",
+ "path": "collections/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy authorized_keys",
+ "description": "destroy collections",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "AuthorizedKey"
+ "$ref": "Collection"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "collections": {
+ "containers": {
"methods": {
"get": {
- "id": "arvados.collections.get",
- "path": "collections/{uuid}",
+ "id": "arvados.containers.get",
+ "path": "containers/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Collection's metadata by UUID.",
+ "description": "Gets a Container's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Collection in question.",
+ "description": "The UUID of the Container in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.collections.list",
- "path": "collections",
+ "id": "arvados.containers.list",
+ "path": "containers",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
- },
- "include_trash": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include collections whose is_trashed attribute is true.",
- "location": "query"
- },
- "include_old_versions": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include past collection versions.",
- "location": "query"
}
},
"response": {
- "$ref": "CollectionList"
+ "$ref": "ContainerList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.collections.create",
- "path": "collections",
+ "id": "arvados.containers.create",
+ "path": "containers",
"httpMethod": "POST",
- "description": "Create a new Collection.",
+ "description": "Create a new Container.",
"parameters": {
"select": {
"type": "array",
"description": "Create object on a remote federated cluster instead of the current one.",
"location": "query",
"required": false
- },
- "replace_files": {
- "type": "object",
- "description": "Files and directories to initialize/replace with content from other collections.",
- "required": false,
- "location": "query",
- "properties": {},
- "additionalProperties": {
- "type": "string"
- }
}
},
"request": {
"required": true,
"properties": {
- "collection": {
- "$ref": "Collection"
+ "container": {
+ "$ref": "Container"
}
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.collections.update",
- "path": "collections/{uuid}",
+ "id": "arvados.containers.update",
+ "path": "containers/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Collection.",
+ "description": "Update attributes of an existing Container.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Collection in question.",
+ "description": "The UUID of the Container in question.",
"required": true,
"location": "path"
},
"description": "Attributes of the updated object to return in the response.",
"required": false,
"location": "query"
- },
- "replace_files": {
- "type": "object",
- "description": "Files and directories to initialize/replace with content from other collections.",
- "required": false,
- "location": "query",
- "properties": {},
- "additionalProperties": {
- "type": "string"
- }
}
},
"request": {
"required": true,
"properties": {
- "collection": {
- "$ref": "Collection"
+ "container": {
+ "$ref": "Container"
}
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.collections.delete",
- "path": "collections/{uuid}",
+ "id": "arvados.containers.delete",
+ "path": "containers/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Collection.",
+ "description": "Delete an existing Container.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Collection in question.",
+ "description": "The UUID of the Container in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "provenance": {
- "id": "arvados.collections.provenance",
- "path": "collections/{uuid}/provenance",
+ "auth": {
+ "id": "arvados.containers.auth",
+ "path": "containers/{uuid}/auth",
"httpMethod": "GET",
- "description": "provenance collections",
+ "description": "auth containers",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "used_by": {
- "id": "arvados.collections.used_by",
- "path": "collections/{uuid}/used_by",
- "httpMethod": "GET",
- "description": "used_by collections",
+ "lock": {
+ "id": "arvados.containers.lock",
+ "path": "containers/{uuid}/lock",
+ "httpMethod": "POST",
+ "description": "lock containers",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "trash": {
- "id": "arvados.collections.trash",
- "path": "collections/{uuid}/trash",
+ "unlock": {
+ "id": "arvados.containers.unlock",
+ "path": "containers/{uuid}/unlock",
"httpMethod": "POST",
- "description": "trash collections",
+ "description": "unlock containers",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "untrash": {
- "id": "arvados.collections.untrash",
- "path": "collections/{uuid}/untrash",
+ "update_priority": {
+ "id": "arvados.containers.update_priority",
+ "path": "containers/{uuid}/update_priority",
"httpMethod": "POST",
- "description": "untrash collections",
+ "description": "update_priority containers",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "secret_mounts": {
+ "id": "arvados.containers.secret_mounts",
+ "path": "containers/{uuid}/secret_mounts",
+ "httpMethod": "GET",
+ "description": "secret_mounts containers",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Container"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "current": {
+ "id": "arvados.containers.current",
+ "path": "containers/current",
+ "httpMethod": "GET",
+ "description": "current containers",
+ "parameters": {},
+ "response": {
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.collections.list",
- "path": "collections",
+ "id": "arvados.containers.list",
+ "path": "containers",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
- },
- "include_trash": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include collections whose is_trashed attribute is true.",
- "location": "query"
- },
- "include_old_versions": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include past collection versions.",
- "location": "query"
}
},
"response": {
- "$ref": "CollectionList"
+ "$ref": "ContainerList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.collections.show",
- "path": "collections/{uuid}",
+ "id": "arvados.containers.show",
+ "path": "containers/{uuid}",
"httpMethod": "GET",
- "description": "show collections",
+ "description": "show containers",
"parameters": {
"uuid": {
"type": "string",
"description": "Attributes of the object to return in the response.",
"required": false,
"location": "query"
- },
- "include_trash": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Show collection even if its is_trashed attribute is true.",
- "location": "query"
- },
- "include_old_versions": {
- "type": "boolean",
- "required": false,
- "default": "true",
- "description": "Include past collection versions.",
- "location": "query"
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.collections.destroy",
- "path": "collections/{uuid}",
+ "id": "arvados.containers.destroy",
+ "path": "containers/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy collections",
+ "description": "destroy containers",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Collection"
+ "$ref": "Container"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "containers": {
+ "container_requests": {
"methods": {
"get": {
- "id": "arvados.containers.get",
- "path": "containers/{uuid}",
+ "id": "arvados.container_requests.get",
+ "path": "container_requests/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Container's metadata by UUID.",
+ "description": "Gets a ContainerRequest's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Container in question.",
+ "description": "The UUID of the ContainerRequest in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Container"
+ "$ref": "ContainerRequest"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.containers.list",
- "path": "containers",
+ "id": "arvados.container_requests.list",
+ "path": "container_requests",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
+ },
+ "include_trash": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include container requests whose owner project is trashed.",
+ "location": "query"
}
},
"response": {
- "$ref": "ContainerList"
+ "$ref": "ContainerRequestList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.containers.create",
- "path": "containers",
+ "id": "arvados.container_requests.create",
+ "path": "container_requests",
"httpMethod": "POST",
- "description": "Create a new Container.",
+ "description": "Create a new ContainerRequest.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "container": {
- "$ref": "Container"
+ "container_request": {
+ "$ref": "ContainerRequest"
}
}
},
"response": {
- "$ref": "Container"
+ "$ref": "ContainerRequest"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.containers.update",
- "path": "containers/{uuid}",
+ "id": "arvados.container_requests.update",
+ "path": "container_requests/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Container.",
+ "description": "Update attributes of an existing ContainerRequest.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Container in question.",
+ "description": "The UUID of the ContainerRequest in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "container": {
- "$ref": "Container"
+ "container_request": {
+ "$ref": "ContainerRequest"
}
}
},
"response": {
- "$ref": "Container"
+ "$ref": "ContainerRequest"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.containers.delete",
- "path": "containers/{uuid}",
+ "id": "arvados.container_requests.delete",
+ "path": "container_requests/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Container.",
+ "description": "Delete an existing ContainerRequest.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Container in question.",
+ "description": "The UUID of the ContainerRequest in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Container"
+ "$ref": "ContainerRequest"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "auth": {
- "id": "arvados.containers.auth",
- "path": "containers/{uuid}/auth",
+ "list": {
+ "id": "arvados.container_requests.list",
+ "path": "container_requests",
"httpMethod": "GET",
- "description": "auth containers",
+ "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>",
"parameters": {
- "uuid": {
- "type": "string",
+ "filters": {
+ "type": "array",
+ "required": false,
"description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Container"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "lock": {
- "id": "arvados.containers.lock",
- "path": "containers/{uuid}/lock",
- "httpMethod": "POST",
- "description": "lock containers",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Container"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "unlock": {
- "id": "arvados.containers.unlock",
- "path": "containers/{uuid}/unlock",
- "httpMethod": "POST",
- "description": "unlock containers",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Container"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "update_priority": {
- "id": "arvados.containers.update_priority",
- "path": "containers/{uuid}/update_priority",
- "httpMethod": "POST",
- "description": "update_priority containers",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Container"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "secret_mounts": {
- "id": "arvados.containers.secret_mounts",
- "path": "containers/{uuid}/secret_mounts",
- "httpMethod": "GET",
- "description": "secret_mounts containers",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Container"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "current": {
- "id": "arvados.containers.current",
- "path": "containers/current",
- "httpMethod": "GET",
- "description": "current containers",
- "parameters": {},
- "response": {
- "$ref": "Container"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "list": {
- "id": "arvados.containers.list",
- "path": "containers",
- "httpMethod": "GET",
- "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>",
- "parameters": {
- "filters": {
- "type": "array",
- "required": false,
- "description": "",
- "location": "query"
- },
- "where": {
- "type": "object",
- "required": false,
+ "location": "query"
+ },
+ "where": {
+ "type": "object",
+ "required": false,
"description": "",
"location": "query"
},
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
+ },
+ "include_trash": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include container requests whose owner project is trashed.",
+ "location": "query"
}
},
"response": {
- "$ref": "ContainerList"
+ "$ref": "ContainerRequestList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.containers.show",
- "path": "containers/{uuid}",
+ "id": "arvados.container_requests.show",
+ "path": "container_requests/{uuid}",
"httpMethod": "GET",
- "description": "show containers",
+ "description": "show container_requests",
"parameters": {
"uuid": {
"type": "string",
"description": "Attributes of the object to return in the response.",
"required": false,
"location": "query"
+ },
+ "include_trash": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Show container request even if its owner project is trashed.",
+ "location": "query"
}
},
"response": {
- "$ref": "Container"
+ "$ref": "ContainerRequest"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.containers.destroy",
- "path": "containers/{uuid}",
+ "id": "arvados.container_requests.destroy",
+ "path": "container_requests/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy containers",
+ "description": "destroy container_requests",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Container"
+ "$ref": "ContainerRequest"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "container_requests": {
+ "groups": {
"methods": {
"get": {
- "id": "arvados.container_requests.get",
- "path": "container_requests/{uuid}",
+ "id": "arvados.groups.get",
+ "path": "groups/{uuid}",
"httpMethod": "GET",
- "description": "Gets a ContainerRequest's metadata by UUID.",
+ "description": "Gets a Group's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ContainerRequest in question.",
+ "description": "The UUID of the Group in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "ContainerRequest"
+ "$ref": "Group"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.container_requests.list",
- "path": "container_requests",
+ "id": "arvados.groups.list",
+ "path": "groups",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"type": "boolean",
"required": false,
"default": "false",
- "description": "Include container requests whose owner project is trashed.",
+ "description": "Include items whose is_trashed attribute is true.",
"location": "query"
}
},
"response": {
- "$ref": "ContainerRequestList"
+ "$ref": "GroupList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.container_requests.create",
- "path": "container_requests",
+ "id": "arvados.groups.create",
+ "path": "groups",
"httpMethod": "POST",
- "description": "Create a new ContainerRequest.",
+ "description": "Create a new Group.",
"parameters": {
"select": {
"type": "array",
"description": "Create object on a remote federated cluster instead of the current one.",
"location": "query",
"required": false
+ },
+ "async": {
+ "required": false,
+ "type": "boolean",
+ "location": "query",
+ "default": "false",
+ "description": "defer permissions update"
}
},
"request": {
"required": true,
"properties": {
- "container_request": {
- "$ref": "ContainerRequest"
+ "group": {
+ "$ref": "Group"
}
}
},
"response": {
- "$ref": "ContainerRequest"
+ "$ref": "Group"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.container_requests.update",
- "path": "container_requests/{uuid}",
+ "id": "arvados.groups.update",
+ "path": "groups/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing ContainerRequest.",
+ "description": "Update attributes of an existing Group.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ContainerRequest in question.",
+ "description": "The UUID of the Group in question.",
"required": true,
"location": "path"
},
"description": "Attributes of the updated object to return in the response.",
"required": false,
"location": "query"
+ },
+ "async": {
+ "required": false,
+ "type": "boolean",
+ "location": "query",
+ "default": "false",
+ "description": "defer permissions update"
}
},
"request": {
"required": true,
"properties": {
- "container_request": {
- "$ref": "ContainerRequest"
+ "group": {
+ "$ref": "Group"
}
}
},
"response": {
- "$ref": "ContainerRequest"
+ "$ref": "Group"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.container_requests.delete",
- "path": "container_requests/{uuid}",
+ "id": "arvados.groups.delete",
+ "path": "groups/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing ContainerRequest.",
+ "description": "Delete an existing Group.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the ContainerRequest in question.",
+ "description": "The UUID of the Group in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "ContainerRequest"
+ "$ref": "Group"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "list": {
- "id": "arvados.container_requests.list",
- "path": "container_requests",
+ "contents": {
+ "id": "arvados.groups.contents",
+ "path": "groups/contents",
"httpMethod": "GET",
- "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>",
+ "description": "contents groups",
"parameters": {
"filters": {
"type": "array",
"type": "boolean",
"required": false,
"default": "false",
- "description": "Include container requests whose owner project is trashed.",
+ "description": "Include items whose is_trashed attribute is true.",
"location": "query"
- }
- },
- "response": {
- "$ref": "ContainerRequestList"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
- ]
- },
- "show": {
- "id": "arvados.container_requests.show",
- "path": "container_requests/{uuid}",
- "httpMethod": "GET",
- "description": "show container_requests",
- "parameters": {
+ },
"uuid": {
"type": "string",
+ "required": false,
+ "default": "",
"description": "",
- "required": true,
- "location": "path"
+ "location": "query"
},
- "select": {
- "type": "array",
- "description": "Attributes of the object to return in the response.",
+ "recursive": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "Include contents from child groups recursively.",
+ "location": "query"
+ },
+ "include": {
+ "type": "string",
"required": false,
+ "description": "Include objects referred to by listed field in \"included\" (only owner_uuid).",
"location": "query"
},
- "include_trash": {
+ "include_old_versions": {
"type": "boolean",
"required": false,
"default": "false",
- "description": "Show container request even if its owner project is trashed.",
+ "description": "Include past collection versions.",
"location": "query"
}
},
"response": {
- "$ref": "ContainerRequest"
+ "$ref": "Group"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "destroy": {
- "id": "arvados.container_requests.destroy",
- "path": "container_requests/{uuid}",
- "httpMethod": "DELETE",
- "description": "destroy container_requests",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "ContainerRequest"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- }
- }
- },
- "groups": {
- "methods": {
- "get": {
- "id": "arvados.groups.get",
- "path": "groups/{uuid}",
- "httpMethod": "GET",
- "description": "Gets a Group's metadata by UUID.",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "The UUID of the Group in question.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "uuid"
- ],
- "response": {
- "$ref": "Group"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
- ]
- },
- "index": {
- "id": "arvados.groups.list",
- "path": "groups",
- "httpMethod": "GET",
- "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>",
+ "shared": {
+ "id": "arvados.groups.shared",
+ "path": "groups/shared",
+ "httpMethod": "GET",
+ "description": "shared groups",
"parameters": {
"filters": {
"type": "array",
"default": "false",
"description": "Include items whose is_trashed attribute is true.",
"location": "query"
- }
- },
- "response": {
- "$ref": "GroupList"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
- ]
- },
- "create": {
- "id": "arvados.groups.create",
- "path": "groups",
- "httpMethod": "POST",
- "description": "Create a new Group.",
- "parameters": {
- "select": {
- "type": "array",
- "description": "Attributes of the new object to return in the response.",
- "required": false,
- "location": "query"
- },
- "ensure_unique_name": {
- "type": "boolean",
- "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
- "location": "query",
- "required": false,
- "default": "false"
},
- "cluster_id": {
+ "include": {
"type": "string",
- "description": "Create object on a remote federated cluster instead of the current one.",
- "location": "query",
- "required": false
- },
- "async": {
"required": false,
- "type": "boolean",
- "location": "query",
- "default": "false",
- "description": "defer permissions update"
- }
- },
- "request": {
- "required": true,
- "properties": {
- "group": {
- "$ref": "Group"
- }
+ "description": "",
+ "location": "query"
}
},
"response": {
"https://api.arvados.org/auth/arvados"
]
},
- "update": {
- "id": "arvados.groups.update",
- "path": "groups/{uuid}",
- "httpMethod": "PUT",
- "description": "Update attributes of an existing Group.",
+ "trash": {
+ "id": "arvados.groups.trash",
+ "path": "groups/{uuid}/trash",
+ "httpMethod": "POST",
+ "description": "trash groups",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Group in question.",
+ "description": "",
"required": true,
"location": "path"
- },
- "select": {
- "type": "array",
- "description": "Attributes of the updated object to return in the response.",
- "required": false,
- "location": "query"
- },
- "async": {
- "required": false,
- "type": "boolean",
- "location": "query",
- "default": "false",
- "description": "defer permissions update"
- }
- },
- "request": {
- "required": true,
- "properties": {
- "group": {
- "$ref": "Group"
- }
}
},
"response": {
"https://api.arvados.org/auth/arvados"
]
},
- "delete": {
- "id": "arvados.groups.delete",
- "path": "groups/{uuid}",
- "httpMethod": "DELETE",
- "description": "Delete an existing Group.",
+ "untrash": {
+ "id": "arvados.groups.untrash",
+ "path": "groups/{uuid}/untrash",
+ "httpMethod": "POST",
+ "description": "untrash groups",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Group in question.",
+ "description": "",
"required": true,
"location": "path"
}
"https://api.arvados.org/auth/arvados"
]
},
- "contents": {
- "id": "arvados.groups.contents",
- "path": "groups/contents",
+ "list": {
+ "id": "arvados.groups.list",
+ "path": "groups",
"httpMethod": "GET",
- "description": "contents groups",
+ "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>",
"parameters": {
"filters": {
"type": "array",
"description": "",
"location": "query"
},
+ "select": {
+ "type": "array",
+ "description": "Attributes of each object to return in the response.",
+ "required": false,
+ "location": "query"
+ },
"distinct": {
"type": "boolean",
"required": false,
"default": "false",
"description": "Include items whose is_trashed attribute is true.",
"location": "query"
- },
+ }
+ },
+ "response": {
+ "$ref": "GroupList"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
+ },
+ "show": {
+ "id": "arvados.groups.show",
+ "path": "groups/{uuid}",
+ "httpMethod": "GET",
+ "description": "show groups",
+ "parameters": {
"uuid": {
"type": "string",
- "required": false,
- "default": "",
"description": "",
- "location": "query"
- },
- "recursive": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include contents from child groups recursively.",
- "location": "query"
+ "required": true,
+ "location": "path"
},
- "include": {
- "type": "string",
+ "select": {
+ "type": "array",
+ "description": "Attributes of the object to return in the response.",
"required": false,
- "description": "Include objects referred to by listed field in \"included\" (only owner_uuid).",
"location": "query"
},
- "include_old_versions": {
+ "include_trash": {
"type": "boolean",
"required": false,
"default": "false",
- "description": "Include past collection versions.",
+ "description": "Show group/project even if its is_trashed attribute is true.",
"location": "query"
}
},
"https://api.arvados.org/auth/arvados"
]
},
- "shared": {
- "id": "arvados.groups.shared",
- "path": "groups/shared",
+ "destroy": {
+ "id": "arvados.groups.destroy",
+ "path": "groups/{uuid}",
+ "httpMethod": "DELETE",
+ "description": "destroy groups",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ }
+ }
+ },
+ "humans": {
+ "methods": {
+ "get": {
+ "id": "arvados.humans.get",
+ "path": "humans/{uuid}",
"httpMethod": "GET",
- "description": "shared groups",
+ "description": "Gets a Human's metadata by UUID.",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "The UUID of the Human in question.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "uuid"
+ ],
+ "response": {
+ "$ref": "Human"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
+ },
+ "index": {
+ "id": "arvados.humans.list",
+ "path": "humans",
+ "httpMethod": "GET",
+ "description": "List Humans.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Humans. For example:\n\n <pre>\n {\n \"kind\":\"arvados#humanList\",\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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
- },
- "include_trash": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include items whose is_trashed attribute is true.",
- "location": "query"
- },
- "include": {
- "type": "string",
+ }
+ },
+ "response": {
+ "$ref": "HumanList"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
+ },
+ "create": {
+ "id": "arvados.humans.create",
+ "path": "humans",
+ "httpMethod": "POST",
+ "description": "Create a new Human.",
+ "parameters": {
+ "select": {
+ "type": "array",
+ "description": "Attributes of the new object to return in the response.",
"required": false,
- "description": "",
"location": "query"
+ },
+ "ensure_unique_name": {
+ "type": "boolean",
+ "description": "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
+ "location": "query",
+ "required": false,
+ "default": "false"
+ },
+ "cluster_id": {
+ "type": "string",
+ "description": "Create object on a remote federated cluster instead of the current one.",
+ "location": "query",
+ "required": false
+ }
+ },
+ "request": {
+ "required": true,
+ "properties": {
+ "human": {
+ "$ref": "Human"
+ }
}
},
"response": {
- "$ref": "Group"
+ "$ref": "Human"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "trash": {
- "id": "arvados.groups.trash",
- "path": "groups/{uuid}/trash",
- "httpMethod": "POST",
- "description": "trash groups",
+ "update": {
+ "id": "arvados.humans.update",
+ "path": "humans/{uuid}",
+ "httpMethod": "PUT",
+ "description": "Update attributes of an existing Human.",
"parameters": {
"uuid": {
"type": "string",
- "description": "",
+ "description": "The UUID of the Human in question.",
"required": true,
"location": "path"
+ },
+ "select": {
+ "type": "array",
+ "description": "Attributes of the updated object to return in the response.",
+ "required": false,
+ "location": "query"
+ }
+ },
+ "request": {
+ "required": true,
+ "properties": {
+ "human": {
+ "$ref": "Human"
+ }
}
},
"response": {
- "$ref": "Group"
+ "$ref": "Human"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "untrash": {
- "id": "arvados.groups.untrash",
- "path": "groups/{uuid}/untrash",
- "httpMethod": "POST",
- "description": "untrash groups",
+ "delete": {
+ "id": "arvados.humans.delete",
+ "path": "humans/{uuid}",
+ "httpMethod": "DELETE",
+ "description": "Delete an existing Human.",
"parameters": {
"uuid": {
"type": "string",
- "description": "",
+ "description": "The UUID of the Human in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Group"
+ "$ref": "Human"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.groups.list",
- "path": "groups",
+ "id": "arvados.humans.list",
+ "path": "humans",
"httpMethod": "GET",
- "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>",
+ "description": "List Humans.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Humans. For example:\n\n <pre>\n {\n \"kind\":\"arvados#humanList\",\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>",
"parameters": {
"filters": {
"type": "array",
"required": false,
"description": "bypass federation behavior, list items from local instance database only",
"location": "query"
- },
- "include_trash": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Include items whose is_trashed attribute is true.",
- "location": "query"
}
},
"response": {
- "$ref": "GroupList"
+ "$ref": "HumanList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.groups.show",
- "path": "groups/{uuid}",
+ "id": "arvados.humans.show",
+ "path": "humans/{uuid}",
"httpMethod": "GET",
- "description": "show groups",
+ "description": "show humans",
"parameters": {
"uuid": {
"type": "string",
"description": "Attributes of the object to return in the response.",
"required": false,
"location": "query"
- },
- "include_trash": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "Show group/project even if its is_trashed attribute is true.",
- "location": "query"
}
},
"response": {
- "$ref": "Group"
+ "$ref": "Human"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.groups.destroy",
- "path": "groups/{uuid}",
+ "id": "arvados.humans.destroy",
+ "path": "humans/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy groups",
+ "description": "destroy humans",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Group"
+ "$ref": "Human"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "humans": {
+ "jobs": {
"methods": {
"get": {
- "id": "arvados.humans.get",
- "path": "humans/{uuid}",
+ "id": "arvados.jobs.get",
+ "path": "jobs/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Human's metadata by UUID.",
+ "description": "Gets a Job's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Human in question.",
+ "description": "The UUID of the Job in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Human"
+ "$ref": "Job"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.humans.list",
- "path": "humans",
+ "id": "arvados.jobs.list",
+ "path": "jobs",
"httpMethod": "GET",
- "description": "List Humans.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Humans. For example:\n\n <pre>\n {\n \"kind\":\"arvados#humanList\",\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>",
+ "description": "List Jobs.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Jobs. For example:\n\n <pre>\n {\n \"kind\":\"arvados#jobList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "HumanList"
+ "$ref": "JobList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.humans.create",
- "path": "humans",
+ "id": "arvados.jobs.create",
+ "path": "jobs",
"httpMethod": "POST",
- "description": "Create a new Human.",
+ "description": "Create a new Job.",
"parameters": {
"select": {
"type": "array",
"description": "Create object on a remote federated cluster instead of the current one.",
"location": "query",
"required": false
+ },
+ "find_or_create": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "",
+ "location": "query"
+ },
+ "filters": {
+ "type": "array",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "minimum_script_version": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "exclude_script_versions": {
+ "type": "array",
+ "required": false,
+ "description": "",
+ "location": "query"
}
},
"request": {
"required": true,
"properties": {
- "human": {
- "$ref": "Human"
+ "job": {
+ "$ref": "Job"
}
}
},
"response": {
- "$ref": "Human"
+ "$ref": "Job"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.humans.update",
- "path": "humans/{uuid}",
+ "id": "arvados.jobs.update",
+ "path": "jobs/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Human.",
+ "description": "Update attributes of an existing Job.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Human in question.",
+ "description": "The UUID of the Job in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "human": {
- "$ref": "Human"
+ "job": {
+ "$ref": "Job"
}
}
},
"response": {
- "$ref": "Human"
+ "$ref": "Job"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.humans.delete",
- "path": "humans/{uuid}",
+ "id": "arvados.jobs.delete",
+ "path": "jobs/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Human.",
+ "description": "Delete an existing Job.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Human in question.",
+ "description": "The UUID of the Job in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Human"
+ "$ref": "Job"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "list": {
- "id": "arvados.humans.list",
- "path": "humans",
+ "queue": {
+ "id": "arvados.jobs.queue",
+ "path": "jobs/queue",
"httpMethod": "GET",
- "description": "List Humans.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Humans. For example:\n\n <pre>\n {\n \"kind\":\"arvados#humanList\",\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>",
+ "description": "queue jobs",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "HumanList"
+ "$ref": "Job"
},
"scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
+ "https://api.arvados.org/auth/arvados"
]
},
- "show": {
- "id": "arvados.humans.show",
- "path": "humans/{uuid}",
+ "queue_size": {
+ "id": "arvados.jobs.queue_size",
+ "path": "jobs/queue_size",
"httpMethod": "GET",
- "description": "show humans",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- },
- "select": {
- "type": "array",
- "description": "Attributes of the object to return in the response.",
- "required": false,
- "location": "query"
- }
- },
+ "description": "queue_size jobs",
+ "parameters": {},
"response": {
- "$ref": "Human"
+ "$ref": "Job"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "destroy": {
- "id": "arvados.humans.destroy",
- "path": "humans/{uuid}",
- "httpMethod": "DELETE",
- "description": "destroy humans",
+ "cancel": {
+ "id": "arvados.jobs.cancel",
+ "path": "jobs/{uuid}/cancel",
+ "httpMethod": "POST",
+ "description": "cancel jobs",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Human"
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "lock": {
+ "id": "arvados.jobs.lock",
+ "path": "jobs/{uuid}/lock",
+ "httpMethod": "POST",
+ "description": "lock jobs",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "list": {
+ "id": "arvados.jobs.list",
+ "path": "jobs",
+ "httpMethod": "GET",
+ "description": "List Jobs.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Jobs. For example:\n\n <pre>\n {\n \"kind\":\"arvados#jobList\",\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>",
+ "parameters": {
+ "filters": {
+ "type": "array",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "where": {
+ "type": "object",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "order": {
+ "type": "array",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "select": {
+ "type": "array",
+ "description": "Attributes of each object to return in the response.",
+ "required": false,
+ "location": "query"
+ },
+ "distinct": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "",
+ "location": "query"
+ },
+ "limit": {
+ "type": "integer",
+ "required": false,
+ "default": "100",
+ "description": "",
+ "location": "query"
+ },
+ "offset": {
+ "type": "integer",
+ "required": false,
+ "default": "0",
+ "description": "",
+ "location": "query"
+ },
+ "count": {
+ "type": "string",
+ "required": false,
+ "default": "exact",
+ "description": "",
+ "location": "query"
+ },
+ "cluster_id": {
+ "type": "string",
+ "description": "List objects on a remote federated cluster instead of the current one.",
+ "location": "query",
+ "required": false
+ },
+ "bypass_federation": {
+ "type": "boolean",
+ "required": false,
+ "description": "bypass federation behavior, list items from local instance database only",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "JobList"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
+ },
+ "show": {
+ "id": "arvados.jobs.show",
+ "path": "jobs/{uuid}",
+ "httpMethod": "GET",
+ "description": "show jobs",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ },
+ "select": {
+ "type": "array",
+ "description": "Attributes of the object to return in the response.",
+ "required": false,
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "destroy": {
+ "id": "arvados.jobs.destroy",
+ "path": "jobs/{uuid}",
+ "httpMethod": "DELETE",
+ "description": "destroy jobs",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Job"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "users": {
+ "pipeline_instances": {
"methods": {
"get": {
- "id": "arvados.users.get",
- "path": "users/{uuid}",
+ "id": "arvados.pipeline_instances.get",
+ "path": "pipeline_instances/{uuid}",
"httpMethod": "GET",
- "description": "Gets a User's metadata by UUID.",
+ "description": "Gets a PipelineInstance's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the User in question.",
+ "description": "The UUID of the PipelineInstance in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.users.list",
- "path": "users",
+ "id": "arvados.pipeline_instances.list",
+ "path": "pipeline_instances",
"httpMethod": "GET",
- "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>",
+ "description": "List PipelineInstances.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineInstances. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineInstanceList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "UserList"
+ "$ref": "PipelineInstanceList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.users.create",
- "path": "users",
+ "id": "arvados.pipeline_instances.create",
+ "path": "pipeline_instances",
"httpMethod": "POST",
- "description": "Create a new User.",
+ "description": "Create a new PipelineInstance.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "user": {
- "$ref": "User"
+ "pipeline_instance": {
+ "$ref": "PipelineInstance"
}
}
},
"response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.users.update",
- "path": "users/{uuid}",
+ "id": "arvados.pipeline_instances.update",
+ "path": "pipeline_instances/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing User.",
+ "description": "Update attributes of an existing PipelineInstance.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the User in question.",
+ "description": "The UUID of the PipelineInstance in question.",
"required": true,
"location": "path"
},
"description": "Attributes of the updated object to return in the response.",
"required": false,
"location": "query"
- },
- "bypass_federation": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "",
- "location": "query"
}
},
"request": {
"required": true,
"properties": {
- "user": {
- "$ref": "User"
+ "pipeline_instance": {
+ "$ref": "PipelineInstance"
}
}
},
"response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.users.delete",
- "path": "users/{uuid}",
+ "id": "arvados.pipeline_instances.delete",
+ "path": "pipeline_instances/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing User.",
+ "description": "Delete an existing PipelineInstance.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the User in question.",
+ "description": "The UUID of the PipelineInstance in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "User"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "current": {
- "id": "arvados.users.current",
- "path": "users/current",
- "httpMethod": "GET",
- "description": "current users",
- "parameters": {},
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "system": {
- "id": "arvados.users.system",
- "path": "users/system",
- "httpMethod": "GET",
- "description": "system users",
- "parameters": {},
- "response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "activate": {
- "id": "arvados.users.activate",
- "path": "users/{uuid}/activate",
+ "cancel": {
+ "id": "arvados.pipeline_instances.cancel",
+ "path": "pipeline_instances/{uuid}/cancel",
"httpMethod": "POST",
- "description": "activate users",
+ "description": "cancel pipeline_instances",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "setup": {
- "id": "arvados.users.setup",
- "path": "users/setup",
- "httpMethod": "POST",
- "description": "setup users",
- "parameters": {
- "uuid": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- },
- "user": {
- "type": "object",
- "required": false,
- "description": "",
- "location": "query"
- },
- "repo_name": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- },
- "vm_uuid": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- },
- "send_notification_email": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "",
- "location": "query"
- }
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "unsetup": {
- "id": "arvados.users.unsetup",
- "path": "users/{uuid}/unsetup",
- "httpMethod": "POST",
- "description": "unsetup users",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "merge": {
- "id": "arvados.users.merge",
- "path": "users/merge",
- "httpMethod": "POST",
- "description": "merge users",
- "parameters": {
- "new_owner_uuid": {
- "type": "string",
- "required": true,
- "description": "",
- "location": "query"
- },
- "new_user_token": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- },
- "redirect_to_new_user": {
- "type": "boolean",
- "required": false,
- "default": "false",
- "description": "",
- "location": "query"
- },
- "old_user_uuid": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- },
- "new_user_uuid": {
- "type": "string",
- "required": false,
- "description": "",
- "location": "query"
- }
- },
- "response": {
- "$ref": "User"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "list": {
- "id": "arvados.users.list",
- "path": "users",
- "httpMethod": "GET",
- "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>",
+ "list": {
+ "id": "arvados.pipeline_instances.list",
+ "path": "pipeline_instances",
+ "httpMethod": "GET",
+ "description": "List PipelineInstances.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineInstances. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineInstanceList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "UserList"
+ "$ref": "PipelineInstanceList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.users.show",
- "path": "users/{uuid}",
+ "id": "arvados.pipeline_instances.show",
+ "path": "pipeline_instances/{uuid}",
"httpMethod": "GET",
- "description": "show users",
+ "description": "show pipeline_instances",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.users.destroy",
- "path": "users/{uuid}",
+ "id": "arvados.pipeline_instances.destroy",
+ "path": "pipeline_instances/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy users",
+ "description": "destroy pipeline_instances",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "User"
+ "$ref": "PipelineInstance"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "pipeline_instances": {
+ "pipeline_templates": {
"methods": {
"get": {
- "id": "arvados.pipeline_instances.get",
- "path": "pipeline_instances/{uuid}",
+ "id": "arvados.pipeline_templates.get",
+ "path": "pipeline_templates/{uuid}",
"httpMethod": "GET",
- "description": "Gets a PipelineInstance's metadata by UUID.",
+ "description": "Gets a PipelineTemplate's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the PipelineInstance in question.",
+ "description": "The UUID of the PipelineTemplate in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "PipelineInstance"
+ "$ref": "PipelineTemplate"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.pipeline_instances.list",
- "path": "pipeline_instances",
+ "id": "arvados.pipeline_templates.list",
+ "path": "pipeline_templates",
"httpMethod": "GET",
- "description": "List PipelineInstances.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineInstances. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineInstanceList\",\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>",
+ "description": "List PipelineTemplates.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineTemplates. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineTemplateList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "PipelineInstanceList"
+ "$ref": "PipelineTemplateList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.pipeline_instances.create",
- "path": "pipeline_instances",
+ "id": "arvados.pipeline_templates.create",
+ "path": "pipeline_templates",
"httpMethod": "POST",
- "description": "Create a new PipelineInstance.",
+ "description": "Create a new PipelineTemplate.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "pipeline_instance": {
- "$ref": "PipelineInstance"
+ "pipeline_template": {
+ "$ref": "PipelineTemplate"
}
}
},
"response": {
- "$ref": "PipelineInstance"
+ "$ref": "PipelineTemplate"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.pipeline_instances.update",
- "path": "pipeline_instances/{uuid}",
+ "id": "arvados.pipeline_templates.update",
+ "path": "pipeline_templates/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing PipelineInstance.",
+ "description": "Update attributes of an existing PipelineTemplate.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the PipelineInstance in question.",
+ "description": "The UUID of the PipelineTemplate in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "pipeline_instance": {
- "$ref": "PipelineInstance"
+ "pipeline_template": {
+ "$ref": "PipelineTemplate"
}
}
},
"response": {
- "$ref": "PipelineInstance"
+ "$ref": "PipelineTemplate"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.pipeline_instances.delete",
- "path": "pipeline_instances/{uuid}",
+ "id": "arvados.pipeline_templates.delete",
+ "path": "pipeline_templates/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing PipelineInstance.",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "The UUID of the PipelineInstance in question.",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "PipelineInstance"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "cancel": {
- "id": "arvados.pipeline_instances.cancel",
- "path": "pipeline_instances/{uuid}/cancel",
- "httpMethod": "POST",
- "description": "cancel pipeline_instances",
+ "description": "Delete an existing PipelineTemplate.",
"parameters": {
"uuid": {
"type": "string",
- "description": "",
+ "description": "The UUID of the PipelineTemplate in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "PipelineInstance"
+ "$ref": "PipelineTemplate"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.pipeline_instances.list",
- "path": "pipeline_instances",
+ "id": "arvados.pipeline_templates.list",
+ "path": "pipeline_templates",
"httpMethod": "GET",
- "description": "List PipelineInstances.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineInstances. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineInstanceList\",\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>",
+ "description": "List PipelineTemplates.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineTemplates. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineTemplateList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "PipelineInstanceList"
+ "$ref": "PipelineTemplateList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.pipeline_instances.show",
- "path": "pipeline_instances/{uuid}",
+ "id": "arvados.pipeline_templates.show",
+ "path": "pipeline_templates/{uuid}",
"httpMethod": "GET",
- "description": "show pipeline_instances",
+ "description": "show pipeline_templates",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "PipelineInstance"
+ "$ref": "PipelineTemplate"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.pipeline_instances.destroy",
- "path": "pipeline_instances/{uuid}",
+ "id": "arvados.pipeline_templates.destroy",
+ "path": "pipeline_templates/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy pipeline_instances",
+ "description": "destroy pipeline_templates",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "PipelineInstance"
+ "$ref": "PipelineTemplate"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "pipeline_templates": {
+ "repositories": {
"methods": {
"get": {
- "id": "arvados.pipeline_templates.get",
- "path": "pipeline_templates/{uuid}",
+ "id": "arvados.repositories.get",
+ "path": "repositories/{uuid}",
"httpMethod": "GET",
- "description": "Gets a PipelineTemplate's metadata by UUID.",
+ "description": "Gets a Repository's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the PipelineTemplate in question.",
+ "description": "The UUID of the Repository in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "PipelineTemplate"
+ "$ref": "Repository"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.pipeline_templates.list",
- "path": "pipeline_templates",
+ "id": "arvados.repositories.list",
+ "path": "repositories",
"httpMethod": "GET",
- "description": "List PipelineTemplates.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineTemplates. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineTemplateList\",\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>",
+ "description": "List Repositories.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Repositories. For example:\n\n <pre>\n {\n \"kind\":\"arvados#repositoryList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "PipelineTemplateList"
+ "$ref": "RepositoryList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.pipeline_templates.create",
- "path": "pipeline_templates",
+ "id": "arvados.repositories.create",
+ "path": "repositories",
"httpMethod": "POST",
- "description": "Create a new PipelineTemplate.",
+ "description": "Create a new Repository.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "pipeline_template": {
- "$ref": "PipelineTemplate"
- }
+ "repository": {
+ "$ref": "Repository"
+ }
}
},
"response": {
- "$ref": "PipelineTemplate"
+ "$ref": "Repository"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.pipeline_templates.update",
- "path": "pipeline_templates/{uuid}",
+ "id": "arvados.repositories.update",
+ "path": "repositories/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing PipelineTemplate.",
+ "description": "Update attributes of an existing Repository.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the PipelineTemplate in question.",
+ "description": "The UUID of the Repository in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "pipeline_template": {
- "$ref": "PipelineTemplate"
+ "repository": {
+ "$ref": "Repository"
}
}
},
"response": {
- "$ref": "PipelineTemplate"
+ "$ref": "Repository"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.pipeline_templates.delete",
- "path": "pipeline_templates/{uuid}",
+ "id": "arvados.repositories.delete",
+ "path": "repositories/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing PipelineTemplate.",
+ "description": "Delete an existing Repository.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the PipelineTemplate in question.",
+ "description": "The UUID of the Repository in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "PipelineTemplate"
+ "$ref": "Repository"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "get_all_permissions": {
+ "id": "arvados.repositories.get_all_permissions",
+ "path": "repositories/get_all_permissions",
+ "httpMethod": "GET",
+ "description": "get_all_permissions repositories",
+ "parameters": {},
+ "response": {
+ "$ref": "Repository"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.pipeline_templates.list",
- "path": "pipeline_templates",
+ "id": "arvados.repositories.list",
+ "path": "repositories",
"httpMethod": "GET",
- "description": "List PipelineTemplates.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching PipelineTemplates. For example:\n\n <pre>\n {\n \"kind\":\"arvados#pipelineTemplateList\",\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>",
+ "description": "List Repositories.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Repositories. For example:\n\n <pre>\n {\n \"kind\":\"arvados#repositoryList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "PipelineTemplateList"
+ "$ref": "RepositoryList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.pipeline_templates.show",
- "path": "pipeline_templates/{uuid}",
+ "id": "arvados.repositories.show",
+ "path": "repositories/{uuid}",
"httpMethod": "GET",
- "description": "show pipeline_templates",
+ "description": "show repositories",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "PipelineTemplate"
+ "$ref": "Repository"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.pipeline_templates.destroy",
- "path": "pipeline_templates/{uuid}",
+ "id": "arvados.repositories.destroy",
+ "path": "repositories/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy pipeline_templates",
+ "description": "destroy repositories",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "PipelineTemplate"
+ "$ref": "Repository"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "repositories": {
+ "specimens": {
"methods": {
"get": {
- "id": "arvados.repositories.get",
- "path": "repositories/{uuid}",
+ "id": "arvados.specimens.get",
+ "path": "specimens/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Repository's metadata by UUID.",
+ "description": "Gets a Specimen's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Repository in question.",
+ "description": "The UUID of the Specimen in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Repository"
+ "$ref": "Specimen"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.repositories.list",
- "path": "repositories",
+ "id": "arvados.specimens.list",
+ "path": "specimens",
"httpMethod": "GET",
- "description": "List Repositories.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Repositories. For example:\n\n <pre>\n {\n \"kind\":\"arvados#repositoryList\",\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>",
+ "description": "List Specimens.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Specimens. For example:\n\n <pre>\n {\n \"kind\":\"arvados#specimenList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "RepositoryList"
+ "$ref": "SpecimenList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.repositories.create",
- "path": "repositories",
+ "id": "arvados.specimens.create",
+ "path": "specimens",
"httpMethod": "POST",
- "description": "Create a new Repository.",
+ "description": "Create a new Specimen.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "repository": {
- "$ref": "Repository"
+ "specimen": {
+ "$ref": "Specimen"
}
}
},
"response": {
- "$ref": "Repository"
+ "$ref": "Specimen"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.repositories.update",
- "path": "repositories/{uuid}",
+ "id": "arvados.specimens.update",
+ "path": "specimens/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Repository.",
+ "description": "Update attributes of an existing Specimen.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Repository in question.",
+ "description": "The UUID of the Specimen in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "repository": {
- "$ref": "Repository"
+ "specimen": {
+ "$ref": "Specimen"
}
}
},
"response": {
- "$ref": "Repository"
+ "$ref": "Specimen"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.repositories.delete",
- "path": "repositories/{uuid}",
+ "id": "arvados.specimens.delete",
+ "path": "specimens/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Repository.",
+ "description": "Delete an existing Specimen.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Repository in question.",
+ "description": "The UUID of the Specimen in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Repository"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "get_all_permissions": {
- "id": "arvados.repositories.get_all_permissions",
- "path": "repositories/get_all_permissions",
- "httpMethod": "GET",
- "description": "get_all_permissions repositories",
- "parameters": {},
- "response": {
- "$ref": "Repository"
+ "$ref": "Specimen"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.repositories.list",
- "path": "repositories",
+ "id": "arvados.specimens.list",
+ "path": "specimens",
"httpMethod": "GET",
- "description": "List Repositories.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Repositories. For example:\n\n <pre>\n {\n \"kind\":\"arvados#repositoryList\",\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>",
+ "description": "List Specimens.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Specimens. For example:\n\n <pre>\n {\n \"kind\":\"arvados#specimenList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "RepositoryList"
+ "$ref": "SpecimenList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.repositories.show",
- "path": "repositories/{uuid}",
+ "id": "arvados.specimens.show",
+ "path": "specimens/{uuid}",
"httpMethod": "GET",
- "description": "show repositories",
+ "description": "show specimens",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Repository"
+ "$ref": "Specimen"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.repositories.destroy",
- "path": "repositories/{uuid}",
+ "id": "arvados.specimens.destroy",
+ "path": "specimens/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy repositories",
+ "description": "destroy specimens",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Repository"
+ "$ref": "Specimen"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "specimens": {
+ "traits": {
"methods": {
"get": {
- "id": "arvados.specimens.get",
- "path": "specimens/{uuid}",
+ "id": "arvados.traits.get",
+ "path": "traits/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Specimen's metadata by UUID.",
+ "description": "Gets a Trait's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Specimen in question.",
+ "description": "The UUID of the Trait in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Specimen"
+ "$ref": "Trait"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.specimens.list",
- "path": "specimens",
+ "id": "arvados.traits.list",
+ "path": "traits",
"httpMethod": "GET",
- "description": "List Specimens.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Specimens. For example:\n\n <pre>\n {\n \"kind\":\"arvados#specimenList\",\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>",
+ "description": "List Traits.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Traits. For example:\n\n <pre>\n {\n \"kind\":\"arvados#traitList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "SpecimenList"
+ "$ref": "TraitList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.specimens.create",
- "path": "specimens",
+ "id": "arvados.traits.create",
+ "path": "traits",
"httpMethod": "POST",
- "description": "Create a new Specimen.",
+ "description": "Create a new Trait.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "specimen": {
- "$ref": "Specimen"
+ "trait": {
+ "$ref": "Trait"
}
}
},
"response": {
- "$ref": "Specimen"
+ "$ref": "Trait"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.specimens.update",
- "path": "specimens/{uuid}",
+ "id": "arvados.traits.update",
+ "path": "traits/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Specimen.",
+ "description": "Update attributes of an existing Trait.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Specimen in question.",
+ "description": "The UUID of the Trait in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "specimen": {
- "$ref": "Specimen"
+ "trait": {
+ "$ref": "Trait"
}
}
},
"response": {
- "$ref": "Specimen"
+ "$ref": "Trait"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.specimens.delete",
- "path": "specimens/{uuid}",
+ "id": "arvados.traits.delete",
+ "path": "traits/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Specimen.",
+ "description": "Delete an existing Trait.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Specimen in question.",
+ "description": "The UUID of the Trait in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Specimen"
+ "$ref": "Trait"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.specimens.list",
- "path": "specimens",
+ "id": "arvados.traits.list",
+ "path": "traits",
"httpMethod": "GET",
- "description": "List Specimens.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Specimens. For example:\n\n <pre>\n {\n \"kind\":\"arvados#specimenList\",\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>",
+ "description": "List Traits.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Traits. For example:\n\n <pre>\n {\n \"kind\":\"arvados#traitList\",\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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "SpecimenList"
+ "$ref": "TraitList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.specimens.show",
- "path": "specimens/{uuid}",
+ "id": "arvados.traits.show",
+ "path": "traits/{uuid}",
"httpMethod": "GET",
- "description": "show specimens",
+ "description": "show traits",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Specimen"
+ "$ref": "Trait"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.specimens.destroy",
- "path": "specimens/{uuid}",
+ "id": "arvados.traits.destroy",
+ "path": "traits/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy specimens",
+ "description": "destroy traits",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Specimen"
+ "$ref": "Trait"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "traits": {
+ "users": {
"methods": {
"get": {
- "id": "arvados.traits.get",
- "path": "traits/{uuid}",
+ "id": "arvados.users.get",
+ "path": "users/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Trait's metadata by UUID.",
+ "description": "Gets a User's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Trait in question.",
+ "description": "The UUID of the User in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Trait"
+ "$ref": "User"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.traits.list",
- "path": "traits",
+ "id": "arvados.users.list",
+ "path": "users",
"httpMethod": "GET",
- "description": "List Traits.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Traits. For example:\n\n <pre>\n {\n \"kind\":\"arvados#traitList\",\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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "TraitList"
+ "$ref": "UserList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.traits.create",
- "path": "traits",
+ "id": "arvados.users.create",
+ "path": "users",
"httpMethod": "POST",
- "description": "Create a new Trait.",
+ "description": "Create a new User.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "trait": {
- "$ref": "Trait"
+ "user": {
+ "$ref": "User"
}
}
},
"response": {
- "$ref": "Trait"
+ "$ref": "User"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.traits.update",
- "path": "traits/{uuid}",
+ "id": "arvados.users.update",
+ "path": "users/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Trait.",
+ "description": "Update attributes of an existing User.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Trait in question.",
+ "description": "The UUID of the User in question.",
"required": true,
"location": "path"
},
"description": "Attributes of the updated object to return in the response.",
"required": false,
"location": "query"
+ },
+ "bypass_federation": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "",
+ "location": "query"
}
},
"request": {
"required": true,
"properties": {
- "trait": {
- "$ref": "Trait"
+ "user": {
+ "$ref": "User"
}
}
},
"response": {
- "$ref": "Trait"
+ "$ref": "User"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.traits.delete",
- "path": "traits/{uuid}",
+ "id": "arvados.users.delete",
+ "path": "users/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Trait.",
+ "description": "Delete an existing User.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Trait in question.",
+ "description": "The UUID of the User in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Trait"
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "current": {
+ "id": "arvados.users.current",
+ "path": "users/current",
+ "httpMethod": "GET",
+ "description": "current users",
+ "parameters": {},
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "system": {
+ "id": "arvados.users.system",
+ "path": "users/system",
+ "httpMethod": "GET",
+ "description": "system users",
+ "parameters": {},
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "activate": {
+ "id": "arvados.users.activate",
+ "path": "users/{uuid}/activate",
+ "httpMethod": "POST",
+ "description": "activate users",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "setup": {
+ "id": "arvados.users.setup",
+ "path": "users/setup",
+ "httpMethod": "POST",
+ "description": "setup users",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "user": {
+ "type": "object",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "repo_name": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "vm_uuid": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "send_notification_email": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "unsetup": {
+ "id": "arvados.users.unsetup",
+ "path": "users/{uuid}/unsetup",
+ "httpMethod": "POST",
+ "description": "unsetup users",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "merge": {
+ "id": "arvados.users.merge",
+ "path": "users/merge",
+ "httpMethod": "POST",
+ "description": "merge users",
+ "parameters": {
+ "new_owner_uuid": {
+ "type": "string",
+ "required": true,
+ "description": "",
+ "location": "query"
+ },
+ "new_user_token": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "redirect_to_new_user": {
+ "type": "boolean",
+ "required": false,
+ "default": "false",
+ "description": "",
+ "location": "query"
+ },
+ "old_user_uuid": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ },
+ "new_user_uuid": {
+ "type": "string",
+ "required": false,
+ "description": "",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "User"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.traits.list",
- "path": "traits",
+ "id": "arvados.users.list",
+ "path": "users",
"httpMethod": "GET",
- "description": "List Traits.\n\n The <code>list</code> method returns a\n <a href=\"/api/resources.html\">resource list</a> of\n matching Traits. For example:\n\n <pre>\n {\n \"kind\":\"arvados#traitList\",\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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "TraitList"
+ "$ref": "UserList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.traits.show",
- "path": "traits/{uuid}",
+ "id": "arvados.users.show",
+ "path": "users/{uuid}",
"httpMethod": "GET",
- "description": "show traits",
+ "description": "show users",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Trait"
+ "$ref": "User"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.traits.destroy",
- "path": "traits/{uuid}",
+ "id": "arvados.users.destroy",
+ "path": "users/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy traits",
+ "description": "destroy users",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Trait"
+ "$ref": "User"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "virtual_machines": {
+ "user_agreements": {
"methods": {
"get": {
- "id": "arvados.virtual_machines.get",
- "path": "virtual_machines/{uuid}",
+ "id": "arvados.user_agreements.get",
+ "path": "user_agreements/{uuid}",
"httpMethod": "GET",
- "description": "Gets a VirtualMachine's metadata by UUID.",
+ "description": "Gets a UserAgreement's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the VirtualMachine in question.",
+ "description": "The UUID of the UserAgreement in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.virtual_machines.list",
- "path": "virtual_machines",
+ "id": "arvados.user_agreements.list",
+ "path": "user_agreements",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "VirtualMachineList"
+ "$ref": "UserAgreementList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.virtual_machines.create",
- "path": "virtual_machines",
+ "id": "arvados.user_agreements.create",
+ "path": "user_agreements",
"httpMethod": "POST",
- "description": "Create a new VirtualMachine.",
+ "description": "Create a new UserAgreement.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "virtual_machine": {
- "$ref": "VirtualMachine"
+ "user_agreement": {
+ "$ref": "UserAgreement"
}
}
},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.virtual_machines.update",
- "path": "virtual_machines/{uuid}",
+ "id": "arvados.user_agreements.update",
+ "path": "user_agreements/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing VirtualMachine.",
+ "description": "Update attributes of an existing UserAgreement.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the VirtualMachine in question.",
+ "description": "The UUID of the UserAgreement in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "virtual_machine": {
- "$ref": "VirtualMachine"
+ "user_agreement": {
+ "$ref": "UserAgreement"
}
}
},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.virtual_machines.delete",
- "path": "virtual_machines/{uuid}",
+ "id": "arvados.user_agreements.delete",
+ "path": "user_agreements/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing VirtualMachine.",
+ "description": "Delete an existing UserAgreement.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the VirtualMachine in question.",
+ "description": "The UUID of the UserAgreement in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "logins": {
- "id": "arvados.virtual_machines.logins",
- "path": "virtual_machines/{uuid}/logins",
+ "signatures": {
+ "id": "arvados.user_agreements.signatures",
+ "path": "user_agreements/signatures",
"httpMethod": "GET",
- "description": "logins virtual_machines",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
+ "description": "signatures user_agreements",
+ "parameters": {},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
- "get_all_logins": {
- "id": "arvados.virtual_machines.get_all_logins",
- "path": "virtual_machines/get_all_logins",
- "httpMethod": "GET",
- "description": "get_all_logins virtual_machines",
+ "sign": {
+ "id": "arvados.user_agreements.sign",
+ "path": "user_agreements/sign",
+ "httpMethod": "POST",
+ "description": "sign user_agreements",
"parameters": {},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.virtual_machines.list",
- "path": "virtual_machines",
+ "id": "arvados.user_agreements.list",
+ "path": "user_agreements",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "VirtualMachineList"
+ "$ref": "UserAgreementList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
"https://api.arvados.org/auth/arvados.readonly"
]
},
+ "new": {
+ "id": "arvados.user_agreements.new",
+ "path": "user_agreements/new",
+ "httpMethod": "GET",
+ "description": "new user_agreements",
+ "parameters": {},
+ "response": {
+ "$ref": "UserAgreement"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
"show": {
- "id": "arvados.virtual_machines.show",
- "path": "virtual_machines/{uuid}",
+ "id": "arvados.user_agreements.show",
+ "path": "user_agreements/{uuid}",
"httpMethod": "GET",
- "description": "show virtual_machines",
+ "description": "show user_agreements",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.virtual_machines.destroy",
- "path": "virtual_machines/{uuid}",
+ "id": "arvados.user_agreements.destroy",
+ "path": "user_agreements/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy virtual_machines",
+ "description": "destroy user_agreements",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "VirtualMachine"
+ "$ref": "UserAgreement"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "workflows": {
+ "virtual_machines": {
"methods": {
"get": {
- "id": "arvados.workflows.get",
- "path": "workflows/{uuid}",
+ "id": "arvados.virtual_machines.get",
+ "path": "virtual_machines/{uuid}",
"httpMethod": "GET",
- "description": "Gets a Workflow's metadata by UUID.",
+ "description": "Gets a VirtualMachine's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Workflow in question.",
+ "description": "The UUID of the VirtualMachine in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "Workflow"
+ "$ref": "VirtualMachine"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.workflows.list",
- "path": "workflows",
+ "id": "arvados.virtual_machines.list",
+ "path": "virtual_machines",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "WorkflowList"
+ "$ref": "VirtualMachineList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.workflows.create",
- "path": "workflows",
+ "id": "arvados.virtual_machines.create",
+ "path": "virtual_machines",
"httpMethod": "POST",
- "description": "Create a new Workflow.",
+ "description": "Create a new VirtualMachine.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "workflow": {
- "$ref": "Workflow"
+ "virtual_machine": {
+ "$ref": "VirtualMachine"
}
}
},
"response": {
- "$ref": "Workflow"
+ "$ref": "VirtualMachine"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.workflows.update",
- "path": "workflows/{uuid}",
+ "id": "arvados.virtual_machines.update",
+ "path": "virtual_machines/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing Workflow.",
+ "description": "Update attributes of an existing VirtualMachine.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Workflow in question.",
+ "description": "The UUID of the VirtualMachine in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "workflow": {
- "$ref": "Workflow"
+ "virtual_machine": {
+ "$ref": "VirtualMachine"
}
}
},
"response": {
- "$ref": "Workflow"
+ "$ref": "VirtualMachine"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.workflows.delete",
- "path": "workflows/{uuid}",
+ "id": "arvados.virtual_machines.delete",
+ "path": "virtual_machines/{uuid}",
"httpMethod": "DELETE",
- "description": "Delete an existing Workflow.",
+ "description": "Delete an existing VirtualMachine.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the Workflow in question.",
+ "description": "The UUID of the VirtualMachine in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "Workflow"
+ "$ref": "VirtualMachine"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "logins": {
+ "id": "arvados.virtual_machines.logins",
+ "path": "virtual_machines/{uuid}/logins",
+ "httpMethod": "GET",
+ "description": "logins virtual_machines",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "VirtualMachine"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ },
+ "get_all_logins": {
+ "id": "arvados.virtual_machines.get_all_logins",
+ "path": "virtual_machines/get_all_logins",
+ "httpMethod": "GET",
+ "description": "get_all_logins virtual_machines",
+ "parameters": {},
+ "response": {
+ "$ref": "VirtualMachine"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.workflows.list",
- "path": "workflows",
+ "id": "arvados.virtual_machines.list",
+ "path": "virtual_machines",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "WorkflowList"
+ "$ref": "VirtualMachineList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"show": {
- "id": "arvados.workflows.show",
- "path": "workflows/{uuid}",
+ "id": "arvados.virtual_machines.show",
+ "path": "virtual_machines/{uuid}",
"httpMethod": "GET",
- "description": "show workflows",
+ "description": "show virtual_machines",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Workflow"
+ "$ref": "VirtualMachine"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"destroy": {
- "id": "arvados.workflows.destroy",
- "path": "workflows/{uuid}",
+ "id": "arvados.virtual_machines.destroy",
+ "path": "virtual_machines/{uuid}",
"httpMethod": "DELETE",
- "description": "destroy workflows",
+ "description": "destroy virtual_machines",
"parameters": {
"uuid": {
"type": "string",
}
},
"response": {
- "$ref": "Workflow"
+ "$ref": "VirtualMachine"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
}
}
},
- "user_agreements": {
+ "workflows": {
"methods": {
"get": {
- "id": "arvados.user_agreements.get",
- "path": "user_agreements/{uuid}",
+ "id": "arvados.workflows.get",
+ "path": "workflows/{uuid}",
"httpMethod": "GET",
- "description": "Gets a UserAgreement's metadata by UUID.",
+ "description": "Gets a Workflow's metadata by UUID.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the UserAgreement in question.",
+ "description": "The UUID of the Workflow in question.",
"required": true,
"location": "path"
}
"uuid"
],
"response": {
- "$ref": "UserAgreement"
+ "$ref": "Workflow"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"index": {
- "id": "arvados.user_agreements.list",
- "path": "user_agreements",
+ "id": "arvados.workflows.list",
+ "path": "workflows",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "UserAgreementList"
+ "$ref": "WorkflowList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
]
},
"create": {
- "id": "arvados.user_agreements.create",
- "path": "user_agreements",
+ "id": "arvados.workflows.create",
+ "path": "workflows",
"httpMethod": "POST",
- "description": "Create a new UserAgreement.",
+ "description": "Create a new Workflow.",
"parameters": {
"select": {
"type": "array",
"request": {
"required": true,
"properties": {
- "user_agreement": {
- "$ref": "UserAgreement"
+ "workflow": {
+ "$ref": "Workflow"
}
}
},
"response": {
- "$ref": "UserAgreement"
+ "$ref": "Workflow"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"update": {
- "id": "arvados.user_agreements.update",
- "path": "user_agreements/{uuid}",
+ "id": "arvados.workflows.update",
+ "path": "workflows/{uuid}",
"httpMethod": "PUT",
- "description": "Update attributes of an existing UserAgreement.",
+ "description": "Update attributes of an existing Workflow.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the UserAgreement in question.",
+ "description": "The UUID of the Workflow in question.",
"required": true,
"location": "path"
},
"request": {
"required": true,
"properties": {
- "user_agreement": {
- "$ref": "UserAgreement"
+ "workflow": {
+ "$ref": "Workflow"
}
}
},
"response": {
- "$ref": "UserAgreement"
+ "$ref": "Workflow"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"delete": {
- "id": "arvados.user_agreements.delete",
- "path": "user_agreements/{uuid}",
- "httpMethod": "DELETE",
- "description": "Delete an existing UserAgreement.",
+ "id": "arvados.workflows.delete",
+ "path": "workflows/{uuid}",
+ "httpMethod": "DELETE",
+ "description": "Delete an existing Workflow.",
"parameters": {
"uuid": {
"type": "string",
- "description": "The UUID of the UserAgreement in question.",
+ "description": "The UUID of the Workflow in question.",
"required": true,
"location": "path"
}
},
"response": {
- "$ref": "UserAgreement"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "signatures": {
- "id": "arvados.user_agreements.signatures",
- "path": "user_agreements/signatures",
- "httpMethod": "GET",
- "description": "signatures user_agreements",
- "parameters": {},
- "response": {
- "$ref": "UserAgreement"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "sign": {
- "id": "arvados.user_agreements.sign",
- "path": "user_agreements/sign",
- "httpMethod": "POST",
- "description": "sign user_agreements",
- "parameters": {},
- "response": {
- "$ref": "UserAgreement"
+ "$ref": "Workflow"
},
"scopes": [
"https://api.arvados.org/auth/arvados"
]
},
"list": {
- "id": "arvados.user_agreements.list",
- "path": "user_agreements",
+ "id": "arvados.workflows.list",
+ "path": "workflows",
"httpMethod": "GET",
- "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>",
+ "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>",
"parameters": {
"filters": {
"type": "array",
}
},
"response": {
- "$ref": "UserAgreementList"
+ "$ref": "WorkflowList"
},
"scopes": [
"https://api.arvados.org/auth/arvados",
"https://api.arvados.org/auth/arvados.readonly"
]
},
- "new": {
- "id": "arvados.user_agreements.new",
- "path": "user_agreements/new",
- "httpMethod": "GET",
- "description": "new user_agreements",
- "parameters": {},
- "response": {
- "$ref": "UserAgreement"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
"show": {
- "id": "arvados.user_agreements.show",
- "path": "user_agreements/{uuid}",
- "httpMethod": "GET",
- "description": "show user_agreements",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- },
- "select": {
- "type": "array",
- "description": "Attributes of the object to return in the response.",
- "required": false,
- "location": "query"
- }
- },
- "response": {
- "$ref": "UserAgreement"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- },
- "destroy": {
- "id": "arvados.user_agreements.destroy",
- "path": "user_agreements/{uuid}",
- "httpMethod": "DELETE",
- "description": "destroy user_agreements",
- "parameters": {
- "uuid": {
- "type": "string",
- "description": "",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "UserAgreement"
- },
- "scopes": [
- "https://api.arvados.org/auth/arvados"
- ]
- }
- }
- },
- "configs": {
- "methods": {
- "get": {
- "id": "arvados.configs.get",
- "path": "config",
- "httpMethod": "GET",
- "description": "Get public config",
- "parameters": {},
- "parameterOrder": [],
- "response": {},
- "scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
- ]
- }
- }
- },
- "vocabularies": {
- "methods": {
- "get": {
- "id": "arvados.vocabularies.get",
- "path": "vocabulary",
- "httpMethod": "GET",
- "description": "Get vocabulary definition",
- "parameters": {},
- "parameterOrder": [],
- "response": {},
- "scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
- ]
- }
- }
- },
- "sys": {
- "methods": {
- "get": {
- "id": "arvados.sys.trash_sweep",
- "path": "sys/trash_sweep",
- "httpMethod": "POST",
- "description": "apply scheduled trash and delete operations",
- "parameters": {},
- "parameterOrder": [],
- "response": {},
- "scopes": [
- "https://api.arvados.org/auth/arvados",
- "https://api.arvados.org/auth/arvados.readonly"
- ]
- }
- }
- }
- },
- "revision": "20220510",
- "schemas": {
- "JobList": {
- "id": "JobList",
- "description": "Job list",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Object type. Always arvados#jobList.",
- "default": "arvados#jobList"
- },
- "etag": {
- "type": "string",
- "description": "List version."
- },
- "items": {
- "type": "array",
- "description": "The list of Jobs.",
- "items": {
- "$ref": "Job"
- }
- },
- "next_link": {
- "type": "string",
- "description": "A link to the next page of Jobs."
- },
- "next_page_token": {
- "type": "string",
- "description": "The page token for the next page of Jobs."
- },
- "selfLink": {
- "type": "string",
- "description": "A link back to this list."
- }
- }
- },
- "Job": {
- "id": "Job",
- "description": "Job",
- "type": "object",
- "uuidPrefix": "8i9sb",
- "properties": {
- "uuid": {
- "type": "string"
- },
- "etag": {
- "type": "string",
- "description": "Object version."
- },
- "owner_uuid": {
- "type": "string"
- },
- "modified_by_client_uuid": {
- "type": "string"
- },
- "modified_by_user_uuid": {
- "type": "string"
- },
- "modified_at": {
- "type": "datetime"
- },
- "submit_id": {
- "type": "string"
- },
- "script": {
- "type": "string"
- },
- "script_version": {
- "type": "string"
- },
- "script_parameters": {
- "type": "Hash"
- },
- "cancelled_by_client_uuid": {
- "type": "string"
- },
- "cancelled_by_user_uuid": {
- "type": "string"
- },
- "cancelled_at": {
- "type": "datetime"
- },
- "started_at": {
- "type": "datetime"
- },
- "finished_at": {
- "type": "datetime"
- },
- "running": {
- "type": "boolean"
- },
- "success": {
- "type": "boolean"
- },
- "output": {
- "type": "string"
- },
- "created_at": {
- "type": "datetime"
- },
- "updated_at": {
- "type": "datetime"
- },
- "is_locked_by_uuid": {
- "type": "string"
- },
- "log": {
- "type": "string"
- },
- "tasks_summary": {
- "type": "Hash"
- },
- "runtime_constraints": {
- "type": "Hash"
- },
- "nondeterministic": {
- "type": "boolean"
- },
- "repository": {
- "type": "string"
- },
- "supplied_script_version": {
- "type": "string"
- },
- "docker_image_locator": {
- "type": "string"
- },
- "priority": {
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "state": {
- "type": "string"
- },
- "arvados_sdk_version": {
- "type": "string"
- },
- "components": {
- "type": "Hash"
+ "id": "arvados.workflows.show",
+ "path": "workflows/{uuid}",
+ "httpMethod": "GET",
+ "description": "show workflows",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ },
+ "select": {
+ "type": "array",
+ "description": "Attributes of the object to return in the response.",
+ "required": false,
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "Workflow"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
},
- "script_parameters_digest": {
- "type": "string"
+ "destroy": {
+ "id": "arvados.workflows.destroy",
+ "path": "workflows/{uuid}",
+ "httpMethod": "DELETE",
+ "description": "destroy workflows",
+ "parameters": {
+ "uuid": {
+ "type": "string",
+ "description": "",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Workflow"
+ },
+ "scopes": [
+ "https://api.arvados.org/auth/arvados"
+ ]
+ }
+ }
+ },
+ "configs": {
+ "methods": {
+ "get": {
+ "id": "arvados.configs.get",
+ "path": "config",
+ "httpMethod": "GET",
+ "description": "Get public config",
+ "parameters": {},
+ "parameterOrder": [],
+ "response": {},
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
+ }
+ }
+ },
+ "vocabularies": {
+ "methods": {
+ "get": {
+ "id": "arvados.vocabularies.get",
+ "path": "vocabulary",
+ "httpMethod": "GET",
+ "description": "Get vocabulary definition",
+ "parameters": {},
+ "parameterOrder": [],
+ "response": {},
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
}
}
},
+ "sys": {
+ "methods": {
+ "get": {
+ "id": "arvados.sys.trash_sweep",
+ "path": "sys/trash_sweep",
+ "httpMethod": "POST",
+ "description": "apply scheduled trash and delete operations",
+ "parameters": {},
+ "parameterOrder": [],
+ "response": {},
+ "scopes": [
+ "https://api.arvados.org/auth/arvados",
+ "https://api.arvados.org/auth/arvados.readonly"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20231117",
+ "schemas": {
"ApiClientList": {
"id": "ApiClientList",
"description": "ApiClient list",
"created_at": {
"type": "datetime"
},
- "updated_at": {
- "type": "datetime"
- },
"is_trusted": {
"type": "boolean"
}
"created_at": {
"type": "datetime"
},
- "updated_at": {
- "type": "datetime"
- },
"default_owner_uuid": {
"type": "string"
},
},
"created_at": {
"type": "datetime"
- },
- "updated_at": {
- "type": "datetime"
}
}
},
"replication_confirmed": {
"type": "integer"
},
- "updated_at": {
- "type": "datetime"
- },
"manifest_text": {
"type": "text"
},
"delete_at": {
"type": "datetime"
},
- "file_names": {
- "type": "text"
- },
"trash_at": {
"type": "datetime"
},
"priority": {
"type": "integer"
},
- "updated_at": {
- "type": "datetime"
- },
"exit_code": {
"type": "integer"
},
"runtime_auth_scopes": {
"type": "Array"
},
- "runtime_token": {
- "type": "text"
- },
"lock_count": {
"type": "integer"
},
"filters": {
"type": "text"
},
- "updated_at": {
- "type": "datetime"
- },
"container_count": {
"type": "integer"
},
"output_ttl": {
"type": "integer"
},
- "runtime_token": {
- "type": "text"
- },
"output_storage_classes": {
"type": "Array"
},
"description": {
"type": "string"
},
- "updated_at": {
- "type": "datetime"
- },
"group_class": {
"type": "string"
},
"$ref": "Human"
}
},
- "next_link": {
- "type": "string",
- "description": "A link to the next page of Humans."
+ "next_link": {
+ "type": "string",
+ "description": "A link to the next page of Humans."
+ },
+ "next_page_token": {
+ "type": "string",
+ "description": "The page token for the next page of Humans."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "A link back to this list."
+ }
+ }
+ },
+ "Human": {
+ "id": "Human",
+ "description": "Human",
+ "type": "object",
+ "uuidPrefix": "7a9it",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Object version."
+ },
+ "owner_uuid": {
+ "type": "string"
+ },
+ "modified_by_client_uuid": {
+ "type": "string"
+ },
+ "modified_by_user_uuid": {
+ "type": "string"
+ },
+ "modified_at": {
+ "type": "datetime"
+ },
+ "properties": {
+ "type": "Hash"
+ },
+ "created_at": {
+ "type": "datetime"
+ }
+ }
+ },
+ "JobList": {
+ "id": "JobList",
+ "description": "Job list",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Object type. Always arvados#jobList.",
+ "default": "arvados#jobList"
+ },
+ "etag": {
+ "type": "string",
+ "description": "List version."
+ },
+ "items": {
+ "type": "array",
+ "description": "The list of Jobs.",
+ "items": {
+ "$ref": "Job"
+ }
+ },
+ "next_link": {
+ "type": "string",
+ "description": "A link to the next page of Jobs."
+ },
+ "next_page_token": {
+ "type": "string",
+ "description": "The page token for the next page of Jobs."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "A link back to this list."
+ }
+ }
+ },
+ "Job": {
+ "id": "Job",
+ "description": "Job",
+ "type": "object",
+ "uuidPrefix": "8i9sb",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Object version."
+ },
+ "owner_uuid": {
+ "type": "string"
+ },
+ "modified_by_client_uuid": {
+ "type": "string"
+ },
+ "modified_by_user_uuid": {
+ "type": "string"
+ },
+ "modified_at": {
+ "type": "datetime"
+ },
+ "submit_id": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_version": {
+ "type": "string"
+ },
+ "script_parameters": {
+ "type": "Hash"
+ },
+ "cancelled_by_client_uuid": {
+ "type": "string"
+ },
+ "cancelled_by_user_uuid": {
+ "type": "string"
+ },
+ "cancelled_at": {
+ "type": "datetime"
+ },
+ "started_at": {
+ "type": "datetime"
+ },
+ "finished_at": {
+ "type": "datetime"
+ },
+ "running": {
+ "type": "boolean"
+ },
+ "success": {
+ "type": "boolean"
+ },
+ "output": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "datetime"
},
- "next_page_token": {
- "type": "string",
- "description": "The page token for the next page of Humans."
+ "is_locked_by_uuid": {
+ "type": "string"
},
- "selfLink": {
- "type": "string",
- "description": "A link back to this list."
- }
- }
- },
- "Human": {
- "id": "Human",
- "description": "Human",
- "type": "object",
- "uuidPrefix": "7a9it",
- "properties": {
- "uuid": {
+ "log": {
"type": "string"
},
- "etag": {
- "type": "string",
- "description": "Object version."
+ "tasks_summary": {
+ "type": "Hash"
},
- "owner_uuid": {
+ "runtime_constraints": {
+ "type": "Hash"
+ },
+ "nondeterministic": {
+ "type": "boolean"
+ },
+ "repository": {
"type": "string"
},
- "modified_by_client_uuid": {
+ "supplied_script_version": {
"type": "string"
},
- "modified_by_user_uuid": {
+ "docker_image_locator": {
"type": "string"
},
- "modified_at": {
- "type": "datetime"
+ "priority": {
+ "type": "integer"
},
- "properties": {
- "type": "Hash"
+ "description": {
+ "type": "string"
},
- "created_at": {
- "type": "datetime"
+ "state": {
+ "type": "string"
},
- "updated_at": {
- "type": "datetime"
+ "arvados_sdk_version": {
+ "type": "string"
+ },
+ "components": {
+ "type": "Hash"
}
}
},
"created_at": {
"type": "datetime"
},
- "updated_at": {
- "type": "datetime"
- },
"created_by_job_task_uuid": {
"type": "string"
},
"modified_at": {
"type": "datetime"
},
- "ping_secret": {
- "type": "string"
- },
"node_uuid": {
"type": "string"
},
"created_at": {
"type": "datetime"
},
- "updated_at": {
- "type": "datetime"
- },
"keep_service_uuid": {
"type": "string"
}
"created_at": {
"type": "datetime"
},
- "updated_at": {
- "type": "datetime"
- },
"read_only": {
"type": "boolean"
}
},
"properties": {
"type": "Hash"
- },
- "updated_at": {
- "type": "datetime"
}
}
},
"type": "string",
"description": "Object version."
},
+ "id": {
+ "type": "integer"
+ },
"owner_uuid": {
"type": "string"
},
"created_at": {
"type": "datetime"
},
- "updated_at": {
- "type": "datetime"
- },
"modified_at": {
"type": "datetime"
},
"ip_address": {
"type": "string"
},
- "first_ping_at": {
- "type": "datetime"
- },
"last_ping_at": {
"type": "datetime"
},
- "info": {
- "type": "Hash"
- },
- "updated_at": {
- "type": "datetime"
- },
"properties": {
"type": "Hash"
},
}
}
},
- "UserList": {
- "id": "UserList",
- "description": "User list",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Object type. Always arvados#userList.",
- "default": "arvados#userList"
- },
- "etag": {
- "type": "string",
- "description": "List version."
- },
- "items": {
- "type": "array",
- "description": "The list of Users.",
- "items": {
- "$ref": "User"
- }
- },
- "next_link": {
- "type": "string",
- "description": "A link to the next page of Users."
- },
- "next_page_token": {
- "type": "string",
- "description": "The page token for the next page of Users."
- },
- "selfLink": {
- "type": "string",
- "description": "A link back to this list."
- }
- }
- },
- "User": {
- "id": "User",
- "description": "User",
- "type": "object",
- "uuidPrefix": "tpzed",
- "properties": {
- "uuid": {
- "type": "string"
- },
- "etag": {
- "type": "string",
- "description": "Object version."
- },
- "owner_uuid": {
- "type": "string"
- },
- "created_at": {
- "type": "datetime"
- },
- "modified_by_client_uuid": {
- "type": "string"
- },
- "modified_by_user_uuid": {
- "type": "string"
- },
- "modified_at": {
- "type": "datetime"
- },
- "email": {
- "type": "string"
- },
- "first_name": {
- "type": "string"
- },
- "last_name": {
- "type": "string"
- },
- "identity_url": {
- "type": "string"
- },
- "is_admin": {
- "type": "boolean"
- },
- "prefs": {
- "type": "Hash"
- },
- "updated_at": {
- "type": "datetime"
- },
- "default_owner_uuid": {
- "type": "string"
- },
- "is_active": {
- "type": "boolean"
- },
- "username": {
- "type": "string"
- },
- "redirect_to_user_uuid": {
- "type": "string"
- }
- }
- },
"PipelineInstanceList": {
"id": "PipelineInstanceList",
"description": "PipelineInstance list",
"components": {
"type": "Hash"
},
- "updated_at": {
- "type": "datetime"
- },
"properties": {
"type": "Hash"
},
"components": {
"type": "Hash"
},
- "updated_at": {
- "type": "datetime"
- },
"description": {
"type": "string"
}
},
"created_at": {
"type": "datetime"
- },
- "updated_at": {
- "type": "datetime"
}
}
},
},
"next_link": {
"type": "string",
- "description": "A link to the next page of Specimens."
- },
- "next_page_token": {
- "type": "string",
- "description": "The page token for the next page of Specimens."
- },
- "selfLink": {
- "type": "string",
- "description": "A link back to this list."
- }
- }
- },
- "Specimen": {
- "id": "Specimen",
- "description": "Specimen",
- "type": "object",
- "uuidPrefix": "j58dm",
- "properties": {
- "uuid": {
- "type": "string"
- },
- "etag": {
- "type": "string",
- "description": "Object version."
- },
- "owner_uuid": {
- "type": "string"
- },
- "created_at": {
- "type": "datetime"
- },
- "modified_by_client_uuid": {
- "type": "string"
- },
- "modified_by_user_uuid": {
- "type": "string"
- },
- "modified_at": {
- "type": "datetime"
- },
- "material": {
- "type": "string"
- },
- "updated_at": {
- "type": "datetime"
- },
- "properties": {
- "type": "Hash"
- }
- }
- },
- "TraitList": {
- "id": "TraitList",
- "description": "Trait list",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Object type. Always arvados#traitList.",
- "default": "arvados#traitList"
- },
- "etag": {
- "type": "string",
- "description": "List version."
- },
- "items": {
- "type": "array",
- "description": "The list of Traits.",
- "items": {
- "$ref": "Trait"
- }
- },
- "next_link": {
- "type": "string",
- "description": "A link to the next page of Traits."
+ "description": "A link to the next page of Specimens."
},
"next_page_token": {
"type": "string",
- "description": "The page token for the next page of Traits."
+ "description": "The page token for the next page of Specimens."
},
"selfLink": {
"type": "string",
}
}
},
- "Trait": {
- "id": "Trait",
- "description": "Trait",
+ "Specimen": {
+ "id": "Specimen",
+ "description": "Specimen",
"type": "object",
- "uuidPrefix": "q1cn2",
+ "uuidPrefix": "j58dm",
"properties": {
"uuid": {
"type": "string"
"owner_uuid": {
"type": "string"
},
+ "created_at": {
+ "type": "datetime"
+ },
"modified_by_client_uuid": {
"type": "string"
},
"modified_at": {
"type": "datetime"
},
- "name": {
+ "material": {
"type": "string"
},
"properties": {
"type": "Hash"
- },
- "created_at": {
- "type": "datetime"
- },
- "updated_at": {
- "type": "datetime"
}
}
},
- "VirtualMachineList": {
- "id": "VirtualMachineList",
- "description": "VirtualMachine list",
+ "TraitList": {
+ "id": "TraitList",
+ "description": "Trait list",
"type": "object",
"properties": {
"kind": {
"type": "string",
- "description": "Object type. Always arvados#virtualMachineList.",
- "default": "arvados#virtualMachineList"
+ "description": "Object type. Always arvados#traitList.",
+ "default": "arvados#traitList"
},
"etag": {
"type": "string",
},
"items": {
"type": "array",
- "description": "The list of VirtualMachines.",
+ "description": "The list of Traits.",
"items": {
- "$ref": "VirtualMachine"
+ "$ref": "Trait"
}
},
"next_link": {
"type": "string",
- "description": "A link to the next page of VirtualMachines."
+ "description": "A link to the next page of Traits."
},
"next_page_token": {
"type": "string",
- "description": "The page token for the next page of VirtualMachines."
+ "description": "The page token for the next page of Traits."
},
"selfLink": {
"type": "string",
}
}
},
- "VirtualMachine": {
- "id": "VirtualMachine",
- "description": "VirtualMachine",
+ "Trait": {
+ "id": "Trait",
+ "description": "Trait",
"type": "object",
- "uuidPrefix": "2x53u",
+ "uuidPrefix": "q1cn2",
"properties": {
"uuid": {
"type": "string"
"modified_at": {
"type": "datetime"
},
- "hostname": {
+ "name": {
"type": "string"
},
- "created_at": {
- "type": "datetime"
+ "properties": {
+ "type": "Hash"
},
- "updated_at": {
+ "created_at": {
"type": "datetime"
}
}
},
- "WorkflowList": {
- "id": "WorkflowList",
- "description": "Workflow list",
+ "UserList": {
+ "id": "UserList",
+ "description": "User list",
"type": "object",
"properties": {
"kind": {
"type": "string",
- "description": "Object type. Always arvados#workflowList.",
- "default": "arvados#workflowList"
+ "description": "Object type. Always arvados#userList.",
+ "default": "arvados#userList"
},
"etag": {
"type": "string",
},
"items": {
"type": "array",
- "description": "The list of Workflows.",
+ "description": "The list of Users.",
"items": {
- "$ref": "Workflow"
+ "$ref": "User"
}
},
"next_link": {
"type": "string",
- "description": "A link to the next page of Workflows."
+ "description": "A link to the next page of Users."
},
"next_page_token": {
"type": "string",
- "description": "The page token for the next page of Workflows."
+ "description": "The page token for the next page of Users."
},
"selfLink": {
"type": "string",
}
}
},
- "Workflow": {
- "id": "Workflow",
- "description": "Workflow",
+ "User": {
+ "id": "User",
+ "description": "User",
"type": "object",
- "uuidPrefix": "7fd4e",
+ "uuidPrefix": "tpzed",
"properties": {
"uuid": {
"type": "string"
"created_at": {
"type": "datetime"
},
+ "modified_by_client_uuid": {
+ "type": "string"
+ },
+ "modified_by_user_uuid": {
+ "type": "string"
+ },
"modified_at": {
"type": "datetime"
},
- "modified_by_client_uuid": {
+ "email": {
"type": "string"
},
- "modified_by_user_uuid": {
+ "first_name": {
"type": "string"
},
- "name": {
+ "last_name": {
"type": "string"
},
- "description": {
- "type": "text"
+ "identity_url": {
+ "type": "string"
},
- "definition": {
- "type": "text"
+ "is_admin": {
+ "type": "boolean"
},
- "updated_at": {
- "type": "datetime"
+ "prefs": {
+ "type": "Hash"
+ },
+ "is_active": {
+ "type": "boolean"
+ },
+ "username": {
+ "type": "string"
}
}
},
"replication_confirmed": {
"type": "integer"
},
- "updated_at": {
- "type": "datetime"
- },
"manifest_text": {
"type": "text"
},
"delete_at": {
"type": "datetime"
},
- "file_names": {
- "type": "text"
- },
"trash_at": {
"type": "datetime"
},
"type": "integer"
}
}
+ },
+ "VirtualMachineList": {
+ "id": "VirtualMachineList",
+ "description": "VirtualMachine list",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Object type. Always arvados#virtualMachineList.",
+ "default": "arvados#virtualMachineList"
+ },
+ "etag": {
+ "type": "string",
+ "description": "List version."
+ },
+ "items": {
+ "type": "array",
+ "description": "The list of VirtualMachines.",
+ "items": {
+ "$ref": "VirtualMachine"
+ }
+ },
+ "next_link": {
+ "type": "string",
+ "description": "A link to the next page of VirtualMachines."
+ },
+ "next_page_token": {
+ "type": "string",
+ "description": "The page token for the next page of VirtualMachines."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "A link back to this list."
+ }
+ }
+ },
+ "VirtualMachine": {
+ "id": "VirtualMachine",
+ "description": "VirtualMachine",
+ "type": "object",
+ "uuidPrefix": "2x53u",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Object version."
+ },
+ "owner_uuid": {
+ "type": "string"
+ },
+ "modified_by_client_uuid": {
+ "type": "string"
+ },
+ "modified_by_user_uuid": {
+ "type": "string"
+ },
+ "modified_at": {
+ "type": "datetime"
+ },
+ "hostname": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "datetime"
+ }
+ }
+ },
+ "WorkflowList": {
+ "id": "WorkflowList",
+ "description": "Workflow list",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Object type. Always arvados#workflowList.",
+ "default": "arvados#workflowList"
+ },
+ "etag": {
+ "type": "string",
+ "description": "List version."
+ },
+ "items": {
+ "type": "array",
+ "description": "The list of Workflows.",
+ "items": {
+ "$ref": "Workflow"
+ }
+ },
+ "next_link": {
+ "type": "string",
+ "description": "A link to the next page of Workflows."
+ },
+ "next_page_token": {
+ "type": "string",
+ "description": "The page token for the next page of Workflows."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "A link back to this list."
+ }
+ }
+ },
+ "Workflow": {
+ "id": "Workflow",
+ "description": "Workflow",
+ "type": "object",
+ "uuidPrefix": "7fd4e",
+ "properties": {
+ "uuid": {
+ "type": "string"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Object version."
+ },
+ "owner_uuid": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "datetime"
+ },
+ "modified_at": {
+ "type": "datetime"
+ },
+ "modified_by_client_uuid": {
+ "type": "string"
+ },
+ "modified_by_user_uuid": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "text"
+ },
+ "definition": {
+ "type": "text"
+ }
+ }
}
},
"servicePath": "arvados/v1/",