Skip to content

Commit 2a1c7c1

Browse files
committed
docs: fix OpenAPI documentation for setDocMdpConfig endpoint
Add proper PHPDoc annotations: - Detailed parameter descriptions for enabled and defaultLevel - Complete DataResponse return type with status codes and schemas - HTTP status code documentation (200, 400, 500) Fixes OpenAPI generation errors. Signed-off-by: Vitor Mattos <[email protected]>
1 parent 73a0391 commit 2a1c7c1

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

lib/Controller/AdminController.php

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -864,9 +864,13 @@ public function footerTemplatePreviewPdf(string $template = '', int $width = 595
864864
/**
865865
* Set DocMDP configuration
866866
*
867-
* @param bool $enabled
868-
* @param int $defaultLevel
869-
* @return DataResponse
867+
* @param bool $enabled Enable or disable DocMDP certification
868+
* @param int $defaultLevel Default DocMDP level (0-3): 0=none, 1=no changes, 2=form fill, 3=form fill + annotations
869+
* @return DataResponse<Http::STATUS_OK, array{message: string}, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: string}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{error: string}, array{}>
870+
*
871+
* 200: Configuration saved successfully
872+
* 400: Invalid DocMDP level provided
873+
* 500: Internal server error
870874
*/
871875
#[ApiRoute(verb: 'POST', url: '/api/{apiVersion}/admin/docmdp/config', requirements: ['apiVersion' => '(v1)'])]
872876
public function setDocMdpConfig(bool $enabled, int $defaultLevel): DataResponse {

0 commit comments

Comments
 (0)