mirror of
https://github.com/LibreSign/libresign.git
synced 2025-12-18 05:20:45 +01:00
chore: update documentation
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
This commit is contained in:
parent
2c7e5e7d6b
commit
993b86db8b
5 changed files with 81 additions and 6 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
32
openapi.json
32
openapi.json
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue