Browse code

Fixed API 1.12 links and misc other fixes

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)

James Turnbull authored on 2014/06/09 09:59:22
Showing 5 changed files
... ...
@@ -103,8 +103,9 @@ pages:
103 103
 - ['reference/api/registry_api.md', 'Reference', 'Docker Registry API']
104 104
 - ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry Spec']
105 105
 - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
106
+- ['reference/api/docker_remote_api_v1.12.md', 'Reference', 'Docker Remote API v1.12']
106 107
 - ['reference/api/docker_remote_api_v1.11.md', 'Reference', 'Docker Remote API v1.11']
107
-- ['reference/api/docker_remote_api_v1.10.md', 'Reference', 'Docker Remote API v1.10']
108
+- ['reference/api/docker_remote_api_v1.10.md', '**HIDDEN**']
108 109
 - ['reference/api/docker_remote_api_v1.9.md', '**HIDDEN**']
109 110
 - ['reference/api/docker_remote_api_v1.8.md', '**HIDDEN**']
110 111
 - ['reference/api/docker_remote_api_v1.7.md', '**HIDDEN**']
... ...
@@ -116,8 +117,8 @@ pages:
116 116
 - ['reference/api/docker_remote_api_v1.1.md', '**HIDDEN**']
117 117
 - ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**']
118 118
 - ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API Client Libraries']
119
-- ['reference/api/docker_io_oauth_api.md', 'Reference', 'Docker IO OAuth API']
120
-- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker IO Accounts API']
119
+- ['reference/api/docker_io_oauth_api.md', 'Reference', 'Docker Hub OAuth API']
120
+- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub Accounts API']
121 121
 
122 122
 - ['jsearch.md', '**HIDDEN**']
123 123
 
... ...
@@ -52,6 +52,7 @@ interfaces:
52 52
  - [Docker Remote API](docker_remote_api/)
53 53
     - [1. Brief introduction](docker_remote_api/#brief-introduction)
54 54
     - [2. Versions](docker_remote_api/#versions)
55
+        - [v1.12](docker_remote_api/#v1-12)
55 56
         - [v1.11](docker_remote_api/#v1-11)
56 57
         - [v1.10](docker_remote_api/#v1-10)
57 58
         - [v1.9](docker_remote_api/#v1-9)
... ...
@@ -83,4 +84,4 @@ interfaces:
83 83
         - [1.3 List email addresses for a user](docker_io_accounts_api/#list-email-addresses-for-a-user)
84 84
         - [1.4 Add email address for a user](docker_io_accounts_api/#add-email-address-for-a-user)
85 85
         - [1.5 Update an email address for a user](docker_io_accounts_api/#update-an-email-address-for-a-user)
86
-        - [1.6 Delete email address for a user](docker_io_accounts_api/#delete-email-address-for-a-user)
87 86
\ No newline at end of file
87
+        - [1.6 Delete email address for a user](docker_io_accounts_api/#delete-email-address-for-a-user)
... ...
@@ -4,29 +4,27 @@ page_keywords: API, Docker, rcli, REST, documentation
4 4
 
5 5
 # Docker Remote API
6 6
 
7
- - The Remote API is replacing rcli
8
- - By default the Docker daemon listens on unix:///var/run/docker.sock
9
-   and the client must have root access to interact with the daemon
10
- - If a group named *docker* exists on your system, docker will apply
11
-   ownership of the socket to the group
7
+ - The Remote API is replacing `rcli`.
8
+ - By default the Docker daemon listens on `unix:///var/run/docker.sock`
9
+   and the client must have `root` access to interact with the daemon.
10
+ - If a group named `docker` exists on your system, docker will apply
11
+   ownership of the socket to the group.
12 12
  - The API tends to be REST, but for some complex commands, like attach
13
-   or pull, the HTTP connection is hijacked to transport stdout stdin
14
-   and stderr
13
+   or pull, the HTTP connection is hijacked to transport STDOUT, STDIN,
14
+   and STDERR.
15 15
  - Since API version 1.2, the auth configuration is now handled client
16
-   side, so the client has to send the authConfig as POST in /images/(name)/push
16
+   side, so the client has to send the `authConfig` as a `POST` in `/images/(name)/push`.
17 17
  - authConfig, set as the `X-Registry-Auth` header, is currently a Base64
18
-   encoded (json) string with credentials:
18
+   encoded (JSON) string with credentials:
19 19
    `{'username': string, 'password': string, 'email': string, 'serveraddress' : string}`
20 20
 
21
-
22
-
23 21
 The current version of the API is v1.12
24 22
 
25
-Calling /images/<name>/insert is the same as calling
26
-/v1.12/images/<name>/insert
23
+Calling `/images/<name>/insert` is the same as calling
24
+`/v1.12/images/<name>/insert`.
27 25
 
28
-You can still call an old version of the api using
29
-/v1.12/images/<name>/insert
26
+You can still call an old version of the API using
27
+`/v1.12/images/<name>/insert`.
30 28
 
31 29
 ## v1.12
32 30
 
... ...
@@ -51,7 +49,7 @@ All the JSON keys are now in CamelCase
51 51
 Trusted builds are now Automated Builds - `is_trusted` is now `is_automated`.
52 52
 
53 53
 **Removed Insert Endpoint**
54
-The insert endpoint has been removed.
54
+The `insert` endpoint has been removed.
55 55
 
56 56
 ## v1.11
57 57
 
... ...
@@ -6,12 +6,12 @@ page_keywords: API, Docker, rcli, REST, documentation
6 6
 
7 7
 ## 1. Brief introduction
8 8
 
9
- - The Remote API has replaced rcli
9
+ - The Remote API has replaced `rcli`.
10 10
  - The daemon listens on `unix:///var/run/docker.sock` but you can bind
11 11
    Docker to another host/port or a Unix socket.
12 12
  - The API tends to be REST, but for some complex commands, like `attach`
13
-   or `pull`, the HTTP connection is hijacked to transport `stdout, stdin`
14
-   and `stderr`
13
+   or `pull`, the HTTP connection is hijacked to transport `STDOUT`, `STDIN`
14
+   and `STDERR`.
15 15
 
16 16
 # 2. Endpoints
17 17
 
... ...
@@ -6,13 +6,13 @@ page_keywords: API, Docker, rcli, REST, documentation
6 6
 
7 7
 ## 1. Brief introduction
8 8
 
9
- - The Remote API has replaced rcli
9
+ - The Remote API has replaced `rcli`.
10 10
  - The daemon listens on `unix:///var/run/docker.sock` but you can
11 11
    [*Bind Docker to another host/port or a Unix socket*](
12 12
    /use/basics/#bind-docker).
13 13
  - The API tends to be REST, but for some complex commands, like `attach`
14
-   or `pull`, the HTTP connection is hijacked to transport `stdout, stdin`
15
-   and `stderr`
14
+   or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
15
+   `STDIN` and `STDERR`.
16 16
 
17 17
 # 2. Endpoints
18 18