fix: openapi endpoint urls

2024-09-04 10:09:10 +02:00
parent eaabf94cd7
commit 25480fe624
13 changed files with 147 additions and 75 deletions
--- a/app/Http/Controllers/Api/ApplicationsController.php
+++ b/app/Http/Controllers/Api/ApplicationsController.php
@@ -53,6 +53,7 @@ class ApplicationsController extends Controller
        summary: 'List',
        description: 'List all applications.',
        path: '/applications',
+        operationId: 'list-applications',
        security: [
            ['bearerAuth' => []],
        ],
@@ -101,6 +102,7 @@ class ApplicationsController extends Controller
        summary: 'Create (Public)',
        description: 'Create new application based on a public git repository.',
        path: '/applications/public',
+        operationId: 'create-public-application',
        security: [
            ['bearerAuth' => []],
        ],
@@ -202,6 +204,7 @@ class ApplicationsController extends Controller
        summary: 'Create (Private - GH App)',
        description: 'Create new application based on a private repository through a Github App.',
        path: '/applications/private-github-app',
+        operationId: 'create-private-github-app-application',
        security: [
            ['bearerAuth' => []],
        ],
@@ -303,6 +306,7 @@ class ApplicationsController extends Controller
        summary: 'Create (Private - Deploy Key)',
        description: 'Create new application based on a private repository through a Deploy Key.',
        path: '/applications/private-deploy-key',
+        operationId: 'create-private-deploy-key-application',
        security: [
            ['bearerAuth' => []],
        ],
@@ -404,6 +408,7 @@ class ApplicationsController extends Controller
        summary: 'Create (Dockerfile)',
        description: 'Create new application based on a simple Dockerfile.',
        path: '/applications/dockerfile',
+        operationId: 'create-dockerfile-application',
        security: [
            ['bearerAuth' => []],
        ],
@@ -490,6 +495,7 @@ class ApplicationsController extends Controller
        summary: 'Create (Docker Image)',
        description: 'Create new application based on a prebuilt docker image',
        path: '/applications/dockerimage',
+        operationId: 'create-dockerimage-application',
        security: [
            ['bearerAuth' => []],
        ],
@@ -573,6 +579,7 @@ class ApplicationsController extends Controller
        summary: 'Create (Docker Compose)',
        description: 'Create new application based on a docker-compose file.',
        path: '/applications/dockercompose',
+        operationId: 'create-dockercompose-application',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1171,6 +1178,7 @@ class ApplicationsController extends Controller
        summary: 'Get',
        description: 'Get application by UUID.',
        path: '/applications/{uuid}',
+        operationId: 'get-application-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1235,6 +1243,7 @@ class ApplicationsController extends Controller
        summary: 'Delete',
        description: 'Delete application by UUID.',
        path: '/applications/{uuid}',
+        operationId: 'delete-application-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1321,6 +1330,7 @@ class ApplicationsController extends Controller
        summary: 'Update',
        description: 'Update application by UUID.',
        path: '/applications/{uuid}',
+        operationId: 'update-application-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1557,6 +1567,7 @@ class ApplicationsController extends Controller
        summary: 'List Envs',
        description: 'List all envs by application UUID.',
        path: '/applications/{uuid}/envs',
+        operationId: 'list-envs-by-application-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1639,6 +1650,7 @@ class ApplicationsController extends Controller
        summary: 'Update Env',
        description: 'Update env by application UUID.',
        path: '/applications/{uuid}/envs',
+        operationId: 'update-env-by-application-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1821,6 +1833,7 @@ class ApplicationsController extends Controller
        summary: 'Update Envs (Bulk)',
        description: 'Update multiple envs by application UUID.',
        path: '/applications/{uuid}/envs/bulk',
+        operationId: 'update-envs-by-application-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -2012,6 +2025,7 @@ class ApplicationsController extends Controller
        summary: 'Create Env',
        description: 'Create env by application UUID.',
        path: '/applications/{uuid}/envs',
+        operationId: 'create-env-by-application-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -2171,6 +2185,7 @@ class ApplicationsController extends Controller
        summary: 'Delete Env',
        description: 'Delete env by UUID.',
        path: '/applications/{uuid}/envs/{env_uuid}',
+        operationId: 'delete-env-by-application-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -2256,6 +2271,7 @@ class ApplicationsController extends Controller
        summary: 'Start',
        description: 'Start application. `Post` request is also accepted.',
        path: '/applications/{uuid}/start',
+        operationId: 'start-application-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -2359,6 +2375,7 @@ class ApplicationsController extends Controller
        summary: 'Stop',
        description: 'Stop application. `Post` request is also accepted.',
        path: '/applications/{uuid}/stop',
+        operationId: 'stop-application-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -2431,6 +2448,7 @@ class ApplicationsController extends Controller
        summary: 'Restart',
        description: 'Restart application. `Post` request is also accepted.',
        path: '/applications/{uuid}/restart',
+        operationId: 'restart-application-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/DatabasesController.php
+++ b/app/Http/Controllers/Api/DatabasesController.php
@@ -46,6 +46,7 @@ class DatabasesController extends Controller
        summary: 'List',
        description: 'List all databases.',
        path: '/databases',
+        operationId: 'list-databases',
        security: [
            ['bearerAuth' => []],
        ],
@@ -91,6 +92,7 @@ class DatabasesController extends Controller
        summary: 'Get',
        description: 'Get database by UUID.',
        path: '/databases/{uuid}',
+        operationId: 'get-database-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -151,6 +153,7 @@ class DatabasesController extends Controller
        summary: 'Update',
        description: 'Update database by UUID.',
        path: '/databases/{uuid}',
+        operationId: 'update-database-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -510,6 +513,7 @@ class DatabasesController extends Controller
        summary: 'Create (PostgreSQL)',
        description: 'Create a new PostgreSQL database.',
        path: '/databases/postgresql',
+        operationId: 'create-database-postgresql',
        security: [
            ['bearerAuth' => []],
        ],
@@ -575,6 +579,7 @@ class DatabasesController extends Controller
        summary: 'Create (Clickhouse)',
        description: 'Create a new Clickhouse database.',
        path: '/databases/clickhouse',
+        operationId: 'create-database-clickhouse',
        security: [
            ['bearerAuth' => []],
        ],
@@ -636,6 +641,7 @@ class DatabasesController extends Controller
        summary: 'Create (DragonFly)',
        description: 'Create a new DragonFly database.',
        path: '/databases/dragonfly',
+        operationId: 'create-database-dragonfly',
        security: [
            ['bearerAuth' => []],
        ],
@@ -696,6 +702,7 @@ class DatabasesController extends Controller
        summary: 'Create (Redis)',
        description: 'Create a new Redis database.',
        path: '/databases/redis',
+        operationId: 'create-database-redis',
        security: [
            ['bearerAuth' => []],
        ],
@@ -757,6 +764,7 @@ class DatabasesController extends Controller
        summary: 'Create (KeyDB)',
        description: 'Create a new KeyDB database.',
        path: '/databases/keydb',
+        operationId: 'create-database-keydb',
        security: [
            ['bearerAuth' => []],
        ],
@@ -818,6 +826,7 @@ class DatabasesController extends Controller
        summary: 'Create (MariaDB)',
        description: 'Create a new MariaDB database.',
        path: '/databases/mariadb',
+        operationId: 'create-database-mariadb',
        security: [
            ['bearerAuth' => []],
        ],
@@ -882,6 +891,7 @@ class DatabasesController extends Controller
        summary: 'Create (MySQL)',
        description: 'Create a new MySQL database.',
        path: '/databases/mysql',
+        operationId: 'create-database-mysql',
        security: [
            ['bearerAuth' => []],
        ],
@@ -945,6 +955,7 @@ class DatabasesController extends Controller
        summary: 'Create (MongoDB)',
        description: 'Create a new MongoDB database.',
        path: '/databases/mongodb',
+        operationId: 'create-database-mongodb',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1514,6 +1525,7 @@ class DatabasesController extends Controller
        summary: 'Delete',
        description: 'Delete database by UUID.',
        path: '/databases/{uuid}',
+        operationId: 'delete-database-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1597,6 +1609,7 @@ class DatabasesController extends Controller
        summary: 'Start',
        description: 'Start database. `Post` request is also accepted.',
        path: '/databases/{uuid}/start',
+        operationId: 'start-database-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1672,6 +1685,7 @@ class DatabasesController extends Controller
        summary: 'Stop',
        description: 'Stop database. `Post` request is also accepted.',
        path: '/databases/{uuid}/stop',
+        operationId: 'stop-database-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -1747,6 +1761,7 @@ class DatabasesController extends Controller
        summary: 'Restart',
        description: 'Restart database. `Post` request is also accepted.',
        path: '/databases/{uuid}/restart',
+        operationId: 'restart-database-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/DeployController.php
+++ b/app/Http/Controllers/Api/DeployController.php
@@ -32,6 +32,7 @@ class DeployController extends Controller
        summary: 'List',
        description: 'List currently running deployments',
        path: '/deployments',
+        operationId: 'list-deployments',
        security: [
            ['bearerAuth' => []],
        ],
@@ -79,6 +80,7 @@ class DeployController extends Controller
        summary: 'Get',
        description: 'Get deployment by UUID.',
        path: '/deployments/{uuid}',
+        operationId: 'get-deployment-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -134,6 +136,7 @@ class DeployController extends Controller
        summary: 'Deploy',
        description: 'Deploy by tag or uuid. `Post` request also accepted.',
        path: '/deploy',
+        operationId: 'deploy-by-tag-or-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/OtherController.php
+++ b/app/Http/Controllers/Api/OtherController.php
@@ -13,6 +13,7 @@ class OtherController extends Controller
        summary: 'Version',
        description: 'Get Coolify version.',
        path: '/version',
+        operationId: 'version',
        security: [
            ['bearerAuth' => []],
        ],
@@ -43,6 +44,7 @@ class OtherController extends Controller
        summary: 'Enable API',
        description: 'Enable API (only with root permissions).',
        path: '/enable',
+        operationId: 'enable-api',
        security: [
            ['bearerAuth' => []],
        ],
@@ -94,6 +96,7 @@ class OtherController extends Controller
        summary: 'Disable API',
        description: 'Disable API (only with root permissions).',
        path: '/disable',
+        operationId: 'disable-api',
        security: [
            ['bearerAuth' => []],
        ],
@@ -158,6 +161,7 @@ class OtherController extends Controller
        summary: 'Healthcheck',
        description: 'Healthcheck endpoint.',
        path: '/healthcheck',
+        operationId: 'healthcheck',
        responses: [
            new OA\Response(
                response: 200,
--- a/app/Http/Controllers/Api/ProjectController.php
+++ b/app/Http/Controllers/Api/ProjectController.php
@@ -13,6 +13,7 @@ class ProjectController extends Controller
        summary: 'List',
        description: 'list projects.',
        path: '/projects',
+        operationId: 'list-projects',
        security: [
            ['bearerAuth' => []],
        ],
@@ -56,6 +57,7 @@ class ProjectController extends Controller
        summary: 'Get',
        description: 'Get project by Uuid.',
        path: '/projects/{uuid}',
+        operationId: 'get-project-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -102,6 +104,7 @@ class ProjectController extends Controller
        summary: 'Environment',
        description: 'Get environment by name.',
        path: '/projects/{uuid}/{environment_name}',
+        operationId: 'get-environment-by-name',
        security: [
            ['bearerAuth' => []],
        ],
@@ -155,6 +158,7 @@ class ProjectController extends Controller
        summary: 'Create',
        description: 'Create Project.',
        path: '/projects',
+        operationId: 'create-project',
        security: [
            ['bearerAuth' => []],
        ],
@@ -250,6 +254,7 @@ class ProjectController extends Controller
        summary: 'Update',
        description: 'Update Project.',
        path: '/projects/{uuid}',
+        operationId: 'update-project-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -355,6 +360,7 @@ class ProjectController extends Controller
        summary: 'Delete',
        description: 'Delete project by UUID.',
        path: '/projects/{uuid}',
+        operationId: 'delete-project-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/ResourcesController.php
+++ b/app/Http/Controllers/Api/ResourcesController.php
@@ -13,6 +13,7 @@ class ResourcesController extends Controller
        summary: 'List',
        description: 'Get all resources.',
        path: '/resources',
+        operationId: 'list-resources',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/SecurityController.php
+++ b/app/Http/Controllers/Api/SecurityController.php
@@ -26,6 +26,7 @@ class SecurityController extends Controller
        summary: 'List',
        description: 'List all private keys.',
        path: '/security/keys',
+        operationId: 'list-private-keys',
        security: [
            ['bearerAuth' => []],
        ],
@@ -68,6 +69,7 @@ class SecurityController extends Controller
        summary: 'Get',
        description: 'Get key by UUID.',
        path: '/security/keys/{uuid}',
+        operationId: 'get-private-key-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -124,6 +126,7 @@ class SecurityController extends Controller
        summary: 'Create',
        description: 'Create a new private key.',
        path: '/security/keys',
+        operationId: 'create-private-key',
        security: [
            ['bearerAuth' => []],
        ],
@@ -217,6 +220,7 @@ class SecurityController extends Controller
        summary: 'Update',
        description: 'Update a private key.',
        path: '/security/keys',
+        operationId: 'update-private-key',
        security: [
            ['bearerAuth' => []],
        ],
@@ -313,6 +317,7 @@ class SecurityController extends Controller
        summary: 'Delete',
        description: 'Delete a private key.',
        path: '/security/keys/{uuid}',
+        operationId: 'delete-private-key-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/ServersController.php
+++ b/app/Http/Controllers/Api/ServersController.php
@@ -46,6 +46,7 @@ class ServersController extends Controller
        summary: 'List',
        description: 'List all servers.',
        path: '/servers',
+        operationId: 'list-servers',
        security: [
            ['bearerAuth' => []],
        ],
@@ -100,6 +101,7 @@ class ServersController extends Controller
        summary: 'Get',
        description: 'Get server by UUID.',
        path: '/servers/{uuid}',
+        operationId: 'get-server-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -177,6 +179,7 @@ class ServersController extends Controller
        summary: 'Resources',
        description: 'Get resources by server.',
        path: '/servers/{uuid}/resources',
+        operationId: 'get-resources-by-server-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -254,6 +257,7 @@ class ServersController extends Controller
        summary: 'Domains',
        description: 'Get domains by server.',
        path: '/servers/{uuid}/domains',
+        operationId: 'get-domains-by-server-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -401,6 +405,7 @@ class ServersController extends Controller
        summary: 'Create',
        description: 'Create Server.',
        path: '/servers',
+        operationId: 'create-server',
        security: [
            ['bearerAuth' => []],
        ],
@@ -545,6 +550,7 @@ class ServersController extends Controller
        summary: 'Update',
        description: 'Update Server.',
        path: '/servers/{uuid}',
+        operationId: 'update-server-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -655,6 +661,7 @@ class ServersController extends Controller
        summary: 'Delete',
        description: 'Delete server by UUID.',
        path: '/servers/{uuid}',
+        operationId: 'delete-server-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -727,6 +734,7 @@ class ServersController extends Controller
        summary: 'Validate',
        description: 'Validate server by UUID.',
        path: '/servers/{uuid}/validate',
+        operationId: 'validate-server-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/ServicesController.php
+++ b/app/Http/Controllers/Api/ServicesController.php
@@ -38,6 +38,7 @@ class ServicesController extends Controller
        summary: 'List',
        description: 'List all services.',
        path: '/services',
+        operationId: 'list-services',
        security: [
            ['bearerAuth' => []],
        ],
@@ -88,6 +89,7 @@ class ServicesController extends Controller
        summary: 'Create',
        description: 'Create a one-click service',
        path: '/services',
+        operationId: 'create-service',
        security: [
            ['bearerAuth' => []],
        ],
@@ -365,6 +367,7 @@ class ServicesController extends Controller
        summary: 'Get',
        description: 'Get service by UUID.',
        path: '/services/{uuid}',
+        operationId: 'get-service-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -422,6 +425,7 @@ class ServicesController extends Controller
        summary: 'Delete',
        description: 'Delete service by UUID.',
        path: '/services/{uuid}',
+        operationId: 'delete-service-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -483,6 +487,7 @@ class ServicesController extends Controller
        summary: 'Start',
        description: 'Start service. `Post` request is also accepted.',
        path: '/services/{uuid}/start',
+        operationId: 'start-service-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -558,6 +563,7 @@ class ServicesController extends Controller
        summary: 'Stop',
        description: 'Stop service. `Post` request is also accepted.',
        path: '/services/{uuid}/stop',
+        operationId: 'stop-service-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
@@ -633,6 +639,7 @@ class ServicesController extends Controller
        summary: 'Restart',
        description: 'Restart service. `Post` request is also accepted.',
        path: '/services/{uuid}/restart',
+        operationId: 'restart-service-by-uuid',
        security: [
            ['bearerAuth' => []],
        ],
--- a/app/Http/Controllers/Api/TeamController.php
+++ b/app/Http/Controllers/Api/TeamController.php
@@ -32,6 +32,7 @@ class TeamController extends Controller
        summary: 'List',
        description: 'Get all teams.',
        path: '/teams',
+        operationId: 'list-teams',
        security: [
            ['bearerAuth' => []],
        ],
@@ -79,6 +80,7 @@ class TeamController extends Controller
        summary: 'Get',
        description: 'Get team by TeamId.',
        path: '/teams/{id}',
+        operationId: 'get-team-by-id',
        security: [
            ['bearerAuth' => []],
        ],
@@ -129,6 +131,7 @@ class TeamController extends Controller
        summary: 'Members',
        description: 'Get members by TeamId.',
        path: '/teams/{id}/members',
+        operationId: 'get-members-by-team-id',
        security: [
            ['bearerAuth' => []],
        ],
@@ -189,6 +192,7 @@ class TeamController extends Controller
        summary: 'Authenticated Team',
        description: 'Get currently authenticated team.',
        path: '/teams/current',
+        operationId: 'get-current-team',
        security: [
            ['bearerAuth' => []],
        ],
@@ -225,6 +229,7 @@ class TeamController extends Controller
        summary: 'Authenticated Team Members',
        description: 'Get currently authenticated team members.',
        path: '/teams/current/members',
+        operationId: 'get-current-team-members',
        security: [
            ['bearerAuth' => []],
        ],