Skip to content

Commit 42d3655

Browse files
garg-muditgarg-mudit
authored
Merge pull request #122 from docusign/muditgarg/connected-fields-api-update
Create connected-fields.rest.swagger.json
2 parents 3c55370 + fba4840 commit 42d3655

File tree

1 file changed

+341
-0
lines changed

1 file changed

+341
-0
lines changed

‎connected-fields.rest.swagger.json‎

Lines changed: 341 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,341 @@
1+
{
2+
"openapi": "3.1.0",
3+
"info": {
4+
"title": "Connected Fields API",
5+
"description": "Connected Fields API",
6+
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/web",
7+
"contact": {
8+
"name": "Docusign Developers",
9+
"email": "[email protected]",
10+
"url": "https://developers.docusign.com/"
11+
},
12+
"version": "v1"
13+
},
14+
"servers": [
15+
{
16+
"url": "https://api-d.docusign.com/v1"
17+
}
18+
],
19+
"paths": {
20+
"/accounts/{accountId}/connected-fields/tab-groups": {
21+
"get": {
22+
"operationId": "ConnectedFieldsApi_GetTabGroups",
23+
"summary": "Returns all tabs associated with the given account",
24+
"description": "Returns all tabs associated with the given account. \n\n **Note**: Unlike the Connected Fields UI, this endpoint returns only fields that are either mandatory or have the **IsRequiredForVerifyingType** <a href=\"https://concerto.accordproject.org/docs/design/specification/model-decorators/\" target=\"_blank\">decorator</a> ",
25+
"parameters": [
26+
{
27+
"name": "accountId",
28+
"required": true,
29+
"in": "path",
30+
"schema": {
31+
"type": "string"
32+
}
33+
},
34+
{
35+
"name": "appId",
36+
"in": "query",
37+
"schema": {
38+
"type": "string"
39+
}
40+
}
41+
],
42+
"x-ds-methodname": "GetConnectedFieldsTabGroups",
43+
"responses": {
44+
"200": {
45+
"description": "Successful response",
46+
"content": {
47+
"application/json": {
48+
"schema": {
49+
"type": "array",
50+
"items": {
51+
"$ref": "#/components/schemas/TabInfo"
52+
}
53+
}
54+
}
55+
}
56+
},
57+
"400": {
58+
"description": "Bad Request",
59+
"content": {
60+
"text/plain": {
61+
"schema": {
62+
"$ref": "#/components/schemas/ErrorResponseDTO"
63+
}
64+
},
65+
"application/json": {
66+
"schema": {
67+
"$ref": "#/components/schemas/ErrorResponseDTO"
68+
}
69+
},
70+
"text/json": {
71+
"schema": {
72+
"$ref": "#/components/schemas/ErrorResponseDTO"
73+
}
74+
}
75+
}
76+
},
77+
"401": {
78+
"description": "Unauthorized - Authentication is required",
79+
"content": {
80+
"text/plain": {
81+
"schema": {
82+
"$ref": "#/components/schemas/ErrorResponseDTO"
83+
}
84+
},
85+
"application/json": {
86+
"schema": {
87+
"$ref": "#/components/schemas/ErrorResponseDTO"
88+
}
89+
},
90+
"text/json": {
91+
"schema": {
92+
"$ref": "#/components/schemas/ErrorResponseDTO"
93+
}
94+
}
95+
}
96+
}
97+
},
98+
"tags": [
99+
"TabInfo"
100+
],
101+
"x-ds-method": "GetConnectedFieldsTabGroups",
102+
"x-ds-service": "TabInfo"
103+
}
104+
}
105+
},
106+
"components": {
107+
"securitySchemes": {
108+
"oauth2": {
109+
"type": "oauth2",
110+
"description": "JWT Bearer token from Docusign authorization server,",
111+
"flows": {
112+
"authorizationCode": {
113+
"authorizationUrl": "https://account-d.docusign.com/oauth/auth",
114+
"tokenUrl": "https://account-d.docusign.com/oauth/token",
115+
"scopes": {
116+
"adm_store_unified_repo_read": "Required to read agreement data from Connected Fields APIs",
117+
"signature": "Used for operations on the Docusign eSignature API"
118+
}
119+
}
120+
}
121+
}
122+
},
123+
"schemas": {
124+
"ErrorResponseDTO": {
125+
"type": "object",
126+
"properties": {
127+
"code": {
128+
"type": "string",
129+
"nullable": true
130+
},
131+
"message": {
132+
"type": "string",
133+
"nullable": true
134+
}
135+
},
136+
"additionalProperties": false,
137+
"x-ds-definition-name": "ErrorResponseDTO"
138+
},
139+
"TabConnectionInstance": {
140+
"type": "object",
141+
"properties": {
142+
"connectionKey": {
143+
"type": "string",
144+
"description": "Identifies an extension app's unique connection key."
145+
},
146+
"connectionValue": {
147+
"type": "string",
148+
"description": "Identifies an extension app's connection instance."
149+
}
150+
},
151+
"required": [
152+
"connectionKey",
153+
"connectionValue"
154+
],
155+
"x-ds-definition-name": "TabConnectionInstance"
156+
},
157+
"TabConnectedFieldsData": {
158+
"type": "object",
159+
"properties": {
160+
"typeSystemNamespace": {
161+
"type": "string",
162+
"description": "The fully qualified namespace for the type system being verified."
163+
},
164+
"typeName": {
165+
"type": "string",
166+
"description": "Name of the type being verified."
167+
},
168+
"supportedOperation": {
169+
"type": "string",
170+
"description": "The operation that the field supports.",
171+
"enum": [
172+
"VerifyType"
173+
]
174+
},
175+
"propertyName": {
176+
"type": "string",
177+
"description": "The name of the individual field being verified."
178+
},
179+
"supportedUri": {
180+
"type": "string",
181+
"description": "Indicates the type verification url of the field."
182+
}
183+
},
184+
"required": [
185+
"typeSystemNamespace",
186+
"typeName",
187+
"supportedOperation",
188+
"propertyName",
189+
"supportedUri"
190+
],
191+
"x-ds-definition-name": "TabConnectedFiledsData"
192+
},
193+
"TabExtensionData": {
194+
"type": "object",
195+
"properties": {
196+
"extensionGroupId": {
197+
"type": "string",
198+
"description": "A unique UUID for each tab group. Tabs associated with the same model or concept will share the same extensionGroupId."
199+
},
200+
"actionInputKey": {
201+
"type": "string",
202+
"description": "Determines input data key required for data verification."
203+
},
204+
"extensionPolicy": {
205+
"type": "string",
206+
"enum": [
207+
"None"
208+
],
209+
"description": "Indicates if the field is required to sign the document"
210+
},
211+
"publisherName": {
212+
"type": "string",
213+
"description": "Publisher of the extension app."
214+
},
215+
"applicationName": {
216+
"type": "string",
217+
"description": "Name of the extension app."
218+
},
219+
"actionName": {
220+
"type": "string",
221+
"description": "Name of an action in an extension app."
222+
},
223+
"extensionContract": {
224+
"type": "string",
225+
"description": "Indicates the template that defines an extension."
226+
},
227+
"actionContract": {
228+
"type": "string",
229+
"description": "Indicates the template defining an action."
230+
},
231+
"extensionName": {
232+
"type": "string",
233+
"description": "Name of the extension."
234+
},
235+
"requiredForExtension": {
236+
"type": "boolean",
237+
"description": "A boolean value that indicates if the field must pass verification to sign the document."
238+
},
239+
"connectionInstances": {
240+
"type": "array",
241+
"description": "Array representing the extension app connection name and instance.",
242+
"items": {
243+
"$ref": "#/components/schemas/TabConnectionInstance"
244+
}
245+
},
246+
"connectedFieldsData": {
247+
"$ref": "#/components/schemas/TabConnectedFieldsData"
248+
}
249+
},
250+
"required": [
251+
"extensionGroupId",
252+
"actionInputKey",
253+
"requiredForExtension"
254+
],
255+
"x-ds-definition-name": "TabExtensionData"
256+
},
257+
"Tab": {
258+
"type": "object",
259+
"properties": {
260+
"extensionData": {
261+
"$ref": "#/components/schemas/TabExtensionData"
262+
},
263+
"tabType": {
264+
"type": "string",
265+
"description": "Indicates the type of tab"
266+
},
267+
"validationPattern": {
268+
"type": "string",
269+
"description": "A regular expression used to validate input for the tab."
270+
},
271+
"validationMessage": {
272+
"type": "string",
273+
"description": "The message displayed if the custom tab fails input validation"
274+
},
275+
"tabLabel": {
276+
"type": "string",
277+
"description": "The label associated to a verification field in a document."
278+
},
279+
"radios": {
280+
"type": "array",
281+
"description": "The radio button properties for the tab (if the tab is of radio type)",
282+
"items": {
283+
"type": "string"
284+
}
285+
}
286+
},
287+
"required": [
288+
"extensionData",
289+
"tabType",
290+
"tabLabel"
291+
],
292+
"x-ds-definition-name": "Tab"
293+
},
294+
"TabInfo": {
295+
"type": "object",
296+
"properties": {
297+
"appId": {
298+
"type": "string",
299+
"description": "Unique ID of the installed extension app"
300+
},
301+
"tabs": {
302+
"type": "array",
303+
"description": "Tab data representing the tabs associated with installed apps in the account ",
304+
"items": {
305+
"$ref": "#/components/schemas/Tab"
306+
}
307+
}
308+
},
309+
"required": [
310+
"appId",
311+
"tabs"
312+
],
313+
"x-ds-category": "ConnectedFields",
314+
"x-ms-summary": "",
315+
"description": "",
316+
"x-ds-definition-name": "TabInfo"
317+
}
318+
}
319+
},
320+
"security": [
321+
{
322+
"oauth2": [
323+
"adm_store_unified_repo_read",
324+
"signature"
325+
]
326+
}
327+
],
328+
"tags": [
329+
{
330+
"name": "TabInfo",
331+
"description": "ConnectedFieldsApi Get tabs for an account"
332+
}
333+
],
334+
"x-ds-categories": [
335+
{
336+
"name": "ConnectedFields",
337+
"summary": "",
338+
"description": ""
339+
}
340+
]
341+
}

0 commit comments

Comments
 (0)