openapi.yaml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
  1. openapi: 3.1.0
  2. info:
  3. title: FastAPI - Swagger UI
  4. version: 1.0.0
  5. paths:
  6. /agent/job:
  7. post:
  8. tags:
  9. - agent job interface
  10. summary: Submit Job
  11. operationId: submit_job_agent_job_post
  12. requestBody:
  13. content:
  14. application/json:
  15. schema:
  16. $ref: '#/components/schemas/BasicRequest'
  17. required: true
  18. responses:
  19. '200':
  20. description: Successful Response
  21. content:
  22. application/json:
  23. schema:
  24. $ref: '#/components/schemas/StandardResponse'
  25. '422':
  26. description: Validation Error
  27. content:
  28. application/json:
  29. schema:
  30. $ref: '#/components/schemas/HTTPValidationError'
  31. /agent/queue:
  32. post:
  33. tags:
  34. - agent job interface
  35. summary: Submit Queue
  36. operationId: submit_queue_agent_queue_post
  37. requestBody:
  38. content:
  39. application/json:
  40. schema:
  41. $ref: '#/components/schemas/BasicRequest'
  42. required: true
  43. responses:
  44. '200':
  45. description: Successful Response
  46. content:
  47. application/json:
  48. schema:
  49. $ref: '#/components/schemas/StandardResponse'
  50. '422':
  51. description: Validation Error
  52. content:
  53. application/json:
  54. schema:
  55. $ref: '#/components/schemas/HTTPValidationError'
  56. /file/upload/{file_type}/{job_id}:
  57. post:
  58. tags:
  59. - agent job interface
  60. summary: Upload File
  61. operationId: upload_file_file_upload__file_type___job_id__post
  62. parameters:
  63. - name: file_type
  64. in: path
  65. required: true
  66. schema:
  67. type: string
  68. title: File Type
  69. - name: job_id
  70. in: path
  71. required: true
  72. schema:
  73. type: integer
  74. title: Job Id
  75. requestBody:
  76. required: true
  77. content:
  78. multipart/form-data:
  79. schema:
  80. $ref: '#/components/schemas/Body_upload_file_file_upload__file_type___job_id__post'
  81. responses:
  82. '200':
  83. description: Successful Response
  84. content:
  85. application/json:
  86. schema:
  87. $ref: '#/components/schemas/StandardResponse'
  88. '422':
  89. description: Validation Error
  90. content:
  91. application/json:
  92. schema:
  93. $ref: '#/components/schemas/HTTPValidationError'
  94. /file/browse:
  95. post:
  96. tags:
  97. - agent job interface
  98. summary: Browser File
  99. operationId: browser_file_file_browse_post
  100. requestBody:
  101. content:
  102. application/json:
  103. schema:
  104. $ref: '#/components/schemas/BasicRequest'
  105. required: true
  106. responses:
  107. '200':
  108. description: Successful Response
  109. content:
  110. application/json:
  111. schema:
  112. $ref: '#/components/schemas/StandardResponse'
  113. '422':
  114. description: Validation Error
  115. content:
  116. application/json:
  117. schema:
  118. $ref: '#/components/schemas/HTTPValidationError'
  119. /file/download/{job_id}:
  120. get:
  121. tags:
  122. - agent job interface
  123. summary: Download File
  124. operationId: download_file_file_download__job_id__get
  125. parameters:
  126. - name: job_id
  127. in: path
  128. required: true
  129. schema:
  130. type: integer
  131. title: Job Id
  132. - name: path
  133. in: query
  134. required: false
  135. schema:
  136. type: string
  137. default: path
  138. title: Path
  139. responses:
  140. '200':
  141. description: Successful Response
  142. content:
  143. application/json:
  144. schema: {}
  145. '422':
  146. description: Validation Error
  147. content:
  148. application/json:
  149. schema:
  150. $ref: '#/components/schemas/HTTPValidationError'
  151. /file/view/{job_id}:
  152. get:
  153. tags:
  154. - agent job interface
  155. summary: View File
  156. operationId: view_file_file_view__job_id__get
  157. parameters:
  158. - name: job_id
  159. in: path
  160. required: true
  161. schema:
  162. type: integer
  163. title: Job Id
  164. - name: path
  165. in: query
  166. required: false
  167. schema:
  168. type: string
  169. default: path
  170. title: Path
  171. responses:
  172. '200':
  173. description: Successful Response
  174. content:
  175. application/json:
  176. schema:
  177. $ref: '#/components/schemas/StandardResponse'
  178. '422':
  179. description: Validation Error
  180. content:
  181. application/json:
  182. schema:
  183. $ref: '#/components/schemas/HTTPValidationError'
  184. /user/session:
  185. post:
  186. tags:
  187. - agent job interface
  188. summary: Register
  189. operationId: register_user_session_post
  190. requestBody:
  191. content:
  192. application/json:
  193. schema:
  194. $ref: '#/components/schemas/BasicRequest'
  195. required: true
  196. responses:
  197. '200':
  198. description: Successful Response
  199. content:
  200. application/json:
  201. schema:
  202. $ref: '#/components/schemas/StandardResponse'
  203. '422':
  204. description: Validation Error
  205. content:
  206. application/json:
  207. schema:
  208. $ref: '#/components/schemas/HTTPValidationError'
  209. /user/logout/{session_id}:
  210. get:
  211. tags:
  212. - agent job interface
  213. summary: Logout
  214. operationId: logout_user_logout__session_id__get
  215. parameters:
  216. - name: session_id
  217. in: path
  218. required: true
  219. schema:
  220. type: string
  221. title: Session Id
  222. responses:
  223. '200':
  224. description: Successful Response
  225. content:
  226. application/json:
  227. schema:
  228. $ref: '#/components/schemas/StandardResponse'
  229. '422':
  230. description: Validation Error
  231. content:
  232. application/json:
  233. schema:
  234. $ref: '#/components/schemas/HTTPValidationError'
  235. /user/signin:
  236. post:
  237. tags:
  238. - agent job interface
  239. summary: Signin
  240. operationId: signin_user_signin_post
  241. requestBody:
  242. content:
  243. application/json:
  244. schema:
  245. $ref: '#/components/schemas/BasicRequest'
  246. required: true
  247. responses:
  248. '200':
  249. description: Successful Response
  250. content:
  251. application/json:
  252. schema:
  253. $ref: '#/components/schemas/StandardResponse'
  254. '422':
  255. description: Validation Error
  256. content:
  257. application/json:
  258. schema:
  259. $ref: '#/components/schemas/HTTPValidationError'
  260. /kb/summary:
  261. post:
  262. tags:
  263. - knowledge build interface
  264. summary: Summary Func
  265. operationId: summary_func_kb_summary_post
  266. requestBody:
  267. content:
  268. application/json:
  269. schema:
  270. $ref: '#/components/schemas/BasicRequest'
  271. required: true
  272. responses:
  273. '200':
  274. description: Successful Response
  275. content:
  276. application/json:
  277. schema:
  278. $ref: '#/components/schemas/StandardResponse'
  279. '422':
  280. description: Validation Error
  281. content:
  282. application/json:
  283. schema:
  284. $ref: '#/components/schemas/HTTPValidationError'
  285. /kb/schemas:
  286. post:
  287. tags:
  288. - knowledge build interface
  289. summary: Schemas Func
  290. operationId: schemas_func_kb_schemas_post
  291. requestBody:
  292. content:
  293. application/json:
  294. schema:
  295. $ref: '#/components/schemas/BasicRequest'
  296. required: true
  297. responses:
  298. '200':
  299. description: Successful Response
  300. content:
  301. application/json:
  302. schema:
  303. $ref: '#/components/schemas/StandardResponse'
  304. '422':
  305. description: Validation Error
  306. content:
  307. application/json:
  308. schema:
  309. $ref: '#/components/schemas/HTTPValidationError'
  310. /kb/nodes:
  311. post:
  312. tags:
  313. - knowledge build interface
  314. summary: Nodes Func
  315. operationId: nodes_func_kb_nodes_post
  316. requestBody:
  317. content:
  318. application/json:
  319. schema:
  320. $ref: '#/components/schemas/BasicRequest'
  321. required: true
  322. responses:
  323. '200':
  324. description: Successful Response
  325. content:
  326. application/json:
  327. schema:
  328. $ref: '#/components/schemas/StandardResponse'
  329. '422':
  330. description: Validation Error
  331. content:
  332. application/json:
  333. schema:
  334. $ref: '#/components/schemas/HTTPValidationError'
  335. components:
  336. schemas:
  337. BasicRequest:
  338. properties:
  339. action:
  340. type: string
  341. title: Action
  342. id:
  343. type: string
  344. title: Id
  345. params:
  346. items:
  347. $ref: '#/components/schemas/BasicRequestParameter'
  348. type: array
  349. title: Params
  350. type: object
  351. required:
  352. - action
  353. - id
  354. - params
  355. title: BasicRequest
  356. BasicRequestParameter:
  357. properties:
  358. name:
  359. type: string
  360. title: Name
  361. value:
  362. anyOf:
  363. - type: string
  364. - type: integer
  365. - type: number
  366. - type: boolean
  367. - items:
  368. type: string
  369. type: array
  370. - items:
  371. type: integer
  372. type: array
  373. - items:
  374. type: number
  375. type: array
  376. - items:
  377. type: boolean
  378. type: array
  379. title: Value
  380. type: object
  381. required:
  382. - name
  383. - value
  384. title: BasicRequestParameter
  385. Body_upload_file_file_upload__file_type___job_id__post:
  386. properties:
  387. file:
  388. type: string
  389. format: binary
  390. title: File
  391. type: object
  392. required:
  393. - file
  394. title: Body_upload_file_file_upload__file_type___job_id__post
  395. HTTPValidationError:
  396. properties:
  397. detail:
  398. items:
  399. $ref: '#/components/schemas/ValidationError'
  400. type: array
  401. title: Detail
  402. type: object
  403. title: HTTPValidationError
  404. StandardResponse:
  405. properties:
  406. code:
  407. type: integer
  408. title: Code
  409. default: 200
  410. message:
  411. type: string
  412. title: Message
  413. default: success
  414. meta:
  415. type: object
  416. title: Meta
  417. default: {}
  418. records:
  419. items: {}
  420. type: array
  421. title: Records
  422. default: []
  423. type: object
  424. title: StandardResponse
  425. ValidationError:
  426. properties:
  427. loc:
  428. items:
  429. anyOf:
  430. - type: string
  431. - type: integer
  432. type: array
  433. title: Location
  434. msg:
  435. type: string
  436. title: Message
  437. type:
  438. type: string
  439. title: Error Type
  440. type: object
  441. required:
  442. - loc
  443. - msg
  444. - type
  445. title: ValidationError