فهرست منبع

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 11 سال پیش
والد
کامیت
11fee48c2d

+ 4 - 3
docs/mkdocs.yml

@@ -103,8 +103,9 @@ pages:
 - ['reference/api/registry_api.md', 'Reference', 'Docker Registry API']
 - ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry Spec']
 - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
+- ['reference/api/docker_remote_api_v1.12.md', 'Reference', 'Docker Remote API v1.12']
 - ['reference/api/docker_remote_api_v1.11.md', 'Reference', 'Docker Remote API v1.11']
-- ['reference/api/docker_remote_api_v1.10.md', 'Reference', 'Docker Remote API v1.10']
+- ['reference/api/docker_remote_api_v1.10.md', '**HIDDEN**']
 - ['reference/api/docker_remote_api_v1.9.md', '**HIDDEN**']
 - ['reference/api/docker_remote_api_v1.8.md', '**HIDDEN**']
 - ['reference/api/docker_remote_api_v1.7.md', '**HIDDEN**']
@@ -116,8 +117,8 @@ pages:
 - ['reference/api/docker_remote_api_v1.1.md', '**HIDDEN**']
 - ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**']
 - ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API Client Libraries']
-- ['reference/api/docker_io_oauth_api.md', 'Reference', 'Docker IO OAuth API']
-- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker IO Accounts API']
+- ['reference/api/docker_io_oauth_api.md', 'Reference', 'Docker Hub OAuth API']
+- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub Accounts API']
 
 - ['jsearch.md', '**HIDDEN**']
 

+ 2 - 1
docs/sources/reference/api.md

@@ -52,6 +52,7 @@ interfaces:
  - [Docker Remote API](docker_remote_api/)
     - [1. Brief introduction](docker_remote_api/#brief-introduction)
     - [2. Versions](docker_remote_api/#versions)
+        - [v1.12](docker_remote_api/#v1-12)
         - [v1.11](docker_remote_api/#v1-11)
         - [v1.10](docker_remote_api/#v1-10)
         - [v1.9](docker_remote_api/#v1-9)
@@ -83,4 +84,4 @@ interfaces:
         - [1.3 List email addresses for a user](docker_io_accounts_api/#list-email-addresses-for-a-user)
         - [1.4 Add email address for a user](docker_io_accounts_api/#add-email-address-for-a-user)
         - [1.5 Update an email address for a user](docker_io_accounts_api/#update-an-email-address-for-a-user)
-        - [1.6 Delete email address for a user](docker_io_accounts_api/#delete-email-address-for-a-user)
+        - [1.6 Delete email address for a user](docker_io_accounts_api/#delete-email-address-for-a-user)

+ 14 - 16
docs/sources/reference/api/docker_remote_api.md

@@ -4,29 +4,27 @@ page_keywords: API, Docker, rcli, REST, documentation
 
 # Docker Remote API
 
- - The Remote API is replacing rcli
- - By default the Docker daemon listens on unix:///var/run/docker.sock
-   and the client must have root access to interact with the daemon
- - If a group named *docker* exists on your system, docker will apply
-   ownership of the socket to the group
+ - The Remote API is replacing `rcli`.
+ - By default the Docker daemon listens on `unix:///var/run/docker.sock`
+   and the client must have `root` access to interact with the daemon.
+ - If a group named `docker` exists on your system, docker will apply
+   ownership of the socket to the group.
  - The API tends to be REST, but for some complex commands, like attach
-   or pull, the HTTP connection is hijacked to transport stdout stdin
-   and stderr
+   or pull, the HTTP connection is hijacked to transport STDOUT, STDIN,
+   and STDERR.
  - Since API version 1.2, the auth configuration is now handled client
-   side, so the client has to send the authConfig as POST in /images/(name)/push
+   side, so the client has to send the `authConfig` as a `POST` in `/images/(name)/push`.
  - authConfig, set as the `X-Registry-Auth` header, is currently a Base64
-   encoded (json) string with credentials:
+   encoded (JSON) string with credentials:
    `{'username': string, 'password': string, 'email': string, 'serveraddress' : string}`
 
-
-
 The current version of the API is v1.12
 
-Calling /images/<name>/insert is the same as calling
-/v1.12/images/<name>/insert
+Calling `/images/<name>/insert` is the same as calling
+`/v1.12/images/<name>/insert`.
 
-You can still call an old version of the api using
-/v1.12/images/<name>/insert
+You can still call an old version of the API using
+`/v1.12/images/<name>/insert`.
 
 ## v1.12
 
@@ -51,7 +49,7 @@ All the JSON keys are now in CamelCase
 Trusted builds are now Automated Builds - `is_trusted` is now `is_automated`.
 
 **Removed Insert Endpoint**
-The insert endpoint has been removed.
+The `insert` endpoint has been removed.
 
 ## v1.11
 

+ 3 - 3
docs/sources/reference/api/docker_remote_api_v1.11.md

@@ -6,12 +6,12 @@ page_keywords: API, Docker, rcli, REST, documentation
 
 ## 1. Brief introduction
 
- - The Remote API has replaced rcli
+ - The Remote API has replaced `rcli`.
  - The daemon listens on `unix:///var/run/docker.sock` but you can bind
    Docker to another host/port or a Unix socket.
  - The API tends to be REST, but for some complex commands, like `attach`
-   or `pull`, the HTTP connection is hijacked to transport `stdout, stdin`
-   and `stderr`
+   or `pull`, the HTTP connection is hijacked to transport `STDOUT`, `STDIN`
+   and `STDERR`.
 
 # 2. Endpoints
 

+ 3 - 3
docs/sources/reference/api/docker_remote_api_v1.12.md

@@ -6,13 +6,13 @@ page_keywords: API, Docker, rcli, REST, documentation
 
 ## 1. Brief introduction
 
- - The Remote API has replaced rcli
+ - The Remote API has replaced `rcli`.
  - The daemon listens on `unix:///var/run/docker.sock` but you can
    [*Bind Docker to another host/port or a Unix socket*](
    /use/basics/#bind-docker).
  - The API tends to be REST, but for some complex commands, like `attach`
-   or `pull`, the HTTP connection is hijacked to transport `stdout, stdin`
-   and `stderr`
+   or `pull`, the HTTP connection is hijacked to transport `STDOUT`,
+   `STDIN` and `STDERR`.
 
 # 2. Endpoints