mirror of
https://github.com/LibreSign/libresign.git
synced 2025-12-18 05:20:45 +01:00
chore: update OpenAPI specs and TypeScript types
- Update openapi.json with new signature-flow endpoint - Regenerate TypeScript types from OpenAPI specs - Auto-generated by openapi-extractor Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
This commit is contained in:
Vitor Mattos
parent
8d83fa7382
commit
7adb0f2342
6 changed files with 436 additions and 8 deletions
|
|
@ -998,6 +998,145 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
|
||||
"post": {
|
||||
"operationId": "admin-set-signature-flow",
|
||||
"summary": "Set signature flow configuration",
|
||||
"description": "This endpoint requires admin access",
|
||||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"security": [
|
||||
{
|
||||
"bearer_auth": []
|
||||
},
|
||||
{
|
||||
"basic_auth": []
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"flow"
|
||||
],
|
||||
"properties": {
|
||||
"flow": {
|
||||
"type": "string",
|
||||
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "apiVersion",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"v1"
|
||||
],
|
||||
"default": "v1"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "OCS-APIRequest",
|
||||
"in": "header",
|
||||
"description": "Required to be true for the API request to pass",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"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": [
|
||||
"signature_flow"
|
||||
],
|
||||
"properties": {
|
||||
"signature_flow": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid flow value",
|
||||
"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": [
|
||||
"message"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
|
||||
"post": {
|
||||
"operationId": "admin-signature-background-save",
|
||||
|
|
|
|||
|
|
@ -6381,7 +6381,7 @@
|
|||
"post": {
|
||||
"operationId": "request_signature-request",
|
||||
"summary": "Request signature",
|
||||
"description": "Request that a file be signed by a group of people",
|
||||
"description": "Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled.",
|
||||
"tags": [
|
||||
"request_signature"
|
||||
],
|
||||
|
|
@ -6411,7 +6411,7 @@
|
|||
},
|
||||
"users": {
|
||||
"type": "array",
|
||||
"description": "Collection of users who must sign the document",
|
||||
"description": "Collection of users who must sign the document. Each user can have: identify, displayName, description, notify, signing_order",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/NewSigner"
|
||||
}
|
||||
|
|
@ -9475,6 +9475,145 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
|
||||
"post": {
|
||||
"operationId": "admin-set-signature-flow",
|
||||
"summary": "Set signature flow configuration",
|
||||
"description": "This endpoint requires admin access",
|
||||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
"security": [
|
||||
{
|
||||
"bearer_auth": []
|
||||
},
|
||||
{
|
||||
"basic_auth": []
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"flow"
|
||||
],
|
||||
"properties": {
|
||||
"flow": {
|
||||
"type": "string",
|
||||
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "apiVersion",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"v1"
|
||||
],
|
||||
"default": "v1"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "OCS-APIRequest",
|
||||
"in": "header",
|
||||
"description": "Required to be true for the API request to pass",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"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": [
|
||||
"signature_flow"
|
||||
],
|
||||
"properties": {
|
||||
"signature_flow": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid flow value",
|
||||
"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": [
|
||||
"message"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
|
||||
"post": {
|
||||
"operationId": "admin-signature-background-save",
|
||||
|
|
|
|||
|
|
@ -6231,7 +6231,7 @@
|
|||
"post": {
|
||||
"operationId": "request_signature-request",
|
||||
"summary": "Request signature",
|
||||
"description": "Request that a file be signed by a group of people",
|
||||
"description": "Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled.",
|
||||
"tags": [
|
||||
"request_signature"
|
||||
],
|
||||
|
|
@ -6261,7 +6261,7 @@
|
|||
},
|
||||
"users": {
|
||||
"type": "array",
|
||||
"description": "Collection of users who must sign the document",
|
||||
"description": "Collection of users who must sign the document. Each user can have: identify, displayName, description, notify, signing_order",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/NewSigner"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -128,6 +128,26 @@ export type paths = {
|
|||
patch?: never;
|
||||
trace?: never;
|
||||
};
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header?: never;
|
||||
path?: never;
|
||||
cookie?: never;
|
||||
};
|
||||
get?: never;
|
||||
put?: never;
|
||||
/**
|
||||
* Set signature flow configuration
|
||||
* @description This endpoint requires admin access
|
||||
*/
|
||||
post: operations["admin-set-signature-flow"];
|
||||
delete?: never;
|
||||
options?: never;
|
||||
head?: never;
|
||||
patch?: never;
|
||||
trace?: never;
|
||||
};
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
|
|
@ -790,6 +810,61 @@ export interface operations {
|
|||
};
|
||||
};
|
||||
};
|
||||
"admin-set-signature-flow": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header: {
|
||||
/** @description Required to be true for the API request to pass */
|
||||
"OCS-APIRequest": boolean;
|
||||
};
|
||||
path: {
|
||||
apiVersion: "v1";
|
||||
};
|
||||
cookie?: never;
|
||||
};
|
||||
requestBody: {
|
||||
content: {
|
||||
"application/json": {
|
||||
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
|
||||
flow: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
responses: {
|
||||
/** @description OK */
|
||||
200: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": {
|
||||
ocs: {
|
||||
meta: components["schemas"]["OCSMeta"];
|
||||
data: {
|
||||
signature_flow: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
/** @description Invalid flow value */
|
||||
400: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": {
|
||||
ocs: {
|
||||
meta: components["schemas"]["OCSMeta"];
|
||||
data: {
|
||||
message: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
"admin-signature-background-get": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
|
|
|
|||
|
|
@ -839,7 +839,7 @@ export type paths = {
|
|||
put?: never;
|
||||
/**
|
||||
* Request signature
|
||||
* @description Request that a file be signed by a group of people
|
||||
* @description Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled.
|
||||
*/
|
||||
post: operations["request_signature-request"];
|
||||
delete?: never;
|
||||
|
|
@ -1139,6 +1139,26 @@ export type paths = {
|
|||
patch?: never;
|
||||
trace?: never;
|
||||
};
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header?: never;
|
||||
path?: never;
|
||||
cookie?: never;
|
||||
};
|
||||
get?: never;
|
||||
put?: never;
|
||||
/**
|
||||
* Set signature flow configuration
|
||||
* @description This endpoint requires admin access
|
||||
*/
|
||||
post: operations["admin-set-signature-flow"];
|
||||
delete?: never;
|
||||
options?: never;
|
||||
head?: never;
|
||||
patch?: never;
|
||||
trace?: never;
|
||||
};
|
||||
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
|
|
@ -3973,7 +3993,7 @@ export interface operations {
|
|||
"application/json": {
|
||||
/** @description File object. */
|
||||
file: components["schemas"]["NewFile"];
|
||||
/** @description Collection of users who must sign the document */
|
||||
/** @description Collection of users who must sign the document. Each user can have: identify, displayName, description, notify, signing_order */
|
||||
users: components["schemas"]["NewSigner"][];
|
||||
/** @description The name of file to sign */
|
||||
name: string;
|
||||
|
|
@ -5186,6 +5206,61 @@ export interface operations {
|
|||
};
|
||||
};
|
||||
};
|
||||
"admin-set-signature-flow": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header: {
|
||||
/** @description Required to be true for the API request to pass */
|
||||
"OCS-APIRequest": boolean;
|
||||
};
|
||||
path: {
|
||||
apiVersion: "v1";
|
||||
};
|
||||
cookie?: never;
|
||||
};
|
||||
requestBody: {
|
||||
content: {
|
||||
"application/json": {
|
||||
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
|
||||
flow: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
responses: {
|
||||
/** @description OK */
|
||||
200: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": {
|
||||
ocs: {
|
||||
meta: components["schemas"]["OCSMeta"];
|
||||
data: {
|
||||
signature_flow: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
/** @description Invalid flow value */
|
||||
400: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": {
|
||||
ocs: {
|
||||
meta: components["schemas"]["OCSMeta"];
|
||||
data: {
|
||||
message: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
"admin-signature-background-get": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
|
|
|
|||
|
|
@ -839,7 +839,7 @@ export type paths = {
|
|||
put?: never;
|
||||
/**
|
||||
* Request signature
|
||||
* @description Request that a file be signed by a group of people
|
||||
* @description Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled.
|
||||
*/
|
||||
post: operations["request_signature-request"];
|
||||
delete?: never;
|
||||
|
|
@ -3515,7 +3515,7 @@ export interface operations {
|
|||
"application/json": {
|
||||
/** @description File object. */
|
||||
file: components["schemas"]["NewFile"];
|
||||
/** @description Collection of users who must sign the document */
|
||||
/** @description Collection of users who must sign the document. Each user can have: identify, displayName, description, notify, signing_order */
|
||||
users: components["schemas"]["NewSigner"][];
|
||||
/** @description The name of file to sign */
|
||||
name: string;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue