docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2106 from mastahyeti/api_1.5_docs_whitespace 

Cleanup whitespace in API 1.5 docs
This commit is contained in:
Andy Rothfusz 2013-10-07 13:23:55 -07:00
parent 194c1dbbd8 7c28683f08
commit ed19693f50
1 changed files with 673 additions and 710 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/sources/api/docker_remote_api_v1.5.rst
View File

@ -95,7 +95,6 @@ List containers
:statuscode 400: bad parameter :statuscode 400: bad parameter
:statuscode 500: server error :statuscode 500: server error
Create a container Create a container
****************** ******************
@ -132,7 +131,6 @@ Create a container
"Volumes":{}, "Volumes":{},
"VolumesFrom":"", "VolumesFrom":"",
"WorkingDir":"" "WorkingDir":""
} }
**Example response**: **Example response**:
@ -153,7 +151,6 @@ Create a container
:statuscode 406: impossible to attach (container not running) :statuscode 406: impossible to attach (container not running)
:statuscode 500: server error :statuscode 500: server error
Inspect a container Inspect a container
******************* *******************
@ -200,7 +197,6 @@ Inspect a container
"Volumes": {}, "Volumes": {},
"VolumesFrom": "", "VolumesFrom": "",
"WorkingDir":"" "WorkingDir":""
}, },
"State": { "State": {
"Running": false, "Running": false,
@ -226,7 +222,6 @@ Inspect a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
List processes running inside a container List processes running inside a container
***************************************** *****************************************
@ -272,7 +267,6 @@ List processes running inside a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Inspect changes on a container's filesystem Inspect changes on a container's filesystem
******************************************* *******************************************
@ -286,7 +280,6 @@ Inspect changes on a container's filesystem
GET /containers/4fa6e0f0c678/changes HTTP/1.1 GET /containers/4fa6e0f0c678/changes HTTP/1.1
**Example response**: **Example response**:
.. sourcecode:: http .. sourcecode:: http
@ -313,7 +306,6 @@ Inspect changes on a container's filesystem
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Export a container Export a container
****************** ******************
@ -327,7 +319,6 @@ Export a container
GET /containers/4fa6e0f0c678/export HTTP/1.1 GET /containers/4fa6e0f0c678/export HTTP/1.1
**Example response**: **Example response**:
.. sourcecode:: http .. sourcecode:: http
@ -341,7 +332,6 @@ Export a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Start a container Start a container
***************** *****************
@ -373,7 +363,6 @@ Start a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Stop a container Stop a container
**************** ****************
@ -398,7 +387,6 @@ Stop a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Restart a container Restart a container
******************* *******************
@ -423,7 +411,6 @@ Restart a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Kill a container Kill a container
**************** ****************
@ -447,7 +434,6 @@ Kill a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Attach to a container Attach to a container
********************* *********************
@ -480,7 +466,6 @@ Attach to a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Wait a container Wait a container
**************** ****************
@ -507,7 +492,6 @@ Wait a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Remove a container Remove a container
******************* *******************
@ -533,7 +517,6 @@ Remove a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Copy files or folders from a container Copy files or folders from a container
************************************** **************************************
@ -565,7 +548,6 @@ Copy files or folders from a container
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
2.2 Images 2.2 Images
---------- ----------
@ -608,7 +590,6 @@ List Images
} }
] ]
**Example request**: **Example request**:
.. sourcecode:: http .. sourcecode:: http
@ -645,7 +626,6 @@ List Images
:statuscode 400: bad parameter :statuscode 400: bad parameter
:statuscode 500: server error :statuscode 500: server error
Create an image Create an image
*************** ***************
@ -683,7 +663,6 @@ Create an image
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
Insert a file in an image Insert a file in an image
************************* *************************
@ -712,7 +691,6 @@ Insert a file in an image
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
Inspect an image Inspect an image
**************** ****************
@ -766,7 +744,6 @@ Inspect an image
:statuscode 404: no such image :statuscode 404: no such image
:statuscode 500: server error :statuscode 500: server error
Get the history of an image Get the history of an image
*************************** ***************************
@ -804,7 +781,6 @@ Get the history of an image
:statuscode 404: no such image :statuscode 404: no such image
:statuscode 500: server error :statuscode 500: server error
Push an image on the registry Push an image on the registry
***************************** *****************************
@ -838,7 +814,6 @@ Push an image on the registry
:statuscode 404: no such image :statuscode 404: no such image
:statuscode 500: server error :statuscode 500: server error
Tag an image into a repository Tag an image into a repository
****************************** ******************************
@ -866,7 +841,6 @@ Tag an image into a repository
:statuscode 409: conflict :statuscode 409: conflict
:statuscode 500: server error :statuscode 500: server error
Remove an image Remove an image
*************** ***************
@ -898,7 +872,6 @@ Remove an image
:statuscode 409: conflict :statuscode 409: conflict
:statuscode 500: server error :statuscode 500: server error
Search images Search images
************* *************
@ -938,7 +911,6 @@ Search images
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
2.3 Misc 2.3 Misc
-------- --------
@ -965,7 +937,6 @@ Build an image from Dockerfile via stdin
{{ STREAM }} {{ STREAM }}
The stream must be a tar archive compressed with one of the following algorithms: The stream must be a tar archive compressed with one of the following algorithms:
identity (no compression), gzip, bzip2, xz. The archive must include a file called identity (no compression), gzip, bzip2, xz. The archive must include a file called
`Dockerfile` at its root. It may include any number of other files, which will be `Dockerfile` at its root. It may include any number of other files, which will be
@ -980,7 +951,6 @@ Build an image from Dockerfile via stdin
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
Check auth configuration Check auth configuration
************************ ************************
@ -1012,7 +982,6 @@ Check auth configuration
:statuscode 204: no error :statuscode 204: no error
:statuscode 500: server error :statuscode 500: server error
Display system-wide information Display system-wide information
******************************* *******************************
@ -1047,7 +1016,6 @@ Display system-wide information
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
Show the docker version information Show the docker version information
*********************************** ***********************************
@ -1077,7 +1045,6 @@ Show the docker version information
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
Create a new image from a container's changes Create a new image from a container's changes
********************************************* *********************************************
@ -1110,7 +1077,6 @@ Create a new image from a container's changes
:statuscode 404: no such container :statuscode 404: no such container
:statuscode 500: server error :statuscode 500: server error
Monitor Docker's events Monitor Docker's events
*********************** ***********************
@ -1140,7 +1106,6 @@ Monitor Docker's events
:statuscode 200: no error :statuscode 200: no error
:statuscode 500: server error :statuscode 500: server error
3. Going further 3. Going further
================ ================
@ -1159,7 +1124,6 @@ Here are the steps of 'docker run' :
* If in detached mode or only stdin is attached: * If in detached mode or only stdin is attached:
* Display the container's id * Display the container's id
3.2 Hijacking 3.2 Hijacking
------------- -------------
@ -1173,4 +1137,3 @@ To enable cross origin requests to the remote api add the flag "-api-enable-cors
.. code-block:: bash .. code-block:: bash
docker -d -H="192.168.1.9:4243" -api-enable-cors docker -d -H="192.168.1.9:4243" -api-enable-cors