chore(api): update API docs
This commit is contained in:
@@ -1432,7 +1432,6 @@ class ServicesController extends Controller
|
|||||||
name: 'latest',
|
name: 'latest',
|
||||||
in: 'query',
|
in: 'query',
|
||||||
description: 'Pull latest images.',
|
description: 'Pull latest images.',
|
||||||
required: false,
|
|
||||||
schema: new OA\Schema(
|
schema: new OA\Schema(
|
||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
default: false,
|
default: false,
|
||||||
|
37
openapi.json
37
openapi.json
@@ -353,6 +353,10 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Password for HTTP Basic Authentication"
|
"description": "Password for HTTP Basic Authentication"
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -701,6 +705,10 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Password for HTTP Basic Authentication"
|
"description": "Password for HTTP Basic Authentication"
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -1049,6 +1057,10 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Password for HTTP Basic Authentication"
|
"description": "Password for HTTP Basic Authentication"
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -1326,6 +1338,10 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Password for HTTP Basic Authentication"
|
"description": "Password for HTTP Basic Authentication"
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -1586,6 +1602,10 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Password for HTTP Basic Authentication"
|
"description": "Password for HTTP Basic Authentication"
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -1685,6 +1705,10 @@
|
|||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Use build server."
|
"description": "Use build server."
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -2147,6 +2171,10 @@
|
|||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"nullable": true,
|
"nullable": true,
|
||||||
"description": "Use build server."
|
"description": "Use build server."
|
||||||
|
},
|
||||||
|
"connect_to_docker_network": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "The flag to connect the service to the predefined Docker network."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"type": "object"
|
"type": "object"
|
||||||
@@ -7017,6 +7045,15 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"format": "uuid"
|
"format": "uuid"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "latest",
|
||||||
|
"in": "query",
|
||||||
|
"description": "Pull latest images.",
|
||||||
|
"schema": {
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
|
28
openapi.yaml
28
openapi.yaml
@@ -259,6 +259,9 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Password for HTTP Basic Authentication'
|
description: 'Password for HTTP Basic Authentication'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
@@ -509,6 +512,9 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Password for HTTP Basic Authentication'
|
description: 'Password for HTTP Basic Authentication'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
@@ -759,6 +765,9 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Password for HTTP Basic Authentication'
|
description: 'Password for HTTP Basic Authentication'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
@@ -956,6 +965,9 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Password for HTTP Basic Authentication'
|
description: 'Password for HTTP Basic Authentication'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
@@ -1144,6 +1156,9 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Password for HTTP Basic Authentication'
|
description: 'Password for HTTP Basic Authentication'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
@@ -1212,6 +1227,9 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Use build server.'
|
description: 'Use build server.'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'201':
|
||||||
@@ -1539,6 +1557,9 @@ paths:
|
|||||||
type: boolean
|
type: boolean
|
||||||
nullable: true
|
nullable: true
|
||||||
description: 'Use build server.'
|
description: 'Use build server.'
|
||||||
|
connect_to_docker_network:
|
||||||
|
type: boolean
|
||||||
|
description: 'The flag to connect the service to the predefined Docker network.'
|
||||||
type: object
|
type: object
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
@@ -4660,6 +4681,13 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
format: uuid
|
format: uuid
|
||||||
|
-
|
||||||
|
name: latest
|
||||||
|
in: query
|
||||||
|
description: 'Pull latest images.'
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: 'Restart service.'
|
description: 'Restart service.'
|
||||||
|
Reference in New Issue
Block a user