rosslh
febe730771
- Replace logos, colors (red/stone palette), and fonts (Overlock/Inter) - Replace text logos with PNG from marketing API - Update AGPL source links to match repo owner - Update PostgreSQL to 17 for Alpine 3.23 - Add Forgejo Actions CI workflow - Remove upstream GitHub Actions workflows - Remove Coolify Cloud upsells, Hetzner provider, and telemetry - Update auto-update to point to Forgejo registry
89 lines
3.3 KiB
PHP
89 lines
3.3 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Api;
|
|
|
|
use OpenApi\Attributes as OA;
|
|
|
|
// MapleDeploy branding: API documentation
|
|
#[OA\Info(title: 'MapleDeploy', version: '0.1')]
|
|
#[OA\Server(url: '/api/v1', description: 'MapleDeploy API. Powered by Coolify.')]
|
|
#[OA\SecurityScheme(
|
|
type: 'http',
|
|
scheme: 'bearer',
|
|
securityScheme: 'bearerAuth',
|
|
description: 'Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.')]
|
|
#[OA\Components(
|
|
responses: [
|
|
new OA\Response(
|
|
response: 400,
|
|
description: 'Invalid token.',
|
|
content: new OA\JsonContent(
|
|
type: 'object',
|
|
properties: [
|
|
new OA\Property(property: 'message', type: 'string', example: 'Invalid token.'),
|
|
]
|
|
)),
|
|
new OA\Response(
|
|
response: 401,
|
|
description: 'Unauthenticated.',
|
|
content: new OA\JsonContent(
|
|
type: 'object',
|
|
properties: [
|
|
new OA\Property(property: 'message', type: 'string', example: 'Unauthenticated.'),
|
|
]
|
|
)),
|
|
new OA\Response(
|
|
response: 404,
|
|
description: 'Resource not found.',
|
|
content: new OA\JsonContent(
|
|
type: 'object',
|
|
properties: [
|
|
new OA\Property(property: 'message', type: 'string', example: 'Resource not found.'),
|
|
]
|
|
)),
|
|
new OA\Response(
|
|
response: 422,
|
|
description: 'Validation error.',
|
|
content: new OA\JsonContent(
|
|
type: 'object',
|
|
properties: [
|
|
new OA\Property(property: 'message', type: 'string', example: 'Validation error.'),
|
|
new OA\Property(
|
|
property: 'errors',
|
|
type: 'object',
|
|
additionalProperties: new OA\AdditionalProperties(
|
|
type: 'array',
|
|
items: new OA\Items(type: 'string')
|
|
),
|
|
example: [
|
|
'name' => ['The name field is required.'],
|
|
'api_url' => ['The api url field is required.', 'The api url format is invalid.'],
|
|
]
|
|
),
|
|
]
|
|
)),
|
|
new OA\Response(
|
|
response: 429,
|
|
description: 'Rate limit exceeded.',
|
|
headers: [
|
|
new OA\Header(
|
|
header: 'Retry-After',
|
|
description: 'Number of seconds to wait before retrying.',
|
|
schema: new OA\Schema(type: 'integer', example: 60)
|
|
),
|
|
],
|
|
content: new OA\JsonContent(
|
|
type: 'object',
|
|
properties: [
|
|
new OA\Property(property: 'message', type: 'string', example: 'Rate limit exceeded. Please try again later.'),
|
|
]
|
|
)),
|
|
],
|
|
)]
|
|
class OpenApi
|
|
{
|
|
// This class is used to generate OpenAPI documentation
|
|
// for the Coolify API. It is not a controller and does
|
|
// not contain any routes. It is used to define the
|
|
// OpenAPI metadata and security scheme for the API.
|
|
}
|