feat(api): enhance OpenAPI specifications with token variable and additional key attributes

This commit is contained in:
Andras Bacsai
2025-04-22 10:44:37 +02:00
parent 4ea00cff31
commit 3160b8a5a5
3 changed files with 24 additions and 2 deletions

View File

@@ -5,7 +5,9 @@ namespace App\Http\Controllers\Api;
use OpenApi\Attributes as OA;
#[OA\Info(title: 'Coolify', version: '0.1')]
#[OA\Server(url: 'https://app.coolify.io/api/v1', description: 'Coolify Cloud API. Change the host to your own instance if you are self-hosting.')]
#[OA\Server(url: 'https://app.coolify.io/api/v1', description: 'Coolify Cloud API. Change the host to your own instance if you are self-hosting.', variables: [
new OA\ServerVariable('token', 'your-coolify-token-here', 'Coolify token for authentication'),
])]
#[OA\SecurityScheme(
type: 'http',
scheme: 'bearer',

View File

@@ -7,7 +7,13 @@
"servers": [
{
"url": "https:\/\/app.coolify.io\/api\/v1",
"description": "Coolify Cloud API. Change the host to your own instance if you are self-hosting."
"description": "Coolify Cloud API. Change the host to your own instance if you are self-hosting.",
"variables": {
"token": {
"default": "Coolify token for authentication",
"description": "your-coolify-token-here"
}
}
}
],
"paths": {
@@ -7729,6 +7735,12 @@
"type": "string",
"format": "private-key"
},
"public_key": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"is_git_related": {
"type": "boolean"
},

View File

@@ -6,6 +6,10 @@ servers:
-
url: 'https://app.coolify.io/api/v1'
description: 'Coolify Cloud API. Change the host to your own instance if you are self-hosting.'
variables:
token:
default: 'Coolify token for authentication'
description: your-coolify-token-here
paths:
/applications:
get:
@@ -5159,6 +5163,10 @@ components:
private_key:
type: string
format: private-key
public_key:
type: string
fingerprint:
type: string
is_git_related:
type: boolean
team_id: