mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Merge pull request #43381 from thaJeztah/docs_swagger_multi_example_fixes
docs: cleanup swagger API with multiple examples (v1.25-v1.41)
This commit is contained in:
Sebastiaan van Stijn
GitHub
commit
86b6c9d640
17 changed files with 180 additions and 307 deletions
|
|
@ -2140,6 +2140,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4088,14 +4089,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4131,14 +4125,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4164,7 +4151,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "ContainerPutArchive"
|
||||
consumes:
|
||||
- "application/x-tar"
|
||||
|
|
@ -4176,6 +4166,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2145,6 +2145,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4093,14 +4094,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4136,14 +4130,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4169,7 +4156,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "ContainerPutArchive"
|
||||
consumes:
|
||||
- "application/x-tar"
|
||||
|
|
@ -4181,6 +4171,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2214,6 +2214,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4173,14 +4174,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4216,14 +4210,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4249,7 +4236,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "ContainerPutArchive"
|
||||
consumes:
|
||||
- "application/x-tar"
|
||||
|
|
@ -4261,6 +4251,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2268,6 +2268,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4265,14 +4266,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4307,14 +4301,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4340,7 +4327,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -4350,6 +4340,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2290,6 +2290,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4299,14 +4300,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4341,14 +4335,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4374,7 +4361,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -4384,6 +4374,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2464,6 +2464,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4533,14 +4534,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4575,14 +4569,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4608,7 +4595,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -4618,6 +4608,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2494,6 +2494,7 @@ definitions:
|
|||
- "10.255.0.10/16"
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4603,14 +4604,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4645,14 +4639,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -4678,7 +4665,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -4688,6 +4678,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2963,6 +2963,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4162,6 +4163,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5842,14 +5844,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5884,14 +5879,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5917,7 +5905,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -5927,6 +5918,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2968,6 +2968,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4167,6 +4168,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5847,14 +5849,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5889,14 +5884,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5922,7 +5910,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -5932,6 +5923,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2979,6 +2979,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4196,6 +4197,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5883,14 +5885,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5925,14 +5920,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5958,7 +5946,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -5968,6 +5959,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2961,6 +2961,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4178,6 +4179,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5870,14 +5872,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5912,14 +5907,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5945,7 +5933,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -5955,6 +5946,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2974,6 +2974,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4191,6 +4192,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5894,14 +5896,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5936,14 +5931,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5969,7 +5957,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -5979,6 +5970,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -2979,6 +2979,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4211,6 +4212,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5921,14 +5923,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5963,14 +5958,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -5996,7 +5984,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -6006,6 +5997,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -3033,6 +3033,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -4265,6 +4266,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -5982,14 +5984,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -6024,14 +6019,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: "The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file)."
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -6057,7 +6045,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -6067,6 +6058,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -3624,6 +3624,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -5073,6 +5074,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -6845,17 +6847,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: |
|
||||
The error message. Either "must specify path parameter"
|
||||
(path cannot be empty) or "not a directory" (path was
|
||||
asserted to be a directory but exists as a file).
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -6890,17 +6882,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: |
|
||||
The error message. Either "must specify path parameter"
|
||||
(path cannot be empty) or "not a directory" (path was
|
||||
asserted to be a directory but exists as a file).
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -6926,7 +6908,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -6936,6 +6921,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -3751,6 +3751,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -5210,6 +5211,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -7151,17 +7153,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: |
|
||||
The error message. Either "must specify path parameter"
|
||||
(path cannot be empty) or "not a directory" (path was
|
||||
asserted to be a directory but exists as a file).
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -7196,17 +7188,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: |
|
||||
The error message. Either "must specify path parameter"
|
||||
(path cannot be empty) or "not a directory" (path was
|
||||
asserted to be a directory but exists as a file).
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -7232,7 +7214,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -7242,6 +7227,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -3839,6 +3839,7 @@ definitions:
|
|||
|
||||
ServiceSpec:
|
||||
description: "User modifiable configuration for a service."
|
||||
type: object
|
||||
properties:
|
||||
Name:
|
||||
description: "Name of the service."
|
||||
|
|
@ -5381,6 +5382,7 @@ definitions:
|
|||
|
||||
PeerNode:
|
||||
description: "Represents a peer-node in the swarm"
|
||||
type: "object"
|
||||
properties:
|
||||
NodeID:
|
||||
description: "Unique identifier of for this node in the swarm."
|
||||
|
|
@ -7332,17 +7334,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: |
|
||||
The error message. Either "must specify path parameter"
|
||||
(path cannot be empty) or "not a directory" (path was
|
||||
asserted to be a directory but exists as a file).
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -7377,17 +7369,7 @@ paths:
|
|||
400:
|
||||
description: "Bad parameter"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/ErrorResponse"
|
||||
- type: "object"
|
||||
properties:
|
||||
message:
|
||||
description: |
|
||||
The error message. Either "must specify path parameter"
|
||||
(path cannot be empty) or "not a directory" (path was
|
||||
asserted to be a directory but exists as a file).
|
||||
type: "string"
|
||||
x-nullable: false
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
404:
|
||||
description: "Container or path does not exist"
|
||||
schema:
|
||||
|
|
@ -7413,7 +7395,10 @@ paths:
|
|||
tags: ["Container"]
|
||||
put:
|
||||
summary: "Extract an archive of files or folders to a directory in a container"
|
||||
description: "Upload a tar archive to be extracted to a path in the filesystem of container id."
|
||||
description: |
|
||||
Upload a tar archive to be extracted to a path in the filesystem of container id.
|
||||
`path` parameter is asserted to be a directory. If it exists as a file, 400 error
|
||||
will be returned with message "not a directory".
|
||||
operationId: "PutContainerArchive"
|
||||
consumes: ["application/x-tar", "application/octet-stream"]
|
||||
responses:
|
||||
|
|
@ -7423,6 +7408,9 @@ paths:
|
|||
description: "Bad parameter"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "not a directory"
|
||||
403:
|
||||
description: "Permission denied, the volume or container rootfs is marked as read-only."
|
||||
schema:
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue