api_docs.go 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579
  1. // Package api Code generated by swaggo/swag. DO NOT EDIT
  2. package api
  3. import "github.com/swaggo/swag"
  4. const docTemplateapi = `{
  5. "schemes": {{ marshal .Schemes }},
  6. "swagger": "2.0",
  7. "info": {
  8. "description": "{{escape .Description}}",
  9. "title": "{{.Title}}",
  10. "contact": {},
  11. "version": "{{.Version}}"
  12. },
  13. "host": "{{.Host}}",
  14. "basePath": "{{.BasePath}}",
  15. "paths": {
  16. "/": {
  17. "get": {
  18. "description": "首页",
  19. "consumes": [
  20. "application/json"
  21. ],
  22. "produces": [
  23. "application/json"
  24. ],
  25. "tags": [
  26. "首页"
  27. ],
  28. "summary": "首页",
  29. "responses": {
  30. "200": {
  31. "description": "OK",
  32. "schema": {
  33. "$ref": "#/definitions/response.Response"
  34. }
  35. },
  36. "500": {
  37. "description": "Internal Server Error",
  38. "schema": {
  39. "$ref": "#/definitions/response.Response"
  40. }
  41. }
  42. }
  43. }
  44. },
  45. "/ab": {
  46. "get": {
  47. "security": [
  48. {
  49. "BearerAuth": []
  50. }
  51. ],
  52. "description": "地址列表",
  53. "consumes": [
  54. "application/json"
  55. ],
  56. "produces": [
  57. "application/json"
  58. ],
  59. "tags": [
  60. "地址"
  61. ],
  62. "summary": "地址列表",
  63. "responses": {
  64. "200": {
  65. "description": "OK",
  66. "schema": {
  67. "$ref": "#/definitions/response.Response"
  68. }
  69. },
  70. "500": {
  71. "description": "Internal Server Error",
  72. "schema": {
  73. "$ref": "#/definitions/response.ErrorResponse"
  74. }
  75. }
  76. }
  77. },
  78. "post": {
  79. "security": [
  80. {
  81. "BearerAuth": []
  82. }
  83. ],
  84. "description": "地址更新",
  85. "consumes": [
  86. "application/json"
  87. ],
  88. "produces": [
  89. "application/json"
  90. ],
  91. "tags": [
  92. "地址"
  93. ],
  94. "summary": "地址更新",
  95. "parameters": [
  96. {
  97. "description": "地址表单",
  98. "name": "body",
  99. "in": "body",
  100. "required": true,
  101. "schema": {
  102. "$ref": "#/definitions/api.AddressBookForm"
  103. }
  104. }
  105. ],
  106. "responses": {
  107. "200": {
  108. "description": "null",
  109. "schema": {
  110. "type": "string"
  111. }
  112. },
  113. "500": {
  114. "description": "Internal Server Error",
  115. "schema": {
  116. "$ref": "#/definitions/response.ErrorResponse"
  117. }
  118. }
  119. }
  120. }
  121. },
  122. "/ab/peer/add/{guid}": {
  123. "post": {
  124. "security": [
  125. {
  126. "BearerAuth": []
  127. }
  128. ],
  129. "description": "添加地址",
  130. "consumes": [
  131. "application/json"
  132. ],
  133. "produces": [
  134. "application/json"
  135. ],
  136. "tags": [
  137. "地址[Personal]"
  138. ],
  139. "summary": "添加地址",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "guid",
  144. "name": "guid",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "200": {
  151. "description": "OK",
  152. "schema": {
  153. "type": "string"
  154. }
  155. },
  156. "500": {
  157. "description": "Internal Server Error",
  158. "schema": {
  159. "$ref": "#/definitions/response.ErrorResponse"
  160. }
  161. }
  162. }
  163. },
  164. "delete": {
  165. "security": [
  166. {
  167. "BearerAuth": []
  168. }
  169. ],
  170. "description": "删除地址",
  171. "consumes": [
  172. "application/json"
  173. ],
  174. "produces": [
  175. "application/json"
  176. ],
  177. "tags": [
  178. "地址[Personal]"
  179. ],
  180. "summary": "删除地址",
  181. "parameters": [
  182. {
  183. "type": "string",
  184. "description": "guid",
  185. "name": "guid",
  186. "in": "path",
  187. "required": true
  188. }
  189. ],
  190. "responses": {
  191. "200": {
  192. "description": "OK",
  193. "schema": {
  194. "type": "string"
  195. }
  196. },
  197. "500": {
  198. "description": "Internal Server Error",
  199. "schema": {
  200. "$ref": "#/definitions/response.ErrorResponse"
  201. }
  202. }
  203. }
  204. }
  205. },
  206. "/ab/peer/update/{guid}": {
  207. "put": {
  208. "security": [
  209. {
  210. "BearerAuth": []
  211. }
  212. ],
  213. "description": "更新地址",
  214. "consumes": [
  215. "application/json"
  216. ],
  217. "produces": [
  218. "application/json"
  219. ],
  220. "tags": [
  221. "地址[Personal]"
  222. ],
  223. "summary": "更新地址",
  224. "parameters": [
  225. {
  226. "type": "string",
  227. "description": "guid",
  228. "name": "guid",
  229. "in": "path",
  230. "required": true
  231. }
  232. ],
  233. "responses": {
  234. "200": {
  235. "description": "OK",
  236. "schema": {
  237. "type": "string"
  238. }
  239. },
  240. "500": {
  241. "description": "Internal Server Error",
  242. "schema": {
  243. "$ref": "#/definitions/response.ErrorResponse"
  244. }
  245. }
  246. }
  247. }
  248. },
  249. "/ab/peers": {
  250. "post": {
  251. "security": [
  252. {
  253. "BearerAuth": []
  254. }
  255. ],
  256. "description": "地址",
  257. "consumes": [
  258. "application/json"
  259. ],
  260. "produces": [
  261. "application/json"
  262. ],
  263. "tags": [
  264. "地址[Personal]"
  265. ],
  266. "summary": "地址列表",
  267. "parameters": [
  268. {
  269. "type": "integer",
  270. "description": "页码",
  271. "name": "current",
  272. "in": "query"
  273. },
  274. {
  275. "type": "integer",
  276. "description": "每页数量",
  277. "name": "pageSize",
  278. "in": "query"
  279. },
  280. {
  281. "type": "string",
  282. "description": "guid",
  283. "name": "ab",
  284. "in": "query"
  285. }
  286. ],
  287. "responses": {
  288. "200": {
  289. "description": "OK",
  290. "schema": {
  291. "$ref": "#/definitions/response.Response"
  292. }
  293. },
  294. "500": {
  295. "description": "Internal Server Error",
  296. "schema": {
  297. "$ref": "#/definitions/response.Response"
  298. }
  299. }
  300. }
  301. }
  302. },
  303. "/ab/personal": {
  304. "post": {
  305. "security": [
  306. {
  307. "BearerAuth": []
  308. }
  309. ],
  310. "description": "个人地址",
  311. "consumes": [
  312. "application/json"
  313. ],
  314. "produces": [
  315. "application/json"
  316. ],
  317. "tags": [
  318. "地址[Personal]"
  319. ],
  320. "summary": "个人地址",
  321. "parameters": [
  322. {
  323. "description": "string valid",
  324. "name": "string",
  325. "in": "body",
  326. "schema": {
  327. "type": "string"
  328. }
  329. }
  330. ],
  331. "responses": {
  332. "200": {
  333. "description": "OK",
  334. "schema": {
  335. "$ref": "#/definitions/response.Response"
  336. }
  337. },
  338. "500": {
  339. "description": "Internal Server Error",
  340. "schema": {
  341. "$ref": "#/definitions/response.Response"
  342. }
  343. }
  344. }
  345. }
  346. },
  347. "/ab/settings": {
  348. "post": {
  349. "security": [
  350. {
  351. "BearerAuth": []
  352. }
  353. ],
  354. "description": "设置",
  355. "consumes": [
  356. "application/json"
  357. ],
  358. "produces": [
  359. "application/json"
  360. ],
  361. "tags": [
  362. "地址[Personal]"
  363. ],
  364. "summary": "设置",
  365. "parameters": [
  366. {
  367. "description": "string valid",
  368. "name": "string",
  369. "in": "body",
  370. "schema": {
  371. "type": "string"
  372. }
  373. }
  374. ],
  375. "responses": {
  376. "200": {
  377. "description": "OK",
  378. "schema": {
  379. "$ref": "#/definitions/response.Response"
  380. }
  381. },
  382. "500": {
  383. "description": "Internal Server Error",
  384. "schema": {
  385. "$ref": "#/definitions/response.Response"
  386. }
  387. }
  388. }
  389. }
  390. },
  391. "/ab/shared/profiles": {
  392. "post": {
  393. "security": [
  394. {
  395. "BearerAuth": []
  396. }
  397. ],
  398. "description": "共享",
  399. "consumes": [
  400. "application/json"
  401. ],
  402. "produces": [
  403. "application/json"
  404. ],
  405. "tags": [
  406. "地址[Personal]"
  407. ],
  408. "summary": "共享地址簿",
  409. "parameters": [
  410. {
  411. "type": "integer",
  412. "description": "页码",
  413. "name": "current",
  414. "in": "query"
  415. },
  416. {
  417. "type": "integer",
  418. "description": "每页数量",
  419. "name": "pageSize",
  420. "in": "query"
  421. }
  422. ],
  423. "responses": {
  424. "200": {
  425. "description": "OK",
  426. "schema": {
  427. "$ref": "#/definitions/response.Response"
  428. }
  429. },
  430. "500": {
  431. "description": "Internal Server Error",
  432. "schema": {
  433. "$ref": "#/definitions/response.Response"
  434. }
  435. }
  436. }
  437. }
  438. },
  439. "/ab/tag/add/{guid}": {
  440. "post": {
  441. "security": [
  442. {
  443. "BearerAuth": []
  444. }
  445. ],
  446. "description": "标签",
  447. "consumes": [
  448. "application/json"
  449. ],
  450. "produces": [
  451. "application/json"
  452. ],
  453. "tags": [
  454. "地址[Personal]"
  455. ],
  456. "summary": "标签添加",
  457. "parameters": [
  458. {
  459. "type": "string",
  460. "description": "guid",
  461. "name": "guid",
  462. "in": "path",
  463. "required": true
  464. }
  465. ],
  466. "responses": {
  467. "200": {
  468. "description": "OK",
  469. "schema": {
  470. "type": "string"
  471. }
  472. },
  473. "500": {
  474. "description": "Internal Server Error",
  475. "schema": {
  476. "$ref": "#/definitions/response.ErrorResponse"
  477. }
  478. }
  479. }
  480. }
  481. },
  482. "/ab/tag/rename/{guid}": {
  483. "put": {
  484. "security": [
  485. {
  486. "BearerAuth": []
  487. }
  488. ],
  489. "description": "标签",
  490. "consumes": [
  491. "application/json"
  492. ],
  493. "produces": [
  494. "application/json"
  495. ],
  496. "tags": [
  497. "地址[Personal]"
  498. ],
  499. "summary": "标签重命名",
  500. "parameters": [
  501. {
  502. "type": "string",
  503. "description": "guid",
  504. "name": "guid",
  505. "in": "path",
  506. "required": true
  507. }
  508. ],
  509. "responses": {
  510. "200": {
  511. "description": "OK",
  512. "schema": {
  513. "type": "string"
  514. }
  515. },
  516. "500": {
  517. "description": "Internal Server Error",
  518. "schema": {
  519. "$ref": "#/definitions/response.ErrorResponse"
  520. }
  521. }
  522. }
  523. }
  524. },
  525. "/ab/tag/update/{guid}": {
  526. "put": {
  527. "security": [
  528. {
  529. "BearerAuth": []
  530. }
  531. ],
  532. "description": "标签",
  533. "consumes": [
  534. "application/json"
  535. ],
  536. "produces": [
  537. "application/json"
  538. ],
  539. "tags": [
  540. "地址[Personal]"
  541. ],
  542. "summary": "标签修改颜色",
  543. "parameters": [
  544. {
  545. "type": "string",
  546. "description": "guid",
  547. "name": "guid",
  548. "in": "path",
  549. "required": true
  550. }
  551. ],
  552. "responses": {
  553. "200": {
  554. "description": "OK",
  555. "schema": {
  556. "type": "string"
  557. }
  558. },
  559. "500": {
  560. "description": "Internal Server Error",
  561. "schema": {
  562. "$ref": "#/definitions/response.ErrorResponse"
  563. }
  564. }
  565. }
  566. }
  567. },
  568. "/ab/tag/{guid}": {
  569. "delete": {
  570. "security": [
  571. {
  572. "BearerAuth": []
  573. }
  574. ],
  575. "description": "标签",
  576. "consumes": [
  577. "application/json"
  578. ],
  579. "produces": [
  580. "application/json"
  581. ],
  582. "tags": [
  583. "地址[Personal]"
  584. ],
  585. "summary": "标签删除",
  586. "parameters": [
  587. {
  588. "type": "string",
  589. "description": "guid",
  590. "name": "guid",
  591. "in": "path",
  592. "required": true
  593. }
  594. ],
  595. "responses": {
  596. "200": {
  597. "description": "OK",
  598. "schema": {
  599. "type": "string"
  600. }
  601. },
  602. "500": {
  603. "description": "Internal Server Error",
  604. "schema": {
  605. "$ref": "#/definitions/response.ErrorResponse"
  606. }
  607. }
  608. }
  609. }
  610. },
  611. "/ab/tags/{guid}": {
  612. "post": {
  613. "security": [
  614. {
  615. "BearerAuth": []
  616. }
  617. ],
  618. "description": "标签",
  619. "consumes": [
  620. "application/json"
  621. ],
  622. "produces": [
  623. "application/json"
  624. ],
  625. "tags": [
  626. "地址[Personal]"
  627. ],
  628. "summary": "标签",
  629. "parameters": [
  630. {
  631. "type": "string",
  632. "description": "guid",
  633. "name": "guid",
  634. "in": "path",
  635. "required": true
  636. }
  637. ],
  638. "responses": {
  639. "200": {
  640. "description": "OK",
  641. "schema": {
  642. "$ref": "#/definitions/model.TagList"
  643. }
  644. },
  645. "500": {
  646. "description": "Internal Server Error",
  647. "schema": {
  648. "$ref": "#/definitions/response.ErrorResponse"
  649. }
  650. }
  651. }
  652. }
  653. },
  654. "/audit/conn": {
  655. "post": {
  656. "description": "审计连接",
  657. "consumes": [
  658. "application/json"
  659. ],
  660. "produces": [
  661. "application/json"
  662. ],
  663. "tags": [
  664. "审计"
  665. ],
  666. "summary": "审计连接",
  667. "parameters": [
  668. {
  669. "description": "审计连接",
  670. "name": "body",
  671. "in": "body",
  672. "required": true,
  673. "schema": {
  674. "$ref": "#/definitions/api.AuditConnForm"
  675. }
  676. }
  677. ],
  678. "responses": {
  679. "200": {
  680. "description": "OK",
  681. "schema": {
  682. "type": "string"
  683. }
  684. },
  685. "500": {
  686. "description": "Internal Server Error",
  687. "schema": {
  688. "$ref": "#/definitions/response.Response"
  689. }
  690. }
  691. }
  692. }
  693. },
  694. "/audit/file": {
  695. "post": {
  696. "description": "审计文件",
  697. "consumes": [
  698. "application/json"
  699. ],
  700. "produces": [
  701. "application/json"
  702. ],
  703. "tags": [
  704. "审计"
  705. ],
  706. "summary": "审计文件",
  707. "parameters": [
  708. {
  709. "description": "审计文件",
  710. "name": "body",
  711. "in": "body",
  712. "required": true,
  713. "schema": {
  714. "$ref": "#/definitions/api.AuditFileForm"
  715. }
  716. }
  717. ],
  718. "responses": {
  719. "200": {
  720. "description": "OK",
  721. "schema": {
  722. "type": "string"
  723. }
  724. },
  725. "500": {
  726. "description": "Internal Server Error",
  727. "schema": {
  728. "$ref": "#/definitions/response.Response"
  729. }
  730. }
  731. }
  732. }
  733. },
  734. "/currentUser": {
  735. "get": {
  736. "security": [
  737. {
  738. "token": []
  739. }
  740. ],
  741. "description": "用户信息",
  742. "consumes": [
  743. "application/json"
  744. ],
  745. "produces": [
  746. "application/json"
  747. ],
  748. "tags": [
  749. "用户"
  750. ],
  751. "summary": "用户信息",
  752. "responses": {
  753. "200": {
  754. "description": "OK",
  755. "schema": {
  756. "$ref": "#/definitions/api.UserPayload"
  757. }
  758. },
  759. "500": {
  760. "description": "Internal Server Error",
  761. "schema": {
  762. "$ref": "#/definitions/response.Response"
  763. }
  764. }
  765. }
  766. }
  767. },
  768. "/heartbeat": {
  769. "post": {
  770. "description": "心跳",
  771. "consumes": [
  772. "application/json"
  773. ],
  774. "produces": [
  775. "application/json"
  776. ],
  777. "tags": [
  778. "首页"
  779. ],
  780. "summary": "心跳",
  781. "responses": {
  782. "200": {
  783. "description": "OK"
  784. },
  785. "500": {
  786. "description": "Internal Server Error",
  787. "schema": {
  788. "$ref": "#/definitions/response.Response"
  789. }
  790. }
  791. }
  792. }
  793. },
  794. "/login": {
  795. "post": {
  796. "description": "登录",
  797. "consumes": [
  798. "application/json"
  799. ],
  800. "produces": [
  801. "application/json"
  802. ],
  803. "tags": [
  804. "登录"
  805. ],
  806. "summary": "登录",
  807. "parameters": [
  808. {
  809. "description": "登录表单",
  810. "name": "body",
  811. "in": "body",
  812. "required": true,
  813. "schema": {
  814. "$ref": "#/definitions/api.LoginForm"
  815. }
  816. }
  817. ],
  818. "responses": {
  819. "200": {
  820. "description": "OK",
  821. "schema": {
  822. "$ref": "#/definitions/api.LoginRes"
  823. }
  824. },
  825. "500": {
  826. "description": "Internal Server Error",
  827. "schema": {
  828. "$ref": "#/definitions/response.ErrorResponse"
  829. }
  830. }
  831. }
  832. }
  833. },
  834. "/login-options": {
  835. "get": {
  836. "description": "登录选项",
  837. "consumes": [
  838. "application/json"
  839. ],
  840. "produces": [
  841. "application/json"
  842. ],
  843. "tags": [
  844. "登录"
  845. ],
  846. "summary": "登录选项",
  847. "responses": {
  848. "200": {
  849. "description": "OK",
  850. "schema": {
  851. "type": "array",
  852. "items": {
  853. "type": "string"
  854. }
  855. }
  856. },
  857. "500": {
  858. "description": "Internal Server Error",
  859. "schema": {
  860. "$ref": "#/definitions/response.ErrorResponse"
  861. }
  862. }
  863. }
  864. }
  865. },
  866. "/logout": {
  867. "post": {
  868. "description": "登出",
  869. "consumes": [
  870. "application/json"
  871. ],
  872. "produces": [
  873. "application/json"
  874. ],
  875. "tags": [
  876. "登录"
  877. ],
  878. "summary": "登出",
  879. "responses": {
  880. "200": {
  881. "description": "OK",
  882. "schema": {
  883. "type": "string"
  884. }
  885. },
  886. "500": {
  887. "description": "Internal Server Error",
  888. "schema": {
  889. "$ref": "#/definitions/response.ErrorResponse"
  890. }
  891. }
  892. }
  893. }
  894. },
  895. "/oauth/callback": {
  896. "get": {
  897. "description": "OauthCallback",
  898. "consumes": [
  899. "application/json"
  900. ],
  901. "produces": [
  902. "application/json"
  903. ],
  904. "tags": [
  905. "Oauth"
  906. ],
  907. "summary": "OauthCallback",
  908. "responses": {
  909. "200": {
  910. "description": "OK",
  911. "schema": {
  912. "$ref": "#/definitions/api.LoginRes"
  913. }
  914. },
  915. "500": {
  916. "description": "Internal Server Error",
  917. "schema": {
  918. "$ref": "#/definitions/response.ErrorResponse"
  919. }
  920. }
  921. }
  922. }
  923. },
  924. "/oidc/auth": {
  925. "post": {
  926. "description": "OidcAuth",
  927. "consumes": [
  928. "application/json"
  929. ],
  930. "produces": [
  931. "application/json"
  932. ],
  933. "tags": [
  934. "Oauth"
  935. ],
  936. "summary": "OidcAuth",
  937. "responses": {
  938. "200": {
  939. "description": "OK",
  940. "schema": {
  941. "$ref": "#/definitions/api.LoginRes"
  942. }
  943. },
  944. "500": {
  945. "description": "Internal Server Error",
  946. "schema": {
  947. "$ref": "#/definitions/response.ErrorResponse"
  948. }
  949. }
  950. }
  951. }
  952. },
  953. "/oidc/auth-query": {
  954. "get": {
  955. "description": "OidcAuthQuery",
  956. "consumes": [
  957. "application/json"
  958. ],
  959. "produces": [
  960. "application/json"
  961. ],
  962. "tags": [
  963. "Oauth"
  964. ],
  965. "summary": "OidcAuthQuery",
  966. "responses": {
  967. "200": {
  968. "description": "OK",
  969. "schema": {
  970. "$ref": "#/definitions/api.LoginRes"
  971. }
  972. },
  973. "500": {
  974. "description": "Internal Server Error",
  975. "schema": {
  976. "$ref": "#/definitions/response.ErrorResponse"
  977. }
  978. }
  979. }
  980. }
  981. },
  982. "/peers": {
  983. "get": {
  984. "security": [
  985. {
  986. "BearerAuth": []
  987. }
  988. ],
  989. "description": "机器",
  990. "consumes": [
  991. "application/json"
  992. ],
  993. "produces": [
  994. "application/json"
  995. ],
  996. "tags": [
  997. "群组"
  998. ],
  999. "summary": "机器",
  1000. "parameters": [
  1001. {
  1002. "type": "integer",
  1003. "description": "页码",
  1004. "name": "page",
  1005. "in": "query"
  1006. },
  1007. {
  1008. "type": "integer",
  1009. "description": "每页数量",
  1010. "name": "pageSize",
  1011. "in": "query"
  1012. },
  1013. {
  1014. "type": "integer",
  1015. "description": "状态",
  1016. "name": "status",
  1017. "in": "query"
  1018. },
  1019. {
  1020. "type": "string",
  1021. "description": "accessible",
  1022. "name": "accessible",
  1023. "in": "query"
  1024. }
  1025. ],
  1026. "responses": {
  1027. "200": {
  1028. "description": "OK",
  1029. "schema": {
  1030. "$ref": "#/definitions/response.DataResponse"
  1031. }
  1032. },
  1033. "500": {
  1034. "description": "Internal Server Error",
  1035. "schema": {
  1036. "$ref": "#/definitions/response.Response"
  1037. }
  1038. }
  1039. }
  1040. }
  1041. },
  1042. "/server-config": {
  1043. "get": {
  1044. "security": [
  1045. {
  1046. "token": []
  1047. }
  1048. ],
  1049. "description": "服务配置,给webclient提供api-server",
  1050. "consumes": [
  1051. "application/json"
  1052. ],
  1053. "produces": [
  1054. "application/json"
  1055. ],
  1056. "tags": [
  1057. "WEBCLIENT"
  1058. ],
  1059. "summary": "服务配置",
  1060. "responses": {
  1061. "200": {
  1062. "description": "OK",
  1063. "schema": {
  1064. "$ref": "#/definitions/response.Response"
  1065. }
  1066. },
  1067. "500": {
  1068. "description": "Internal Server Error",
  1069. "schema": {
  1070. "$ref": "#/definitions/response.Response"
  1071. }
  1072. }
  1073. }
  1074. }
  1075. },
  1076. "/server-config-v2": {
  1077. "get": {
  1078. "security": [
  1079. {
  1080. "token": []
  1081. }
  1082. ],
  1083. "description": "服务配置,给webclient提供api-server",
  1084. "consumes": [
  1085. "application/json"
  1086. ],
  1087. "produces": [
  1088. "application/json"
  1089. ],
  1090. "tags": [
  1091. "WEBCLIENT_V2"
  1092. ],
  1093. "summary": "服务配置",
  1094. "responses": {
  1095. "200": {
  1096. "description": "OK",
  1097. "schema": {
  1098. "$ref": "#/definitions/response.Response"
  1099. }
  1100. },
  1101. "500": {
  1102. "description": "Internal Server Error",
  1103. "schema": {
  1104. "$ref": "#/definitions/response.Response"
  1105. }
  1106. }
  1107. }
  1108. }
  1109. },
  1110. "/shared-peer": {
  1111. "post": {
  1112. "description": "分享的peer",
  1113. "consumes": [
  1114. "application/json"
  1115. ],
  1116. "produces": [
  1117. "application/json"
  1118. ],
  1119. "tags": [
  1120. "WEBCLIENT"
  1121. ],
  1122. "summary": "分享的peer",
  1123. "responses": {
  1124. "200": {
  1125. "description": "OK",
  1126. "schema": {
  1127. "$ref": "#/definitions/response.Response"
  1128. }
  1129. },
  1130. "500": {
  1131. "description": "Internal Server Error",
  1132. "schema": {
  1133. "$ref": "#/definitions/response.Response"
  1134. }
  1135. }
  1136. }
  1137. }
  1138. },
  1139. "/sysinfo": {
  1140. "post": {
  1141. "description": "提交系统信息",
  1142. "consumes": [
  1143. "application/json"
  1144. ],
  1145. "produces": [
  1146. "application/json"
  1147. ],
  1148. "tags": [
  1149. "地址"
  1150. ],
  1151. "summary": "提交系统信息",
  1152. "parameters": [
  1153. {
  1154. "description": "系统信息表单",
  1155. "name": "body",
  1156. "in": "body",
  1157. "required": true,
  1158. "schema": {
  1159. "$ref": "#/definitions/api.PeerForm"
  1160. }
  1161. }
  1162. ],
  1163. "responses": {
  1164. "200": {
  1165. "description": "SYSINFO_UPDATED,ID_NOT_FOUND",
  1166. "schema": {
  1167. "type": "string"
  1168. }
  1169. },
  1170. "500": {
  1171. "description": "Internal Server Error",
  1172. "schema": {
  1173. "$ref": "#/definitions/response.ErrorResponse"
  1174. }
  1175. }
  1176. }
  1177. }
  1178. },
  1179. "/users": {
  1180. "get": {
  1181. "security": [
  1182. {
  1183. "BearerAuth": []
  1184. }
  1185. ],
  1186. "description": "用户列表",
  1187. "consumes": [
  1188. "application/json"
  1189. ],
  1190. "produces": [
  1191. "application/json"
  1192. ],
  1193. "tags": [
  1194. "群组"
  1195. ],
  1196. "summary": "用户列表",
  1197. "parameters": [
  1198. {
  1199. "type": "integer",
  1200. "description": "页码",
  1201. "name": "page",
  1202. "in": "query"
  1203. },
  1204. {
  1205. "type": "integer",
  1206. "description": "每页数量",
  1207. "name": "pageSize",
  1208. "in": "query"
  1209. },
  1210. {
  1211. "type": "integer",
  1212. "description": "状态",
  1213. "name": "status",
  1214. "in": "query"
  1215. },
  1216. {
  1217. "type": "string",
  1218. "description": "accessible",
  1219. "name": "accessible",
  1220. "in": "query"
  1221. }
  1222. ],
  1223. "responses": {
  1224. "200": {
  1225. "description": "OK",
  1226. "schema": {
  1227. "allOf": [
  1228. {
  1229. "$ref": "#/definitions/response.DataResponse"
  1230. },
  1231. {
  1232. "type": "object",
  1233. "properties": {
  1234. "data": {
  1235. "type": "array",
  1236. "items": {
  1237. "$ref": "#/definitions/api.UserPayload"
  1238. }
  1239. }
  1240. }
  1241. }
  1242. ]
  1243. }
  1244. },
  1245. "500": {
  1246. "description": "Internal Server Error",
  1247. "schema": {
  1248. "$ref": "#/definitions/response.ErrorResponse"
  1249. }
  1250. }
  1251. }
  1252. }
  1253. }
  1254. },
  1255. "definitions": {
  1256. "api.AddressBookForm": {
  1257. "type": "object",
  1258. "properties": {
  1259. "data": {
  1260. "type": "string",
  1261. "example": "{\"tags\":[\"tag1\",\"tag2\",\"tag3\"],\"peers\":[{\"id\":\"abc\",\"username\":\"abv-l\",\"hostname\":\"\",\"platform\":\"Windows\",\"alias\":\"\",\"tags\":[\"tag1\",\"tag2\"],\"hash\":\"hash\"}],\"tag_colors\":\"{\\\"tag1\\\":4288585374,\\\"tag2\\\":4278238420,\\\"tag3\\\":4291681337}\"}"
  1262. }
  1263. }
  1264. },
  1265. "api.AuditConnForm": {
  1266. "type": "object",
  1267. "properties": {
  1268. "action": {
  1269. "type": "string"
  1270. },
  1271. "conn_id": {
  1272. "type": "integer"
  1273. },
  1274. "id": {
  1275. "type": "string"
  1276. },
  1277. "ip": {
  1278. "type": "string"
  1279. },
  1280. "peer": {
  1281. "type": "array",
  1282. "items": {
  1283. "type": "string"
  1284. }
  1285. },
  1286. "session_id": {
  1287. "type": "number"
  1288. },
  1289. "type": {
  1290. "type": "integer"
  1291. },
  1292. "uuid": {
  1293. "type": "string"
  1294. }
  1295. }
  1296. },
  1297. "api.AuditFileForm": {
  1298. "type": "object",
  1299. "properties": {
  1300. "id": {
  1301. "type": "string"
  1302. },
  1303. "info": {
  1304. "type": "string"
  1305. },
  1306. "is_file": {
  1307. "type": "boolean"
  1308. },
  1309. "path": {
  1310. "type": "string"
  1311. },
  1312. "peer_id": {
  1313. "type": "string"
  1314. },
  1315. "type": {
  1316. "type": "integer"
  1317. },
  1318. "uuid": {
  1319. "type": "string"
  1320. }
  1321. }
  1322. },
  1323. "api.DeviceInfoInLogin": {
  1324. "type": "object",
  1325. "properties": {
  1326. "name": {
  1327. "type": "string"
  1328. },
  1329. "os": {
  1330. "type": "string"
  1331. },
  1332. "type": {
  1333. "type": "string"
  1334. }
  1335. }
  1336. },
  1337. "api.LoginForm": {
  1338. "type": "object",
  1339. "required": [
  1340. "username"
  1341. ],
  1342. "properties": {
  1343. "autoLogin": {
  1344. "type": "boolean"
  1345. },
  1346. "deviceInfo": {
  1347. "$ref": "#/definitions/api.DeviceInfoInLogin"
  1348. },
  1349. "id": {
  1350. "type": "string"
  1351. },
  1352. "password": {
  1353. "type": "string",
  1354. "maxLength": 32,
  1355. "minLength": 4
  1356. },
  1357. "type": {
  1358. "type": "string"
  1359. },
  1360. "username": {
  1361. "type": "string",
  1362. "maxLength": 32,
  1363. "minLength": 2
  1364. },
  1365. "uuid": {
  1366. "type": "string"
  1367. }
  1368. }
  1369. },
  1370. "api.LoginRes": {
  1371. "type": "object",
  1372. "properties": {
  1373. "access_token": {
  1374. "type": "string"
  1375. },
  1376. "secret": {
  1377. "type": "string"
  1378. },
  1379. "tfa_type": {
  1380. "type": "string"
  1381. },
  1382. "type": {
  1383. "type": "string"
  1384. },
  1385. "user": {
  1386. "$ref": "#/definitions/api.UserPayload"
  1387. }
  1388. }
  1389. },
  1390. "api.PeerForm": {
  1391. "type": "object",
  1392. "properties": {
  1393. "cpu": {
  1394. "type": "string"
  1395. },
  1396. "hostname": {
  1397. "type": "string"
  1398. },
  1399. "id": {
  1400. "type": "string"
  1401. },
  1402. "memory": {
  1403. "type": "string"
  1404. },
  1405. "os": {
  1406. "type": "string"
  1407. },
  1408. "username": {
  1409. "type": "string"
  1410. },
  1411. "uuid": {
  1412. "type": "string"
  1413. },
  1414. "version": {
  1415. "type": "string"
  1416. }
  1417. }
  1418. },
  1419. "api.UserPayload": {
  1420. "type": "object",
  1421. "properties": {
  1422. "email": {
  1423. "type": "string"
  1424. },
  1425. "info": {
  1426. "type": "object",
  1427. "additionalProperties": true
  1428. },
  1429. "is_admin": {
  1430. "type": "boolean"
  1431. },
  1432. "name": {
  1433. "type": "string"
  1434. },
  1435. "note": {
  1436. "type": "string"
  1437. },
  1438. "status": {
  1439. "type": "integer"
  1440. }
  1441. }
  1442. },
  1443. "model.AddressBookCollection": {
  1444. "type": "object",
  1445. "required": [
  1446. "name"
  1447. ],
  1448. "properties": {
  1449. "created_at": {
  1450. "type": "string"
  1451. },
  1452. "id": {
  1453. "type": "integer"
  1454. },
  1455. "name": {
  1456. "type": "string"
  1457. },
  1458. "updated_at": {
  1459. "type": "string"
  1460. },
  1461. "user_id": {
  1462. "type": "integer"
  1463. }
  1464. }
  1465. },
  1466. "model.Tag": {
  1467. "type": "object",
  1468. "properties": {
  1469. "collection": {
  1470. "$ref": "#/definitions/model.AddressBookCollection"
  1471. },
  1472. "collection_id": {
  1473. "type": "integer"
  1474. },
  1475. "color": {
  1476. "description": "color 是flutter的颜色值,从0x00000000 到 0xFFFFFFFF; 前两位表示透明度,后面6位表示颜色, 可以转成rgba",
  1477. "type": "integer"
  1478. },
  1479. "created_at": {
  1480. "type": "string"
  1481. },
  1482. "id": {
  1483. "type": "integer"
  1484. },
  1485. "name": {
  1486. "type": "string"
  1487. },
  1488. "updated_at": {
  1489. "type": "string"
  1490. },
  1491. "user_id": {
  1492. "type": "integer"
  1493. }
  1494. }
  1495. },
  1496. "model.TagList": {
  1497. "type": "object",
  1498. "properties": {
  1499. "list": {
  1500. "type": "array",
  1501. "items": {
  1502. "$ref": "#/definitions/model.Tag"
  1503. }
  1504. },
  1505. "page": {
  1506. "type": "integer"
  1507. },
  1508. "page_size": {
  1509. "type": "integer"
  1510. },
  1511. "total": {
  1512. "type": "integer"
  1513. }
  1514. }
  1515. },
  1516. "response.DataResponse": {
  1517. "type": "object",
  1518. "properties": {
  1519. "data": {},
  1520. "total": {
  1521. "type": "integer"
  1522. }
  1523. }
  1524. },
  1525. "response.ErrorResponse": {
  1526. "type": "object",
  1527. "properties": {
  1528. "error": {
  1529. "type": "string"
  1530. }
  1531. }
  1532. },
  1533. "response.Response": {
  1534. "type": "object",
  1535. "properties": {
  1536. "code": {
  1537. "type": "integer"
  1538. },
  1539. "data": {},
  1540. "message": {
  1541. "type": "string"
  1542. }
  1543. }
  1544. }
  1545. },
  1546. "securityDefinitions": {
  1547. "BearerAuth": {
  1548. "type": "apiKey",
  1549. "name": "Authorization",
  1550. "in": "header"
  1551. },
  1552. "token": {
  1553. "type": "apiKey",
  1554. "name": "api-token",
  1555. "in": "header"
  1556. }
  1557. }
  1558. }`
  1559. // SwaggerInfoapi holds exported Swagger Info so clients can modify it
  1560. var SwaggerInfoapi = &swag.Spec{
  1561. Version: "1.0",
  1562. Host: "",
  1563. BasePath: "/api",
  1564. Schemes: []string{},
  1565. Title: "管理系统API",
  1566. Description: "接口",
  1567. InfoInstanceName: "api",
  1568. SwaggerTemplate: docTemplateapi,
  1569. LeftDelim: "{{",
  1570. RightDelim: "}}",
  1571. }
  1572. func init() {
  1573. swag.Register(SwaggerInfoapi.InstanceName(), SwaggerInfoapi)
  1574. }