openapi.yaml 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336
  1. # Generated with protoc-gen-openapi
  2. # https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
  3. openapi: 3.0.3
  4. info:
  5. title: ""
  6. version: 0.0.1
  7. paths:
  8. /apis/v2/user/alarm-clock/delete:
  9. get:
  10. tags:
  11. - AlarmClock
  12. description: 删除闹钟
  13. operationId: AlarmClock_DeleteAlarmClock
  14. parameters:
  15. - name: id
  16. in: query
  17. description: 闹钟ID
  18. schema:
  19. type: string
  20. responses:
  21. "200":
  22. description: OK
  23. content:
  24. application/json:
  25. schema:
  26. $ref: '#/components/schemas/api.user.v2.DeleteAlarmClockResponse'
  27. /apis/v2/userctx/user/alarm-clock/create:
  28. post:
  29. tags:
  30. - AlarmClock
  31. description: 创建闹钟
  32. operationId: AlarmClock_CreateAlarmClock
  33. requestBody:
  34. content:
  35. application/json:
  36. schema:
  37. $ref: '#/components/schemas/api.user.v2.CreateAlarmClockRequest'
  38. required: true
  39. responses:
  40. "200":
  41. description: OK
  42. content:
  43. application/json:
  44. schema:
  45. $ref: '#/components/schemas/api.user.v2.CreateAlarmClockResponse'
  46. /apis/v2/userctx/user/alarm-clock/getall:
  47. get:
  48. tags:
  49. - AlarmClock
  50. description: 获取闹钟
  51. operationId: AlarmClock_GetAlarmClock
  52. parameters:
  53. - name: cid
  54. in: query
  55. schema:
  56. type: string
  57. responses:
  58. "200":
  59. description: OK
  60. content:
  61. application/json:
  62. schema:
  63. $ref: '#/components/schemas/api.user.v2.GetAlarmClockResponse'
  64. /apis/v2/userctx/user/alarm-clock/update:
  65. post:
  66. tags:
  67. - AlarmClock
  68. description: 修改闹钟
  69. operationId: AlarmClock_UpdateAlarmClock
  70. requestBody:
  71. content:
  72. application/json:
  73. schema:
  74. $ref: '#/components/schemas/api.user.v2.UpdateAlarmClockRequest'
  75. required: true
  76. responses:
  77. "200":
  78. description: OK
  79. content:
  80. application/json:
  81. schema:
  82. $ref: '#/components/schemas/api.user.v2.UpdateAlarmClockResponse'
  83. /apis/v2/userctx/user/child/contacts/create:
  84. post:
  85. tags:
  86. - Contacts
  87. description: 创建联系人
  88. operationId: Contacts_CreateContactPerson
  89. requestBody:
  90. content:
  91. application/json:
  92. schema:
  93. $ref: '#/components/schemas/api.user.v2.CreateContactPersonRequest'
  94. required: true
  95. responses:
  96. "200":
  97. description: OK
  98. content:
  99. application/json:
  100. schema:
  101. $ref: '#/components/schemas/api.user.v2.CreateContactPersonResponse'
  102. /apis/v2/userctx/user/child/contacts/delete:
  103. get:
  104. tags:
  105. - Contacts
  106. description: 删除联系人
  107. operationId: Contacts_DeleteContactPerson
  108. parameters:
  109. - name: id
  110. in: query
  111. schema:
  112. type: string
  113. responses:
  114. "200":
  115. description: OK
  116. content:
  117. application/json:
  118. schema:
  119. $ref: '#/components/schemas/api.user.v2.DeleteContactPersonResponse'
  120. /apis/v2/userctx/user/child/contacts/firend/add:
  121. post:
  122. tags:
  123. - Contacts
  124. description: 添加好友
  125. operationId: Contacts_AddFirend
  126. requestBody:
  127. content:
  128. application/json:
  129. schema:
  130. $ref: '#/components/schemas/api.user.v2.AddFirendRequest'
  131. required: true
  132. responses:
  133. "200":
  134. description: OK
  135. content:
  136. application/json:
  137. schema:
  138. $ref: '#/components/schemas/api.user.v2.AddFirendResponse'
  139. /apis/v2/userctx/user/child/contacts/firend/delete:
  140. delete:
  141. tags:
  142. - Contacts
  143. description: 删除好友
  144. operationId: Contacts_DeleteFirend
  145. parameters:
  146. - name: id
  147. in: query
  148. schema:
  149. type: string
  150. responses:
  151. "200":
  152. description: OK
  153. content:
  154. application/json:
  155. schema:
  156. $ref: '#/components/schemas/api.user.v2.DeleteFirendResponse'
  157. /apis/v2/userctx/user/child/contacts/firend/generate-code:
  158. post:
  159. tags:
  160. - Contacts
  161. description: 生成好友码
  162. operationId: Contacts_GenerateFirendCode
  163. requestBody:
  164. content:
  165. application/json:
  166. schema:
  167. $ref: '#/components/schemas/api.user.v2.GenerateFirendCodeRequest'
  168. required: true
  169. responses:
  170. "200":
  171. description: OK
  172. content:
  173. application/json:
  174. schema:
  175. $ref: '#/components/schemas/api.user.v2.GenerateFirendCodeResponse'
  176. /apis/v2/userctx/user/child/contacts/firend/get:
  177. get:
  178. tags:
  179. - Contacts
  180. description: 好友列表
  181. operationId: Contacts_GetFirend
  182. parameters:
  183. - name: ticket
  184. in: query
  185. schema:
  186. type: string
  187. responses:
  188. "200":
  189. description: OK
  190. content:
  191. application/json:
  192. schema:
  193. $ref: '#/components/schemas/api.user.v2.GetFirendResponse'
  194. /apis/v2/userctx/user/child/contacts/get:
  195. get:
  196. tags:
  197. - Contacts
  198. description: 获取联系人
  199. operationId: Contacts_GetContactPerson
  200. parameters:
  201. - name: cid
  202. in: query
  203. schema:
  204. type: string
  205. responses:
  206. "200":
  207. description: OK
  208. content:
  209. application/json:
  210. schema:
  211. $ref: '#/components/schemas/api.user.v2.GetContactPersonResponse'
  212. /apis/v2/userctx/user/child/contacts/update:
  213. post:
  214. tags:
  215. - Contacts
  216. description: 更新联系人
  217. operationId: Contacts_UpdateContactPerson
  218. requestBody:
  219. content:
  220. application/json:
  221. schema:
  222. $ref: '#/components/schemas/api.user.v2.UpdateContactPersonRequest'
  223. required: true
  224. responses:
  225. "200":
  226. description: OK
  227. content:
  228. application/json:
  229. schema:
  230. $ref: '#/components/schemas/api.user.v2.UpdateContactPersonResponse'
  231. /apis/v2/userctx/user/child/contacts/wristwatch/get:
  232. get:
  233. tags:
  234. - Contacts
  235. description: 手表获取联系人
  236. operationId: Contacts_GetWristwatchContactPerson
  237. parameters:
  238. - name: ticket
  239. in: query
  240. schema:
  241. type: string
  242. responses:
  243. "200":
  244. description: OK
  245. content:
  246. application/json:
  247. schema:
  248. $ref: '#/components/schemas/api.user.v2.GetWristwatchContactPersonResponse'
  249. /apis/v2/userctx/user/child/create:
  250. post:
  251. tags:
  252. - Child
  253. description: 创建新的小孩
  254. operationId: Child_CreateChild
  255. requestBody:
  256. content:
  257. application/json:
  258. schema:
  259. $ref: '#/components/schemas/api.user.v2.CreateChildRequest'
  260. required: true
  261. responses:
  262. "200":
  263. description: OK
  264. content:
  265. application/json:
  266. schema:
  267. $ref: '#/components/schemas/api.user.v2.CreateChildResponse'
  268. /apis/v2/userctx/user/child/delete:
  269. get:
  270. tags:
  271. - Child
  272. description: 删除小孩
  273. operationId: Child_DeleteChild
  274. parameters:
  275. - name: cid
  276. in: query
  277. schema:
  278. type: string
  279. responses:
  280. "200":
  281. description: OK
  282. content:
  283. application/json:
  284. schema:
  285. $ref: '#/components/schemas/api.user.v2.DeleteChildResponse'
  286. /apis/v2/userctx/user/child/device/bind:
  287. post:
  288. tags:
  289. - Device
  290. description: 绑定设备
  291. operationId: Device_DeviceBind
  292. requestBody:
  293. content:
  294. application/json:
  295. schema:
  296. $ref: '#/components/schemas/api.user.v2.DeviceBindRequest'
  297. required: true
  298. responses:
  299. "200":
  300. description: OK
  301. content:
  302. application/json:
  303. schema:
  304. $ref: '#/components/schemas/api.user.v2.DeviceBindResponse'
  305. /apis/v2/userctx/user/child/device/binding:
  306. get:
  307. tags:
  308. - Device
  309. description: 获取设备绑定状态
  310. operationId: Device_DeviceBinding
  311. parameters:
  312. - name: ticket
  313. in: query
  314. schema:
  315. type: string
  316. responses:
  317. "200":
  318. description: OK
  319. content:
  320. application/json:
  321. schema:
  322. $ref: '#/components/schemas/api.user.v2.DeviceBindingResponse'
  323. /apis/v2/userctx/user/child/device/exchange:
  324. get:
  325. tags:
  326. - Device
  327. description: 交换三码
  328. operationId: Device_DeviceExchange
  329. parameters:
  330. - name: hc
  331. in: query
  332. schema:
  333. type: string
  334. responses:
  335. "200":
  336. description: OK
  337. content:
  338. application/json:
  339. schema:
  340. $ref: '#/components/schemas/api.user.v2.DeviceExchangeResponse'
  341. /apis/v2/userctx/user/child/device/unbind:
  342. post:
  343. tags:
  344. - Device
  345. description: 解绑设备
  346. operationId: Device_DeviceUnbind
  347. requestBody:
  348. content:
  349. application/json:
  350. schema:
  351. $ref: '#/components/schemas/api.user.v2.DeviceUnbindRequest'
  352. required: true
  353. responses:
  354. "200":
  355. description: OK
  356. content:
  357. application/json:
  358. schema:
  359. $ref: '#/components/schemas/api.user.v2.DeviceUnbindResponse'
  360. /apis/v2/userctx/user/child/get:
  361. get:
  362. tags:
  363. - Child
  364. description: 获取用户自己的小孩列表
  365. operationId: Child_GetChild
  366. responses:
  367. "200":
  368. description: OK
  369. content:
  370. application/json:
  371. schema:
  372. $ref: '#/components/schemas/api.user.v2.GetChildResponse'
  373. /apis/v2/userctx/user/child/school-disable/create:
  374. post:
  375. tags:
  376. - SchoolDisable
  377. description: 创建上课禁用
  378. operationId: SchoolDisable_CreateSchoolDisable
  379. requestBody:
  380. content:
  381. application/json:
  382. schema:
  383. $ref: '#/components/schemas/api.user.v2.CreateSchoolDisableRequest'
  384. required: true
  385. responses:
  386. "200":
  387. description: OK
  388. content:
  389. application/json:
  390. schema:
  391. $ref: '#/components/schemas/api.user.v2.CreateSchoolDisableResponse'
  392. /apis/v2/userctx/user/child/school-disable/delete:
  393. get:
  394. tags:
  395. - SchoolDisable
  396. description: 删除上课禁用
  397. operationId: SchoolDisable_DeleteSchoolDisable
  398. parameters:
  399. - name: id
  400. in: query
  401. schema:
  402. type: string
  403. responses:
  404. "200":
  405. description: OK
  406. content:
  407. application/json:
  408. schema:
  409. $ref: '#/components/schemas/api.user.v2.DeleteSchoolDisableResponse'
  410. /apis/v2/userctx/user/child/school-disable/get:
  411. get:
  412. tags:
  413. - SchoolDisable
  414. description: 获取上课禁用
  415. operationId: SchoolDisable_GetSchoolDisable
  416. parameters:
  417. - name: cid
  418. in: query
  419. schema:
  420. type: string
  421. responses:
  422. "200":
  423. description: OK
  424. content:
  425. application/json:
  426. schema:
  427. $ref: '#/components/schemas/api.user.v2.GetSchoolDisableResponse'
  428. /apis/v2/userctx/user/child/school-disable/update:
  429. post:
  430. tags:
  431. - SchoolDisable
  432. description: 更新上课禁用
  433. operationId: SchoolDisable_UpdateSchoolDisable
  434. requestBody:
  435. content:
  436. application/json:
  437. schema:
  438. $ref: '#/components/schemas/api.user.v2.UpdateSchoolDisableRequest'
  439. required: true
  440. responses:
  441. "200":
  442. description: OK
  443. content:
  444. application/json:
  445. schema:
  446. $ref: '#/components/schemas/api.user.v2.UpdateSchoolDisableResponse'
  447. /apis/v2/userctx/user/child/school-disable/wristwatch/get:
  448. get:
  449. tags:
  450. - SchoolDisable
  451. description: 手表获取上课禁用
  452. operationId: SchoolDisable_GetWristwatchSchoolDisable
  453. parameters:
  454. - name: ticket
  455. in: query
  456. schema:
  457. type: string
  458. responses:
  459. "200":
  460. description: OK
  461. content:
  462. application/json:
  463. schema:
  464. $ref: '#/components/schemas/api.user.v2.GetWristwatchSchoolDisableResponse'
  465. /apis/v2/userctx/user/child/update:
  466. post:
  467. tags:
  468. - Child
  469. description: 更新小孩信息
  470. operationId: Child_UpdateChild
  471. requestBody:
  472. content:
  473. application/json:
  474. schema:
  475. $ref: '#/components/schemas/api.user.v2.UpdateChildRequest'
  476. required: true
  477. responses:
  478. "200":
  479. description: OK
  480. content:
  481. application/json:
  482. schema:
  483. $ref: '#/components/schemas/api.user.v2.UpdateChildResponse'
  484. /apis/v2/userctx/user/reset-password:
  485. post:
  486. tags:
  487. - User
  488. description: 重设密码
  489. operationId: User_ResetPassword
  490. requestBody:
  491. content:
  492. application/json:
  493. schema:
  494. $ref: '#/components/schemas/api.user.v2.ResetPasswordRequest'
  495. required: true
  496. responses:
  497. "200":
  498. description: OK
  499. content:
  500. application/json:
  501. schema:
  502. $ref: '#/components/schemas/api.user.v2.ResetPasswordResponse'
  503. /apis/v2/userctx/user/retrieve-password:
  504. post:
  505. tags:
  506. - User
  507. description: 找回密码
  508. operationId: User_RetrievePassword
  509. requestBody:
  510. content:
  511. application/json:
  512. schema:
  513. $ref: '#/components/schemas/api.user.v2.RetrievePasswordRequest'
  514. required: true
  515. responses:
  516. "200":
  517. description: OK
  518. content:
  519. application/json:
  520. schema:
  521. $ref: '#/components/schemas/api.user.v2.RetrievePasswordResponse'
  522. /apis/v2/userctx/user/sign-in:
  523. post:
  524. tags:
  525. - User
  526. description: 登录
  527. operationId: User_SignIn
  528. requestBody:
  529. content:
  530. application/json:
  531. schema:
  532. $ref: '#/components/schemas/api.user.v2.SignInRequest'
  533. required: true
  534. responses:
  535. "200":
  536. description: OK
  537. content:
  538. application/json:
  539. schema:
  540. $ref: '#/components/schemas/api.user.v2.SignInResponse'
  541. /apis/v2/userctx/user/sign-up:
  542. post:
  543. tags:
  544. - User
  545. description: 注册
  546. operationId: User_SignUp
  547. requestBody:
  548. content:
  549. application/json:
  550. schema:
  551. $ref: '#/components/schemas/api.user.v2.SignUpRequest'
  552. required: true
  553. responses:
  554. "200":
  555. description: OK
  556. content:
  557. application/json:
  558. schema:
  559. $ref: '#/components/schemas/api.user.v2.SignUpResponse'
  560. /apis/v2/userctx/user/sms-code:
  561. post:
  562. tags:
  563. - User
  564. description: 短信验证码
  565. operationId: User_SMSCode
  566. requestBody:
  567. content:
  568. application/json:
  569. schema:
  570. $ref: '#/components/schemas/api.user.v2.SMSCodeRequest'
  571. required: true
  572. responses:
  573. "200":
  574. description: OK
  575. content:
  576. application/json:
  577. schema:
  578. $ref: '#/components/schemas/api.user.v2.SMSCodeResponse'
  579. /apis/v2/userctx/user/unregister:
  580. post:
  581. tags:
  582. - User
  583. description: 注销
  584. operationId: User_Unregister
  585. requestBody:
  586. content:
  587. application/json:
  588. schema:
  589. $ref: '#/components/schemas/api.user.v2.UnregisterRequest'
  590. required: true
  591. responses:
  592. "200":
  593. description: OK
  594. content:
  595. application/json:
  596. schema:
  597. $ref: '#/components/schemas/api.user.v2.UnregisterResponse'
  598. /apis/v2/userctx/user/wristwatch/alarm-clock/get:
  599. get:
  600. tags:
  601. - AlarmClock
  602. description: 手表获取闹钟
  603. operationId: AlarmClock_GetWristwatchAlarmClock
  604. parameters:
  605. - name: ticket
  606. in: query
  607. schema:
  608. type: string
  609. responses:
  610. "200":
  611. description: OK
  612. content:
  613. application/json:
  614. schema:
  615. $ref: '#/components/schemas/api.user.v2.GetWristwatchAlarmClockResponse'
  616. components:
  617. schemas:
  618. api.user.v2.AddFirendRequest:
  619. type: object
  620. properties:
  621. code:
  622. type: string
  623. description: 添加好友 Request
  624. api.user.v2.AddFirendResponse:
  625. type: object
  626. properties: {}
  627. description: 添加好友 Response
  628. api.user.v2.CreateAlarmClockRequest:
  629. type: object
  630. properties:
  631. cid:
  632. type: string
  633. description: 小孩ID
  634. label:
  635. type: string
  636. description: 闹钟标签
  637. repeats:
  638. type: string
  639. description: '重复天 eg: 1000000 周一开启 1111100 工作日开启'
  640. time:
  641. type: string
  642. description: 'Time 闹钟时间 格式: HH:mm'
  643. onceTime:
  644. type: string
  645. description: 仅一次时间戳
  646. status:
  647. type: boolean
  648. description: 是否开启
  649. description: 创建闹钟 Request
  650. api.user.v2.CreateAlarmClockResponse:
  651. type: object
  652. properties: {}
  653. description: 创建闹钟 Response
  654. api.user.v2.CreateChildRequest:
  655. type: object
  656. properties:
  657. name:
  658. type: string
  659. description: 小孩姓名
  660. phoneNumber:
  661. type: string
  662. description: 小孩电话
  663. areaCode:
  664. type: string
  665. description: 小孩电话区号
  666. avatar:
  667. type: string
  668. description: 小孩头像
  669. birthday:
  670. type: string
  671. description: 小孩生日
  672. appellation:
  673. type: string
  674. description: 小孩对自己的称谓
  675. gender:
  676. type: integer
  677. description: 小孩性别
  678. format: enum
  679. weight:
  680. type: integer
  681. description: 小孩体重
  682. format: int32
  683. height:
  684. type: integer
  685. description: 小孩身高
  686. format: int32
  687. api.user.v2.CreateChildResponse:
  688. type: object
  689. properties:
  690. cid:
  691. type: string
  692. api.user.v2.CreateContactPersonRequest:
  693. type: object
  694. properties:
  695. avatar:
  696. type: string
  697. phoneNumber:
  698. type: string
  699. areaCode:
  700. type: string
  701. appellation:
  702. type: string
  703. description: 小孩对自己的称谓
  704. role:
  705. type: integer
  706. format: enum
  707. cid:
  708. type: string
  709. description: 创建联系人 Request
  710. api.user.v2.CreateContactPersonResponse:
  711. type: object
  712. properties: {}
  713. description: 创建联系人 Response
  714. api.user.v2.CreateSchoolDisableRequest:
  715. type: object
  716. properties:
  717. cid:
  718. type: string
  719. repeats:
  720. type: string
  721. startTime:
  722. type: string
  723. endTime:
  724. type: string
  725. status:
  726. type: boolean
  727. description: 创建上课禁用 Request
  728. api.user.v2.CreateSchoolDisableResponse:
  729. type: object
  730. properties:
  731. id:
  732. type: string
  733. description: 创建上课禁用 Response
  734. api.user.v2.DeleteAlarmClockResponse:
  735. type: object
  736. properties: {}
  737. description: 删除闹钟 Response
  738. api.user.v2.DeleteChildResponse:
  739. type: object
  740. properties: {}
  741. api.user.v2.DeleteContactPersonResponse:
  742. type: object
  743. properties: {}
  744. description: 删除联系人 Response
  745. api.user.v2.DeleteFirendResponse:
  746. type: object
  747. properties: {}
  748. description: 删除好友 Response
  749. api.user.v2.DeleteSchoolDisableResponse:
  750. type: object
  751. properties: {}
  752. description: 删除上课禁用 Response
  753. api.user.v2.DeviceBindRequest:
  754. type: object
  755. properties:
  756. cid:
  757. type: string
  758. ticket:
  759. type: string
  760. description: 绑定设备 Request
  761. api.user.v2.DeviceBindResponse:
  762. type: object
  763. properties: {}
  764. description: 绑定设备 Response
  765. api.user.v2.DeviceBindingResponse:
  766. type: object
  767. properties:
  768. isBind:
  769. type: boolean
  770. description: 是否被绑定
  771. cid:
  772. type: string
  773. description: 被绑定的小孩ID
  774. token:
  775. type: string
  776. description: |-
  777. 设备的 accessToken
  778. 后续接口需要通过这个来进行交互
  779. weight:
  780. type: integer
  781. description: 体重
  782. format: int32
  783. height:
  784. type: integer
  785. description: 身高
  786. format: int32
  787. description: 获取设备绑定状态 Response
  788. api.user.v2.DeviceExchangeResponse:
  789. type: object
  790. properties:
  791. ticket:
  792. type: string
  793. description: |-
  794. ticket 用于生成设备绑定二维码使用
  795. 在连接 temp websocket 时也会用到
  796. aseKey:
  797. type: string
  798. hc:
  799. type: string
  800. activationTime:
  801. type: string
  802. description: 设备激活时间
  803. api.user.v2.DeviceUnbindRequest:
  804. type: object
  805. properties:
  806. cid:
  807. type: string
  808. ticket:
  809. type: string
  810. description: 解绑设备
  811. api.user.v2.DeviceUnbindResponse:
  812. type: object
  813. properties: {}
  814. description: 解绑设备
  815. api.user.v2.GenerateFirendCodeRequest:
  816. type: object
  817. properties:
  818. ticket:
  819. type: string
  820. description: 生成好友码 Request
  821. api.user.v2.GenerateFirendCodeResponse:
  822. type: object
  823. properties:
  824. code:
  825. type: string
  826. description: 生成好友码 Response
  827. api.user.v2.GetAlarmClockResponse:
  828. type: object
  829. properties:
  830. alarmClocks:
  831. type: array
  832. items:
  833. $ref: '#/components/schemas/api.user.v2.GetAlarmClockResponse_AlarmClock'
  834. description: 获取闹钟 Response
  835. api.user.v2.GetAlarmClockResponse_AlarmClock:
  836. type: object
  837. properties:
  838. cid:
  839. type: string
  840. label:
  841. type: string
  842. repeats:
  843. type: string
  844. time:
  845. type: string
  846. onceTime:
  847. type: string
  848. id:
  849. type: string
  850. status:
  851. type: boolean
  852. api.user.v2.GetChildResponse:
  853. type: object
  854. properties:
  855. childList:
  856. type: array
  857. items:
  858. $ref: '#/components/schemas/api.user.v2.GetChildResponse_Child'
  859. api.user.v2.GetChildResponse_Child:
  860. type: object
  861. properties:
  862. cid:
  863. type: string
  864. description: 小孩ID
  865. stepCount:
  866. type: integer
  867. format: int32
  868. name:
  869. type: string
  870. avatar:
  871. type: string
  872. device:
  873. allOf:
  874. - $ref: '#/components/schemas/api.user.v2.GetChildResponse_Device'
  875. description: 绑定的设备
  876. lastLocation:
  877. allOf:
  878. - $ref: '#/components/schemas/api.user.v2.GetChildResponse_Location'
  879. description: 最后一次位置
  880. api.user.v2.GetChildResponse_Device:
  881. type: object
  882. properties:
  883. did:
  884. type: string
  885. battery:
  886. type: integer
  887. format: int32
  888. signal:
  889. type: integer
  890. format: int32
  891. signalMax:
  892. type: integer
  893. format: int32
  894. ticket:
  895. type: string
  896. api.user.v2.GetChildResponse_Location:
  897. type: object
  898. properties:
  899. latitude:
  900. type: string
  901. longitude:
  902. type: string
  903. positionTime:
  904. type: string
  905. radius:
  906. type: integer
  907. format: int32
  908. pointType:
  909. type: integer
  910. format: enum
  911. api.user.v2.GetContactPersonResponse:
  912. type: object
  913. properties:
  914. persons:
  915. type: array
  916. items:
  917. $ref: '#/components/schemas/api.user.v2.GetContactPersonResponse_Person'
  918. description: 获取联系人 Response
  919. api.user.v2.GetContactPersonResponse_Person:
  920. type: object
  921. properties:
  922. id:
  923. type: string
  924. avatar:
  925. type: string
  926. phoneNumber:
  927. type: string
  928. areaCode:
  929. type: string
  930. appellation:
  931. type: string
  932. role:
  933. type: integer
  934. format: enum
  935. api.user.v2.GetFirendResponse:
  936. type: object
  937. properties:
  938. firends:
  939. type: array
  940. items:
  941. $ref: '#/components/schemas/api.user.v2.GetFirendResponse_Firend'
  942. description: 好友列表 Response
  943. api.user.v2.GetFirendResponse_Firend:
  944. type: object
  945. properties:
  946. id:
  947. type: string
  948. ticket:
  949. type: string
  950. name:
  951. type: string
  952. api.user.v2.GetSchoolDisableResponse:
  953. type: object
  954. properties:
  955. schoolDisables:
  956. type: array
  957. items:
  958. $ref: '#/components/schemas/api.user.v2.GetSchoolDisableResponse_SchoolDisable'
  959. description: 获取上课禁用 Response
  960. api.user.v2.GetSchoolDisableResponse_SchoolDisable:
  961. type: object
  962. properties:
  963. cid:
  964. type: string
  965. repeats:
  966. type: string
  967. startTime:
  968. type: string
  969. endTime:
  970. type: string
  971. status:
  972. type: boolean
  973. id:
  974. type: string
  975. api.user.v2.GetWristwatchAlarmClockResponse:
  976. type: object
  977. properties:
  978. alarmClocks:
  979. type: array
  980. items:
  981. $ref: '#/components/schemas/api.user.v2.GetWristwatchAlarmClockResponse_AlarmClock'
  982. description: 手表获取闹钟 Response
  983. api.user.v2.GetWristwatchAlarmClockResponse_AlarmClock:
  984. type: object
  985. properties:
  986. cid:
  987. type: string
  988. label:
  989. type: string
  990. repeats:
  991. type: string
  992. time:
  993. type: string
  994. onceTime:
  995. type: string
  996. id:
  997. type: string
  998. status:
  999. type: boolean
  1000. api.user.v2.GetWristwatchContactPersonResponse:
  1001. type: object
  1002. properties:
  1003. persons:
  1004. type: array
  1005. items:
  1006. $ref: '#/components/schemas/api.user.v2.GetWristwatchContactPersonResponse_Person'
  1007. description: 手表获取联系人 Response
  1008. api.user.v2.GetWristwatchContactPersonResponse_Person:
  1009. type: object
  1010. properties:
  1011. id:
  1012. type: string
  1013. userId:
  1014. type: string
  1015. phoneNumber:
  1016. type: string
  1017. areaCode:
  1018. type: string
  1019. appellation:
  1020. type: string
  1021. role:
  1022. type: integer
  1023. format: enum
  1024. isChat:
  1025. type: boolean
  1026. isSos:
  1027. type: boolean
  1028. isAddedByWristwatch:
  1029. type: boolean
  1030. api.user.v2.GetWristwatchSchoolDisableResponse:
  1031. type: object
  1032. properties:
  1033. schoolDisables:
  1034. type: array
  1035. items:
  1036. $ref: '#/components/schemas/api.user.v2.GetWristwatchSchoolDisableResponse_SchoolDisable'
  1037. description: 手表获取上课禁用 Response
  1038. api.user.v2.GetWristwatchSchoolDisableResponse_SchoolDisable:
  1039. type: object
  1040. properties:
  1041. cid:
  1042. type: string
  1043. repeats:
  1044. type: string
  1045. startTime:
  1046. type: string
  1047. endTime:
  1048. type: string
  1049. status:
  1050. type: boolean
  1051. id:
  1052. type: string
  1053. api.user.v2.ResetPasswordRequest:
  1054. type: object
  1055. properties:
  1056. oldPassword:
  1057. type: string
  1058. description: 旧密码
  1059. newPassword:
  1060. type: string
  1061. description: 新密码
  1062. description: 重设密码 Request
  1063. api.user.v2.ResetPasswordResponse:
  1064. type: object
  1065. properties: {}
  1066. description: 重设密码 Response
  1067. api.user.v2.RetrievePasswordRequest:
  1068. type: object
  1069. properties:
  1070. email:
  1071. type: string
  1072. description: 邮箱
  1073. password:
  1074. type: string
  1075. description: 新密码
  1076. description: 找回密码 Request
  1077. api.user.v2.RetrievePasswordResponse:
  1078. type: object
  1079. properties: {}
  1080. description: 找回密码 Response
  1081. api.user.v2.SMSCodeRequest:
  1082. type: object
  1083. properties:
  1084. phone:
  1085. type: string
  1086. description: 手机号
  1087. areaCode:
  1088. type: string
  1089. description: 国家码
  1090. api.user.v2.SMSCodeResponse:
  1091. type: object
  1092. properties: {}
  1093. api.user.v2.SignInRequest:
  1094. type: object
  1095. properties:
  1096. phone:
  1097. type: string
  1098. description: 手机号
  1099. areaCode:
  1100. type: string
  1101. description: 国家码
  1102. password:
  1103. type: string
  1104. description: 密码
  1105. email:
  1106. type: string
  1107. description: 邮箱
  1108. captcha:
  1109. type: string
  1110. description: 验证码
  1111. description: 登录 Request
  1112. api.user.v2.SignInResponse:
  1113. type: object
  1114. properties:
  1115. token:
  1116. type: string
  1117. description: 当前登录的 AccessToken
  1118. uid:
  1119. type: string
  1120. description: 当前登录的用户
  1121. childList:
  1122. type: array
  1123. items:
  1124. $ref: '#/components/schemas/api.user.v2.SignInResponse_Child'
  1125. description: 绑定的小孩列表
  1126. description: 登录 Response
  1127. api.user.v2.SignInResponse_Child:
  1128. type: object
  1129. properties:
  1130. cid:
  1131. type: string
  1132. description: 小孩ID
  1133. stepCount:
  1134. type: integer
  1135. format: int32
  1136. name:
  1137. type: string
  1138. avatar:
  1139. type: string
  1140. device:
  1141. allOf:
  1142. - $ref: '#/components/schemas/api.user.v2.SignInResponse_Device'
  1143. description: 绑定的设备
  1144. lastLocation:
  1145. allOf:
  1146. - $ref: '#/components/schemas/api.user.v2.SignInResponse_Location'
  1147. description: 最后一次位置
  1148. api.user.v2.SignInResponse_Device:
  1149. type: object
  1150. properties:
  1151. did:
  1152. type: string
  1153. battery:
  1154. type: integer
  1155. format: int32
  1156. signal:
  1157. type: integer
  1158. format: int32
  1159. signalMax:
  1160. type: integer
  1161. format: int32
  1162. ticket:
  1163. type: string
  1164. api.user.v2.SignInResponse_Location:
  1165. type: object
  1166. properties:
  1167. latitude:
  1168. type: string
  1169. longitude:
  1170. type: string
  1171. positionTime:
  1172. type: string
  1173. radius:
  1174. type: integer
  1175. format: int32
  1176. pointType:
  1177. type: integer
  1178. format: enum
  1179. api.user.v2.SignUpRequest:
  1180. type: object
  1181. properties:
  1182. phone:
  1183. type: string
  1184. description: 手机号
  1185. areaCode:
  1186. type: string
  1187. description: 国家码
  1188. password:
  1189. type: string
  1190. description: 密码
  1191. email:
  1192. type: string
  1193. description: 邮箱
  1194. captcha:
  1195. type: string
  1196. description: 验证码
  1197. api.user.v2.SignUpResponse:
  1198. type: object
  1199. properties: {}
  1200. api.user.v2.UnregisterRequest:
  1201. type: object
  1202. properties:
  1203. password:
  1204. type: string
  1205. description: 密码
  1206. description: 注销账号 Request
  1207. api.user.v2.UnregisterResponse:
  1208. type: object
  1209. properties: {}
  1210. description: 注销账号 Response
  1211. api.user.v2.UpdateAlarmClockRequest:
  1212. type: object
  1213. properties:
  1214. cid:
  1215. type: string
  1216. description: 小孩ID
  1217. label:
  1218. type: string
  1219. description: 闹钟标签
  1220. repeats:
  1221. type: string
  1222. description: '重复天 eg: 1000000 周一开启 1111100 工作日开启'
  1223. time:
  1224. type: string
  1225. description: 'Time 闹钟时间 格式: HH:mm'
  1226. onceTime:
  1227. type: string
  1228. description: 仅一次时间戳
  1229. id:
  1230. type: string
  1231. description: 闹钟ID
  1232. status:
  1233. type: boolean
  1234. description: 是否开启
  1235. description: 修改闹钟 Request
  1236. api.user.v2.UpdateAlarmClockResponse:
  1237. type: object
  1238. properties: {}
  1239. description: 修改闹钟 Response
  1240. api.user.v2.UpdateChildRequest:
  1241. type: object
  1242. properties:
  1243. name:
  1244. type: string
  1245. description: 小孩姓名
  1246. phoneNumber:
  1247. type: string
  1248. description: 小孩电话
  1249. areaCode:
  1250. type: string
  1251. description: 小孩电话区号
  1252. avatar:
  1253. type: string
  1254. description: 小孩头像
  1255. birthday:
  1256. type: string
  1257. description: 小孩生日
  1258. appellation:
  1259. type: string
  1260. description: 小孩对自己的称谓
  1261. gender:
  1262. type: integer
  1263. description: 小孩性别
  1264. format: enum
  1265. weight:
  1266. type: integer
  1267. description: 小孩体重
  1268. format: int32
  1269. height:
  1270. type: integer
  1271. description: 小孩身高
  1272. format: int32
  1273. cid:
  1274. type: string
  1275. description: 小孩ID
  1276. api.user.v2.UpdateChildResponse:
  1277. type: object
  1278. properties: {}
  1279. api.user.v2.UpdateContactPersonRequest:
  1280. type: object
  1281. properties:
  1282. id:
  1283. type: string
  1284. avatar:
  1285. type: string
  1286. phoneNumber:
  1287. type: string
  1288. areaCode:
  1289. type: string
  1290. appellation:
  1291. type: string
  1292. role:
  1293. type: integer
  1294. format: enum
  1295. uid:
  1296. type: string
  1297. description: 更新联系人 Request
  1298. api.user.v2.UpdateContactPersonResponse:
  1299. type: object
  1300. properties: {}
  1301. description: 更新联系人 Response
  1302. api.user.v2.UpdateSchoolDisableRequest:
  1303. type: object
  1304. properties:
  1305. id:
  1306. type: string
  1307. cid:
  1308. type: string
  1309. repeats:
  1310. type: string
  1311. startTime:
  1312. type: string
  1313. endTime:
  1314. type: string
  1315. status:
  1316. type: boolean
  1317. description: 更新上课禁用 Request
  1318. api.user.v2.UpdateSchoolDisableResponse:
  1319. type: object
  1320. properties: {}
  1321. description: 更新上课禁用 Response
  1322. tags:
  1323. - name: AlarmClock
  1324. - name: Child
  1325. - name: Contacts
  1326. - name: Device
  1327. description: |-
  1328. 设备服务
  1329. - 绑定设备
  1330. - 解绑设备
  1331. - 查询设备绑定状态
  1332. - 设备交换三码
  1333. - name: SchoolDisable
  1334. - name: User