From 2934d4a2590a01841f4f1577211603ab6c8ea3c1 Mon Sep 17 00:00:00 2001
From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com>
Date: Tue, 27 May 2025 15:10:20 +0200
Subject: [PATCH] chore(api): update API docs

---
 .../Controllers/Api/ServicesController.php    |  1 -
 openapi.json                                  | 37 +++++++++++++++++++
 openapi.yaml                                  | 28 ++++++++++++++
 3 files changed, 65 insertions(+), 1 deletion(-)

diff --git a/app/Http/Controllers/Api/ServicesController.php b/app/Http/Controllers/Api/ServicesController.php
index 4f2cb61d7..542be83de 100644
--- a/app/Http/Controllers/Api/ServicesController.php
+++ b/app/Http/Controllers/Api/ServicesController.php
@@ -1432,7 +1432,6 @@ public function action_stop(Request $request)
                 name: 'latest',
                 in: 'query',
                 description: 'Pull latest images.',
-                required: false,
                 schema: new OA\Schema(
                     type: 'boolean',
                     default: false,
diff --git a/openapi.json b/openapi.json
index 40f663e51..791828aed 100644
--- a/openapi.json
+++ b/openapi.json
@@ -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": {
diff --git a/openapi.yaml b/openapi.yaml
index c5113d9f7..3f2fa1c59 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -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.'