1
0

openapi.json 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "user_status",
  5. "version": "0.0.1",
  6. "description": "User status",
  7. "license": {
  8. "name": "agpl"
  9. }
  10. },
  11. "components": {
  12. "securitySchemes": {
  13. "basic_auth": {
  14. "type": "http",
  15. "scheme": "basic"
  16. },
  17. "bearer_auth": {
  18. "type": "http",
  19. "scheme": "bearer"
  20. }
  21. },
  22. "schemas": {
  23. "Capabilities": {
  24. "type": "object",
  25. "required": [
  26. "user_status"
  27. ],
  28. "properties": {
  29. "user_status": {
  30. "type": "object",
  31. "required": [
  32. "enabled",
  33. "restore",
  34. "supports_emoji"
  35. ],
  36. "properties": {
  37. "enabled": {
  38. "type": "boolean"
  39. },
  40. "restore": {
  41. "type": "boolean"
  42. },
  43. "supports_emoji": {
  44. "type": "boolean"
  45. }
  46. }
  47. }
  48. }
  49. },
  50. "ClearAt": {
  51. "type": "object",
  52. "required": [
  53. "type",
  54. "time"
  55. ],
  56. "properties": {
  57. "type": {
  58. "type": "string",
  59. "enum": [
  60. "period",
  61. "end-of"
  62. ]
  63. },
  64. "time": {
  65. "oneOf": [
  66. {
  67. "type": "integer",
  68. "format": "int64"
  69. },
  70. {
  71. "$ref": "#/components/schemas/ClearAtTimeType"
  72. }
  73. ]
  74. }
  75. }
  76. },
  77. "ClearAtTimeType": {
  78. "type": "string",
  79. "enum": [
  80. "day",
  81. "week"
  82. ]
  83. },
  84. "OCSMeta": {
  85. "type": "object",
  86. "required": [
  87. "status",
  88. "statuscode"
  89. ],
  90. "properties": {
  91. "status": {
  92. "type": "string"
  93. },
  94. "statuscode": {
  95. "type": "integer"
  96. },
  97. "message": {
  98. "type": "string"
  99. },
  100. "totalitems": {
  101. "type": "string"
  102. },
  103. "itemsperpage": {
  104. "type": "string"
  105. }
  106. }
  107. },
  108. "Predefined": {
  109. "type": "object",
  110. "required": [
  111. "id",
  112. "icon",
  113. "message",
  114. "clearAt",
  115. "visible"
  116. ],
  117. "properties": {
  118. "id": {
  119. "type": "string"
  120. },
  121. "icon": {
  122. "type": "string"
  123. },
  124. "message": {
  125. "type": "string"
  126. },
  127. "clearAt": {
  128. "$ref": "#/components/schemas/ClearAt",
  129. "nullable": true
  130. },
  131. "visible": {
  132. "type": "boolean",
  133. "nullable": true
  134. }
  135. }
  136. },
  137. "Private": {
  138. "allOf": [
  139. {
  140. "$ref": "#/components/schemas/Public"
  141. },
  142. {
  143. "type": "object",
  144. "required": [
  145. "messageId",
  146. "messageIsPredefined",
  147. "statusIsUserDefined"
  148. ],
  149. "properties": {
  150. "messageId": {
  151. "type": "string",
  152. "nullable": true
  153. },
  154. "messageIsPredefined": {
  155. "type": "boolean"
  156. },
  157. "statusIsUserDefined": {
  158. "type": "boolean"
  159. }
  160. }
  161. }
  162. ]
  163. },
  164. "Public": {
  165. "type": "object",
  166. "required": [
  167. "userId",
  168. "message",
  169. "icon",
  170. "clearAt",
  171. "status"
  172. ],
  173. "properties": {
  174. "userId": {
  175. "type": "string"
  176. },
  177. "message": {
  178. "type": "string",
  179. "nullable": true
  180. },
  181. "icon": {
  182. "type": "string",
  183. "nullable": true
  184. },
  185. "clearAt": {
  186. "type": "integer",
  187. "format": "int64",
  188. "nullable": true
  189. },
  190. "status": {
  191. "$ref": "#/components/schemas/Type"
  192. }
  193. }
  194. },
  195. "Type": {
  196. "type": "string",
  197. "enum": [
  198. "online",
  199. "away",
  200. "dnd",
  201. "busy",
  202. "offline",
  203. "invisible"
  204. ]
  205. }
  206. }
  207. },
  208. "paths": {
  209. "/ocs/v2.php/apps/user_status/api/v1/heartbeat": {
  210. "put": {
  211. "operationId": "heartbeat-heartbeat",
  212. "summary": "Keep the status alive",
  213. "tags": [
  214. "heartbeat"
  215. ],
  216. "security": [
  217. {
  218. "bearer_auth": []
  219. },
  220. {
  221. "basic_auth": []
  222. }
  223. ],
  224. "parameters": [
  225. {
  226. "name": "status",
  227. "in": "query",
  228. "description": "Only online, away",
  229. "required": true,
  230. "schema": {
  231. "type": "string"
  232. }
  233. },
  234. {
  235. "name": "OCS-APIRequest",
  236. "in": "header",
  237. "description": "Required to be true for the API request to pass",
  238. "required": true,
  239. "schema": {
  240. "type": "boolean",
  241. "default": true
  242. }
  243. }
  244. ],
  245. "responses": {
  246. "200": {
  247. "description": "Status successfully updated",
  248. "content": {
  249. "application/json": {
  250. "schema": {
  251. "type": "object",
  252. "required": [
  253. "ocs"
  254. ],
  255. "properties": {
  256. "ocs": {
  257. "type": "object",
  258. "required": [
  259. "meta",
  260. "data"
  261. ],
  262. "properties": {
  263. "meta": {
  264. "$ref": "#/components/schemas/OCSMeta"
  265. },
  266. "data": {
  267. "$ref": "#/components/schemas/Private"
  268. }
  269. }
  270. }
  271. }
  272. }
  273. }
  274. }
  275. },
  276. "400": {
  277. "description": "Invalid status to update",
  278. "content": {
  279. "application/json": {
  280. "schema": {
  281. "type": "object",
  282. "required": [
  283. "ocs"
  284. ],
  285. "properties": {
  286. "ocs": {
  287. "type": "object",
  288. "required": [
  289. "meta",
  290. "data"
  291. ],
  292. "properties": {
  293. "meta": {
  294. "$ref": "#/components/schemas/OCSMeta"
  295. },
  296. "data": {}
  297. }
  298. }
  299. }
  300. }
  301. }
  302. }
  303. },
  304. "500": {
  305. "description": "",
  306. "content": {
  307. "application/json": {
  308. "schema": {
  309. "type": "object",
  310. "required": [
  311. "ocs"
  312. ],
  313. "properties": {
  314. "ocs": {
  315. "type": "object",
  316. "required": [
  317. "meta",
  318. "data"
  319. ],
  320. "properties": {
  321. "meta": {
  322. "$ref": "#/components/schemas/OCSMeta"
  323. },
  324. "data": {}
  325. }
  326. }
  327. }
  328. }
  329. }
  330. }
  331. },
  332. "204": {
  333. "description": "User has no status to keep alive",
  334. "content": {
  335. "application/json": {
  336. "schema": {
  337. "type": "object",
  338. "required": [
  339. "ocs"
  340. ],
  341. "properties": {
  342. "ocs": {
  343. "type": "object",
  344. "required": [
  345. "meta",
  346. "data"
  347. ],
  348. "properties": {
  349. "meta": {
  350. "$ref": "#/components/schemas/OCSMeta"
  351. },
  352. "data": {}
  353. }
  354. }
  355. }
  356. }
  357. }
  358. }
  359. }
  360. }
  361. }
  362. },
  363. "/ocs/v2.php/apps/user_status/api/v1/predefined_statuses": {
  364. "get": {
  365. "operationId": "predefined_status-find-all",
  366. "summary": "Get all predefined messages",
  367. "tags": [
  368. "predefined_status"
  369. ],
  370. "security": [
  371. {
  372. "bearer_auth": []
  373. },
  374. {
  375. "basic_auth": []
  376. }
  377. ],
  378. "parameters": [
  379. {
  380. "name": "OCS-APIRequest",
  381. "in": "header",
  382. "description": "Required to be true for the API request to pass",
  383. "required": true,
  384. "schema": {
  385. "type": "boolean",
  386. "default": true
  387. }
  388. }
  389. ],
  390. "responses": {
  391. "200": {
  392. "description": "Predefined statuses returned",
  393. "content": {
  394. "application/json": {
  395. "schema": {
  396. "type": "object",
  397. "required": [
  398. "ocs"
  399. ],
  400. "properties": {
  401. "ocs": {
  402. "type": "object",
  403. "required": [
  404. "meta",
  405. "data"
  406. ],
  407. "properties": {
  408. "meta": {
  409. "$ref": "#/components/schemas/OCSMeta"
  410. },
  411. "data": {
  412. "type": "array",
  413. "items": {
  414. "$ref": "#/components/schemas/Predefined"
  415. }
  416. }
  417. }
  418. }
  419. }
  420. }
  421. }
  422. }
  423. }
  424. }
  425. }
  426. },
  427. "/ocs/v2.php/apps/user_status/api/v1/statuses": {
  428. "get": {
  429. "operationId": "statuses-find-all",
  430. "summary": "Find statuses of users",
  431. "tags": [
  432. "statuses"
  433. ],
  434. "security": [
  435. {
  436. "bearer_auth": []
  437. },
  438. {
  439. "basic_auth": []
  440. }
  441. ],
  442. "parameters": [
  443. {
  444. "name": "limit",
  445. "in": "query",
  446. "description": "Maximum number of statuses to find",
  447. "schema": {
  448. "type": "integer",
  449. "format": "int64",
  450. "nullable": true
  451. }
  452. },
  453. {
  454. "name": "offset",
  455. "in": "query",
  456. "description": "Offset for finding statuses",
  457. "schema": {
  458. "type": "integer",
  459. "format": "int64",
  460. "nullable": true
  461. }
  462. },
  463. {
  464. "name": "OCS-APIRequest",
  465. "in": "header",
  466. "description": "Required to be true for the API request to pass",
  467. "required": true,
  468. "schema": {
  469. "type": "boolean",
  470. "default": true
  471. }
  472. }
  473. ],
  474. "responses": {
  475. "200": {
  476. "description": "Statuses returned",
  477. "content": {
  478. "application/json": {
  479. "schema": {
  480. "type": "object",
  481. "required": [
  482. "ocs"
  483. ],
  484. "properties": {
  485. "ocs": {
  486. "type": "object",
  487. "required": [
  488. "meta",
  489. "data"
  490. ],
  491. "properties": {
  492. "meta": {
  493. "$ref": "#/components/schemas/OCSMeta"
  494. },
  495. "data": {
  496. "type": "array",
  497. "items": {
  498. "$ref": "#/components/schemas/Public"
  499. }
  500. }
  501. }
  502. }
  503. }
  504. }
  505. }
  506. }
  507. }
  508. }
  509. }
  510. },
  511. "/ocs/v2.php/apps/user_status/api/v1/statuses/{userId}": {
  512. "get": {
  513. "operationId": "statuses-find",
  514. "summary": "Find the status of a user",
  515. "tags": [
  516. "statuses"
  517. ],
  518. "security": [
  519. {
  520. "bearer_auth": []
  521. },
  522. {
  523. "basic_auth": []
  524. }
  525. ],
  526. "parameters": [
  527. {
  528. "name": "userId",
  529. "in": "path",
  530. "description": "ID of the user",
  531. "required": true,
  532. "schema": {
  533. "type": "string"
  534. }
  535. },
  536. {
  537. "name": "OCS-APIRequest",
  538. "in": "header",
  539. "description": "Required to be true for the API request to pass",
  540. "required": true,
  541. "schema": {
  542. "type": "boolean",
  543. "default": true
  544. }
  545. }
  546. ],
  547. "responses": {
  548. "200": {
  549. "description": "Status returned",
  550. "content": {
  551. "application/json": {
  552. "schema": {
  553. "type": "object",
  554. "required": [
  555. "ocs"
  556. ],
  557. "properties": {
  558. "ocs": {
  559. "type": "object",
  560. "required": [
  561. "meta",
  562. "data"
  563. ],
  564. "properties": {
  565. "meta": {
  566. "$ref": "#/components/schemas/OCSMeta"
  567. },
  568. "data": {
  569. "$ref": "#/components/schemas/Public"
  570. }
  571. }
  572. }
  573. }
  574. }
  575. }
  576. }
  577. },
  578. "404": {
  579. "description": "The user was not found",
  580. "content": {
  581. "text/plain": {
  582. "schema": {
  583. "type": "string"
  584. }
  585. }
  586. }
  587. }
  588. }
  589. }
  590. },
  591. "/ocs/v2.php/apps/user_status/api/v1/user_status": {
  592. "get": {
  593. "operationId": "user_status-get-status",
  594. "summary": "Get the status of the current user",
  595. "tags": [
  596. "user_status"
  597. ],
  598. "security": [
  599. {
  600. "bearer_auth": []
  601. },
  602. {
  603. "basic_auth": []
  604. }
  605. ],
  606. "parameters": [
  607. {
  608. "name": "OCS-APIRequest",
  609. "in": "header",
  610. "description": "Required to be true for the API request to pass",
  611. "required": true,
  612. "schema": {
  613. "type": "boolean",
  614. "default": true
  615. }
  616. }
  617. ],
  618. "responses": {
  619. "200": {
  620. "description": "The status was found successfully",
  621. "content": {
  622. "application/json": {
  623. "schema": {
  624. "type": "object",
  625. "required": [
  626. "ocs"
  627. ],
  628. "properties": {
  629. "ocs": {
  630. "type": "object",
  631. "required": [
  632. "meta",
  633. "data"
  634. ],
  635. "properties": {
  636. "meta": {
  637. "$ref": "#/components/schemas/OCSMeta"
  638. },
  639. "data": {
  640. "$ref": "#/components/schemas/Private"
  641. }
  642. }
  643. }
  644. }
  645. }
  646. }
  647. }
  648. },
  649. "404": {
  650. "description": "The user was not found",
  651. "content": {
  652. "text/plain": {
  653. "schema": {
  654. "type": "string"
  655. }
  656. }
  657. }
  658. }
  659. }
  660. }
  661. },
  662. "/ocs/v2.php/apps/user_status/api/v1/user_status/status": {
  663. "put": {
  664. "operationId": "user_status-set-status",
  665. "summary": "Update the status type of the current user",
  666. "tags": [
  667. "user_status"
  668. ],
  669. "security": [
  670. {
  671. "bearer_auth": []
  672. },
  673. {
  674. "basic_auth": []
  675. }
  676. ],
  677. "parameters": [
  678. {
  679. "name": "statusType",
  680. "in": "query",
  681. "description": "The new status type",
  682. "required": true,
  683. "schema": {
  684. "type": "string"
  685. }
  686. },
  687. {
  688. "name": "OCS-APIRequest",
  689. "in": "header",
  690. "description": "Required to be true for the API request to pass",
  691. "required": true,
  692. "schema": {
  693. "type": "boolean",
  694. "default": true
  695. }
  696. }
  697. ],
  698. "responses": {
  699. "200": {
  700. "description": "The status was updated successfully",
  701. "content": {
  702. "application/json": {
  703. "schema": {
  704. "type": "object",
  705. "required": [
  706. "ocs"
  707. ],
  708. "properties": {
  709. "ocs": {
  710. "type": "object",
  711. "required": [
  712. "meta",
  713. "data"
  714. ],
  715. "properties": {
  716. "meta": {
  717. "$ref": "#/components/schemas/OCSMeta"
  718. },
  719. "data": {
  720. "$ref": "#/components/schemas/Private"
  721. }
  722. }
  723. }
  724. }
  725. }
  726. }
  727. }
  728. },
  729. "400": {
  730. "description": "The status type is invalid",
  731. "content": {
  732. "text/plain": {
  733. "schema": {
  734. "type": "string"
  735. }
  736. }
  737. }
  738. }
  739. }
  740. }
  741. },
  742. "/ocs/v2.php/apps/user_status/api/v1/user_status/message/predefined": {
  743. "put": {
  744. "operationId": "user_status-set-predefined-message",
  745. "summary": "Set the message to a predefined message for the current user",
  746. "tags": [
  747. "user_status"
  748. ],
  749. "security": [
  750. {
  751. "bearer_auth": []
  752. },
  753. {
  754. "basic_auth": []
  755. }
  756. ],
  757. "parameters": [
  758. {
  759. "name": "messageId",
  760. "in": "query",
  761. "description": "ID of the predefined message",
  762. "required": true,
  763. "schema": {
  764. "type": "string"
  765. }
  766. },
  767. {
  768. "name": "clearAt",
  769. "in": "query",
  770. "description": "When the message should be cleared",
  771. "schema": {
  772. "type": "integer",
  773. "format": "int64",
  774. "nullable": true
  775. }
  776. },
  777. {
  778. "name": "OCS-APIRequest",
  779. "in": "header",
  780. "description": "Required to be true for the API request to pass",
  781. "required": true,
  782. "schema": {
  783. "type": "boolean",
  784. "default": true
  785. }
  786. }
  787. ],
  788. "responses": {
  789. "200": {
  790. "description": "The message was updated successfully",
  791. "content": {
  792. "application/json": {
  793. "schema": {
  794. "type": "object",
  795. "required": [
  796. "ocs"
  797. ],
  798. "properties": {
  799. "ocs": {
  800. "type": "object",
  801. "required": [
  802. "meta",
  803. "data"
  804. ],
  805. "properties": {
  806. "meta": {
  807. "$ref": "#/components/schemas/OCSMeta"
  808. },
  809. "data": {
  810. "$ref": "#/components/schemas/Private"
  811. }
  812. }
  813. }
  814. }
  815. }
  816. }
  817. }
  818. },
  819. "400": {
  820. "description": "The clearAt or message-id is invalid",
  821. "content": {
  822. "text/plain": {
  823. "schema": {
  824. "type": "string"
  825. }
  826. }
  827. }
  828. }
  829. }
  830. }
  831. },
  832. "/ocs/v2.php/apps/user_status/api/v1/user_status/message/custom": {
  833. "put": {
  834. "operationId": "user_status-set-custom-message",
  835. "summary": "Set the message to a custom message for the current user",
  836. "tags": [
  837. "user_status"
  838. ],
  839. "security": [
  840. {
  841. "bearer_auth": []
  842. },
  843. {
  844. "basic_auth": []
  845. }
  846. ],
  847. "parameters": [
  848. {
  849. "name": "statusIcon",
  850. "in": "query",
  851. "description": "Icon of the status",
  852. "schema": {
  853. "type": "string",
  854. "nullable": true
  855. }
  856. },
  857. {
  858. "name": "message",
  859. "in": "query",
  860. "description": "Message of the status",
  861. "schema": {
  862. "type": "string",
  863. "nullable": true
  864. }
  865. },
  866. {
  867. "name": "clearAt",
  868. "in": "query",
  869. "description": "When the message should be cleared",
  870. "schema": {
  871. "type": "integer",
  872. "format": "int64",
  873. "nullable": true
  874. }
  875. },
  876. {
  877. "name": "OCS-APIRequest",
  878. "in": "header",
  879. "description": "Required to be true for the API request to pass",
  880. "required": true,
  881. "schema": {
  882. "type": "boolean",
  883. "default": true
  884. }
  885. }
  886. ],
  887. "responses": {
  888. "200": {
  889. "description": "The message was updated successfully",
  890. "content": {
  891. "application/json": {
  892. "schema": {
  893. "type": "object",
  894. "required": [
  895. "ocs"
  896. ],
  897. "properties": {
  898. "ocs": {
  899. "type": "object",
  900. "required": [
  901. "meta",
  902. "data"
  903. ],
  904. "properties": {
  905. "meta": {
  906. "$ref": "#/components/schemas/OCSMeta"
  907. },
  908. "data": {
  909. "$ref": "#/components/schemas/Private"
  910. }
  911. }
  912. }
  913. }
  914. }
  915. }
  916. }
  917. },
  918. "400": {
  919. "description": "The clearAt or icon is invalid or the message is too long",
  920. "content": {
  921. "text/plain": {
  922. "schema": {
  923. "type": "string"
  924. }
  925. }
  926. }
  927. }
  928. }
  929. }
  930. },
  931. "/ocs/v2.php/apps/user_status/api/v1/user_status/message": {
  932. "delete": {
  933. "operationId": "user_status-clear-message",
  934. "summary": "Clear the message of the current user",
  935. "tags": [
  936. "user_status"
  937. ],
  938. "security": [
  939. {
  940. "bearer_auth": []
  941. },
  942. {
  943. "basic_auth": []
  944. }
  945. ],
  946. "parameters": [
  947. {
  948. "name": "OCS-APIRequest",
  949. "in": "header",
  950. "description": "Required to be true for the API request to pass",
  951. "required": true,
  952. "schema": {
  953. "type": "boolean",
  954. "default": true
  955. }
  956. }
  957. ],
  958. "responses": {
  959. "200": {
  960. "description": "Message cleared successfully",
  961. "content": {
  962. "application/json": {
  963. "schema": {
  964. "type": "object",
  965. "required": [
  966. "ocs"
  967. ],
  968. "properties": {
  969. "ocs": {
  970. "type": "object",
  971. "required": [
  972. "meta",
  973. "data"
  974. ],
  975. "properties": {
  976. "meta": {
  977. "$ref": "#/components/schemas/OCSMeta"
  978. },
  979. "data": {}
  980. }
  981. }
  982. }
  983. }
  984. }
  985. }
  986. }
  987. }
  988. }
  989. },
  990. "/ocs/v2.php/apps/user_status/api/v1/user_status/revert/{messageId}": {
  991. "delete": {
  992. "operationId": "user_status-revert-status",
  993. "summary": "Revert the status to the previous status",
  994. "tags": [
  995. "user_status"
  996. ],
  997. "security": [
  998. {
  999. "bearer_auth": []
  1000. },
  1001. {
  1002. "basic_auth": []
  1003. }
  1004. ],
  1005. "parameters": [
  1006. {
  1007. "name": "messageId",
  1008. "in": "path",
  1009. "description": "ID of the message to delete",
  1010. "required": true,
  1011. "schema": {
  1012. "type": "string"
  1013. }
  1014. },
  1015. {
  1016. "name": "OCS-APIRequest",
  1017. "in": "header",
  1018. "description": "Required to be true for the API request to pass",
  1019. "required": true,
  1020. "schema": {
  1021. "type": "boolean",
  1022. "default": true
  1023. }
  1024. }
  1025. ],
  1026. "responses": {
  1027. "200": {
  1028. "description": "Status reverted",
  1029. "content": {
  1030. "application/json": {
  1031. "schema": {
  1032. "type": "object",
  1033. "required": [
  1034. "ocs"
  1035. ],
  1036. "properties": {
  1037. "ocs": {
  1038. "type": "object",
  1039. "required": [
  1040. "meta",
  1041. "data"
  1042. ],
  1043. "properties": {
  1044. "meta": {
  1045. "$ref": "#/components/schemas/OCSMeta"
  1046. },
  1047. "data": {
  1048. "oneOf": [
  1049. {
  1050. "$ref": "#/components/schemas/Private"
  1051. },
  1052. {
  1053. "type": "array",
  1054. "maxLength": 0
  1055. }
  1056. ]
  1057. }
  1058. }
  1059. }
  1060. }
  1061. }
  1062. }
  1063. }
  1064. }
  1065. }
  1066. }
  1067. }
  1068. },
  1069. "tags": []
  1070. }