API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Apr 8th, 2019
254
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 28.57 KB | None | 0 0
raw download clone embed print report
  1. swagger: "2.0"
  2. info:
  3. description: This API is for Service Providers that are coming into IBM Cloud Private
  4. For Data
  5. title: Service Provider API Spec
  6. license:
  7. name: (c) IBM. All rights reserved
  8. version: Beta
  9. basePath: /v1
  10. paths:
  11. /grant:
  12. post:
  13. description: Its expected that the Admin (originally the creator of the service
  14. instance) grants access to Zen users. This post action allows the user to
  15. get some rights to work with the service instance. This action can only triggered
  16. by the owner of the service instance resource or an admin. A role/privilege
  17. in the service instance may also be associated with this user.
  18. consumes:
  19. - application/json
  20. produces:
  21. - application/json
  22. tags:
  23. - users
  24. summary: Associate one or more users to the service instance.
  25. operationId: addUserToServiceInstance
  26. parameters:
  27. - type: string
  28. description: Added by zen-core-api to identify the current user that triggered
  29. the request
  30. name: jwt-auth-user-payload
  31. in: header
  32. - type: string
  33. description: Basic Authorization token which is generated and unique to each
  34. service provider. This will need be used by service broker to talk to service
  35. provider
  36. name: Authorization
  37. in: header
  38. - description: ServiceInstance metadataartifact that needs to be added to the
  39. Database
  40. name: body
  41. in: body
  42. required: true
  43. schema:
  44. $ref: '#/definitions/AddUsersSchema'
  45. responses:
  46. "200":
  47. description: Success
  48. schema:
  49. $ref: '#/definitions/SuccessPostResponse'
  50. "400":
  51. description: Error
  52. schema:
  53. $ref: '#/definitions/ErrorResponse'
  54. "401":
  55. description: Unauthorized
  56. schema:
  57. $ref: '#/definitions/ErrorResponse'
  58. "404":
  59. description: Not found
  60. schema:
  61. $ref: '#/definitions/ErrorResponse'
  62. "409":
  63. description: Resource Already Exists
  64. schema:
  65. $ref: '#/definitions/ErrorResponse'
  66. "500":
  67. description: Internal Server Error
  68. schema:
  69. $ref: '#/definitions/ErrorResponse'
  70. /job/details/{jobid}:
  71. post:
  72. description: Given the service instane id and job id, this api returns details
  73. about the particular job.
  74. consumes:
  75. - application/json
  76. produces:
  77. - application/json
  78. tags:
  79. - jobs
  80. summary: Returns the job details for a particular instance.
  81. operationId: getJobDetails
  82. parameters:
  83. - type: string
  84. description: Added by zen-core-api to identify the current user that triggered
  85. the request
  86. name: jwt-auth-user-payload
  87. in: header
  88. - type: string
  89. description: Basic Authorization token which is generated and unique to each
  90. service provider. This will need be used by service broker to talk to service
  91. provider
  92. name: Authorization
  93. in: header
  94. - type: string
  95. description: jobid for which we want the details
  96. name: jobid
  97. in: path
  98. required: true
  99. - description: meta information about the serviceInstance that was provisioned.
  100. name: body
  101. in: body
  102. required: true
  103. schema:
  104. $ref: '#/definitions/ServiceInstanceMetadata'
  105. responses:
  106. "200":
  107. description: Success
  108. schema:
  109. $ref: '#/definitions/Job'
  110. "400":
  111. description: Error
  112. schema:
  113. $ref: '#/definitions/ErrorResponse'
  114. "401":
  115. description: Unauthorized
  116. schema:
  117. $ref: '#/definitions/ErrorResponse'
  118. "404":
  119. description: Not found
  120. schema:
  121. $ref: '#/definitions/ErrorResponse'
  122. "500":
  123. description: Internal Server Error
  124. schema:
  125. $ref: '#/definitions/ErrorResponse'
  126. /job/logs/{jobid}:
  127. post:
  128. description: Given the service instane id and job id, this api returns Logs
  129. about the particular job.
  130. consumes:
  131. - application/json
  132. produces:
  133. - application/octet-stream
  134. tags:
  135. - jobs
  136. summary: Returns the job logs for a particular job.
  137. operationId: getJobLogs
  138. parameters:
  139. - type: string
  140. description: Added by zen-core-api to identify the current user that triggered
  141. the request
  142. name: jwt-auth-user-payload
  143. in: header
  144. - type: string
  145. description: Basic Authorization token which is generated and unique to each
  146. service provider. This will need be used by service broker to talk to service
  147. provider
  148. name: Authorization
  149. in: header
  150. - type: string
  151. description: jobid for which we want the details
  152. name: jobid
  153. in: path
  154. required: true
  155. - description: meta information about the serviceInstance that was provisioned.
  156. name: body
  157. in: body
  158. required: true
  159. schema:
  160. $ref: '#/definitions/ServiceInstanceMetadata'
  161. responses:
  162. "200":
  163. description: Success
  164. schema:
  165. type: string
  166. format: binary
  167. "400":
  168. description: Error
  169. schema:
  170. $ref: '#/definitions/ErrorResponse'
  171. "401":
  172. description: Unauthorized
  173. schema:
  174. $ref: '#/definitions/ErrorResponse'
  175. "404":
  176. description: Not found
  177. schema:
  178. $ref: '#/definitions/ErrorResponse'
  179. "500":
  180. description: Internal Server Error
  181. schema:
  182. $ref: '#/definitions/ErrorResponse'
  183. /job/{jobid}:
  184. delete:
  185. description: Given the job id and service instance id, this api deletes the
  186. job and returns the response.
  187. consumes:
  188. - application/json
  189. produces:
  190. - application/json
  191. tags:
  192. - jobs
  193. summary: Delete a particular job
  194. operationId: DeleteJob
  195. parameters:
  196. - type: string
  197. description: Added by zen-core-api to identify the current user that triggered
  198. the request
  199. name: jwt-auth-user-payload
  200. in: header
  201. - type: string
  202. description: Basic Authorization token which is generated and unique to each
  203. service provider. This will need be used by service broker to talk to service
  204. provider
  205. name: Authorization
  206. in: header
  207. - type: string
  208. description: jobid for which we want the details
  209. name: jobid
  210. in: path
  211. required: true
  212. - description: meta information about the serviceInstance that was provisioned.
  213. name: body
  214. in: body
  215. required: true
  216. schema:
  217. $ref: '#/definitions/ServiceInstanceMetadata'
  218. responses:
  219. "200":
  220. description: Success
  221. schema:
  222. $ref: '#/definitions/SuccessResponse'
  223. "400":
  224. description: Error
  225. schema:
  226. $ref: '#/definitions/ErrorResponse'
  227. "401":
  228. description: Unauthorized
  229. schema:
  230. $ref: '#/definitions/ErrorResponse'
  231. "404":
  232. description: Not found
  233. schema:
  234. $ref: '#/definitions/ErrorResponse'
  235. "500":
  236. description: Internal Server Error
  237. schema:
  238. $ref: '#/definitions/ErrorResponse'
  239. /jobs:
  240. post:
  241. description: Given the service instane id, returns the list of jobs with along
  242. with some metadata.
  243. consumes:
  244. - application/json
  245. produces:
  246. - application/json
  247. tags:
  248. - jobs
  249. summary: Returns the list of jobs associated with the service instance.
  250. operationId: getJobs
  251. parameters:
  252. - type: string
  253. description: Added by zen-core-api to identify the current user that triggered
  254. the request
  255. name: jwt-auth-user-payload
  256. in: header
  257. - type: string
  258. description: Basic Authorization token which is generated and unique to each
  259. service provider. This will need be used by service broker to talk to service
  260. provider
  261. name: Authorization
  262. in: header
  263. - description: meta information about the serviceInstance that was provisioned.
  264. name: body
  265. in: body
  266. required: true
  267. schema:
  268. $ref: '#/definitions/ServiceInstanceMetadata'
  269. responses:
  270. "200":
  271. description: Success
  272. schema:
  273. $ref: '#/definitions/SuccessJobsResponse'
  274. "400":
  275. description: Error
  276. schema:
  277. $ref: '#/definitions/ErrorResponse'
  278. "401":
  279. description: Unauthorized
  280. schema:
  281. $ref: '#/definitions/ErrorResponse'
  282. "404":
  283. description: Not found
  284. schema:
  285. $ref: '#/definitions/ErrorResponse'
  286. "500":
  287. description: Internal Server Error
  288. schema:
  289. $ref: '#/definitions/ErrorResponse'
  290. /monitor:
  291. get:
  292. tags:
  293. - monitor
  294. summary: checks whether the server is up
  295. operationId: getMonitor
  296. responses:
  297. "200":
  298. description: Success
  299. schema:
  300. $ref: '#/definitions/SuccessGetResponse'
  301. default:
  302. description: Error
  303. schema:
  304. $ref: '#/definitions/ErrorResponse'
  305. /monitorServiceInstance:
  306. post:
  307. description: returns the details like connection-info, metadata and statis of
  308. the provisioned instance of an addon.
  309. consumes:
  310. - application/json
  311. produces:
  312. - application/json
  313. tags:
  314. - provisioner
  315. summary: monitor the status of the provisioned service Instance and returns
  316. the details of the provisioned service instance.
  317. operationId: monitorProvisionedServiceInstance
  318. parameters:
  319. - type: string
  320. description: Added by zen-core-api to identify the current user that triggered
  321. the request
  322. name: jwt-auth-user-payload
  323. in: header
  324. - type: string
  325. description: Basic Authorization token which is generated and unique to each
  326. service provider. This will need be used by service broker to talk to service
  327. provider
  328. name: Authorization
  329. in: header
  330. - description: meta information about the serviceInstance that was provisioned.
  331. name: body
  332. in: body
  333. required: true
  334. schema:
  335. $ref: '#/definitions/ServiceInstanceMetadata'
  336. responses:
  337. "200":
  338. description: Success
  339. schema:
  340. $ref: '#/definitions/SuccessMonitorResponse'
  341. "400":
  342. description: Error
  343. schema:
  344. $ref: '#/definitions/ErrorResponse'
  345. "401":
  346. description: Unauthorized
  347. schema:
  348. $ref: '#/definitions/ErrorResponse'
  349. "404":
  350. description: Not found
  351. schema:
  352. $ref: '#/definitions/ErrorResponse'
  353. "500":
  354. description: Internal Server Error
  355. schema:
  356. $ref: '#/definitions/ErrorResponse'
  357. /provision:
  358. post:
  359. description: this api provisions a new service instance in ICP for Data
  360. consumes:
  361. - application/json
  362. produces:
  363. - application/json
  364. tags:
  365. - provisioner
  366. summary: Provision a new Service Instance
  367. operationId: postServiceInstance
  368. parameters:
  369. - type: string
  370. description: Added by zen-core-api to identify the current user that triggered
  371. the request
  372. name: jwt-auth-user-payload
  373. in: header
  374. - type: string
  375. description: Basic Authorization token which is generated and unique to each
  376. service provider. This will need be used by service broker to talk to service
  377. provider
  378. name: Authorization
  379. in: header
  380. - description: information about the service instance that needs to be provisioned
  381. name: body
  382. in: body
  383. required: true
  384. schema:
  385. $ref: '#/definitions/ServiceInstanceMetadata'
  386. responses:
  387. "200":
  388. description: Success
  389. schema:
  390. $ref: '#/definitions/SuccessPostResponse'
  391. "400":
  392. description: Error
  393. schema:
  394. $ref: '#/definitions/ErrorResponse'
  395. "401":
  396. description: Unauthorized
  397. schema:
  398. $ref: '#/definitions/ErrorResponse'
  399. "404":
  400. description: Not found
  401. schema:
  402. $ref: '#/definitions/ErrorResponse'
  403. "500":
  404. description: Internal Server Error
  405. schema:
  406. $ref: '#/definitions/ErrorResponse'
  407. delete:
  408. description: This deletes the actual service instance and only returns success
  409. response on successfull deletion of the instance and all the users associated
  410. to that database
  411. consumes:
  412. - application/json
  413. produces:
  414. - application/json
  415. tags:
  416. - provisioner
  417. summary: deletes the service instance (including all users in that service
  418. instance)
  419. operationId: deleteServiceInstance
  420. parameters:
  421. - type: string
  422. description: Added by zen-core-api to identify the current user that triggered
  423. the request
  424. name: jwt-auth-user-payload
  425. in: header
  426. - type: string
  427. description: jwt based Authorization bearer token
  428. name: Authorization
  429. in: header
  430. - description: meta information about the service instance that needs to be
  431. deprovisioned
  432. name: body
  433. in: body
  434. required: true
  435. schema:
  436. $ref: '#/definitions/ServiceInstanceMetadata'
  437. responses:
  438. "200":
  439. description: Success
  440. schema:
  441. $ref: '#/definitions/SuccessResponse'
  442. "400":
  443. description: Error
  444. schema:
  445. $ref: '#/definitions/ErrorResponse'
  446. "401":
  447. description: Unauthorized
  448. schema:
  449. $ref: '#/definitions/ErrorResponse'
  450. "404":
  451. description: Not found
  452. schema:
  453. $ref: '#/definitions/ErrorResponse'
  454. "500":
  455. description: Internal Server Error
  456. schema:
  457. $ref: '#/definitions/ErrorResponse'
  458. /provisionstatus:
  459. get:
  460. tags:
  461. - provisioner
  462. summary: Get the Status of the service instance and the Progress of provisioning
  463. operationId: getProvisionStatus
  464. parameters:
  465. - type: string
  466. description: The Service Instance ID of the service instance
  467. name: SID
  468. in: query
  469. required: true
  470. - type: string
  471. description: The Namespace that the service instance is in
  472. name: namespace
  473. in: query
  474. required: true
  475. responses:
  476. "200":
  477. description: Success
  478. schema:
  479. $ref: '#/definitions/SuccessProvisionStatusResponse'
  480. "400":
  481. description: Error
  482. schema:
  483. $ref: '#/definitions/ErrorResponse'
  484. "401":
  485. description: Unauthorized
  486. schema:
  487. $ref: '#/definitions/ErrorResponse'
  488. "404":
  489. description: Not found
  490. schema:
  491. $ref: '#/definitions/ErrorResponse'
  492. "500":
  493. description: Internal Server Error
  494. schema:
  495. $ref: '#/definitions/ErrorResponse'
  496. /revoke:
  497. delete:
  498. consumes:
  499. - application/json
  500. produces:
  501. - application/json
  502. tags:
  503. - users
  504. summary: deletes multiple users associations for this service instance from
  505. the database
  506. operationId: deleteServiceInstanceUser
  507. parameters:
  508. - type: string
  509. description: Added by zen-core-api to identify the current user that triggered
  510. the request
  511. name: jwt-auth-user-payload
  512. in: header
  513. - type: string
  514. description: Basic Authorization token which is generated and unique to each
  515. service provider. This will need be used by service broker to talk to service
  516. provider
  517. name: Authorization
  518. in: header
  519. - description: arrays of usernames to delete
  520. name: body
  521. in: body
  522. required: true
  523. schema:
  524. $ref: '#/definitions/RevokeUsersSchema'
  525. responses:
  526. "200":
  527. description: Success
  528. schema:
  529. $ref: '#/definitions/SuccessResponse'
  530. "400":
  531. description: Error
  532. schema:
  533. $ref: '#/definitions/ErrorResponse'
  534. "401":
  535. description: Unauthorized
  536. schema:
  537. $ref: '#/definitions/ErrorResponse'
  538. "404":
  539. description: Not found
  540. schema:
  541. $ref: '#/definitions/ErrorResponse'
  542. "500":
  543. description: Internal Server Error
  544. schema:
  545. $ref: '#/definitions/ErrorResponse'
  546. /serviceInstance/users/password:
  547. patch:
  548. description: Can only be done by the user who belongs to the service instance
  549. consumes:
  550. - application/json
  551. produces:
  552. - application/json
  553. tags:
  554. - users
  555. summary: Updates user password for a service instance.
  556. operationId: patchUserPasswordServiceInstance
  557. parameters:
  558. - type: string
  559. description: Added by zen-core-api to identify the current user that triggered
  560. the request
  561. name: jwt-auth-user-payload
  562. in: header
  563. - type: string
  564. description: Basic Authorization token which is generated and unique to each
  565. service provider. This will need be used by service broker to talk to service
  566. provider
  567. name: Authorization
  568. in: header
  569. - description: ServiceInstance metadataartifact that needs to be added to the
  570. Database
  571. name: body
  572. in: body
  573. schema:
  574. $ref: '#/definitions/PatchPasswordSchema'
  575. responses:
  576. "200":
  577. description: Success
  578. schema:
  579. $ref: '#/definitions/SuccessResponse'
  580. "400":
  581. description: Error
  582. schema:
  583. $ref: '#/definitions/ErrorResponse'
  584. "401":
  585. description: Unauthorized
  586. schema:
  587. $ref: '#/definitions/ErrorResponse'
  588. "404":
  589. description: Not found
  590. schema:
  591. $ref: '#/definitions/ErrorResponse'
  592. "500":
  593. description: Internal Server Error
  594. schema:
  595. $ref: '#/definitions/ErrorResponse'
  596. /serviceInstance/users/role:
  597. patch:
  598. description: Can only be done by an "Admin" or equivalent role in the service
  599. instance
  600. consumes:
  601. - application/json
  602. produces:
  603. - application/json
  604. tags:
  605. - users
  606. summary: Updates user role for a service instance.
  607. operationId: patchUserRoleServiceInstance
  608. parameters:
  609. - type: string
  610. description: Added by zen-core-api to identify the current user that triggered
  611. the request
  612. name: jwt-auth-user-payload
  613. in: header
  614. - type: string
  615. description: Basic Authorization token which is generated and unique to each
  616. service provider. This will need be used by service broker to talk to service
  617. provider
  618. name: Authorization
  619. in: header
  620. - description: ServiceInstance metadataartifact that needs to be added to the
  621. Database
  622. name: body
  623. in: body
  624. schema:
  625. $ref: '#/definitions/PatchUserRoleSchema'
  626. responses:
  627. "200":
  628. description: Success
  629. schema:
  630. $ref: '#/definitions/SuccessResponse'
  631. "400":
  632. description: Error
  633. schema:
  634. $ref: '#/definitions/ErrorResponse'
  635. "401":
  636. description: Unauthorized
  637. schema:
  638. $ref: '#/definitions/ErrorResponse'
  639. "404":
  640. description: Not found
  641. schema:
  642. $ref: '#/definitions/ErrorResponse'
  643. "500":
  644. description: Internal Server Error
  645. schema:
  646. $ref: '#/definitions/ErrorResponse'
  647. /storageclasses:
  648. get:
  649. tags:
  650. - storage
  651. summary: gets the available storage classes
  652. operationId: getStorageClasses
  653. responses:
  654. "200":
  655. description: Success
  656. schema:
  657. $ref: '#/definitions/SuccessStorageClassesResponse'
  658. "400":
  659. description: Error
  660. schema:
  661. $ref: '#/definitions/ErrorResponse'
  662. "401":
  663. description: Unauthorized
  664. schema:
  665. $ref: '#/definitions/ErrorResponse'
  666. "404":
  667. description: Not found
  668. schema:
  669. $ref: '#/definitions/ErrorResponse'
  670. "500":
  671. description: Internal Server Error
  672. schema:
  673. $ref: '#/definitions/ErrorResponse'
  674. definitions:
  675. AddUsersSchema:
  676. type: object
  677. properties:
  678. CurrentUserRecord:
  679. $ref: '#/definitions/CurrentUserRecord'
  680. ServiceInstanceMetadata:
  681. $ref: '#/definitions/ServiceInstanceMetadata'
  682. users:
  683. type: array
  684. items:
  685. $ref: '#/definitions/ServiceInstanceUsersMetadata'
  686. CurrentUserRecord:
  687. type: object
  688. required:
  689. - uid
  690. - role
  691. - username
  692. properties:
  693. SID:
  694. type: string
  695. display_name:
  696. type: string
  697. password:
  698. type: string
  699. role:
  700. type: string
  701. service_username:
  702. type: string
  703. uid:
  704. type: string
  705. username:
  706. type: string
  707. ErrorResponse:
  708. type: object
  709. properties:
  710. _messageCode_:
  711. description: error code
  712. type: string
  713. _statusCode_:
  714. description: http error code
  715. type: integer
  716. format: int32
  717. exception:
  718. description: string representation of the error
  719. type: string
  720. message:
  721. description: error message
  722. type: string
  723. Job:
  724. type: object
  725. properties:
  726. job_creation_date:
  727. description: Creation Date of the job
  728. type: string
  729. job_id:
  730. description: ID of the job
  731. type: string
  732. job_name:
  733. description: Name of the job
  734. type: string
  735. job_status:
  736. description: status of the job
  737. type: string
  738. job_submitted_by:
  739. description: Username of person who sumbitted the job
  740. type: string
  741. job_type:
  742. description: Type of the job
  743. type: string
  744. payload_obj:
  745. description: free-form metadata object that can contain information about
  746. the job
  747. type: object
  748. project_id:
  749. description: id of the watson studio project from which the job was kicked
  750. off
  751. type: string
  752. PatchPasswordSchema:
  753. type: object
  754. properties:
  755. CurrentUserRecord:
  756. $ref: '#/definitions/CurrentUserRecord'
  757. ServiceInstanceMetadata:
  758. $ref: '#/definitions/ServiceInstanceMetadata'
  759. newpassword:
  760. type: string
  761. oldpassword:
  762. type: string
  763. username:
  764. type: string
  765. example: admin
  766. PatchUserRoleSchema:
  767. type: object
  768. properties:
  769. CurrentUserRecord:
  770. $ref: '#/definitions/CurrentUserRecord'
  771. ServiceInstanceMetadata:
  772. $ref: '#/definitions/ServiceInstanceMetadata'
  773. users:
  774. type: array
  775. items:
  776. $ref: '#/definitions/UserRoleSchema'
  777. RevokeUsersSchema:
  778. type: object
  779. properties:
  780. CurrentUserRecord:
  781. $ref: '#/definitions/CurrentUserRecord'
  782. ServiceInstanceMetadata:
  783. $ref: '#/definitions/ServiceInstanceMetadata'
  784. users:
  785. type: array
  786. items:
  787. description: array of usernames to delete
  788. type: string
  789. ServiceInstanceMetadata:
  790. type: object
  791. properties:
  792. metadata:
  793. description: this is all the metadata provided by User while provisioning.
  794. type: object
  795. parameters:
  796. description: parameters in the form of key value pair that are needed as part
  797. of provision
  798. type: object
  799. serviceInstanceDescription:
  800. type: string
  801. serviceInstanceDisplayName:
  802. type: string
  803. serviceInstanceNamespace:
  804. description: the namespace of provisioned service Instance
  805. type: string
  806. transientFields:
  807. type: object
  808. zenServiceInstanceInfo:
  809. $ref: '#/definitions/ZenServiceInstanceInfo'
  810. ServiceInstanceUsersMetadata:
  811. type: object
  812. properties:
  813. password:
  814. type: string
  815. role:
  816. type: string
  817. uid:
  818. type: string
  819. username:
  820. type: string
  821. SuccessGetResponse:
  822. type: object
  823. properties:
  824. _messageCode_:
  825. description: message code
  826. type: string
  827. message:
  828. description: message
  829. type: string
  830. requestObj:
  831. type: object
  832. status:
  833. description: message
  834. type: string
  835. SuccessGetStatus:
  836. type: object
  837. properties:
  838. status:
  839. description: status of the string
  840. type: string
  841. SuccessJobDetailsResponse:
  842. type: object
  843. properties:
  844. _statusCode_:
  845. description: 200 success code
  846. type: integer
  847. details:
  848. type: object
  849. SuccessJobsResponse:
  850. type: object
  851. properties:
  852. _statusCode_:
  853. description: 200 success Code
  854. type: integer
  855. jobs:
  856. type: array
  857. items:
  858. $ref: '#/definitions/Job'
  859. SuccessMonitorResponse:
  860. type: object
  861. properties:
  862. connection-info:
  863. type: object
  864. message:
  865. type: string
  866. metadata:
  867. type: object
  868. status:
  869. type: string
  870. SuccessPostResponse:
  871. type: object
  872. properties:
  873. message:
  874. description: success message
  875. type: string
  876. metadata:
  877. description: response obj that will be saved in zenmetastore db
  878. type: object
  879. SuccessProvisionStatusResponse:
  880. type: object
  881. properties:
  882. message:
  883. type: string
  884. provision_progress:
  885. type: string
  886. status:
  887. type: string
  888. SuccessResponse:
  889. type: object
  890. properties:
  891. _messageCode_:
  892. description: message code
  893. type: string
  894. message:
  895. description: message
  896. type: string
  897. SuccessStorageClassesResponse:
  898. type: object
  899. properties:
  900. _messageCode_:
  901. description: message code
  902. type: string
  903. message:
  904. description: message
  905. type: string
  906. storage_classes:
  907. type: array
  908. items:
  909. description: name of the storage class
  910. type: string
  911. UserRoleSchema:
  912. type: object
  913. required:
  914. - username
  915. - role
  916. properties:
  917. role:
  918. type: string
  919. example: user or admin
  920. username:
  921. type: string
  922. example: admin
  923. ZenServiceInstanceInfo:
  924. type: object
  925. properties:
  926. zenControlPlaneNamespace:
  927. description: the namespace where Service Broker (zen-core-api in this case)
  928. resides. "zen" might not be the namespace where icp4d is installed.
  929. type: string
  930. zenServiceInstanceId:
  931. description: serviceInstanceId of the provisioned database
  932. type: string
  933. zenServiceInstanceSecret:
  934. description: default password generated by zen-core-api.
  935. type: string
  936. zenServiceInstanceType:
  937. description: the type of serviceInstance. e.g db2wh, eventstore, mongodb etc.
  938. type: string
  939. zenServiceInstanceUID:
  940. description: zen service instane uid
  941. type: string
  942. zenServiceInstanceUserName:
  943. description: zen service instane username
  944. type: string
  945. zenServiceInstanceVersion:
  946. description: version of the type.
  947. type: string
  948. tags:
  949. - name: monitor
  950. - description: API to launch service instances when invoked by a ICP for Data user
  951. with right permissions
  952. name: provisioner
  953. - name: storage
  954. - name: users
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!