feat(api): enhance OpenAPI specifications with token variable and additional key attributes
This commit is contained in:
@@ -5,7 +5,9 @@ namespace App\Http\Controllers\Api;
|
|||||||
use OpenApi\Attributes as OA;
|
use OpenApi\Attributes as OA;
|
||||||
|
|
||||||
#[OA\Info(title: 'Coolify', version: '0.1')]
|
#[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(
|
#[OA\SecurityScheme(
|
||||||
type: 'http',
|
type: 'http',
|
||||||
scheme: 'bearer',
|
scheme: 'bearer',
|
||||||
|
|||||||
14
openapi.json
14
openapi.json
@@ -7,7 +7,13 @@
|
|||||||
"servers": [
|
"servers": [
|
||||||
{
|
{
|
||||||
"url": "https:\/\/app.coolify.io\/api\/v1",
|
"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": {
|
"paths": {
|
||||||
@@ -7729,6 +7735,12 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"format": "private-key"
|
"format": "private-key"
|
||||||
},
|
},
|
||||||
|
"public_key": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"fingerprint": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
"is_git_related": {
|
"is_git_related": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -6,6 +6,10 @@ servers:
|
|||||||
-
|
-
|
||||||
url: 'https://app.coolify.io/api/v1'
|
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:
|
paths:
|
||||||
/applications:
|
/applications:
|
||||||
get:
|
get:
|
||||||
@@ -5159,6 +5163,10 @@ components:
|
|||||||
private_key:
|
private_key:
|
||||||
type: string
|
type: string
|
||||||
format: private-key
|
format: private-key
|
||||||
|
public_key:
|
||||||
|
type: string
|
||||||
|
fingerprint:
|
||||||
|
type: string
|
||||||
is_git_related:
|
is_git_related:
|
||||||
type: boolean
|
type: boolean
|
||||||
team_id:
|
team_id:
|
||||||
|
|||||||
Reference in New Issue
Block a user