API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jun 25th, 2019
214
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 44.51 KB | None | 0 0
raw download clone embed print report
  1. swagger: "2.0"
  2. info:
  3. description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
  4. version: "1.0.0"
  5. title: "Puzzleware Box API"
  6. termsOfService: "http://swagger.io/terms/"
  7. contact:
  8. email: "apiteam@swagger.io"
  9. license:
  10. name: "Apache 2.0"
  11. url: "http://www.apache.org/licenses/LICENSE-2.0.html"
  12. host: "pw.lumadis.lt"
  13. basePath: "/box2.0"
  14. tags:
  15. - name: "channels"
  16. description: "Placeholder"
  17. externalDocs:
  18. description: "ext placeholder"
  19. url: "http://swagger.io"
  20. - name: "recommended"
  21. description: "Access to Petstore orders"
  22. - name: "genres"
  23. description: "Operations about user"
  24. externalDocs:
  25. description: "Find out more about our store"
  26. url: "http://swagger.io"
  27. - name: "tvshows"
  28. description: "Access to Petstore orders"
  29. - name: "epg"
  30. description: "Access to Petstore orders"
  31. - name: "epggrid"
  32. description: "Access to Petstore orders"
  33. - name: "epgarchive"
  34. description: "Access to Petstore orders"
  35. - name: "favorites"
  36. description: "Access to Petstore orders"
  37. - name: "userinfo"
  38. description: "Access to Petstore orders"
  39. - name: "settings"
  40. description: "Access to Petstore orders"
  41. - name: "system"
  42. description: "Access to Petstore orders"
  43. - name: "servers"
  44. description: "Access to Petstore orders"
  45. - name: "geocountries"
  46. description: "Access to Petstore orders"
  47. - name: "geocities"
  48. description: "Access to Petstore orders"
  49. - name: "vod_content"
  50. description: "Access to Petstore orders"
  51. - name: "actors"
  52. description: "Access to Petstore orders"
  53. - name: "directors"
  54. description: "Access to Petstore orders"
  55. - name: "register"
  56. description: "Access to Petstore orders"
  57. schemes:
  58. - "https"
  59. paths:
  60. /channels/lang/{lang}:
  61. get:
  62. tags:
  63. - "channels"
  64. summary: "Provides channels list for the authorized customer."
  65. description: ""
  66. operationId: "getChannels"
  67. produces:
  68. - "application/json"
  69. parameters:
  70. - in: "path"
  71. name: "lang"
  72. type: "string"
  73. description: "language code, available options: lt, en, ru."
  74. required: true
  75. responses:
  76. 200:
  77. description: "success : true"
  78. schema:
  79. type: "array"
  80. items:
  81. $ref: "#/definitions/Channel"
  82. 403:
  83. description: "error: invalid_token
  84. error_description: The access token provided has expired
  85. "
  86. security:
  87. - oauth:
  88. - "write:pets"
  89. - "read:pets"
  90. /channels/{channel}/spritesfrom={from}to={to}:
  91. get:
  92. tags:
  93. - "channels"
  94. summary: "Provides information about channel’s sprite images."
  95. description: ""
  96. operationId: "getChannelSprites"
  97. produces:
  98. - "application/json"
  99. parameters:
  100. - in: "path"
  101. name: "channel"
  102. type: "integer"
  103. description: "channel id, ex. 11274."
  104. required: true
  105. - in: "path"
  106. name: "from"
  107. type: "string"
  108. description: "day, ex. 2018-08-23 13:30:00."
  109. required: true
  110. - in: "path"
  111. name: "to"
  112. type: "string"
  113. description: "day, ex. 2018-08-23 14:30:00."
  114. required: true
  115. responses:
  116. 200:
  117. description: "success : true"
  118. schema:
  119. type: "array"
  120. items:
  121. $ref: "#/definitions/ChannelSprites"
  122. 403:
  123. description: "error: invalid_token
  124. error_description: The access token provided has expired
  125. "
  126. security:
  127. - oauth:
  128. - "write:pets"
  129. - "read:pets"
  130. /recommended:
  131. get:
  132. tags:
  133. - "recommended"
  134. summary: "Provides recommended programs marked with rating star “5/5” property."
  135. description: ""
  136. operationId: "getRecommended"
  137. produces:
  138. - "application/json"
  139. responses:
  140. 200:
  141. description: "success : true"
  142. schema:
  143. type: "array"
  144. items:
  145. $ref: "#/definitions/EPGProgram"
  146. 403:
  147. description: "error: invalid_token
  148. error_description: The access token provided has expired
  149. "
  150. security:
  151. - oauth:
  152. - "write:pets"
  153. - "read:pets"
  154. /genres/lang/{lang}:
  155. get:
  156. tags:
  157. - "genres"
  158. summary: "Provides TV genres list."
  159. description: ""
  160. operationId: "getGenres"
  161. produces:
  162. - "application/json"
  163. parameters:
  164. - in: "path"
  165. name: "lang"
  166. type: "string"
  167. description: "language code, available options: lt, en, ru."
  168. required: true
  169. responses:
  170. 200:
  171. description: "success : true"
  172. schema:
  173. type: "array"
  174. items:
  175. $ref: "#/definitions/ChannelGenre"
  176. 403:
  177. description: "error: invalid_token
  178. error_description: The access token provided has expired
  179. "
  180. security:
  181. - oauth:
  182. - "write:pets"
  183. - "read:pets"
  184.  
  185. /tvshows/lang/{lang}:
  186. get:
  187. tags:
  188. - "tvshows"
  189. summary: "Provides TV shows list."
  190. description: ""
  191. operationId: "getTvShows"
  192. produces:
  193. - "application/json"
  194. parameters:
  195. - in: "path"
  196. name: "lang"
  197. type: "string"
  198. description: "language code, available options: lt, en, ru."
  199. required: true
  200. responses:
  201. 200:
  202. description: "success : true"
  203. schema:
  204. type: "array"
  205. items:
  206. $ref: "#/definitions/ChannelGenre"
  207. 403:
  208. description: "error: invalid_token
  209. error_description: The access token provided has expired
  210. "
  211. security:
  212. - oauth:
  213. - "write:pets"
  214. - "read:pets"
  215.  
  216.  
  217. /epg/channel/{channel}/date/{date}:
  218. get:
  219. tags:
  220. - "epg"
  221. summary: "Provides TV shows list."
  222. description: ""
  223. operationId: "getEpg"
  224. produces:
  225. - "application/json"
  226. parameters:
  227. - in: "path"
  228. name: "channel"
  229. type: "integer"
  230. description: "channel id, ex. 74."
  231. required: true
  232. - in: "path"
  233. name: "date"
  234. type: "string"
  235. description: "day, ex. 2014-05-23."
  236. required: true
  237. responses:
  238. 200:
  239. description: "success : true"
  240. schema:
  241. type: "array"
  242. items:
  243. $ref: "#/definitions/adb.EpgProgram"
  244. 403:
  245. description: "error: invalid_token
  246. error_description: The access token provided has expired
  247. "
  248. security:
  249. - oauth:
  250. - "write:pets"
  251. - "read:pets"
  252.  
  253. /epg/{epg}/channel/{channel}/sprites:
  254. get:
  255. tags:
  256. - "epg"
  257. summary: "Provides TV shows list."
  258. description: ""
  259. operationId: "getEpgSprites"
  260. produces:
  261. - "application/json"
  262. parameters:
  263. - in: "path"
  264. name: "channel"
  265. type: "integer"
  266. description: "channel id, ex. 74."
  267. required: true
  268. - in: "path"
  269. name: "epg"
  270. type: "string"
  271. description: "epg Id, ex. 8768g7654d54342a342"
  272. required: true
  273. responses:
  274. 200:
  275. description: "success : true"
  276. schema:
  277. type: "array"
  278. items:
  279. $ref: "#/definitions/ChannelSprites"
  280. 403:
  281. description: "error: invalid_token
  282. error_description: The access token provided has expired
  283. "
  284. security:
  285. - oauth:
  286. - "write:pets"
  287. - "read:pets"
  288.  
  289. /epggrid/channels/{channels}/from/{from}/to/{to}:
  290. get:
  291. tags:
  292. - "epggrid"
  293. summary: "Provides TV shows list."
  294. description: ""
  295. operationId: "getEpgGrid"
  296. produces:
  297. - "application/json"
  298. parameters:
  299. - in: "path"
  300. name: "channels"
  301. type: "array"
  302. items:
  303. type: "integer"
  304. description: "channel's id's, ex. '74,72,75'"
  305. required: true
  306. - in: "path"
  307. name: "from"
  308. type: "string"
  309. description: "day, ex. 2018-08-23 13:30:00."
  310. required: true
  311. - in: "path"
  312. name: "to"
  313. type: "string"
  314. description: "day, ex. 2018-08-23 14:30:00."
  315. required: true
  316. responses:
  317. 200:
  318. description: "success : true"
  319. schema:
  320. type: "array"
  321. items:
  322. $ref: "#/definitions/ChannelEPGProgram"
  323. 403:
  324. description: "error: invalid_token
  325. error_description: The access token provided has expired"
  326. security:
  327. - oauth:
  328. - "write:pets"
  329. - "read:pets"
  330.  
  331. /epgarchive/channel/{channel}/from/{from}/to/{to}:
  332. get:
  333. tags:
  334. - "epgarchive"
  335. summary: "Provides TV shows list."
  336. description: ""
  337. operationId: "getEpgArchive"
  338. produces:
  339. - "application/json"
  340. parameters:
  341. - in: "path"
  342. name: "channel"
  343. type: "integer"
  344. description: "channel id, ex. 74."
  345. required: true
  346. - in: "path"
  347. name: "from"
  348. type: "string"
  349. description: "day, ex. 2018-08-23 13:30:00."
  350. required: true
  351. - in: "path"
  352. name: "to"
  353. type: "string"
  354. description: "day, ex. 2018-08-23 14:30:00."
  355. required: true
  356. responses:
  357. 200:
  358. description: "success : true"
  359. schema:
  360. type: "array"
  361. items:
  362. $ref: "#/definitions/EPGArchiveProgram"
  363. 403:
  364. description: "error: invalid_token
  365. error_description: The access token provided has expired
  366. "
  367. security:
  368. - oauth:
  369. - "write:pets"
  370. - "read:pets"
  371. /favorites:
  372. get:
  373. tags:
  374. - "favorites"
  375. summary: "Provides favorite channel list."
  376. description: ""
  377. operationId: "getFavorites"
  378. produces:
  379. - "application/json"
  380. responses:
  381. 200:
  382. description: "success : true"
  383. schema:
  384. type: "array"
  385. items:
  386. type: "string"
  387. 403:
  388. description: "error: invalid_token
  389. error_description: The access token provided has expired
  390. "
  391. security:
  392. - oauth:
  393. - "write:pets"
  394. - "read:pets"
  395. post:
  396. tags:
  397. - "favorites"
  398. summary: "Provides favorite channel list."
  399. description: ""
  400. operationId: "postFavorites"
  401. consumes:
  402. - "application/x-www-form-urlencoded"
  403. produces:
  404. - "application/json"
  405. parameters:
  406. - in: "formData"
  407. name: "channel"
  408. type: "integer"
  409. description: "channel id, ex. 74."
  410. required: true
  411.  
  412. responses:
  413. 200:
  414. description: "success : true"
  415. schema:
  416. items:
  417. $ref: "#/definitions/FavoritesInserted"
  418. 403:
  419. description: "error: invalid_token
  420. error_description: The access token provided has expired
  421. "
  422. security:
  423. - oauth:
  424. - "write:pets"
  425. - "read:pets"
  426.  
  427.  
  428. /userinfo:
  429. get:
  430. tags:
  431. - "userinfo"
  432. summary: "Provides favorite channel list."
  433. description: ""
  434. operationId: "getUserinfo"
  435. produces:
  436. - "application/json"
  437. responses:
  438. 200:
  439. description: "success : true"
  440. schema:
  441. items:
  442. $ref: "#/definitions/UserInfoData"
  443. 403:
  444. description: "error: invalid_token
  445. error_description: The access token provided has expired
  446. "
  447. security:
  448. - oauth:
  449. - "write:pets"
  450. - "read:pets"
  451. post:
  452. tags:
  453. - "userinfo"
  454. summary: "Provides favorite channel list."
  455. description: ""
  456. operationId: "postUserinfo"
  457. consumes:
  458. - "application/x-www-form-urlencoded"
  459. produces:
  460. - "application/json"
  461. parameters:
  462. - in: "formData"
  463. name: "title"
  464. type: "string"
  465. description: "Equipment title"
  466. required: true
  467. - in: "formData"
  468. name: "serial_number"
  469. type: "string"
  470. description: "Equipment serial number"
  471. required: true
  472. - in: "formData"
  473. name: "aflag"
  474. type: "boolean"
  475. description: "Enable/Disable showing of the archive information. 0 – disables this option, 1- enables it"
  476. required: true
  477. - in: "formData"
  478. name: "pin"
  479. type: "integer"
  480. description: "PIN code"
  481. required: true
  482.  
  483. responses:
  484. 200:
  485. description: "success : true"
  486. 403:
  487. description: "error: invalid_token
  488. error_description: The access token provided has expired
  489. "
  490. security:
  491. - oauth:
  492. - "write:pets"
  493. - "read:pets"
  494.  
  495.  
  496. /settings:
  497. get:
  498. tags:
  499. - "settings"
  500. summary: "Provides user settings."
  501. description: ""
  502. operationId: "getSettings"
  503. produces:
  504. - "application/json"
  505. responses:
  506. 200:
  507. description: "success : true"
  508. schema:
  509. items:
  510. $ref: "#/definitions/EquipmentSettings"
  511. 403:
  512. description: "error: invalid_token
  513. error_description: The access token provided has expired
  514. "
  515. security:
  516. - oauth:
  517. - "write:pets"
  518. - "read:pets"
  519. post:
  520. tags:
  521. - "settings"
  522. summary: "Provides user settings."
  523. description: ""
  524. operationId: "postSettings"
  525. consumes:
  526. - "application/x-www-form-urlencoded"
  527. produces:
  528. - "application/json"
  529. parameters:
  530. - in: "formData"
  531. name: "lang"
  532. type: "string"
  533. description: "language, available options - 'lt_LT', 'ru_RU', 'en_US', 'lv_LV'"
  534. required: true
  535. - in: "formData"
  536. name: "tz"
  537. type: "string"
  538. description: "time zone, ex. Europe/Vilnius"
  539. required: true
  540. - in: "formData"
  541. name: "location"
  542. type: "integer"
  543. description: "city id, city and country list can be retrieved by useing geocountiries and geocities methods. "
  544. required: true
  545.  
  546. responses:
  547. 200:
  548. description: "success : true"
  549.  
  550. 403:
  551. description: "error: invalid_token
  552. error_description: The access token provided has expired
  553. "
  554. security:
  555. - oauth:
  556. - "write:pets"
  557. - "read:pets"
  558.  
  559. /system:
  560. get:
  561. tags:
  562. - "system"
  563. summary: "Provides information about the system – system status."
  564. description: ""
  565. operationId: "getSystem"
  566. produces:
  567. - "application/json"
  568. responses:
  569. 200:
  570. description: "success : true"
  571. schema:
  572. items:
  573. $ref: "#/definitions/SystemStatus"
  574. 403:
  575. description: "error: invalid_token
  576. error_description: The access token provided has expired
  577. "
  578. security:
  579. - oauth:
  580. - "write:pets"
  581. - "read:pets"
  582.  
  583. /servers:
  584. get:
  585. tags:
  586. - "servers"
  587. summary: "Provides server list."
  588. description: ""
  589. operationId: "getServers"
  590. produces:
  591. - "application/json"
  592. responses:
  593. 200:
  594. description: "success : true"
  595. schema:
  596. items:
  597. type: "array"
  598. items:
  599. $ref: "#/definitions/EPGArchiveServerCustomerGroup"
  600. 403:
  601. description: "error: invalid_token
  602. error_description: The access token provided has expired
  603. "
  604. security:
  605. - oauth:
  606. - "write:pets"
  607. - "read:pets"
  608.  
  609. /geocountries:
  610. get:
  611. tags:
  612. - "geocountries"
  613. summary: "Provides server list."
  614. description: ""
  615. operationId: "getGeocountries"
  616. produces:
  617. - "application/json"
  618. responses:
  619. 200:
  620. description: "success : true"
  621. schema:
  622. type: "array"
  623. items:
  624. $ref: "#/definitions/GeoCountryMin"
  625. 403:
  626. description: "error: invalid_token
  627. error_description: The access token provided has expired
  628. "
  629. security:
  630. - oauth:
  631. - "write:pets"
  632. - "read:pets"
  633.  
  634. /geocities:
  635. get:
  636. tags:
  637. - "geocities"
  638. summary: "Provides server list."
  639. description: ""
  640. operationId: "getGeocities"
  641. produces:
  642. - "application/json"
  643. responses:
  644. 200:
  645. description: "success : true"
  646. schema:
  647. type: "array"
  648. items:
  649. $ref: "#/definitions/GeoCity"
  650. 403:
  651. description: "error: invalid_token
  652. error_description: The access token provided has expired
  653. "
  654. security:
  655. - oauth:
  656. - "write:pets"
  657. - "read:pets"
  658.  
  659.  
  660.  
  661. /vodcontent/lang/{lang}/:
  662. get:
  663. tags:
  664. - "vod_content"
  665. summary: "Provides TV genres list."
  666. description: ""
  667. operationId: "getGenres"
  668. produces:
  669. - "application/json"
  670. parameters:
  671. - in: "path"
  672. name: "lang"
  673. type: "string"
  674. description: "language code, available options: lt, en, ru."
  675. required: true
  676. responses:
  677. 200:
  678. description: "success : true"
  679. schema:
  680. type: "array"
  681. items:
  682. $ref: "#/definitions/ChannelGenre"
  683. 403:
  684. description: "error: invalid_token
  685. error_description: The access token provided has expired
  686. "
  687. security:
  688. - oauth:
  689. - "write:pets"
  690. - "read:pets"
  691.  
  692. /pet/findByStatus:
  693. get:
  694. tags:
  695. - "pet"
  696. summary: "Finds Pets by status"
  697. description: "Multiple status values can be provided with comma separated strings"
  698. operationId: "findPetsByStatus"
  699. produces:
  700. - "application/xml"
  701. - "application/json"
  702. parameters:
  703. - name: "status"
  704. in: "query"
  705. description: "Status values that need to be considered for filter"
  706. required: true
  707. type: "array"
  708. items:
  709. type: "string"
  710. enum:
  711. - "available"
  712. - "pending"
  713. - "sold"
  714. default: "available"
  715. collectionFormat: "multi"
  716. responses:
  717. 200:
  718. description: "successful operation"
  719. schema:
  720. type: "array"
  721. items:
  722. $ref: "#/definitions/Pet"
  723. 400:
  724. description: "Invalid status value"
  725. security:
  726. - oauth:
  727. - "write:pets"
  728. - "read:pets"
  729. /pet/findByTags:
  730. get:
  731. tags:
  732. - "pet"
  733. summary: "Finds Pets by tags"
  734. description: "Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing."
  735. operationId: "findPetsByTags"
  736. produces:
  737. - "application/xml"
  738. - "application/json"
  739. parameters:
  740. - name: "tags"
  741. in: "query"
  742. description: "Tags to filter by"
  743. required: true
  744. type: "array"
  745. items:
  746. type: "string"
  747. collectionFormat: "multi"
  748. responses:
  749. 200:
  750. description: "successful operation"
  751. schema:
  752. type: "array"
  753. items:
  754. $ref: "#/definitions/Pet"
  755. 400:
  756. description: "Invalid tag value"
  757. security:
  758. - oauth:
  759. - "write:pets"
  760. - "read:pets"
  761. deprecated: true
  762. /pet/{petId}:
  763. get:
  764. tags:
  765. - "pet"
  766. summary: "Find pet by ID"
  767. description: "Returns a single pet"
  768. operationId: "getPetById"
  769. produces:
  770. - "application/xml"
  771. - "application/json"
  772. parameters:
  773. - name: "petId"
  774. in: "path"
  775. description: "ID of pet to return"
  776. required: true
  777. type: "integer"
  778. format: "int64"
  779. responses:
  780. 200:
  781. description: "successful operation"
  782. schema:
  783. $ref: "#/definitions/Pet"
  784. 400:
  785. description: "Invalid ID supplied"
  786. 404:
  787. description: "Pet not found"
  788. security:
  789. - api_key: []
  790. post:
  791. tags:
  792. - "pet"
  793. summary: "Updates a pet in the store with form data"
  794. description: ""
  795. operationId: "updatePetWithForm"
  796. consumes:
  797. - "application/x-www-form-urlencoded"
  798. produces:
  799. - "application/xml"
  800. - "application/json"
  801. parameters:
  802. - name: "petId"
  803. in: "path"
  804. description: "ID of pet that needs to be updated"
  805. required: true
  806. type: "integer"
  807. format: "int64"
  808. - name: "name"
  809. in: "formData"
  810. description: "Updated name of the pet"
  811. required: false
  812. type: "string"
  813. - name: "status"
  814. in: "formData"
  815. description: "Updated status of the pet"
  816. required: false
  817. type: "string"
  818. responses:
  819. 405:
  820. description: "Invalid input"
  821. security:
  822. - oauth:
  823. - "write:pets"
  824. - "read:pets"
  825. delete:
  826. tags:
  827. - "pet"
  828. summary: "Deletes a pet"
  829. description: ""
  830. operationId: "deletePet"
  831. produces:
  832. - "application/xml"
  833. - "application/json"
  834. parameters:
  835. - name: "api_key"
  836. in: "header"
  837. required: false
  838. type: "string"
  839. - name: "petId"
  840. in: "path"
  841. description: "Pet id to delete"
  842. required: true
  843. type: "integer"
  844. format: "int64"
  845. responses:
  846. 400:
  847. description: "Invalid ID supplied"
  848. 404:
  849. description: "Pet not found"
  850. security:
  851. - oauth:
  852. - "write:pets"
  853. - "read:pets"
  854. /pet/{petId}/uploadImage:
  855. post:
  856. tags:
  857. - "pet"
  858. summary: "uploads an image"
  859. description: ""
  860. operationId: "uploadFile"
  861. consumes:
  862. - "multipart/form-data"
  863. produces:
  864. - "application/json"
  865. parameters:
  866. - name: "petId"
  867. in: "path"
  868. description: "ID of pet to update"
  869. required: true
  870. type: "integer"
  871. format: "int64"
  872. - name: "additionalMetadata"
  873. in: "formData"
  874. description: "Additional data to pass to server"
  875. required: false
  876. type: "string"
  877. - name: "file"
  878. in: "formData"
  879. description: "file to upload"
  880. required: false
  881. type: "file"
  882. responses:
  883. 200:
  884. description: "successful operation"
  885. schema:
  886. $ref: "#/definitions/ApiResponse"
  887. security:
  888. - oauth:
  889. - "write:pets"
  890. - "read:pets"
  891. /store/inventory:
  892. get:
  893. tags:
  894. - "store"
  895. summary: "Returns pet inventories by status"
  896. description: "Returns a map of status codes to quantities"
  897. operationId: "getInventory"
  898. produces:
  899. - "application/json"
  900. parameters: []
  901. responses:
  902. 200:
  903. description: "successful operation"
  904. schema:
  905. type: "object"
  906. additionalProperties:
  907. type: "integer"
  908. format: "int32"
  909. security:
  910. - api_key: []
  911. /store/order:
  912. post:
  913. tags:
  914. - "store"
  915. summary: "Place an order for a pet"
  916. description: ""
  917. operationId: "placeOrder"
  918. produces:
  919. - "application/xml"
  920. - "application/json"
  921. parameters:
  922. - in: "body"
  923. name: "body"
  924. description: "order placed for purchasing the pet"
  925. required: true
  926. schema:
  927. $ref: "#/definitions/Order"
  928. responses:
  929. 200:
  930. description: "successful operation"
  931. schema:
  932. $ref: "#/definitions/Order"
  933. 400:
  934. description: "Invalid Order"
  935. /store/order/{orderId}:
  936. get:
  937. tags:
  938. - "store"
  939. summary: "Find purchase order by ID"
  940. description: "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions"
  941. operationId: "getOrderById"
  942. produces:
  943. - "application/xml"
  944. - "application/json"
  945. parameters:
  946. - name: "orderId"
  947. in: "path"
  948. description: "ID of pet that needs to be fetched"
  949. required: true
  950. type: "integer"
  951. maximum: 10.0
  952. minimum: 1.0
  953. format: "int64"
  954. responses:
  955. 200:
  956. description: "successful operation"
  957. schema:
  958. $ref: "#/definitions/Order"
  959. 400:
  960. description: "Invalid ID supplied"
  961. 404:
  962. description: "Order not found"
  963. delete:
  964. tags:
  965. - "store"
  966. summary: "Delete purchase order by ID"
  967. description: "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors"
  968. operationId: "deleteOrder"
  969. produces:
  970. - "application/xml"
  971. - "application/json"
  972. parameters:
  973. - name: "orderId"
  974. in: "path"
  975. description: "ID of the order that needs to be deleted"
  976. required: true
  977. type: "integer"
  978. minimum: 1.0
  979. format: "int64"
  980. responses:
  981. 400:
  982. description: "Invalid ID supplied"
  983. 404:
  984. description: "Order not found"
  985. /user:
  986. post:
  987. tags:
  988. - "user"
  989. summary: "Create user"
  990. description: "This can only be done by the logged in user."
  991. operationId: "createUser"
  992. produces:
  993. - "application/xml"
  994. - "application/json"
  995. parameters:
  996. - in: "body"
  997. name: "body"
  998. description: "Created user object"
  999. required: true
  1000. schema:
  1001. $ref: "#/definitions/User"
  1002. responses:
  1003. default:
  1004. description: "successful operation"
  1005. /user/createWithArray:
  1006. post:
  1007. tags:
  1008. - "user"
  1009. summary: "Creates list of users with given input array"
  1010. description: ""
  1011. operationId: "createUsersWithArrayInput"
  1012. produces:
  1013. - "application/xml"
  1014. - "application/json"
  1015. parameters:
  1016. - in: "body"
  1017. name: "body"
  1018. description: "List of user object"
  1019. required: true
  1020. schema:
  1021. type: "array"
  1022. items:
  1023. $ref: "#/definitions/User"
  1024. responses:
  1025. default:
  1026. description: "successful operation"
  1027. /user/createWithList:
  1028. post:
  1029. tags:
  1030. - "user"
  1031. summary: "Creates list of users with given input array"
  1032. description: ""
  1033. operationId: "createUsersWithListInput"
  1034. produces:
  1035. - "application/xml"
  1036. - "application/json"
  1037. parameters:
  1038. - in: "body"
  1039. name: "body"
  1040. description: "List of user object"
  1041. required: true
  1042. schema:
  1043. type: "array"
  1044. items:
  1045. $ref: "#/definitions/User"
  1046. responses:
  1047. default:
  1048. description: "successful operation"
  1049. /user/login:
  1050. get:
  1051. tags:
  1052. - "user"
  1053. summary: "Logs user into the system"
  1054. description: ""
  1055. operationId: "loginUser"
  1056. produces:
  1057. - "application/xml"
  1058. - "application/json"
  1059. parameters:
  1060. - name: "username"
  1061. in: "query"
  1062. description: "The user name for login"
  1063. required: true
  1064. type: "string"
  1065. - name: "password"
  1066. in: "query"
  1067. description: "The password for login in clear text"
  1068. required: true
  1069. type: "string"
  1070. responses:
  1071. 200:
  1072. description: "successful operation"
  1073. schema:
  1074. type: "string"
  1075. headers:
  1076. X-Rate-Limit:
  1077. type: "integer"
  1078. format: "int32"
  1079. description: "calls per hour allowed by the user"
  1080. X-Expires-After:
  1081. type: "string"
  1082. format: "date-time"
  1083. description: "date in UTC when token expires"
  1084. 400:
  1085. description: "Invalid username/password supplied"
  1086. /user/logout:
  1087. get:
  1088. tags:
  1089. - "user"
  1090. summary: "Logs out current logged in user session"
  1091. description: ""
  1092. operationId: "logoutUser"
  1093. produces:
  1094. - "application/xml"
  1095. - "application/json"
  1096. parameters: []
  1097. responses:
  1098. default:
  1099. description: "successful operation"
  1100. /user/{username}:
  1101. get:
  1102. tags:
  1103. - "user"
  1104. summary: "Get user by user name"
  1105. description: ""
  1106. operationId: "getUserByName"
  1107. produces:
  1108. - "application/xml"
  1109. - "application/json"
  1110. parameters:
  1111. - name: "username"
  1112. in: "path"
  1113. description: "The name that needs to be fetched. Use user1 for testing. "
  1114. required: true
  1115. type: "string"
  1116. responses:
  1117. 200:
  1118. description: "successful operation"
  1119. schema:
  1120. $ref: "#/definitions/User"
  1121. 400:
  1122. description: "Invalid username supplied"
  1123. 404:
  1124. description: "User not found"
  1125. put:
  1126. tags:
  1127. - "user"
  1128. summary: "Updated user"
  1129. description: "This can only be done by the logged in user."
  1130. operationId: "updateUser"
  1131. produces:
  1132. - "application/xml"
  1133. - "application/json"
  1134. parameters:
  1135. - name: "username"
  1136. in: "path"
  1137. description: "name that need to be updated"
  1138. required: true
  1139. type: "string"
  1140. - in: "body"
  1141. name: "body"
  1142. description: "Updated user object"
  1143. required: true
  1144. schema:
  1145. $ref: "#/definitions/User"
  1146. responses:
  1147. 400:
  1148. description: "Invalid user supplied"
  1149. 404:
  1150. description: "User not found"
  1151. delete:
  1152. tags:
  1153. - "user"
  1154. summary: "Delete user"
  1155. description: "This can only be done by the logged in user."
  1156. operationId: "deleteUser"
  1157. produces:
  1158. - "application/xml"
  1159. - "application/json"
  1160. parameters:
  1161. - name: "username"
  1162. in: "path"
  1163. description: "The name that needs to be deleted"
  1164. required: true
  1165. type: "string"
  1166. responses:
  1167. 200:
  1168. description: ""
  1169. 400:
  1170. description: "Invalid username supplied"
  1171. 404:
  1172. description: "User not found"
  1173. securityDefinitions:
  1174. oauth:
  1175. type: "oauth2"
  1176. authorizationUrl: "https://pw.lumadis.lt/box2.0/index"
  1177. flow: "implicit"
  1178. scopes:
  1179. write:pets: "modify pets in your account"
  1180. read:pets: "read your pets"
  1181. api_key:
  1182. type: "basic"
  1183. definitions:
  1184. Channel:
  1185. type: "object"
  1186. properties:
  1187. id:
  1188. type: "integer"
  1189. format: "init64"
  1190. channel_type_id:
  1191. type: "integer"
  1192. format: "init64"
  1193. genre_id:
  1194. type: "integer"
  1195. format: "init64"
  1196. ip:
  1197. type: "string"
  1198. rating:
  1199. type: "string"
  1200. logo:
  1201. type: "string"
  1202. encryption:
  1203. type: "number"
  1204. ambercrypted:
  1205. type: "number"
  1206. video_enc:
  1207. type: "string"
  1208. recordable:
  1209. type: "number"
  1210. archive_server_id:
  1211. type: "integer"
  1212. archive_channel_id:
  1213. type: "integer"
  1214. enabled:
  1215. type: "number"
  1216. streamer_id:
  1217. type: "integer"
  1218. streamer_channel_id:
  1219. type: "integer"
  1220. video_pid:
  1221. type: "integer"
  1222. profile_id:
  1223. type: "integer"
  1224. created_on:
  1225. type: "string"
  1226. format: "datetime"
  1227. creator_id:
  1228. type: "integer"
  1229. modified_on:
  1230. type: "string"
  1231. format: "datetime"
  1232. modifier_id:
  1233. type: "integer"
  1234. order:
  1235. type: "integer"
  1236. is_dvbc:
  1237. type: "number"
  1238. dvbc_frequency:
  1239. type: "integer"
  1240. dvbc_srate:
  1241. type: "integer"
  1242. dvbc_qam:
  1243. type: "integer"
  1244. dvbc_pcr:
  1245. type: "integer"
  1246. dvbc_vfmt:
  1247. type: "string"
  1248. modulation:
  1249. type: "integer"
  1250. service_id:
  1251. type: "integer"
  1252. is_ott:
  1253. type: "number"
  1254. ott_server_id:
  1255. type: "integer"
  1256. odisey_service_id:
  1257. type: "integer"
  1258. hls_type:
  1259. type: "number"
  1260. ott_path:
  1261. type: "string"
  1262. prg_lifetime:
  1263. type: "integer"
  1264. aspect_ratios:
  1265. type: "string"
  1266. dvbt_fec:
  1267. type: "string"
  1268. dvbt_frequency:
  1269. type: "string"
  1270. dvbt_guard:
  1271. type: "string"
  1272. dvbt_modulation:
  1273. type: "string"
  1274. dvbt_type:
  1275. type: "number"
  1276. bandwidth:
  1277. type: "integer"
  1278. thumbnail_server_id:
  1279. type: "integer"
  1280. thumbnail_service_id:
  1281. type: "integer"
  1282. chapter_channel_id:
  1283. type: "integer"
  1284.  
  1285.  
  1286. ChannelSprites:
  1287. type: "object"
  1288. properties:
  1289. step:
  1290. type: "integer"
  1291. tile:
  1292. type: "string"
  1293. scale:
  1294. type: "string"
  1295. sprites:
  1296. type: "array"
  1297. items:
  1298. $ref: "#/definitions/Sprite"
  1299. Sprite:
  1300. type: "object"
  1301. properties:
  1302. sprite:
  1303. type: "string"
  1304. start:
  1305. type: "string"
  1306. stop:
  1307. type: "string"
  1308.  
  1309. EPGProgram:
  1310. type: "object"
  1311. properties:
  1312. adb.EpgProgram:
  1313. $ref: "#/definitions/adb.EpgProgram"
  1314. TVShowImage:
  1315. type: "string"
  1316.  
  1317. adb.EpgProgram:
  1318. type: "object"
  1319. properties:
  1320. ID:
  1321. type: "string"
  1322. EPGChannelID:
  1323. type: "string"
  1324. ChannelID:
  1325. type: "integer"
  1326. Start:
  1327. type: "string"
  1328. format: "datetime"
  1329. Stop:
  1330. type: "string"
  1331. format: "datetime"
  1332. Lenght:
  1333. type: "string"
  1334. Timezone:
  1335. type: "string"
  1336. Title:
  1337. type: "string"
  1338. Description:
  1339. type: "string"
  1340. Poster:
  1341. type: "string"
  1342. Lang:
  1343. type: "string"
  1344. TVShowID:
  1345. type: "integer"
  1346. GenreID:
  1347. type: "integer"
  1348. RatingStar:
  1349. type: "string"
  1350. Recordable:
  1351. type: "boolean"
  1352. Episode:
  1353. type: "string"
  1354. Category:
  1355. type: "string"
  1356. Date:
  1357. type: "string"
  1358. Directors:
  1359. type: "string"
  1360. Actors:
  1361. type: "string"
  1362.  
  1363.  
  1364. ChannelEPGProgram:
  1365. type: "object"
  1366. properties:
  1367. ID:
  1368. type: "string"
  1369. Start:
  1370. type: "string"
  1371. Stop:
  1372. type: "string"
  1373. GenreID:
  1374. type: "integer"
  1375. TVShowID:
  1376. type: "integer"
  1377. RatingStar:
  1378. type: "string"
  1379. Title:
  1380. type: "string"
  1381. OriginalTitle:
  1382. type: "string"
  1383. Description:
  1384. type: "string"
  1385. Poster:
  1386. type: "string"
  1387. ChannelId:
  1388. type: "string"
  1389. TVShowURL:
  1390. type: "string"
  1391. Recordable:
  1392. type: "boolean"
  1393. Episode:
  1394. type: "string"
  1395. Category:
  1396. type: "string"
  1397. Date:
  1398. type: "string"
  1399. Directors:
  1400. type: "string"
  1401. Actors:
  1402. type: "string"
  1403.  
  1404. ChannelGenre:
  1405. type: "object"
  1406. properties:
  1407. ID:
  1408. type: "integer"
  1409. Logo:
  1410. type: "string"
  1411. Color:
  1412. type: "string"
  1413. Name:
  1414. type: "string"
  1415.  
  1416. EPGArchiveProgram:
  1417. type: "object"
  1418. properties:
  1419. ID:
  1420. type: "string"
  1421. ServicePath:
  1422. type: "string"
  1423. Start:
  1424. type: "string"
  1425. Stop:
  1426. type: "string"
  1427. Title:
  1428. type: "string"
  1429. Description:
  1430. type: "string"
  1431. Poster:
  1432. type: "string"
  1433. Screenshot:
  1434. type: "string"
  1435. URL:
  1436. type: "string"
  1437. Lang:
  1438. type: "string"
  1439. ArchiveServers:
  1440. type: "array"
  1441. items:
  1442. type: "string"
  1443. Recordable:
  1444. type: "boolean"
  1445.  
  1446. FavoritesInserted:
  1447. type: "object"
  1448. properties:
  1449. receivedCount:
  1450. type: "integer"
  1451. insertedCount:
  1452. type: "integer"
  1453.  
  1454.  
  1455. UserInfoData:
  1456. type: "object"
  1457. properties:
  1458. ProfileID:
  1459. type: "integer"
  1460. UserID:
  1461. type: "integer"
  1462. EquipmentId:
  1463. type: "integer"
  1464. EquipmentPIN:
  1465. type: "string"
  1466. TimezoneOffset:
  1467. type: "string"
  1468. Username:
  1469. type: "string"
  1470. UserSurname:
  1471. type: "string"
  1472. UserEmail:
  1473. type: "string"
  1474. ArchivesFlag:
  1475. type: "integer"
  1476. ExternalIP:
  1477. type: "string"
  1478.  
  1479.  
  1480. EquipmentSettings:
  1481. type: "object"
  1482. properties:
  1483. Language:
  1484. type: "string"
  1485. Timezone:
  1486. type: "string"
  1487. Location:
  1488. type: "string"
  1489. InActiveTimeout:
  1490. type: "string"
  1491.  
  1492. SystemStatus:
  1493. type: "object"
  1494. properties:
  1495. Maintenance:
  1496. type: "boolean"
  1497. Message:
  1498. type: "string"
  1499.  
  1500.  
  1501. EPGArchiveServer:
  1502. type: "object"
  1503. properties:
  1504. ID:
  1505. type: "integer"
  1506. Name:
  1507. type: "string"
  1508. ServerTag:
  1509. type: "string"
  1510. Username:
  1511. type: "string"
  1512. Password:
  1513. type: "string"
  1514. Secret:
  1515. type: "string"
  1516. Location:
  1517. type: "string"
  1518. URL:
  1519. type: "string"
  1520. Version:
  1521. type: "integer"
  1522. Type:
  1523. type: "integer"
  1524. Priority:
  1525. type: "integer"
  1526. SpeedTestOption:
  1527. type: "integer"
  1528. SpeedTestPath:
  1529. type: "string"
  1530. Extension:
  1531. type: "string"
  1532. PRGLifetime:
  1533. type: "integer"
  1534. ParentID:
  1535. type: "integer"
  1536. Enabled:
  1537. type: "boolean"
  1538.  
  1539.  
  1540. EPGArchiveServerCustomerGroup:
  1541. type: "object"
  1542. properties:
  1543. EPGArchiveServer:
  1544. $ref: "#/definitions/EPGArchiveServer"
  1545.  
  1546. Default:
  1547. type: "boolean"
  1548.  
  1549.  
  1550. GeoCountryMin:
  1551. type: "object"
  1552. properties:
  1553. ID:
  1554. type: "string"
  1555. Name:
  1556. type: "string"
  1557. ISO2:
  1558. type: "string"
  1559.  
  1560. GeoCity:
  1561. type: "object"
  1562. properties:
  1563. ID:
  1564. type: "string"
  1565. CountryID:
  1566. type: "string"
  1567. Name:
  1568. type: "string"
  1569. PostCode:
  1570. type: "string"
  1571. Altitude:
  1572. type: "string"
  1573. Latitude:
  1574. type: "string"
  1575. Longitude:
  1576. type: "string"
  1577.  
  1578. VODShortContent:
  1579. type: "object"
  1580. properties:
  1581. ID:
  1582. type: "string"
  1583. Image:
  1584. type: "string"
  1585. Year:
  1586. type: "string"
  1587. Title:
  1588. type: "string"
  1589. Genre:
  1590. type: "string"
  1591.  
  1592. VODPerson:
  1593. type: "object"
  1594. properties:
  1595. ID:
  1596. type: "string"
  1597. Name:
  1598. type: "string"
  1599. Picture:
  1600. type: "string"
  1601.  
  1602. VODExtContentEpisode:
  1603. type: "object"
  1604. properties:
  1605. Season:
  1606. type: "integer"
  1607. Episode:
  1608. type: "integer"
  1609. Duration:
  1610. type: "integer"
  1611. Title:
  1612. type: "string"
  1613. ServerID:
  1614. type: "integer"
  1615. File:
  1616. type: "string"
  1617.  
  1618.  
  1619. VODFullContent:
  1620. type: "object"
  1621. properties:
  1622. ID:
  1623. type: "string"
  1624. VODServerID:
  1625. type: "string"
  1626. MediaFile:
  1627. type: "string"
  1628. Image:
  1629. type: "string"
  1630. Year:
  1631. type: "string"
  1632. Released:
  1633. type: "string"
  1634. IMDBRating:
  1635. type: "string"
  1636. Rating:
  1637. type: "string"
  1638. Duration:
  1639. type: "string"
  1640. MetaScore:
  1641. type: "string"
  1642. IMDBVotes:
  1643. type: "string"
  1644. Type:
  1645. type: "string"
  1646. Genre:
  1647. type: "string"
  1648. Lang:
  1649. type: "string"
  1650. Title:
  1651. type: "string"
  1652. TagLine:
  1653. type: "string"
  1654. Description:
  1655. type: "string"
  1656. OriginalLanguage:
  1657. type: "string"
  1658. Actors:
  1659. type: "string"
  1660. Directors:
  1661. type: "string"
  1662. Episodes:
  1663. type: "array"
  1664. items:
  1665. $ref: "#/definitions/VODExtContentEpisode"
  1666.  
  1667. VODFullContentWithIds:
  1668. type: "object"
  1669. properties:
  1670. ID:
  1671. type: "string"
  1672. VODServerID:
  1673. type: "string"
  1674. MediaFile:
  1675. type: "string"
  1676. Image:
  1677. type: "string"
  1678. Year:
  1679. type: "string"
  1680. Released:
  1681. type: "string"
  1682. IMDBRating:
  1683. type: "string"
  1684. Rating:
  1685. type: "string"
  1686. Duration:
  1687. type: "string"
  1688. MetaScore:
  1689. type: "string"
  1690. IMDBVotes:
  1691. type: "string"
  1692. Type:
  1693. type: "string"
  1694. Genre:
  1695. type: "string"
  1696. Lang:
  1697. type: "string"
  1698. Title:
  1699. type: "string"
  1700. TagLine:
  1701. type: "string"
  1702. Description:
  1703. type: "string"
  1704. OriginalLanguage:
  1705. type: "string"
  1706. Actors:
  1707. type: "string"
  1708. Directors:
  1709. type: "string"
  1710. Episodes:
  1711. type: "array"
  1712. items:
  1713. $ref: "#/definitions/VODExtContentEpisode"
  1714.  
  1715.  
  1716.  
  1717. Order:
  1718. type: "object"
  1719. properties:
  1720. id:
  1721. type: "integer"
  1722. format: "int64"
  1723. petId:
  1724. type: "integer"
  1725. format: "int64"
  1726. quantity:
  1727. type: "integer"
  1728. format: "int32"
  1729. shipDate:
  1730. type: "string"
  1731. format: "date-time"
  1732. status:
  1733. type: "string"
  1734. description: "Order Status"
  1735. enum:
  1736. - "placed"
  1737. - "approved"
  1738. - "delivered"
  1739. complete:
  1740. type: "boolean"
  1741. default: false
  1742. xml:
  1743. name: "Order"
  1744. Category:
  1745. type: "object"
  1746. properties:
  1747. id:
  1748. type: "integer"
  1749. format: "int64"
  1750. name:
  1751. type: "string"
  1752. xml:
  1753. name: "Category"
  1754. User:
  1755. type: "object"
  1756. properties:
  1757. id:
  1758. type: "integer"
  1759. format: "int64"
  1760. username:
  1761. type: "string"
  1762. firstName:
  1763. type: "string"
  1764. lastName:
  1765. type: "string"
  1766. email:
  1767. type: "string"
  1768. password:
  1769. type: "string"
  1770. phone:
  1771. type: "string"
  1772. userStatus:
  1773. type: "integer"
  1774. format: "int32"
  1775. description: "User Status"
  1776. xml:
  1777. name: "User"
  1778. Tag:
  1779. type: "object"
  1780. properties:
  1781. id:
  1782. type: "integer"
  1783. format: "int64"
  1784. name:
  1785. type: "string"
  1786. xml:
  1787. name: "Tag"
  1788. Pet:
  1789. type: "object"
  1790. required:
  1791. - "name"
  1792. - "photoUrls"
  1793. properties:
  1794. id:
  1795. type: "integer"
  1796. format: "int64"
  1797. category:
  1798. $ref: "#/definitions/Category"
  1799. name:
  1800. type: "string"
  1801. example: "doggie"
  1802. photoUrls:
  1803. type: "array"
  1804. xml:
  1805. name: "photoUrl"
  1806. wrapped: true
  1807. items:
  1808. type: "string"
  1809. tags:
  1810. type: "array"
  1811. xml:
  1812. name: "tag"
  1813. wrapped: true
  1814. items:
  1815. $ref: "#/definitions/Tag"
  1816. status:
  1817. type: "string"
  1818. description: "pet status in the store"
  1819. enum:
  1820. - "available"
  1821. - "pending"
  1822. - "sold"
  1823. xml:
  1824. name: "Pet"
  1825. ApiResponse:
  1826. type: "object"
  1827. properties:
  1828. code:
  1829. type: "integer"
  1830. format: "int32"
  1831. type:
  1832. type: "string"
  1833. message:
  1834. type: "string"
  1835. externalDocs:
  1836. description: "Find out more about Swagger"
  1837. url: "http://swagger.io"
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!