WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-20 14:42:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update opensign.yaml

Browse Source
This commit is contained in:
prafull-opensignlabs
2024-01-15 13:17:55 +05:30
committed by GitHub
parent d00d31eaf2
commit fd34ba778c
1 changed files with 66 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/API-docs/opensign.yaml
+66 -43
View File
@@ -146,7 +146,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_1'
$ref: '#/components/schemas/inline_response_200_2'
"404":
description: Contact not found!
content:
@@ -192,7 +192,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_2'
$ref: '#/components/schemas/inline_response_200_3'
"404":
description: Contact not found!
content:
@@ -234,9 +234,7 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/contactdetails'
$ref: '#/components/schemas/inline_response_200_4'
"405":
description: Invalid API Token!
content:
@@ -266,7 +264,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_3'
$ref: '#/components/schemas/inline_response_200_5'
"405":
description: Invalid API Token!
content:
@@ -307,7 +305,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_4'
$ref: '#/components/schemas/inline_response_200_6'
"404":
description: Document not found!
content:
@@ -353,7 +351,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_5'
$ref: '#/components/schemas/inline_response_200_7'
"404":
description: Document not found!
content:
@@ -430,9 +428,7 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/document'
$ref: '#/components/schemas/inline_response_200_8'
"404":
description: Report not available!
content:
@@ -474,9 +470,13 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_6'
$ref: '#/components/schemas/inline_response_200_9'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
/template/{template_id}:
get:
tags:
@@ -508,7 +508,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_7'
$ref: '#/components/schemas/inline_response_200_10'
"404":
description: Template not found!
content:
@@ -556,7 +556,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_8'
$ref: '#/components/schemas/inline_response_200_11'
"400":
description: Please provide valid field names!
content:
@@ -604,7 +604,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_9'
$ref: '#/components/schemas/inline_response_200_12'
"404":
description: Template not found!
content:
@@ -643,7 +643,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_200_10'
$ref: '#/components/schemas/inline_response_200_13'
"405":
description: Invalid API Token!
content:
@@ -690,15 +690,13 @@ components:
createTemplateResponse:
type: object
properties:
code:
objectId:
type: number
format: number
type:
type: string
message:
url:
type: string
example: https://exampleurl.com
xml:
name: '##default'
name: createTemplateResponse
template:
type: object
properties:
@@ -909,6 +907,14 @@ components:
message:
type: string
example: "Something went wrong, please try again later!"
inline_response_200_2:
type: object
properties:
code:
type: number
example: 200
result:
$ref: '#/components/schemas/contactdetails'
inline_response_404_2:
type: object
properties:
@@ -918,15 +924,6 @@ components:
message:
type: string
example: Contact not found!
inline_response_200_2:
type: object
properties:
code:
type: number
example: 200
message:
type: string
example: Contact deleted successfully!
inline_response_200_3:
type: object
properties:
@@ -936,9 +933,17 @@ components:
message:
type: string
example: Contact deleted successfully!
result:
$ref: '#/components/schemas/inline_response_200_3_result'
inline_response_200_4:
type: object
properties:
code:
type: number
example: 200
result:
type: array
items:
$ref: '#/components/schemas/contactdetails'
inline_response_200_5:
type: object
properties:
code:
@@ -946,7 +951,15 @@ components:
example: 200
message:
type: string
example: Contact created successfully!
example: Document created successfully!
result:
$ref: '#/components/schemas/inline_response_200_5_result'
inline_response_200_6:
type: object
properties:
code:
type: number
example: 200
result:
$ref: '#/components/schemas/document'
inline_response_404_3:
@@ -958,7 +971,7 @@ components:
message:
type: string
example: Document not found!
inline_response_200_5:
inline_response_200_7:
type: object
properties:
code:
@@ -967,6 +980,16 @@ components:
message:
type: string
example: Document deleted successfully!
inline_response_200_8:
type: object
properties:
code:
type: number
example: 200
result:
type: array
items:
$ref: '#/components/schemas/document'
inline_response_404_4:
type: object
properties:
@@ -976,7 +999,7 @@ components:
message:
type: string
example: Report not available!
inline_response_200_6:
inline_response_200_9:
type: object
properties:
code:
@@ -987,7 +1010,7 @@ components:
example: Template created successfully!
result:
$ref: '#/components/schemas/createTemplateResponse'
inline_response_200_7:
inline_response_200_10:
type: object
properties:
code:
@@ -1023,7 +1046,7 @@ components:
type: string
format: string
example: xjsba1GaxP
inline_response_200_8:
inline_response_200_11:
type: object
properties:
code:
@@ -1035,7 +1058,7 @@ components:
format: string
example: Template upated sucessfully
result:
$ref: '#/components/schemas/inline_response_200_8_result'
$ref: '#/components/schemas/inline_response_200_11_result'
inline_response_400:
type: object
properties:
@@ -1058,7 +1081,7 @@ components:
type: string
format: string
example: Template not found!
inline_response_200_9:
inline_response_200_12:
type: object
properties:
code:
@@ -1067,7 +1090,7 @@ components:
message:
type: string
example: Template deleted successfully!
inline_response_200_10:
inline_response_200_13:
type: object
properties:
code:
@@ -1083,7 +1106,7 @@ components:
Name:
type: string
example: joe
inline_response_200_3_result:
inline_response_200_5_result:
type: object
properties:
objectId:
@@ -1094,7 +1117,7 @@ components:
type: string
format: string
example: https://example.com
inline_response_200_8_result:
inline_response_200_11_result:
type: object
properties:
objectId: