chore: update documentation

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
This commit is contained in:
Vitor Mattos 2025-11-06 01:03:37 -03:00
parent 2c7e5e7d6b
commit 993b86db8b
No known key found for this signature in database
GPG key ID: 6FECE2AD4809003A
5 changed files with 81 additions and 6 deletions

View file

@ -36,6 +36,7 @@ class CrlController extends Controller {
*
* @param string $instanceId Instance identifier
* @param int $generation Generation identifier
* @param string $engineType Engine type identifier
* @return DataDownloadResponse<Http::STATUS_OK, string, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{error: string, message: string}, array{}>
*
* 200: CRL retrieved successfully in DER format

View file

@ -1168,7 +1168,7 @@
}
}
},
"/index.php/apps/libresign/crl": {
"/index.php/apps/libresign/crl/{instanceId}/{generation}/{engineType}/crl.der": {
"get": {
"operationId": "crl-get-revocation-list",
"summary": "Get Certificate Revocation List in DER format (RFC 5280 compliant)",
@ -1184,6 +1184,36 @@
"basic_auth": []
}
],
"parameters": [
{
"name": "instanceId",
"in": "path",
"description": "Instance identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "generation",
"in": "path",
"description": "Generation identifier",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "engineType",
"in": "path",
"description": "Engine type identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "CRL retrieved successfully in DER format",

View file

@ -1018,7 +1018,7 @@
}
}
},
"/index.php/apps/libresign/crl": {
"/index.php/apps/libresign/crl/{instanceId}/{generation}/{engineType}/crl.der": {
"get": {
"operationId": "crl-get-revocation-list",
"summary": "Get Certificate Revocation List in DER format (RFC 5280 compliant)",
@ -1034,6 +1034,36 @@
"basic_auth": []
}
],
"parameters": [
{
"name": "instanceId",
"in": "path",
"description": "Instance identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "generation",
"in": "path",
"description": "Generation identifier",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "engineType",
"in": "path",
"description": "Engine type identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "CRL retrieved successfully in DER format",

View file

@ -21,7 +21,7 @@ export type paths = {
patch?: never;
trace?: never;
};
"/index.php/apps/libresign/crl": {
"/index.php/apps/libresign/crl/{instanceId}/{generation}/{engineType}/crl.der": {
parameters: {
query?: never;
header?: never;
@ -1655,7 +1655,14 @@ export interface operations {
parameters: {
query?: never;
header?: never;
path?: never;
path: {
/** @description Instance identifier */
instanceId: string;
/** @description Generation identifier */
generation: number;
/** @description Engine type identifier */
engineType: string;
};
cookie?: never;
};
requestBody?: never;

View file

@ -21,7 +21,7 @@ export type paths = {
patch?: never;
trace?: never;
};
"/index.php/apps/libresign/crl": {
"/index.php/apps/libresign/crl/{instanceId}/{generation}/{engineType}/crl.der": {
parameters: {
query?: never;
header?: never;
@ -1304,7 +1304,14 @@ export interface operations {
parameters: {
query?: never;
header?: never;
path?: never;
path: {
/** @description Instance identifier */
instanceId: string;
/** @description Generation identifier */
generation: number;
/** @description Engine type identifier */
engineType: string;
};
cookie?: never;
};
requestBody?: never;