fix: documentation

Signed-off-by: Vitor Mattos <[email protected]>
LibreSign · May 28, 2024 · 879ebd7 · 879ebd7
1 parent d240ff8
commit 879ebd7
Show file tree

Hide file tree

Showing 5 changed files with 124 additions and 1 deletion.
diff --git a/lib/Controller/RequestSignatureController.php b/lib/Controller/RequestSignatureController.php
@@ -205,10 +205,11 @@ public function deleteOneRequestSignatureUsingFileId(int $fileId, int $signReque
 	 * You can only request exclusion as any sign
 	 *
 	 * @param integer $fileId Node id of a Nextcloud file
-	 * @return DataResponse<Http::STATUS_OK, array{message: string}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, array{message: string}, array{}>
+	 * @return DataResponse<Http::STATUS_OK, array{message: string}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, array{message: string}, array{}>|DataResponse<Http::STATUS_UNPROCESSABLE_ENTITY, array{action: integer, errors: string[]}, array{}>
 	 *
 	 * 200: OK
 	 * 401: Failed
+	 * 422: Failed
 	 */
 	#[NoAdminRequired]
 	#[NoCSRFRequired]

diff --git a/openapi-full.json b/openapi-full.json
@@ -5589,6 +5589,52 @@
                                 }
                             }
                         }
+                    },
+                    "422": {
+                        "description": "Failed",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {
+                                                    "type": "object",
+                                                    "required": [
+                                                        "action",
+                                                        "errors"
+                                                    ],
+                                                    "properties": {
+                                                        "action": {
+                                                            "type": "integer",
+                                                            "format": "int64"
+                                                        },
+                                                        "errors": {
+                                                            "type": "array",
+                                                            "items": {
+                                                                "type": "string"
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
                     }
                 }
             },

diff --git a/openapi.json b/openapi.json
@@ -5474,6 +5474,52 @@
                                 }
                             }
                         }
+                    },
+                    "422": {
+                        "description": "Failed",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {
+                                                    "type": "object",
+                                                    "required": [
+                                                        "action",
+                                                        "errors"
+                                                    ],
+                                                    "properties": {
+                                                        "action": {
+                                                            "type": "integer",
+                                                            "format": "int64"
+                                                        },
+                                                        "errors": {
+                                                            "type": "array",
+                                                            "items": {
+                                                                "type": "string"
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
                     }
                 }
             },

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -2371,6 +2371,21 @@ export type operations = {
           };
         };
       };
+      /** @description Failed */
+      422: {
+        content: {
+          "application/json": {
+            ocs: {
+              meta: components["schemas"]["OCSMeta"];
+              data: {
+                /** Format: int64 */
+                action: number;
+                errors: string[];
+              };
+            };
+          };
+        };
+      };
     };
   };
   /**

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -2306,6 +2306,21 @@ export type operations = {
           };
         };
       };
+      /** @description Failed */
+      422: {
+        content: {
+          "application/json": {
+            ocs: {
+              meta: components["schemas"]["OCSMeta"];
+              data: {
+                /** Format: int64 */
+                action: number;
+                errors: string[];
+              };
+            };
+          };
+        };
+      };
     };
   };
   /**