1. docker
  2. Commit f6140060e3b7fc8e6f577ca95be0eb5bf8cd1fd4
Browse code

Fix commit api document

The commit message field should be `comment`, not `m`
https://github.com/docker/docker/blob/master/api/server/server.go#L478

Signed-off-by: Huayi Zhang <irachex@gmail.com>

Huayi Zhang authored on 2014/10/16 19:08:15
Showing 4 changed files
docs/sources/reference/api/docker_remote_api_v1.12.md
History View file @ f614006
... ... 
@@ -1208,7 +1208,7 @@ Create a new image from a container's changes
1208 1208
1209 1209 
 **Example request**:
1210 1210
1211 
-        POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
1211 
+        POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
1212 1212 
         Content-Type: application/json
1213 1213
1214 1214 
         {
... ... 
@@ -1256,7 +1256,7 @@ Query Parameters:
1256 1256 
 -   **container** – source container
1257 1257 
 -   **repo** – repository
1258 1258 
 -   **tag** – tag
1259 
--   **m** – commit message
1259 
+-   **comment** – commit message
1260 1260 
 -   **author** – author (e.g., "John Hannibal Smith
1261 1261 
     <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1262 1262
docs/sources/reference/api/docker_remote_api_v1.13.md
History View file @ f614006
... ... 
@@ -1197,7 +1197,7 @@ Create a new image from a container's changes
1197 1197
1198 1198 
 **Example request**:
1199 1199
1200 
-        POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
1200 
+        POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
1201 1201 
         Content-Type: application/json
1202 1202
1203 1203 
         {
... ... 
@@ -1245,7 +1245,7 @@ Query Parameters:
1245 1245 
 -   **container** – source container
1246 1246 
 -   **repo** – repository
1247 1247 
 -   **tag** – tag
1248 
--   **m** – commit message
1248 
+-   **comment** – commit message
1249 1249 
 -   **author** – author (e.g., "John Hannibal Smith
1250 1250 
     <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1251 1251
docs/sources/reference/api/docker_remote_api_v1.14.md
History View file @ f614006
... ... 
@@ -1202,7 +1202,7 @@ Create a new image from a container's changes
1202 1202
1203 1203 
 **Example request**:
1204 1204
1205 
-        POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
1205 
+        POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
1206 1206 
         Content-Type: application/json
1207 1207
1208 1208 
         {
... ... 
@@ -1250,7 +1250,7 @@ Query Parameters:
1250 1250 
 -   **container** – source container
1251 1251 
 -   **repo** – repository
1252 1252 
 -   **tag** – tag
1253 
--   **m** – commit message
1253 
+-   **comment** – commit message
1254 1254 
 -   **author** – author (e.g., "John Hannibal Smith
1255 1255 
     <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1256 1256
docs/sources/reference/api/docker_remote_api_v1.15.md
History View file @ f614006
... ... 
@@ -399,7 +399,7 @@ Status Codes:
399 399
400 400 
 `GET /containers/(id)/resize?h=<height>&w=<width>`
401 401
402 
-Resize the TTY of container `id`
402 
+Resize the TTY of container `id`
403 403
404 404 
 **Example request**:
405 405
... ... 
@@ -1237,7 +1237,7 @@ Create a new image from a container's changes
1237 1237
1238 1238 
 **Example request**:
1239 1239
1240 
-        POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
1240 
+        POST /commit?container=44c004db4b17&comment=message&repo=myrepo HTTP/1.1
1241 1241 
         Content-Type: application/json
1242 1242
1243 1243 
         {
... ... 
@@ -1285,7 +1285,7 @@ Query Parameters:
1285 1285 
 -   **container** – source container
1286 1286 
 -   **repo** – repository
1287 1287 
 -   **tag** – tag
1288 
--   **m** – commit message
1288 
+-   **comment** – commit message
1289 1289 
 -   **author** – author (e.g., "John Hannibal Smith
1290 1290 
     <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1291 1291