API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Sep 14th, 2017
79
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 65.33 KB | None | 0 0
raw download clone embed print report
  1. swagger: '2.0'
  2. info:
  3. version: 0.1.0
  4. title: license-manager-api
  5. basePath: /api/v0
  6. paths:
  7. '/users/{id}/accessTokens/{fk}':
  8. get:
  9. tags:
  10. - user
  11. summary: Find a related item by id for accessTokens.
  12. operationId: user.prototype.__findById__accessTokens
  13. parameters:
  14. - name: id
  15. in: path
  16. description: user id
  17. required: true
  18. type: string
  19. format: JSON
  20. - name: fk
  21. in: path
  22. description: Foreign key for accessTokens
  23. required: true
  24. type: string
  25. format: JSON
  26. responses:
  27. '200':
  28. description: Request was successful
  29. schema:
  30. $ref: '#/definitions/AccessToken'
  31. deprecated: false
  32. delete:
  33. tags:
  34. - user
  35. summary: Delete a related item by id for accessTokens.
  36. operationId: user.prototype.__destroyById__accessTokens
  37. parameters:
  38. - name: id
  39. in: path
  40. description: user id
  41. required: true
  42. type: string
  43. format: JSON
  44. - name: fk
  45. in: path
  46. description: Foreign key for accessTokens
  47. required: true
  48. type: string
  49. format: JSON
  50. responses:
  51. '204':
  52. description: Request was successful
  53. deprecated: false
  54. put:
  55. tags:
  56. - user
  57. summary: Update a related item by id for accessTokens.
  58. operationId: user.prototype.__updateById__accessTokens
  59. parameters:
  60. - name: id
  61. in: path
  62. description: user id
  63. required: true
  64. type: string
  65. format: JSON
  66. - name: fk
  67. in: path
  68. description: Foreign key for accessTokens
  69. required: true
  70. type: string
  71. format: JSON
  72. - name: data
  73. in: body
  74. required: false
  75. schema:
  76. $ref: '#/definitions/AccessToken'
  77. responses:
  78. '200':
  79. description: Request was successful
  80. schema:
  81. $ref: '#/definitions/AccessToken'
  82. deprecated: false
  83. '/users/{id}/groups/{fk}':
  84. get:
  85. tags:
  86. - user
  87. summary: Find a related item by id for groups.
  88. operationId: user.prototype.__findById__groups
  89. parameters:
  90. - name: id
  91. in: path
  92. description: user id
  93. required: true
  94. type: string
  95. format: JSON
  96. - name: fk
  97. in: path
  98. description: Foreign key for groups
  99. required: true
  100. type: string
  101. format: JSON
  102. responses:
  103. '200':
  104. description: Request was successful
  105. schema:
  106. $ref: '#/definitions/group'
  107. deprecated: false
  108. delete:
  109. tags:
  110. - user
  111. summary: Delete a related item by id for groups.
  112. operationId: user.prototype.__destroyById__groups
  113. parameters:
  114. - name: id
  115. in: path
  116. description: user id
  117. required: true
  118. type: string
  119. format: JSON
  120. - name: fk
  121. in: path
  122. description: Foreign key for groups
  123. required: true
  124. type: string
  125. format: JSON
  126. responses:
  127. '204':
  128. description: Request was successful
  129. deprecated: false
  130. put:
  131. tags:
  132. - user
  133. summary: Update a related item by id for groups.
  134. operationId: user.prototype.__updateById__groups
  135. parameters:
  136. - name: id
  137. in: path
  138. description: user id
  139. required: true
  140. type: string
  141. format: JSON
  142. - name: fk
  143. in: path
  144. description: Foreign key for groups
  145. required: true
  146. type: string
  147. format: JSON
  148. - name: data
  149. in: body
  150. required: false
  151. schema:
  152. $ref: '#/definitions/group'
  153. responses:
  154. '200':
  155. description: Request was successful
  156. schema:
  157. $ref: '#/definitions/group'
  158. deprecated: false
  159. '/users/{id}/accessTokens':
  160. get:
  161. tags:
  162. - user
  163. summary: Queries accessTokens of user.
  164. operationId: user.prototype.__get__accessTokens
  165. parameters:
  166. - name: id
  167. in: path
  168. description: user id
  169. required: true
  170. type: string
  171. format: JSON
  172. - name: filter
  173. in: query
  174. required: false
  175. type: string
  176. format: JSON
  177. responses:
  178. '200':
  179. description: Request was successful
  180. schema:
  181. type: array
  182. items:
  183. $ref: '#/definitions/AccessToken'
  184. deprecated: false
  185. post:
  186. tags:
  187. - user
  188. summary: Creates a new instance in accessTokens of this model.
  189. operationId: user.prototype.__create__accessTokens
  190. parameters:
  191. - name: id
  192. in: path
  193. description: user id
  194. required: true
  195. type: string
  196. format: JSON
  197. - name: data
  198. in: body
  199. required: false
  200. schema:
  201. $ref: '#/definitions/AccessToken'
  202. responses:
  203. '200':
  204. description: Request was successful
  205. schema:
  206. $ref: '#/definitions/AccessToken'
  207. deprecated: false
  208. delete:
  209. tags:
  210. - user
  211. summary: Deletes all accessTokens of this model.
  212. operationId: user.prototype.__delete__accessTokens
  213. parameters:
  214. - name: id
  215. in: path
  216. description: user id
  217. required: true
  218. type: string
  219. format: JSON
  220. responses:
  221. '204':
  222. description: Request was successful
  223. deprecated: false
  224. '/users/{id}/accessTokens/count':
  225. get:
  226. tags:
  227. - user
  228. summary: Counts accessTokens of user.
  229. operationId: user.prototype.__count__accessTokens
  230. parameters:
  231. - name: id
  232. in: path
  233. description: user id
  234. required: true
  235. type: string
  236. format: JSON
  237. - name: where
  238. in: query
  239. description: Criteria to match model instances
  240. required: false
  241. type: string
  242. format: JSON
  243. responses:
  244. '200':
  245. description: Request was successful
  246. schema:
  247. type: object
  248. properties:
  249. count:
  250. type: number
  251. format: double
  252. deprecated: false
  253. '/users/{id}/groups':
  254. get:
  255. tags:
  256. - user
  257. summary: Queries groups of user.
  258. operationId: user.prototype.__get__groups
  259. parameters:
  260. - name: id
  261. in: path
  262. description: user id
  263. required: true
  264. type: string
  265. format: JSON
  266. - name: filter
  267. in: query
  268. required: false
  269. type: string
  270. format: JSON
  271. responses:
  272. '200':
  273. description: Request was successful
  274. schema:
  275. type: array
  276. items:
  277. $ref: '#/definitions/group'
  278. deprecated: false
  279. post:
  280. tags:
  281. - user
  282. summary: Creates a new instance in groups of this model.
  283. operationId: user.prototype.__create__groups
  284. parameters:
  285. - name: id
  286. in: path
  287. description: user id
  288. required: true
  289. type: string
  290. format: JSON
  291. - name: data
  292. in: body
  293. required: false
  294. schema:
  295. $ref: '#/definitions/group'
  296. responses:
  297. '200':
  298. description: Request was successful
  299. schema:
  300. $ref: '#/definitions/group'
  301. deprecated: false
  302. delete:
  303. tags:
  304. - user
  305. summary: Deletes all groups of this model.
  306. operationId: user.prototype.__delete__groups
  307. parameters:
  308. - name: id
  309. in: path
  310. description: user id
  311. required: true
  312. type: string
  313. format: JSON
  314. responses:
  315. '204':
  316. description: Request was successful
  317. deprecated: false
  318. '/users/{id}/groups/count':
  319. get:
  320. tags:
  321. - user
  322. summary: Counts groups of user.
  323. operationId: user.prototype.__count__groups
  324. parameters:
  325. - name: id
  326. in: path
  327. description: user id
  328. required: true
  329. type: string
  330. format: JSON
  331. - name: where
  332. in: query
  333. description: Criteria to match model instances
  334. required: false
  335. type: string
  336. format: JSON
  337. responses:
  338. '200':
  339. description: Request was successful
  340. schema:
  341. type: object
  342. properties:
  343. count:
  344. type: number
  345. format: double
  346. deprecated: false
  347. /users:
  348. post:
  349. tags:
  350. - user
  351. summary: Create a new instance of the model and persist it into the data source.
  352. operationId: user.create
  353. parameters:
  354. - name: data
  355. in: body
  356. description: Model instance data
  357. required: false
  358. schema:
  359. description: Model instance data
  360. $ref: '#/definitions/user'
  361. responses:
  362. '200':
  363. description: Request was successful
  364. schema:
  365. $ref: '#/definitions/user'
  366. deprecated: false
  367. patch:
  368. tags:
  369. - user
  370. summary: >-
  371. Patch an existing model instance or insert a new one into the data
  372. source.
  373. operationId: user.patchOrCreate
  374. parameters:
  375. - name: data
  376. in: body
  377. description: Model instance data
  378. required: false
  379. schema:
  380. description: Model instance data
  381. $ref: '#/definitions/user'
  382. responses:
  383. '200':
  384. description: Request was successful
  385. schema:
  386. $ref: '#/definitions/user'
  387. deprecated: false
  388. put:
  389. tags:
  390. - user
  391. summary: >-
  392. Replace an existing model instance or insert a new one into the data
  393. source.
  394. operationId: user.replaceOrCreate__put_users
  395. parameters:
  396. - name: data
  397. in: body
  398. description: Model instance data
  399. required: false
  400. schema:
  401. description: Model instance data
  402. $ref: '#/definitions/user'
  403. responses:
  404. '200':
  405. description: Request was successful
  406. schema:
  407. $ref: '#/definitions/user'
  408. deprecated: false
  409. get:
  410. tags:
  411. - user
  412. summary: Find all instances of the model matched by filter from the data source.
  413. operationId: user.find
  414. parameters:
  415. - name: filter
  416. in: query
  417. description: >-
  418. Filter defining fields, where, include, order, offset, and limit -
  419. must be a JSON-encoded string ({"something":"value"})
  420. required: false
  421. type: string
  422. format: JSON
  423. responses:
  424. '200':
  425. description: Request was successful
  426. schema:
  427. type: array
  428. items:
  429. $ref: '#/definitions/user'
  430. deprecated: false
  431. /users/replaceOrCreate:
  432. post:
  433. tags:
  434. - user
  435. summary: >-
  436. Replace an existing model instance or insert a new one into the data
  437. source.
  438. operationId: user.replaceOrCreate__post_users_replaceOrCreate
  439. parameters:
  440. - name: data
  441. in: body
  442. description: Model instance data
  443. required: false
  444. schema:
  445. description: Model instance data
  446. $ref: '#/definitions/user'
  447. responses:
  448. '200':
  449. description: Request was successful
  450. schema:
  451. $ref: '#/definitions/user'
  452. deprecated: false
  453. /users/upsertWithWhere:
  454. post:
  455. tags:
  456. - user
  457. summary: >-
  458. Update an existing model instance or insert a new one into the data
  459. source based on the where criteria.
  460. operationId: user.upsertWithWhere
  461. parameters:
  462. - name: where
  463. in: query
  464. description: Criteria to match model instances
  465. required: false
  466. type: string
  467. format: JSON
  468. - name: data
  469. in: body
  470. description: An object of model property name/value pairs
  471. required: false
  472. schema:
  473. description: An object of model property name/value pairs
  474. $ref: '#/definitions/user'
  475. responses:
  476. '200':
  477. description: Request was successful
  478. schema:
  479. $ref: '#/definitions/user'
  480. deprecated: false
  481. '/users/{id}/exists':
  482. get:
  483. tags:
  484. - user
  485. summary: Check whether a model instance exists in the data source.
  486. operationId: 'user.exists__get_users_{id}_exists'
  487. parameters:
  488. - name: id
  489. in: path
  490. description: Model id
  491. required: true
  492. type: string
  493. format: JSON
  494. responses:
  495. '200':
  496. description: Request was successful
  497. schema:
  498. type: object
  499. properties:
  500. exists:
  501. type: boolean
  502. deprecated: false
  503. '/users/{id}':
  504. head:
  505. tags:
  506. - user
  507. summary: Check whether a model instance exists in the data source.
  508. operationId: 'user.exists__head_users_{id}'
  509. parameters:
  510. - name: id
  511. in: path
  512. description: Model id
  513. required: true
  514. type: string
  515. format: JSON
  516. responses:
  517. '200':
  518. description: Request was successful
  519. schema:
  520. type: object
  521. properties:
  522. exists:
  523. type: boolean
  524. deprecated: false
  525. get:
  526. tags:
  527. - user
  528. summary: 'Find a model instance by {{id}} from the data source.'
  529. operationId: user.findById
  530. parameters:
  531. - name: id
  532. in: path
  533. description: Model id
  534. required: true
  535. type: string
  536. format: JSON
  537. - name: filter
  538. in: query
  539. description: >-
  540. Filter defining fields and include - must be a JSON-encoded string
  541. ({"something":"value"})
  542. required: false
  543. type: string
  544. format: JSON
  545. responses:
  546. '200':
  547. description: Request was successful
  548. schema:
  549. $ref: '#/definitions/user'
  550. deprecated: false
  551. put:
  552. tags:
  553. - user
  554. summary: >-
  555. Replace attributes for a model instance and persist it into the data
  556. source.
  557. operationId: 'user.replaceById__put_users_{id}'
  558. parameters:
  559. - name: id
  560. in: path
  561. description: Model id
  562. required: true
  563. type: string
  564. format: JSON
  565. - name: data
  566. in: body
  567. description: Model instance data
  568. required: false
  569. schema:
  570. description: Model instance data
  571. $ref: '#/definitions/user'
  572. responses:
  573. '200':
  574. description: Request was successful
  575. schema:
  576. $ref: '#/definitions/user'
  577. deprecated: false
  578. delete:
  579. tags:
  580. - user
  581. summary: 'Delete a model instance by {{id}} from the data source.'
  582. operationId: user.deleteById
  583. parameters:
  584. - name: id
  585. in: path
  586. description: Model id
  587. required: true
  588. type: string
  589. format: JSON
  590. responses:
  591. '200':
  592. description: Request was successful
  593. schema:
  594. type: object
  595. deprecated: false
  596. patch:
  597. tags:
  598. - user
  599. summary: >-
  600. Patch attributes for a model instance and persist it into the data
  601. source.
  602. operationId: user.prototype.patchAttributes
  603. parameters:
  604. - name: id
  605. in: path
  606. description: user id
  607. required: true
  608. type: string
  609. format: JSON
  610. - name: data
  611. in: body
  612. description: An object of model property name/value pairs
  613. required: false
  614. schema:
  615. description: An object of model property name/value pairs
  616. $ref: '#/definitions/user'
  617. responses:
  618. '200':
  619. description: Request was successful
  620. schema:
  621. $ref: '#/definitions/user'
  622. deprecated: false
  623. '/users/{id}/replace':
  624. post:
  625. tags:
  626. - user
  627. summary: >-
  628. Replace attributes for a model instance and persist it into the data
  629. source.
  630. operationId: 'user.replaceById__post_users_{id}_replace'
  631. parameters:
  632. - name: id
  633. in: path
  634. description: Model id
  635. required: true
  636. type: string
  637. format: JSON
  638. - name: data
  639. in: body
  640. description: Model instance data
  641. required: false
  642. schema:
  643. description: Model instance data
  644. $ref: '#/definitions/user'
  645. responses:
  646. '200':
  647. description: Request was successful
  648. schema:
  649. $ref: '#/definitions/user'
  650. deprecated: false
  651. /users/findOne:
  652. get:
  653. tags:
  654. - user
  655. summary: Find first instance of the model matched by filter from the data source.
  656. operationId: user.findOne
  657. parameters:
  658. - name: filter
  659. in: query
  660. description: >-
  661. Filter defining fields, where, include, order, offset, and limit -
  662. must be a JSON-encoded string ({"something":"value"})
  663. required: false
  664. type: string
  665. format: JSON
  666. responses:
  667. '200':
  668. description: Request was successful
  669. schema:
  670. $ref: '#/definitions/user'
  671. deprecated: false
  672. /users/update:
  673. post:
  674. tags:
  675. - user
  676. summary: 'Update instances of the model matched by {{where}} from the data source.'
  677. operationId: user.updateAll
  678. parameters:
  679. - name: where
  680. in: query
  681. description: Criteria to match model instances
  682. required: false
  683. type: string
  684. format: JSON
  685. - name: data
  686. in: body
  687. description: An object of model property name/value pairs
  688. required: false
  689. schema:
  690. description: An object of model property name/value pairs
  691. $ref: '#/definitions/user'
  692. responses:
  693. '200':
  694. description: Request was successful
  695. schema:
  696. description: Information related to the outcome of the operation
  697. type: object
  698. properties:
  699. count:
  700. description: The number of instances updated
  701. type: number
  702. format: double
  703. deprecated: false
  704. /users/count:
  705. get:
  706. tags:
  707. - user
  708. summary: Count instances of the model matched by where from the data source.
  709. operationId: user.count
  710. parameters:
  711. - name: where
  712. in: query
  713. description: Criteria to match model instances
  714. required: false
  715. type: string
  716. format: JSON
  717. responses:
  718. '200':
  719. description: Request was successful
  720. schema:
  721. type: object
  722. properties:
  723. count:
  724. type: number
  725. format: double
  726. deprecated: false
  727. /users/change-stream:
  728. post:
  729. tags:
  730. - user
  731. summary: Create a change stream.
  732. operationId: user.createChangeStream__post_users_change-stream
  733. parameters:
  734. - name: options
  735. in: formData
  736. required: false
  737. type: string
  738. format: JSON
  739. responses:
  740. '200':
  741. description: Request was successful
  742. schema:
  743. type: file
  744. deprecated: false
  745. get:
  746. tags:
  747. - user
  748. summary: Create a change stream.
  749. operationId: user.createChangeStream__get_users_change-stream
  750. parameters:
  751. - name: options
  752. in: query
  753. required: false
  754. type: string
  755. format: JSON
  756. responses:
  757. '200':
  758. description: Request was successful
  759. schema:
  760. type: file
  761. deprecated: false
  762. /users/login:
  763. post:
  764. tags:
  765. - user
  766. summary: Login a user with username/email and password.
  767. operationId: user.login
  768. parameters:
  769. - name: credentials
  770. in: body
  771. required: true
  772. schema:
  773. type: object
  774. - name: include
  775. in: query
  776. description: >-
  777. Related objects to include in the response. See the description of
  778. return value for more details.
  779. required: false
  780. type: string
  781. format: JSON
  782. responses:
  783. '200':
  784. description: Request was successful
  785. schema:
  786. description: >+
  787. El cuerpo de respuesta contiene propiedades de la AccessToken
  788. creada durante el inicio de la sesión.
  789.  
  790. Dependiendo del valor del parámetro `include`, el cuerpo puede
  791. contener propiedades adicionales:
  792.  
  793. - `user` - `U+007BUserU+007D` - Datos del usuario conectado actualmente. (`include=user`)
  794.  
  795. type: object
  796. deprecated: false
  797. /users/logout:
  798. post:
  799. tags:
  800. - user
  801. summary: Logout a user with access token.
  802. operationId: user.logout
  803. parameters: []
  804. responses:
  805. '204':
  806. description: Request was successful
  807. deprecated: false
  808. '/users/{id}/verify':
  809. post:
  810. tags:
  811. - user
  812. summary: Trigger user's identity verification with configured verifyOptions
  813. operationId: user.prototype.verify
  814. parameters:
  815. - name: id
  816. in: path
  817. description: user id
  818. required: true
  819. type: string
  820. format: JSON
  821. responses:
  822. '204':
  823. description: Request was successful
  824. deprecated: false
  825. /users/confirm:
  826. get:
  827. tags:
  828. - user
  829. summary: Confirm a user registration with identity verification token.
  830. operationId: user.confirm
  831. parameters:
  832. - name: uid
  833. in: query
  834. required: true
  835. type: string
  836. - name: token
  837. in: query
  838. required: true
  839. type: string
  840. - name: redirect
  841. in: query
  842. required: false
  843. type: string
  844. responses:
  845. '204':
  846. description: Request was successful
  847. deprecated: false
  848. /users/reset:
  849. post:
  850. tags:
  851. - user
  852. summary: Reset password for a user with email.
  853. operationId: user.resetPassword
  854. parameters:
  855. - name: options
  856. in: body
  857. required: true
  858. schema:
  859. type: object
  860. responses:
  861. '204':
  862. description: Request was successful
  863. deprecated: false
  864. /users/change-password:
  865. post:
  866. tags:
  867. - user
  868. summary: Change a user's password.
  869. operationId: user.changePassword
  870. parameters:
  871. - name: oldPassword
  872. in: formData
  873. required: true
  874. type: string
  875. - name: newPassword
  876. in: formData
  877. required: true
  878. type: string
  879. responses:
  880. '204':
  881. description: Request was successful
  882. deprecated: false
  883. /users/reset-password:
  884. post:
  885. tags:
  886. - user
  887. summary: Reset user's password via a password-reset token.
  888. operationId: user.setPassword
  889. parameters:
  890. - name: newPassword
  891. in: formData
  892. required: true
  893. type: string
  894. responses:
  895. '204':
  896. description: Request was successful
  897. deprecated: false
  898. '/groups/{id}/owner':
  899. get:
  900. tags:
  901. - group
  902. summary: Fetches belongsTo relation owner.
  903. operationId: group.prototype.__get__owner
  904. parameters:
  905. - name: id
  906. in: path
  907. description: group id
  908. required: true
  909. type: string
  910. format: JSON
  911. - name: refresh
  912. in: query
  913. required: false
  914. type: boolean
  915. responses:
  916. '200':
  917. description: Request was successful
  918. schema:
  919. $ref: '#/definitions/user'
  920. deprecated: false
  921. '/groups/{id}/members/{fk}':
  922. get:
  923. tags:
  924. - group
  925. summary: Find a related item by id for members.
  926. operationId: group.prototype.__findById__members
  927. parameters:
  928. - name: id
  929. in: path
  930. description: group id
  931. required: true
  932. type: string
  933. format: JSON
  934. - name: fk
  935. in: path
  936. description: Foreign key for members
  937. required: true
  938. type: string
  939. format: JSON
  940. responses:
  941. '200':
  942. description: Request was successful
  943. schema:
  944. $ref: '#/definitions/user'
  945. deprecated: false
  946. delete:
  947. tags:
  948. - group
  949. summary: Delete a related item by id for members.
  950. operationId: group.prototype.__destroyById__members
  951. parameters:
  952. - name: id
  953. in: path
  954. description: group id
  955. required: true
  956. type: string
  957. format: JSON
  958. - name: fk
  959. in: path
  960. description: Foreign key for members
  961. required: true
  962. type: string
  963. format: JSON
  964. responses:
  965. '204':
  966. description: Request was successful
  967. deprecated: false
  968. put:
  969. tags:
  970. - group
  971. summary: Update a related item by id for members.
  972. operationId: group.prototype.__updateById__members
  973. parameters:
  974. - name: id
  975. in: path
  976. description: group id
  977. required: true
  978. type: string
  979. format: JSON
  980. - name: fk
  981. in: path
  982. description: Foreign key for members
  983. required: true
  984. type: string
  985. format: JSON
  986. - name: data
  987. in: body
  988. required: false
  989. schema:
  990. $ref: '#/definitions/user'
  991. responses:
  992. '200':
  993. description: Request was successful
  994. schema:
  995. $ref: '#/definitions/user'
  996. deprecated: false
  997. '/groups/{id}/members/rel/{fk}':
  998. put:
  999. tags:
  1000. - group
  1001. summary: Add a related item by id for members.
  1002. operationId: group.prototype.__link__members
  1003. parameters:
  1004. - name: id
  1005. in: path
  1006. description: group id
  1007. required: true
  1008. type: string
  1009. format: JSON
  1010. - name: fk
  1011. in: path
  1012. description: Foreign key for members
  1013. required: true
  1014. type: string
  1015. format: JSON
  1016. - name: data
  1017. in: body
  1018. required: false
  1019. schema:
  1020. $ref: '#/definitions/groupuser'
  1021. responses:
  1022. '200':
  1023. description: Request was successful
  1024. schema:
  1025. $ref: '#/definitions/groupuser'
  1026. deprecated: false
  1027. delete:
  1028. tags:
  1029. - group
  1030. summary: Remove the members relation to an item by id.
  1031. operationId: group.prototype.__unlink__members
  1032. parameters:
  1033. - name: id
  1034. in: path
  1035. description: group id
  1036. required: true
  1037. type: string
  1038. format: JSON
  1039. - name: fk
  1040. in: path
  1041. description: Foreign key for members
  1042. required: true
  1043. type: string
  1044. format: JSON
  1045. responses:
  1046. '204':
  1047. description: Request was successful
  1048. deprecated: false
  1049. head:
  1050. tags:
  1051. - group
  1052. summary: Check the existence of members relation to an item by id.
  1053. operationId: group.prototype.__exists__members
  1054. parameters:
  1055. - name: id
  1056. in: path
  1057. description: group id
  1058. required: true
  1059. type: string
  1060. format: JSON
  1061. - name: fk
  1062. in: path
  1063. description: Foreign key for members
  1064. required: true
  1065. type: string
  1066. format: JSON
  1067. responses:
  1068. '200':
  1069. description: Request was successful
  1070. schema:
  1071. type: boolean
  1072. deprecated: false
  1073. '/groups/{id}/clusters/{fk}':
  1074. get:
  1075. tags:
  1076. - group
  1077. summary: Find a related item by id for clusters.
  1078. operationId: group.prototype.__findById__clusters
  1079. parameters:
  1080. - name: id
  1081. in: path
  1082. description: group id
  1083. required: true
  1084. type: string
  1085. format: JSON
  1086. - name: fk
  1087. in: path
  1088. description: Foreign key for clusters
  1089. required: true
  1090. type: string
  1091. format: JSON
  1092. responses:
  1093. '200':
  1094. description: Request was successful
  1095. schema:
  1096. $ref: '#/definitions/cluster'
  1097. deprecated: false
  1098. delete:
  1099. tags:
  1100. - group
  1101. summary: Delete a related item by id for clusters.
  1102. operationId: group.prototype.__destroyById__clusters
  1103. parameters:
  1104. - name: id
  1105. in: path
  1106. description: group id
  1107. required: true
  1108. type: string
  1109. format: JSON
  1110. - name: fk
  1111. in: path
  1112. description: Foreign key for clusters
  1113. required: true
  1114. type: string
  1115. format: JSON
  1116. responses:
  1117. '204':
  1118. description: Request was successful
  1119. deprecated: false
  1120. put:
  1121. tags:
  1122. - group
  1123. summary: Update a related item by id for clusters.
  1124. operationId: group.prototype.__updateById__clusters
  1125. parameters:
  1126. - name: id
  1127. in: path
  1128. description: group id
  1129. required: true
  1130. type: string
  1131. format: JSON
  1132. - name: fk
  1133. in: path
  1134. description: Foreign key for clusters
  1135. required: true
  1136. type: string
  1137. format: JSON
  1138. - name: data
  1139. in: body
  1140. required: false
  1141. schema:
  1142. $ref: '#/definitions/cluster'
  1143. responses:
  1144. '200':
  1145. description: Request was successful
  1146. schema:
  1147. $ref: '#/definitions/cluster'
  1148. deprecated: false
  1149. '/groups/{id}/organizations/{fk}':
  1150. get:
  1151. tags:
  1152. - group
  1153. summary: Find a related item by id for organizations.
  1154. operationId: group.prototype.__findById__organizations
  1155. parameters:
  1156. - name: id
  1157. in: path
  1158. description: group id
  1159. required: true
  1160. type: string
  1161. format: JSON
  1162. - name: fk
  1163. in: path
  1164. description: Foreign key for organizations
  1165. required: true
  1166. type: string
  1167. format: JSON
  1168. responses:
  1169. '200':
  1170. description: Request was successful
  1171. schema:
  1172. $ref: '#/definitions/organization'
  1173. deprecated: false
  1174. delete:
  1175. tags:
  1176. - group
  1177. summary: Delete a related item by id for organizations.
  1178. operationId: group.prototype.__destroyById__organizations
  1179. parameters:
  1180. - name: id
  1181. in: path
  1182. description: group id
  1183. required: true
  1184. type: string
  1185. format: JSON
  1186. - name: fk
  1187. in: path
  1188. description: Foreign key for organizations
  1189. required: true
  1190. type: string
  1191. format: JSON
  1192. responses:
  1193. '204':
  1194. description: Request was successful
  1195. deprecated: false
  1196. put:
  1197. tags:
  1198. - group
  1199. summary: Update a related item by id for organizations.
  1200. operationId: group.prototype.__updateById__organizations
  1201. parameters:
  1202. - name: id
  1203. in: path
  1204. description: group id
  1205. required: true
  1206. type: string
  1207. format: JSON
  1208. - name: fk
  1209. in: path
  1210. description: Foreign key for organizations
  1211. required: true
  1212. type: string
  1213. format: JSON
  1214. - name: data
  1215. in: body
  1216. required: false
  1217. schema:
  1218. $ref: '#/definitions/organization'
  1219. responses:
  1220. '200':
  1221. description: Request was successful
  1222. schema:
  1223. $ref: '#/definitions/organization'
  1224. deprecated: false
  1225. '/groups/{id}/license-pools/{fk}':
  1226. get:
  1227. tags:
  1228. - group
  1229. summary: Find a related item by id for license-pools.
  1230. operationId: group.prototype.__findById__license-pools
  1231. parameters:
  1232. - name: id
  1233. in: path
  1234. description: group id
  1235. required: true
  1236. type: string
  1237. format: JSON
  1238. - name: fk
  1239. in: path
  1240. description: Foreign key for license-pools
  1241. required: true
  1242. type: string
  1243. format: JSON
  1244. responses:
  1245. '200':
  1246. description: Request was successful
  1247. schema:
  1248. $ref: '#/definitions/license-pool'
  1249. deprecated: false
  1250. delete:
  1251. tags:
  1252. - group
  1253. summary: Delete a related item by id for license-pools.
  1254. operationId: group.prototype.__destroyById__license-pools
  1255. parameters:
  1256. - name: id
  1257. in: path
  1258. description: group id
  1259. required: true
  1260. type: string
  1261. format: JSON
  1262. - name: fk
  1263. in: path
  1264. description: Foreign key for license-pools
  1265. required: true
  1266. type: string
  1267. format: JSON
  1268. responses:
  1269. '204':
  1270. description: Request was successful
  1271. deprecated: false
  1272. put:
  1273. tags:
  1274. - group
  1275. summary: Update a related item by id for license-pools.
  1276. operationId: group.prototype.__updateById__license-pools
  1277. parameters:
  1278. - name: id
  1279. in: path
  1280. description: group id
  1281. required: true
  1282. type: string
  1283. format: JSON
  1284. - name: fk
  1285. in: path
  1286. description: Foreign key for license-pools
  1287. required: true
  1288. type: string
  1289. format: JSON
  1290. - name: data
  1291. in: body
  1292. required: false
  1293. schema:
  1294. $ref: '#/definitions/license-pool'
  1295. responses:
  1296. '200':
  1297. description: Request was successful
  1298. schema:
  1299. $ref: '#/definitions/license-pool'
  1300. deprecated: false
  1301. '/groups/{id}/members':
  1302. get:
  1303. tags:
  1304. - group
  1305. summary: Queries members of group.
  1306. operationId: group.prototype.__get__members
  1307. parameters:
  1308. - name: id
  1309. in: path
  1310. description: group id
  1311. required: true
  1312. type: string
  1313. format: JSON
  1314. - name: filter
  1315. in: query
  1316. required: false
  1317. type: string
  1318. format: JSON
  1319. responses:
  1320. '200':
  1321. description: Request was successful
  1322. schema:
  1323. type: array
  1324. items:
  1325. $ref: '#/definitions/user'
  1326. deprecated: false
  1327. post:
  1328. tags:
  1329. - group
  1330. summary: Creates a new instance in members of this model.
  1331. operationId: group.prototype.__create__members
  1332. parameters:
  1333. - name: id
  1334. in: path
  1335. description: group id
  1336. required: true
  1337. type: string
  1338. format: JSON
  1339. - name: data
  1340. in: body
  1341. required: false
  1342. schema:
  1343. $ref: '#/definitions/user'
  1344. responses:
  1345. '200':
  1346. description: Request was successful
  1347. schema:
  1348. $ref: '#/definitions/user'
  1349. deprecated: false
  1350. delete:
  1351. tags:
  1352. - group
  1353. summary: Deletes all members of this model.
  1354. operationId: group.prototype.__delete__members
  1355. parameters:
  1356. - name: id
  1357. in: path
  1358. description: group id
  1359. required: true
  1360. type: string
  1361. format: JSON
  1362. responses:
  1363. '204':
  1364. description: Request was successful
  1365. deprecated: false
  1366. '/groups/{id}/members/count':
  1367. get:
  1368. tags:
  1369. - group
  1370. summary: Counts members of group.
  1371. operationId: group.prototype.__count__members
  1372. parameters:
  1373. - name: id
  1374. in: path
  1375. description: group id
  1376. required: true
  1377. type: string
  1378. format: JSON
  1379. - name: where
  1380. in: query
  1381. description: Criteria to match model instances
  1382. required: false
  1383. type: string
  1384. format: JSON
  1385. responses:
  1386. '200':
  1387. description: Request was successful
  1388. schema:
  1389. type: object
  1390. properties:
  1391. count:
  1392. type: number
  1393. format: double
  1394. deprecated: false
  1395. '/groups/{id}/clusters':
  1396. get:
  1397. tags:
  1398. - group
  1399. summary: Queries clusters of group.
  1400. operationId: group.prototype.__get__clusters
  1401. parameters:
  1402. - name: id
  1403. in: path
  1404. description: group id
  1405. required: true
  1406. type: string
  1407. format: JSON
  1408. - name: filter
  1409. in: query
  1410. required: false
  1411. type: string
  1412. format: JSON
  1413. responses:
  1414. '200':
  1415. description: Request was successful
  1416. schema:
  1417. type: array
  1418. items:
  1419. $ref: '#/definitions/cluster'
  1420. deprecated: false
  1421. post:
  1422. tags:
  1423. - group
  1424. summary: Creates a new instance in clusters of this model.
  1425. operationId: group.prototype.__create__clusters
  1426. parameters:
  1427. - name: id
  1428. in: path
  1429. description: group id
  1430. required: true
  1431. type: string
  1432. format: JSON
  1433. - name: data
  1434. in: body
  1435. required: false
  1436. schema:
  1437. $ref: '#/definitions/cluster'
  1438. responses:
  1439. '200':
  1440. description: Request was successful
  1441. schema:
  1442. $ref: '#/definitions/cluster'
  1443. deprecated: false
  1444. delete:
  1445. tags:
  1446. - group
  1447. summary: Deletes all clusters of this model.
  1448. operationId: group.prototype.__delete__clusters
  1449. parameters:
  1450. - name: id
  1451. in: path
  1452. description: group id
  1453. required: true
  1454. type: string
  1455. format: JSON
  1456. responses:
  1457. '204':
  1458. description: Request was successful
  1459. deprecated: false
  1460. '/groups/{id}/clusters/count':
  1461. get:
  1462. tags:
  1463. - group
  1464. summary: Counts clusters of group.
  1465. operationId: group.prototype.__count__clusters
  1466. parameters:
  1467. - name: id
  1468. in: path
  1469. description: group id
  1470. required: true
  1471. type: string
  1472. format: JSON
  1473. - name: where
  1474. in: query
  1475. description: Criteria to match model instances
  1476. required: false
  1477. type: string
  1478. format: JSON
  1479. responses:
  1480. '200':
  1481. description: Request was successful
  1482. schema:
  1483. type: object
  1484. properties:
  1485. count:
  1486. type: number
  1487. format: double
  1488. deprecated: false
  1489. '/groups/{id}/organizations':
  1490. get:
  1491. tags:
  1492. - group
  1493. summary: Queries organizations of group.
  1494. operationId: group.prototype.__get__organizations
  1495. parameters:
  1496. - name: id
  1497. in: path
  1498. description: group id
  1499. required: true
  1500. type: string
  1501. format: JSON
  1502. - name: filter
  1503. in: query
  1504. required: false
  1505. type: string
  1506. format: JSON
  1507. responses:
  1508. '200':
  1509. description: Request was successful
  1510. schema:
  1511. type: array
  1512. items:
  1513. $ref: '#/definitions/organization'
  1514. deprecated: false
  1515. post:
  1516. tags:
  1517. - group
  1518. summary: Creates a new instance in organizations of this model.
  1519. operationId: group.prototype.__create__organizations
  1520. parameters:
  1521. - name: id
  1522. in: path
  1523. description: group id
  1524. required: true
  1525. type: string
  1526. format: JSON
  1527. - name: data
  1528. in: body
  1529. required: false
  1530. schema:
  1531. $ref: '#/definitions/organization'
  1532. responses:
  1533. '200':
  1534. description: Request was successful
  1535. schema:
  1536. $ref: '#/definitions/organization'
  1537. deprecated: false
  1538. delete:
  1539. tags:
  1540. - group
  1541. summary: Deletes all organizations of this model.
  1542. operationId: group.prototype.__delete__organizations
  1543. parameters:
  1544. - name: id
  1545. in: path
  1546. description: group id
  1547. required: true
  1548. type: string
  1549. format: JSON
  1550. responses:
  1551. '204':
  1552. description: Request was successful
  1553. deprecated: false
  1554. '/groups/{id}/organizations/count':
  1555. get:
  1556. tags:
  1557. - group
  1558. summary: Counts organizations of group.
  1559. operationId: group.prototype.__count__organizations
  1560. parameters:
  1561. - name: id
  1562. in: path
  1563. description: group id
  1564. required: true
  1565. type: string
  1566. format: JSON
  1567. - name: where
  1568. in: query
  1569. description: Criteria to match model instances
  1570. required: false
  1571. type: string
  1572. format: JSON
  1573. responses:
  1574. '200':
  1575. description: Request was successful
  1576. schema:
  1577. type: object
  1578. properties:
  1579. count:
  1580. type: number
  1581. format: double
  1582. deprecated: false
  1583. '/groups/{id}/license-pools':
  1584. get:
  1585. tags:
  1586. - group
  1587. summary: Queries license-pools of group.
  1588. operationId: group.prototype.__get__license-pools
  1589. parameters:
  1590. - name: id
  1591. in: path
  1592. description: group id
  1593. required: true
  1594. type: string
  1595. format: JSON
  1596. - name: filter
  1597. in: query
  1598. required: false
  1599. type: string
  1600. format: JSON
  1601. responses:
  1602. '200':
  1603. description: Request was successful
  1604. schema:
  1605. type: array
  1606. items:
  1607. $ref: '#/definitions/license-pool'
  1608. deprecated: false
  1609. post:
  1610. tags:
  1611. - group
  1612. summary: Creates a new instance in license-pools of this model.
  1613. operationId: group.prototype.__create__license-pools
  1614. parameters:
  1615. - name: id
  1616. in: path
  1617. description: group id
  1618. required: true
  1619. type: string
  1620. format: JSON
  1621. - name: data
  1622. in: body
  1623. required: false
  1624. schema:
  1625. $ref: '#/definitions/license-pool'
  1626. responses:
  1627. '200':
  1628. description: Request was successful
  1629. schema:
  1630. $ref: '#/definitions/license-pool'
  1631. deprecated: false
  1632. delete:
  1633. tags:
  1634. - group
  1635. summary: Deletes all license-pools of this model.
  1636. operationId: group.prototype.__delete__license-pools
  1637. parameters:
  1638. - name: id
  1639. in: path
  1640. description: group id
  1641. required: true
  1642. type: string
  1643. format: JSON
  1644. responses:
  1645. '204':
  1646. description: Request was successful
  1647. deprecated: false
  1648. '/groups/{id}/license-pools/count':
  1649. get:
  1650. tags:
  1651. - group
  1652. summary: Counts license-pools of group.
  1653. operationId: group.prototype.__count__license-pools
  1654. parameters:
  1655. - name: id
  1656. in: path
  1657. description: group id
  1658. required: true
  1659. type: string
  1660. format: JSON
  1661. - name: where
  1662. in: query
  1663. description: Criteria to match model instances
  1664. required: false
  1665. type: string
  1666. format: JSON
  1667. responses:
  1668. '200':
  1669. description: Request was successful
  1670. schema:
  1671. type: object
  1672. properties:
  1673. count:
  1674. type: number
  1675. format: double
  1676. deprecated: false
  1677. /groups:
  1678. post:
  1679. tags:
  1680. - group
  1681. summary: Create a new instance of the model and persist it into the data source.
  1682. operationId: group.create
  1683. parameters:
  1684. - name: data
  1685. in: body
  1686. description: Model instance data
  1687. required: false
  1688. schema:
  1689. description: Model instance data
  1690. $ref: '#/definitions/group'
  1691. responses:
  1692. '200':
  1693. description: Request was successful
  1694. schema:
  1695. $ref: '#/definitions/group'
  1696. deprecated: false
  1697. patch:
  1698. tags:
  1699. - group
  1700. summary: >-
  1701. Patch an existing model instance or insert a new one into the data
  1702. source.
  1703. operationId: group.patchOrCreate
  1704. parameters:
  1705. - name: data
  1706. in: body
  1707. description: Model instance data
  1708. required: false
  1709. schema:
  1710. description: Model instance data
  1711. $ref: '#/definitions/group'
  1712. responses:
  1713. '200':
  1714. description: Request was successful
  1715. schema:
  1716. $ref: '#/definitions/group'
  1717. deprecated: false
  1718. put:
  1719. tags:
  1720. - group
  1721. summary: >-
  1722. Replace an existing model instance or insert a new one into the data
  1723. source.
  1724. operationId: group.replaceOrCreate__put_groups
  1725. parameters:
  1726. - name: data
  1727. in: body
  1728. description: Model instance data
  1729. required: false
  1730. schema:
  1731. description: Model instance data
  1732. $ref: '#/definitions/group'
  1733. responses:
  1734. '200':
  1735. description: Request was successful
  1736. schema:
  1737. $ref: '#/definitions/group'
  1738. deprecated: false
  1739. get:
  1740. tags:
  1741. - group
  1742. summary: Find all instances of the model matched by filter from the data source.
  1743. operationId: group.find
  1744. parameters:
  1745. - name: filter
  1746. in: query
  1747. description: >-
  1748. Filter defining fields, where, include, order, offset, and limit -
  1749. must be a JSON-encoded string ({"something":"value"})
  1750. required: false
  1751. type: string
  1752. format: JSON
  1753. responses:
  1754. '200':
  1755. description: Request was successful
  1756. schema:
  1757. type: array
  1758. items:
  1759. $ref: '#/definitions/group'
  1760. deprecated: false
  1761. /groups/replaceOrCreate:
  1762. post:
  1763. tags:
  1764. - group
  1765. summary: >-
  1766. Replace an existing model instance or insert a new one into the data
  1767. source.
  1768. operationId: group.replaceOrCreate__post_groups_replaceOrCreate
  1769. parameters:
  1770. - name: data
  1771. in: body
  1772. description: Model instance data
  1773. required: false
  1774. schema:
  1775. description: Model instance data
  1776. $ref: '#/definitions/group'
  1777. responses:
  1778. '200':
  1779. description: Request was successful
  1780. schema:
  1781. $ref: '#/definitions/group'
  1782. deprecated: false
  1783. /groups/upsertWithWhere:
  1784. post:
  1785. tags:
  1786. - group
  1787. summary: >-
  1788. Update an existing model instance or insert a new one into the data
  1789. source based on the where criteria.
  1790. operationId: group.upsertWithWhere
  1791. parameters:
  1792. - name: where
  1793. in: query
  1794. description: Criteria to match model instances
  1795. required: false
  1796. type: string
  1797. format: JSON
  1798. - name: data
  1799. in: body
  1800. description: An object of model property name/value pairs
  1801. required: false
  1802. schema:
  1803. description: An object of model property name/value pairs
  1804. $ref: '#/definitions/group'
  1805. responses:
  1806. '200':
  1807. description: Request was successful
  1808. schema:
  1809. $ref: '#/definitions/group'
  1810. deprecated: false
  1811. '/groups/{id}/exists':
  1812. get:
  1813. tags:
  1814. - group
  1815. summary: Check whether a model instance exists in the data source.
  1816. operationId: 'group.exists__get_groups_{id}_exists'
  1817. parameters:
  1818. - name: id
  1819. in: path
  1820. description: Model id
  1821. required: true
  1822. type: string
  1823. format: JSON
  1824. responses:
  1825. '200':
  1826. description: Request was successful
  1827. schema:
  1828. type: object
  1829. properties:
  1830. exists:
  1831. type: boolean
  1832. deprecated: false
  1833. '/groups/{id}':
  1834. head:
  1835. tags:
  1836. - group
  1837. summary: Check whether a model instance exists in the data source.
  1838. operationId: 'group.exists__head_groups_{id}'
  1839. parameters:
  1840. - name: id
  1841. in: path
  1842. description: Model id
  1843. required: true
  1844. type: string
  1845. format: JSON
  1846. responses:
  1847. '200':
  1848. description: Request was successful
  1849. schema:
  1850. type: object
  1851. properties:
  1852. exists:
  1853. type: boolean
  1854. deprecated: false
  1855. get:
  1856. tags:
  1857. - group
  1858. summary: 'Find a model instance by {{id}} from the data source.'
  1859. operationId: group.findById
  1860. parameters:
  1861. - name: id
  1862. in: path
  1863. description: Model id
  1864. required: true
  1865. type: string
  1866. format: JSON
  1867. - name: filter
  1868. in: query
  1869. description: >-
  1870. Filter defining fields and include - must be a JSON-encoded string
  1871. ({"something":"value"})
  1872. required: false
  1873. type: string
  1874. format: JSON
  1875. responses:
  1876. '200':
  1877. description: Request was successful
  1878. schema:
  1879. $ref: '#/definitions/group'
  1880. deprecated: false
  1881. put:
  1882. tags:
  1883. - group
  1884. summary: >-
  1885. Replace attributes for a model instance and persist it into the data
  1886. source.
  1887. operationId: 'group.replaceById__put_groups_{id}'
  1888. parameters:
  1889. - name: id
  1890. in: path
  1891. description: Model id
  1892. required: true
  1893. type: string
  1894. format: JSON
  1895. - name: data
  1896. in: body
  1897. description: Model instance data
  1898. required: false
  1899. schema:
  1900. description: Model instance data
  1901. $ref: '#/definitions/group'
  1902. responses:
  1903. '200':
  1904. description: Request was successful
  1905. schema:
  1906. $ref: '#/definitions/group'
  1907. deprecated: false
  1908. delete:
  1909. tags:
  1910. - group
  1911. summary: 'Delete a model instance by {{id}} from the data source.'
  1912. operationId: group.deleteById
  1913. parameters:
  1914. - name: id
  1915. in: path
  1916. description: Model id
  1917. required: true
  1918. type: string
  1919. format: JSON
  1920. responses:
  1921. '200':
  1922. description: Request was successful
  1923. schema:
  1924. type: object
  1925. deprecated: false
  1926. patch:
  1927. tags:
  1928. - group
  1929. summary: >-
  1930. Patch attributes for a model instance and persist it into the data
  1931. source.
  1932. operationId: group.prototype.patchAttributes
  1933. parameters:
  1934. - name: id
  1935. in: path
  1936. description: group id
  1937. required: true
  1938. type: string
  1939. format: JSON
  1940. - name: data
  1941. in: body
  1942. description: An object of model property name/value pairs
  1943. required: false
  1944. schema:
  1945. description: An object of model property name/value pairs
  1946. $ref: '#/definitions/group'
  1947. responses:
  1948. '200':
  1949. description: Request was successful
  1950. schema:
  1951. $ref: '#/definitions/group'
  1952. deprecated: false
  1953. '/groups/{id}/replace':
  1954. post:
  1955. tags:
  1956. - group
  1957. summary: >-
  1958. Replace attributes for a model instance and persist it into the data
  1959. source.
  1960. operationId: 'group.replaceById__post_groups_{id}_replace'
  1961. parameters:
  1962. - name: id
  1963. in: path
  1964. description: Model id
  1965. required: true
  1966. type: string
  1967. format: JSON
  1968. - name: data
  1969. in: body
  1970. description: Model instance data
  1971. required: false
  1972. schema:
  1973. description: Model instance data
  1974. $ref: '#/definitions/group'
  1975. responses:
  1976. '200':
  1977. description: Request was successful
  1978. schema:
  1979. $ref: '#/definitions/group'
  1980. deprecated: false
  1981. /groups/findOne:
  1982. get:
  1983. tags:
  1984. - group
  1985. summary: Find first instance of the model matched by filter from the data source.
  1986. operationId: group.findOne
  1987. parameters:
  1988. - name: filter
  1989. in: query
  1990. description: >-
  1991. Filter defining fields, where, include, order, offset, and limit -
  1992. must be a JSON-encoded string ({"something":"value"})
  1993. required: false
  1994. type: string
  1995. format: JSON
  1996. responses:
  1997. '200':
  1998. description: Request was successful
  1999. schema:
  2000. $ref: '#/definitions/group'
  2001. deprecated: false
  2002. /groups/update:
  2003. post:
  2004. tags:
  2005. - group
  2006. summary: 'Update instances of the model matched by {{where}} from the data source.'
  2007. operationId: group.updateAll
  2008. parameters:
  2009. - name: where
  2010. in: query
  2011. description: Criteria to match model instances
  2012. required: false
  2013. type: string
  2014. format: JSON
  2015. - name: data
  2016. in: body
  2017. description: An object of model property name/value pairs
  2018. required: false
  2019. schema:
  2020. description: An object of model property name/value pairs
  2021. $ref: '#/definitions/group'
  2022. responses:
  2023. '200':
  2024. description: Request was successful
  2025. schema:
  2026. description: Information related to the outcome of the operation
  2027. type: object
  2028. properties:
  2029. count:
  2030. description: The number of instances updated
  2031. type: number
  2032. format: double
  2033. deprecated: false
  2034. /groups/count:
  2035. get:
  2036. tags:
  2037. - group
  2038. summary: Count instances of the model matched by where from the data source.
  2039. operationId: group.count
  2040. parameters:
  2041. - name: where
  2042. in: query
  2043. description: Criteria to match model instances
  2044. required: false
  2045. type: string
  2046. format: JSON
  2047. responses:
  2048. '200':
  2049. description: Request was successful
  2050. schema:
  2051. type: object
  2052. properties:
  2053. count:
  2054. type: number
  2055. format: double
  2056. deprecated: false
  2057. /groups/change-stream:
  2058. post:
  2059. tags:
  2060. - group
  2061. summary: Create a change stream.
  2062. operationId: group.createChangeStream__post_groups_change-stream
  2063. parameters:
  2064. - name: options
  2065. in: formData
  2066. required: false
  2067. type: string
  2068. format: JSON
  2069. responses:
  2070. '200':
  2071. description: Request was successful
  2072. schema:
  2073. type: file
  2074. deprecated: false
  2075. get:
  2076. tags:
  2077. - group
  2078. summary: Create a change stream.
  2079. operationId: group.createChangeStream__get_groups_change-stream
  2080. parameters:
  2081. - name: options
  2082. in: query
  2083. required: false
  2084. type: string
  2085. format: JSON
  2086. responses:
  2087. '200':
  2088. description: Request was successful
  2089. schema:
  2090. type: file
  2091. deprecated: false
  2092. '/groups/{id}/add-member':
  2093. post:
  2094. tags:
  2095. - group
  2096. operationId: group.prototype.addMember
  2097. parameters:
  2098. - name: id
  2099. in: path
  2100. description: group id
  2101. required: true
  2102. type: string
  2103. format: JSON
  2104. - name: email
  2105. in: body
  2106. required: false
  2107. schema:
  2108. type: object
  2109. responses:
  2110. '204':
  2111. description: Request was successful
  2112. deprecated: false
  2113. '/groups/{id}/license-pools/{nk}/group':
  2114. get:
  2115. tags:
  2116. - group
  2117. summary: Fetches belongsTo relation group.
  2118. operationId: group.prototype.__get__license-pools__group
  2119. parameters:
  2120. - name: id
  2121. in: path
  2122. description: group id
  2123. required: true
  2124. type: string
  2125. format: JSON
  2126. - name: nk
  2127. in: path
  2128. description: Foreign key for license-pools.
  2129. required: true
  2130. type: string
  2131. format: JSON
  2132. - name: refresh
  2133. in: query
  2134. required: false
  2135. type: boolean
  2136. responses:
  2137. '200':
  2138. description: Request was successful
  2139. schema:
  2140. $ref: '#/definitions/group'
  2141. deprecated: false
  2142. '/groups/{id}/license-pools/{nk}/cluster':
  2143. get:
  2144. tags:
  2145. - group
  2146. summary: Fetches belongsTo relation cluster.
  2147. operationId: group.prototype.__get__license-pools__cluster
  2148. parameters:
  2149. - name: id
  2150. in: path
  2151. description: group id
  2152. required: true
  2153. type: string
  2154. format: JSON
  2155. - name: nk
  2156. in: path
  2157. description: Foreign key for license-pools.
  2158. required: true
  2159. type: string
  2160. format: JSON
  2161. - name: refresh
  2162. in: query
  2163. required: false
  2164. type: boolean
  2165. responses:
  2166. '200':
  2167. description: Request was successful
  2168. schema:
  2169. $ref: '#/definitions/cluster'
  2170. deprecated: false
  2171. '/groups/{id}/license-pools/{nk}/organization':
  2172. get:
  2173. tags:
  2174. - group
  2175. summary: Fetches belongsTo relation organization.
  2176. operationId: group.prototype.__get__license-pools__organization
  2177. parameters:
  2178. - name: id
  2179. in: path
  2180. description: group id
  2181. required: true
  2182. type: string
  2183. format: JSON
  2184. - name: nk
  2185. in: path
  2186. description: Foreign key for license-pools.
  2187. required: true
  2188. type: string
  2189. format: JSON
  2190. - name: refresh
  2191. in: query
  2192. required: false
  2193. type: boolean
  2194. responses:
  2195. '200':
  2196. description: Request was successful
  2197. schema:
  2198. $ref: '#/definitions/organization'
  2199. deprecated: false
  2200. '/groups/{id}/license-pools/{nk}/licenses/{fk}':
  2201. get:
  2202. tags:
  2203. - group
  2204. summary: Find a related item by id for licenses.
  2205. operationId: group.prototype.__findById__license-pools__licenses
  2206. parameters:
  2207. - name: id
  2208. in: path
  2209. description: group id
  2210. required: true
  2211. type: string
  2212. format: JSON
  2213. - name: nk
  2214. in: path
  2215. description: Foreign key for license-pools.
  2216. required: true
  2217. type: string
  2218. format: JSON
  2219. - name: fk
  2220. in: path
  2221. description: Foreign key for licenses
  2222. required: true
  2223. type: string
  2224. format: JSON
  2225. responses:
  2226. '200':
  2227. description: Request was successful
  2228. schema:
  2229. $ref: '#/definitions/license'
  2230. deprecated: false
  2231. delete:
  2232. tags:
  2233. - group
  2234. summary: Delete a related item by id for licenses.
  2235. operationId: group.prototype.__destroyById__license-pools__licenses
  2236. parameters:
  2237. - name: id
  2238. in: path
  2239. description: group id
  2240. required: true
  2241. type: string
  2242. format: JSON
  2243. - name: nk
  2244. in: path
  2245. description: Foreign key for license-pools.
  2246. required: true
  2247. type: string
  2248. format: JSON
  2249. - name: fk
  2250. in: path
  2251. description: Foreign key for licenses
  2252. required: true
  2253. type: string
  2254. format: JSON
  2255. responses:
  2256. '204':
  2257. description: Request was successful
  2258. deprecated: false
  2259. put:
  2260. tags:
  2261. - group
  2262. summary: Update a related item by id for licenses.
  2263. operationId: group.prototype.__updateById__license-pools__licenses
  2264. parameters:
  2265. - name: id
  2266. in: path
  2267. description: group id
  2268. required: true
  2269. type: string
  2270. format: JSON
  2271. - name: nk
  2272. in: path
  2273. description: Foreign key for license-pools.
  2274. required: true
  2275. type: string
  2276. format: JSON
  2277. - name: fk
  2278. in: path
  2279. description: Foreign key for licenses
  2280. required: true
  2281. type: string
  2282. format: JSON
  2283. - name: data
  2284. in: body
  2285. required: false
  2286. schema:
  2287. $ref: '#/definitions/license'
  2288. responses:
  2289. '200':
  2290. description: Request was successful
  2291. schema:
  2292. $ref: '#/definitions/license'
  2293. deprecated: false
  2294. '/groups/{id}/license-pools/{nk}/licenses':
  2295. get:
  2296. tags:
  2297. - group
  2298. summary: Queries licenses of license-pool.
  2299. operationId: group.prototype.__get__license-pools__licenses
  2300. parameters:
  2301. - name: id
  2302. in: path
  2303. description: group id
  2304. required: true
  2305. type: string
  2306. format: JSON
  2307. - name: nk
  2308. in: path
  2309. description: Foreign key for license-pools.
  2310. required: true
  2311. type: string
  2312. format: JSON
  2313. - name: filter
  2314. in: query
  2315. required: false
  2316. type: string
  2317. format: JSON
  2318. responses:
  2319. '200':
  2320. description: Request was successful
  2321. schema:
  2322. type: array
  2323. items:
  2324. $ref: '#/definitions/license'
  2325. deprecated: false
  2326. post:
  2327. tags:
  2328. - group
  2329. summary: Creates a new instance in licenses of this model.
  2330. operationId: group.prototype.__create__license-pools__licenses
  2331. parameters:
  2332. - name: id
  2333. in: path
  2334. description: group id
  2335. required: true
  2336. type: string
  2337. format: JSON
  2338. - name: nk
  2339. in: path
  2340. description: Foreign key for license-pools.
  2341. required: true
  2342. type: string
  2343. format: JSON
  2344. - name: data
  2345. in: body
  2346. required: false
  2347. schema:
  2348. $ref: '#/definitions/license'
  2349. responses:
  2350. '200':
  2351. description: Request was successful
  2352. schema:
  2353. $ref: '#/definitions/license'
  2354. deprecated: false
  2355. delete:
  2356. tags:
  2357. - group
  2358. summary: Deletes all licenses of this model.
  2359. operationId: group.prototype.__delete__license-pools__licenses
  2360. parameters:
  2361. - name: id
  2362. in: path
  2363. description: group id
  2364. required: true
  2365. type: string
  2366. format: JSON
  2367. - name: nk
  2368. in: path
  2369. description: Foreign key for license-pools.
  2370. required: true
  2371. type: string
  2372. format: JSON
  2373. responses:
  2374. '204':
  2375. description: Request was successful
  2376. deprecated: false
  2377. '/groups/{id}/license-pools/{nk}/licenses/count':
  2378. get:
  2379. tags:
  2380. - group
  2381. summary: Counts licenses of license-pool.
  2382. operationId: group.prototype.__count__license-pools__licenses
  2383. parameters:
  2384. - name: id
  2385. in: path
  2386. description: group id
  2387. required: true
  2388. type: string
  2389. format: JSON
  2390. - name: nk
  2391. in: path
  2392. description: Foreign key for license-pools.
  2393. required: true
  2394. type: string
  2395. format: JSON
  2396. - name: where
  2397. in: query
  2398. description: Criteria to match model instances
  2399. required: false
  2400. type: string
  2401. format: JSON
  2402. responses:
  2403. '200':
  2404. description: Request was successful
  2405. schema:
  2406. type: object
  2407. properties:
  2408. count:
  2409. type: number
  2410. format: double
  2411. deprecated: false
  2412. tags:
  2413. - name: user
  2414. - name: group
  2415. consumes:
  2416. - application/json
  2417. - application/x-www-form-urlencoded
  2418. - application/xml
  2419. - text/xml
  2420. produces:
  2421. - application/json
  2422. - application/xml
  2423. - text/xml
  2424. - application/javascript
  2425. - text/javascript
  2426. definitions:
  2427. x-any:
  2428. properties: {}
  2429. AccessToken:
  2430. properties:
  2431. id:
  2432. type: string
  2433. ttl:
  2434. default: 1209600
  2435. description: time to live in seconds (2 weeks by default)
  2436. type: number
  2437. format: double
  2438. scopes:
  2439. description: Array of scopes granted to this access token.
  2440. type: array
  2441. items:
  2442. type: string
  2443. created:
  2444. type: string
  2445. format: date-time
  2446. userId:
  2447. $ref: '#/definitions/ObjectID'
  2448. required:
  2449. - id
  2450. additionalProperties: false
  2451. group:
  2452. properties:
  2453. id:
  2454. $ref: '#/definitions/ObjectID'
  2455. ownerId:
  2456. $ref: '#/definitions/ObjectID'
  2457. additionalProperties: false
  2458. user:
  2459. properties:
  2460. firstName:
  2461. type: string
  2462. lastName:
  2463. type: string
  2464. realm:
  2465. type: string
  2466. username:
  2467. type: string
  2468. email:
  2469. type: string
  2470. emailVerified:
  2471. type: boolean
  2472. id:
  2473. $ref: '#/definitions/ObjectID'
  2474. required:
  2475. - firstName
  2476. - lastName
  2477. - email
  2478. additionalProperties: false
  2479. groupuser:
  2480. properties:
  2481. id:
  2482. $ref: '#/definitions/ObjectID'
  2483. groupId:
  2484. $ref: '#/definitions/ObjectID'
  2485. userId:
  2486. $ref: '#/definitions/ObjectID'
  2487. additionalProperties: false
  2488. cluster:
  2489. properties:
  2490. id:
  2491. $ref: '#/definitions/ObjectID'
  2492. groupId:
  2493. $ref: '#/definitions/ObjectID'
  2494. additionalProperties: false
  2495. organization:
  2496. properties:
  2497. clusterId:
  2498. $ref: '#/definitions/ObjectID'
  2499. id:
  2500. $ref: '#/definitions/ObjectID'
  2501. groupId:
  2502. $ref: '#/definitions/ObjectID'
  2503. required:
  2504. - clusterId
  2505. additionalProperties: false
  2506. license-pool:
  2507. properties:
  2508. clusterId:
  2509. $ref: '#/definitions/ObjectID'
  2510. id:
  2511. $ref: '#/definitions/ObjectID'
  2512. groupId:
  2513. $ref: '#/definitions/ObjectID'
  2514. organizationId:
  2515. $ref: '#/definitions/ObjectID'
  2516. required:
  2517. - clusterId
  2518. additionalProperties: false
  2519. license:
  2520. properties:
  2521. id:
  2522. $ref: '#/definitions/ObjectID'
  2523. poolId:
  2524. $ref: '#/definitions/ObjectID'
  2525. additionalProperties: false
  2526. ObjectID:
  2527. type: string
  2528. pattern: '^[a-fA-F\d]{24}$'
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!