-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathagentbridge.schema.json
More file actions
452 lines (452 loc) · 14.6 KB
/
agentbridge.schema.json
File metadata and controls
452 lines (452 loc) · 14.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "AgentBridge Protocol Schema",
"description": "JSON Schema for validating AgentBridge Protocol files",
"type": "object",
"required": ["metadata", "info", "actions", "flows"],
"properties": {
"$schema": {
"type": "string",
"description": "Schema URI reference"
},
"metadata": {
"type": "object",
"required": ["version"],
"properties": {
"version": {
"type": "string",
"description": "AgentBridge specification version",
"pattern": "^[0-9]+(\\.[0-9]+)*$"
}
},
"additionalProperties": false
},
"info": {
"type": "object",
"required": ["title", "description", "version", "baseUrl"],
"properties": {
"title": {
"type": "string",
"description": "Name of the API"
},
"description": {
"type": "string",
"description": "Comprehensive description of the API"
},
"version": {
"type": "string",
"description": "API version identifier",
"pattern": "^[0-9]+(\\.[0-9]+)*$"
},
"baseUrl": {
"type": "string",
"description": "Base URL for API endpoints",
"format": "uri"
}
},
"additionalProperties": false
},
"authentication": {
"type": "object",
"required": ["type", "parameters", "implementation"],
"properties": {
"type": {
"type": "string",
"description": "Authentication type",
"enum": ["credential"]
},
"parameters": {
"type": "object",
"description": "Credentials required for authentication",
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["description"],
"properties": {
"description": {
"type": "string",
"description": "Description of the credential parameter"
},
"schema": {
"type": "object",
"description": "JSON Schema of the credential parameter"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"implementation": {
"type": "object",
"description": "How authentication is implemented",
"minProperties": 1,
"properties": {
"headers": {
"type": "object",
"description": "Headers used for authentication",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "string",
"description": "Header value template"
}
},
"additionalProperties": false
},
"queryParameters": {
"type": "object",
"description": "Query parameters used for authentication",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "string",
"description": "Query parameter value template"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"actions": {
"type": "object",
"description": "API operations",
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": [
"id",
"description",
"endpoint",
"method",
"requestFormat",
"responseFormat"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the action"
},
"description": {
"type": "string",
"description": "Description of what the action does"
},
"endpoint": {
"type": "string",
"description": "API endpoint path",
"pattern": "^/"
},
"method": {
"type": "string",
"description": "HTTP method",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"OPTIONS"
]
},
"requestFormat": {
"type": "object",
"required": ["contentType"],
"properties": {
"contentType": {
"type": "string",
"description": "Content type of the request"
},
"parameters": {
"type": "object",
"description": "Parameters for the request",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["description", "in"],
"properties": {
"description": {
"type": "string",
"description": "Description of the parameter"
},
"in": {
"type": "string",
"enum": ["path", "query"],
"description": "Where the parameter is located (path or query)"
},
"required": {
"type": "boolean",
"description": "Whether the parameter is required"
},
"example": {
"description": "Example value for the parameter"
},
"schema": {
"type": "object",
"description": "JSON Schema of the parameter"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"description": "JSON Schema of the request body"
}
},
"additionalProperties": false
},
"responseFormat": {
"type": "object",
"required": ["contentType"],
"properties": {
"contentType": {
"type": "string",
"description": "Content type of the response"
},
"schema": {
"description": "Schema of the response"
},
"example": {
"description": "Example response"
}
},
"additionalProperties": false
},
"errors": {
"type": "array",
"description": "Possible error responses",
"items": {
"type": "object",
"required": ["code", "reason"],
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code"
},
"reason": {
"type": "string",
"description": "Reason for the error"
},
"resolution": {
"type": "string",
"description": "How to resolve the error"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"flows": {
"type": "object",
"description": "Multi-step operations",
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["id", "description", "steps", "parameters", "response"],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the flow"
},
"description": {
"type": "string",
"description": "Description of the flow's purpose"
},
"parameters": {
"type": "array",
"description": "Parameters for the flow",
"items": {
"type": "object",
"required": ["name", "description"],
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter"
},
"description": {
"type": "string",
"description": "Description of the parameter"
},
"required": {
"type": "boolean",
"description": "Whether the parameter is required",
"default": false
},
"type": {
"type": "string",
"description": "Data type of the parameter",
"enum": [
"string",
"number",
"integer",
"boolean",
"array",
"object"
]
},
"schema": {
"type": "object",
"description": "JSON Schema of the parameter"
}
},
"additionalProperties": false
}
},
"response": {
"type": "object",
"description": "Response schema for the flow",
"required": ["schema"],
"properties": {
"schema": {
"type": "object",
"description": "Schema defining the structure of the flow response",
"properties": {
"type": {
"type": "string",
"enum": ["object"]
},
"properties": {
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["type", "description"],
"properties": {
"type": {
"type": "string",
"enum": [
"string",
"number",
"integer",
"boolean",
"array",
"object"
]
},
"description": {
"type": "string"
}
}
}
}
}
}
}
}
},
"steps": {
"type": "array",
"description": "Sequence of actions to execute",
"minItems": 1,
"items": {
"type": "object",
"required": ["actionId", "description"],
"properties": {
"actionId": {
"type": "string",
"description": "Reference to an action ID"
},
"description": {
"type": "string",
"description": "Description of this step"
}
},
"additionalProperties": false
}
},
"dataFlow": {
"type": "array",
"description": "Data mapping between steps and flow inputs/outputs",
"items": {
"type": "object",
"required": ["from", "to", "description"],
"properties": {
"from": {
"type": "string",
"description": "Source data path"
},
"to": {
"type": "string",
"description": "Target data path"
},
"description": {
"type": "string",
"description": "Description of the data mapping"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"entities": {
"type": "object",
"description": "Data structure definitions",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["id", "properties"],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the entity"
},
"properties": {
"type": "object",
"description": "Entity properties",
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"type": "object",
"required": ["type", "description"],
"properties": {
"type": {
"type": "string",
"description": "Data type of the property",
"enum": [
"string",
"number",
"integer",
"boolean",
"array",
"object"
]
},
"description": {
"type": "string",
"description": "Description of the property"
},
"items": {
"description": "Schema for array items"
}
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}