Skip to content

Commit

Permalink
chore: update OpenAPI documentation
Browse files Browse the repository at this point in the history 
Signed-off-by: Victor Bianchi <[email protected]>
  • Loading branch information
@v-bianchi
v-bianchi committed Sep 30, 2024
1 parent 4bb4690 commit b2a69f4
Show file tree
Hide file tree
Showing 4 changed files with 232 additions and 8 deletions.
69 changes: 67 additions & 2 deletions openapi-full.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1128,6 +1128,48 @@
}
}
},
"/index.php/apps/libresign/p/sign/{uuid}/pdf": {
"get": {
"operationId": "page-sign-pdf",
"summary": "Sign page to authenticated signer",
"description": "The path is used only by frontend",
"tags": [
"page"
],
"security": [
{},
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Sign request uuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/index.php/apps/libresign/p/sign/{uuid}": {
"get": {
"operationId": "page-sign",
Expand Down Expand Up @@ -3695,9 +3737,32 @@
}
},
{
"name": "status",
"name": "status[]",
"in": "query",
"description": "Status could be none or many of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted.",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "start",
"in": "query",
"description": "Start date of signature request (UNIX timestamp)",
"schema": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
{
"name": "end",
"in": "query",
"description": "Status could be one of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted.",
"description": "End date of signature request (UNIX timestamp)",
"schema": {
"type": "integer",
"format": "int64",
Expand Down
69 changes: 67 additions & 2 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1032,6 +1032,48 @@
}
}
},
"/index.php/apps/libresign/p/sign/{uuid}/pdf": {
"get": {
"operationId": "page-sign-pdf",
"summary": "Sign page to authenticated signer",
"description": "The path is used only by frontend",
"tags": [
"page"
],
"security": [
{},
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "Sign request uuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/index.php/apps/libresign/p/sign/{uuid}": {
"get": {
"operationId": "page-sign",
Expand Down Expand Up @@ -3599,9 +3641,32 @@
}
},
{
"name": "status",
"name": "status[]",
"in": "query",
"description": "Status could be none or many of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted.",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "start",
"in": "query",
"description": "Start date of signature request (UNIX timestamp)",
"schema": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
{
"name": "end",
"in": "query",
"description": "Status could be one of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted.",
"description": "End date of signature request (UNIX timestamp)",
"schema": {
"type": "integer",
"format": "int64",
Expand Down
51 changes: 49 additions & 2 deletions src/types/openapi/openapi-full.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,26 @@ export type paths = {
patch?: never;
trace?: never;
};
"/index.php/apps/libresign/p/sign/{uuid}/pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Sign page to authenticated signer
* @description The path is used only by frontend
*/
get: operations["page-sign-pdf"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/index.php/apps/libresign/p/sign/{uuid}": {
parameters: {
query?: never;
Expand Down Expand Up @@ -1419,6 +1439,29 @@ export interface operations {
};
};
};
"page-sign-pdf": {
parameters: {
query?: never;
header?: never;
path: {
/** @description Sign request uuid */
uuid: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"text/html": string;
};
};
};
};
"page-sign": {
parameters: {
query?: never;
Expand Down Expand Up @@ -2453,8 +2496,12 @@ export interface operations {
signer_uuid?: string | null;
/** @description The nodeId (also called fileId). Is the id of a file at Nextcloud */
nodeId?: string | null;
/** @description Status could be one of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted. */
status?: number | null;
/** @description Status could be none or many of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted. */
"status[]"?: number[] | null;
/** @description Start date of signature request (UNIX timestamp) */
start?: number | null;
/** @description End date of signature request (UNIX timestamp) */
end?: number | null;
};
header: {
/** @description Required to be true for the API request to pass */
Expand Down
51 changes: 49 additions & 2 deletions src/types/openapi/openapi.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,26 @@ export type paths = {
patch?: never;
trace?: never;
};
"/index.php/apps/libresign/p/sign/{uuid}/pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Sign page to authenticated signer
* @description The path is used only by frontend
*/
get: operations["page-sign-pdf"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/index.php/apps/libresign/p/sign/{uuid}": {
parameters: {
query?: never;
Expand Down Expand Up @@ -1273,6 +1293,29 @@ export interface operations {
};
};
};
"page-sign-pdf": {
parameters: {
query?: never;
header?: never;
path: {
/** @description Sign request uuid */
uuid: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"text/html": string;
};
};
};
};
"page-sign": {
parameters: {
query?: never;
Expand Down Expand Up @@ -2307,8 +2350,12 @@ export interface operations {
signer_uuid?: string | null;
/** @description The nodeId (also called fileId). Is the id of a file at Nextcloud */
nodeId?: string | null;
/** @description Status could be one of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted. */
status?: number | null;
/** @description Status could be none or many of 0 = draft, 1 = able to sign, 2 = partial signed, 3 = signed, 4 = deleted. */
"status[]"?: number[] | null;
/** @description Start date of signature request (UNIX timestamp) */
start?: number | null;
/** @description End date of signature request (UNIX timestamp) */
end?: number | null;
};
header: {
/** @description Required to be true for the API request to pass */
Expand Down

0 comments on commit b2a69f4

Please sign in to comment.