user.swagger.json 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. {
  2. "swagger": "2.0",
  3. "info": {
  4. "title": "user.proto",
  5. "version": "version not set"
  6. },
  7. "schemes": [
  8. "http",
  9. "https"
  10. ],
  11. "consumes": [
  12. "application/json"
  13. ],
  14. "produces": [
  15. "application/json"
  16. ],
  17. "paths": {
  18. "/v1/user/create": {
  19. "post": {
  20. "operationId": "Create",
  21. "responses": {
  22. "200": {
  23. "description": "",
  24. "schema": {
  25. "$ref": "#/definitions/pbUserResponse"
  26. }
  27. }
  28. },
  29. "parameters": [
  30. {
  31. "name": "body",
  32. "in": "body",
  33. "required": true,
  34. "schema": {
  35. "$ref": "#/definitions/pbUserCreateRequest"
  36. }
  37. }
  38. ],
  39. "tags": [
  40. "UserService"
  41. ]
  42. }
  43. },
  44. "/v1/user/delete": {
  45. "post": {
  46. "operationId": "Delete",
  47. "responses": {
  48. "200": {
  49. "description": "",
  50. "schema": {
  51. "$ref": "#/definitions/pbUserResponse"
  52. }
  53. }
  54. },
  55. "parameters": [
  56. {
  57. "name": "body",
  58. "in": "body",
  59. "required": true,
  60. "schema": {
  61. "$ref": "#/definitions/pbUserDeleteRequest"
  62. }
  63. }
  64. ],
  65. "tags": [
  66. "UserService"
  67. ]
  68. }
  69. },
  70. "/v1/user/genconfig": {
  71. "post": {
  72. "operationId": "GenConfig",
  73. "responses": {
  74. "200": {
  75. "description": "",
  76. "schema": {
  77. "$ref": "#/definitions/pbUserGenConfigResponse"
  78. }
  79. }
  80. },
  81. "parameters": [
  82. {
  83. "name": "body",
  84. "in": "body",
  85. "required": true,
  86. "schema": {
  87. "$ref": "#/definitions/pbUserGenConfigRequest"
  88. }
  89. }
  90. ],
  91. "tags": [
  92. "UserService"
  93. ]
  94. }
  95. },
  96. "/v1/user/list": {
  97. "post": {
  98. "operationId": "List",
  99. "responses": {
  100. "200": {
  101. "description": "",
  102. "schema": {
  103. "$ref": "#/definitions/pbUserResponse"
  104. }
  105. }
  106. },
  107. "parameters": [
  108. {
  109. "name": "body",
  110. "in": "body",
  111. "required": true,
  112. "schema": {
  113. "$ref": "#/definitions/pbUserListRequest"
  114. }
  115. }
  116. ],
  117. "tags": [
  118. "UserService"
  119. ]
  120. }
  121. },
  122. "/v1/user/renew": {
  123. "post": {
  124. "operationId": "Renew",
  125. "responses": {
  126. "200": {
  127. "description": "",
  128. "schema": {
  129. "$ref": "#/definitions/pbUserResponse"
  130. }
  131. }
  132. },
  133. "parameters": [
  134. {
  135. "name": "body",
  136. "in": "body",
  137. "required": true,
  138. "schema": {
  139. "$ref": "#/definitions/pbUserRenewRequest"
  140. }
  141. }
  142. ],
  143. "tags": [
  144. "UserService"
  145. ]
  146. }
  147. },
  148. "/v1/user/update": {
  149. "post": {
  150. "operationId": "Update",
  151. "responses": {
  152. "200": {
  153. "description": "",
  154. "schema": {
  155. "$ref": "#/definitions/pbUserResponse"
  156. }
  157. }
  158. },
  159. "parameters": [
  160. {
  161. "name": "body",
  162. "in": "body",
  163. "required": true,
  164. "schema": {
  165. "$ref": "#/definitions/pbUserUpdateRequest"
  166. }
  167. }
  168. ],
  169. "tags": [
  170. "UserService"
  171. ]
  172. }
  173. }
  174. },
  175. "definitions": {
  176. "UserResponseUser": {
  177. "type": "object",
  178. "properties": {
  179. "Username": {
  180. "type": "string"
  181. },
  182. "ServerSerialNumber": {
  183. "type": "string"
  184. },
  185. "Cert": {
  186. "type": "string"
  187. },
  188. "CreatedAt": {
  189. "type": "string"
  190. },
  191. "IPNet": {
  192. "type": "string"
  193. },
  194. "NoGW": {
  195. "type": "boolean",
  196. "format": "boolean"
  197. },
  198. "HostID": {
  199. "type": "integer",
  200. "format": "int64"
  201. }
  202. }
  203. },
  204. "UserUpdateRequestGWPref": {
  205. "type": "string",
  206. "enum": [
  207. "NOPREF",
  208. "NOGW",
  209. "GW"
  210. ],
  211. "default": "NOPREF"
  212. },
  213. "UserUpdateRequestStaticPref": {
  214. "type": "string",
  215. "enum": [
  216. "NOPREFSTATIC",
  217. "NOSTATIC",
  218. "STATIC"
  219. ],
  220. "default": "NOPREFSTATIC"
  221. },
  222. "pbUserCreateRequest": {
  223. "type": "object",
  224. "properties": {
  225. "Username": {
  226. "type": "string"
  227. },
  228. "Password": {
  229. "type": "string"
  230. },
  231. "NoGW": {
  232. "type": "boolean",
  233. "format": "boolean"
  234. },
  235. "HostID": {
  236. "type": "integer",
  237. "format": "int64"
  238. }
  239. }
  240. },
  241. "pbUserDeleteRequest": {
  242. "type": "object",
  243. "properties": {
  244. "Username": {
  245. "type": "string"
  246. }
  247. }
  248. },
  249. "pbUserGenConfigRequest": {
  250. "type": "object",
  251. "properties": {
  252. "Username": {
  253. "type": "string"
  254. }
  255. }
  256. },
  257. "pbUserGenConfigResponse": {
  258. "type": "object",
  259. "properties": {
  260. "ClientConfig": {
  261. "type": "string"
  262. }
  263. }
  264. },
  265. "pbUserListRequest": {
  266. "type": "object"
  267. },
  268. "pbUserRenewRequest": {
  269. "type": "object",
  270. "properties": {
  271. "Username": {
  272. "type": "string"
  273. }
  274. }
  275. },
  276. "pbUserResponse": {
  277. "type": "object",
  278. "properties": {
  279. "users": {
  280. "type": "array",
  281. "items": {
  282. "$ref": "#/definitions/UserResponseUser"
  283. }
  284. }
  285. }
  286. },
  287. "pbUserUpdateRequest": {
  288. "type": "object",
  289. "properties": {
  290. "Username": {
  291. "type": "string"
  292. },
  293. "Password": {
  294. "type": "string"
  295. },
  296. "gwpref": {
  297. "$ref": "#/definitions/UserUpdateRequestGWPref"
  298. },
  299. "HostID": {
  300. "type": "integer",
  301. "format": "int64"
  302. },
  303. "staticpref": {
  304. "$ref": "#/definitions/UserUpdateRequestStaticPref"
  305. }
  306. }
  307. }
  308. }
  309. }