Merge branch '2328-keep-permission-flags' (closes #2328)
[arvados.git] / doc / api / index.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 title: API Reference
5
6 ...
7
8
9
10 h2. Concepts
11
12 * Each API uses the same "authentication mechanism":authentication.html.
13 * Resources in requests and responses adhere to a "common structure":resources.html.
14 * API transactions use common "REST methods":methods.html.
15 * API transactions are subject to a "permission model":permission-model.html.
16 * "Job tasks":schema/JobTask.html use some special API features.
17
18 h2. Resources
19
20 h3. Generic Resources
21
22 * "Collection":schema/Collection.html
23 * "Job":schema/Job.html
24 * "JobTask":schema/JobTask.html
25 * "Link":schema/Link.html
26 * "Log":schema/Log.html
27 * "PipelineTemplate":schema/PipelineTemplate.html
28 * "PipelineInstance":schema/PipelineInstance.html
29 * "Group":schema/Group.html
30 * "Human":schema/Human.html
31 * "Specimen":schema/Specimen.html
32 * "Trait":schema/Trait.html
33 * "User":schema/User.html
34
35 h3. Authentication
36
37 These Arvados resources govern authorization and "authentication":authentication.html:
38
39 * "ApiClient":schema/ApiClient.html
40 * "ApiClientAuthorization":schema/ApiClientAuthorization.html
41 * "AuthorizedKey":schema/AuthorizedKey.html
42
43 h3. Arvados Infrastructure
44
45 These resources govern the Arvados infrastructure itself: Git repositories, Keep disks, active nodes, etc.
46
47 * "KeepDisk":schema/KeepDisk.html
48 * "Node":schema/Node.html
49 * "Repository":schema/Repository.html
50 * "VirtualMachine":schema/VirtualMachine.html