chore(api): update API docs

This commit is contained in:
peaklabs-dev
2025-05-27 15:10:20 +02:00
parent df8cfcccc9
commit 2934d4a259
3 changed files with 65 additions and 1 deletions

View File

@@ -1432,7 +1432,6 @@ class ServicesController extends Controller
name: 'latest',
in: 'query',
description: 'Pull latest images.',
required: false,
schema: new OA\Schema(
type: 'boolean',
default: false,

View File

@@ -353,6 +353,10 @@
"type": "string",
"nullable": true,
"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"
@@ -701,6 +705,10 @@
"type": "string",
"nullable": true,
"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"
@@ -1049,6 +1057,10 @@
"type": "string",
"nullable": true,
"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"
@@ -1326,6 +1338,10 @@
"type": "string",
"nullable": true,
"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"
@@ -1586,6 +1602,10 @@
"type": "string",
"nullable": true,
"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"
@@ -1685,6 +1705,10 @@
"type": "boolean",
"nullable": true,
"description": "Use build server."
},
"connect_to_docker_network": {
"type": "boolean",
"description": "The flag to connect the service to the predefined Docker network."
}
},
"type": "object"
@@ -2147,6 +2171,10 @@
"type": "boolean",
"nullable": true,
"description": "Use build server."
},
"connect_to_docker_network": {
"type": "boolean",
"description": "The flag to connect the service to the predefined Docker network."
}
},
"type": "object"
@@ -7017,6 +7045,15 @@
"type": "string",
"format": "uuid"
}
},
{
"name": "latest",
"in": "query",
"description": "Pull latest images.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {

View File

@@ -259,6 +259,9 @@ paths:
type: string
nullable: true
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
responses:
'201':
@@ -509,6 +512,9 @@ paths:
type: string
nullable: true
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
responses:
'201':
@@ -759,6 +765,9 @@ paths:
type: string
nullable: true
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
responses:
'201':
@@ -956,6 +965,9 @@ paths:
type: string
nullable: true
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
responses:
'201':
@@ -1144,6 +1156,9 @@ paths:
type: string
nullable: true
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
responses:
'201':
@@ -1212,6 +1227,9 @@ paths:
type: boolean
nullable: true
description: 'Use build server.'
connect_to_docker_network:
type: boolean
description: 'The flag to connect the service to the predefined Docker network.'
type: object
responses:
'201':
@@ -1539,6 +1557,9 @@ paths:
type: boolean
nullable: true
description: 'Use build server.'
connect_to_docker_network:
type: boolean
description: 'The flag to connect the service to the predefined Docker network.'
type: object
responses:
'200':
@@ -4660,6 +4681,13 @@ paths:
schema:
type: string
format: uuid
-
name: latest
in: query
description: 'Pull latest images.'
schema:
type: boolean
default: false
responses:
'200':
description: 'Restart service.'