Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 

3018 строки
86 KiB

  1. openapi: 3.1.0
  2. info:
  3. title: 'Matsen API Platform'
  4. description: ''
  5. version: 1.0.0
  6. servers:
  7. -
  8. url: /
  9. description: ''
  10. paths:
  11. /api/comments:
  12. get:
  13. operationId: api_comments_get_collection
  14. tags:
  15. - Comment
  16. responses:
  17. 200:
  18. description: 'Comment collection'
  19. content:
  20. application/ld+json:
  21. schema:
  22. type: object
  23. properties:
  24. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Comment.jsonld' } }
  25. 'hydra:totalItems': { type: integer, minimum: 0 }
  26. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  27. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  28. required:
  29. - 'hydra:member'
  30. application/json:
  31. schema:
  32. type: array
  33. items:
  34. $ref: '#/components/schemas/Comment'
  35. text/html:
  36. schema:
  37. type: array
  38. items:
  39. $ref: '#/components/schemas/Comment'
  40. application/hal+json:
  41. schema:
  42. type: object
  43. properties:
  44. _embedded: { type: array, items: { $ref: '#/components/schemas/Comment.jsonhal' } }
  45. totalItems: { type: integer, minimum: 0 }
  46. itemsPerPage: { type: integer, minimum: 0 }
  47. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  48. required:
  49. - _links
  50. - _embedded
  51. summary: 'Retrieves the collection of Comment resources.'
  52. description: 'Retrieves the collection of Comment resources.'
  53. parameters:
  54. -
  55. name: page
  56. in: query
  57. description: 'The collection page number'
  58. required: false
  59. deprecated: false
  60. allowEmptyValue: true
  61. schema:
  62. type: integer
  63. default: 1
  64. style: form
  65. explode: false
  66. allowReserved: false
  67. -
  68. name: itemsPerPage
  69. in: query
  70. description: 'The number of items per page'
  71. required: false
  72. deprecated: false
  73. allowEmptyValue: true
  74. schema:
  75. type: integer
  76. default: 10
  77. minimum: 0
  78. maximum: 50
  79. style: form
  80. explode: false
  81. allowReserved: false
  82. deprecated: false
  83. post:
  84. operationId: api_comments_post
  85. tags:
  86. - Comment
  87. responses:
  88. 201:
  89. description: 'Comment resource created'
  90. content:
  91. application/ld+json:
  92. schema:
  93. $ref: '#/components/schemas/Comment.jsonld'
  94. application/json:
  95. schema:
  96. $ref: '#/components/schemas/Comment'
  97. text/html:
  98. schema:
  99. $ref: '#/components/schemas/Comment'
  100. application/hal+json:
  101. schema:
  102. $ref: '#/components/schemas/Comment.jsonhal'
  103. links: { }
  104. 400:
  105. description: 'Invalid input'
  106. 422:
  107. description: 'Unprocessable entity'
  108. summary: 'Creates a Comment resource.'
  109. description: 'Creates a Comment resource.'
  110. parameters: []
  111. requestBody:
  112. description: 'The new Comment resource'
  113. content:
  114. application/ld+json:
  115. schema:
  116. $ref: '#/components/schemas/Comment.jsonld'
  117. application/json:
  118. schema:
  119. $ref: '#/components/schemas/Comment'
  120. text/html:
  121. schema:
  122. $ref: '#/components/schemas/Comment'
  123. application/hal+json:
  124. schema:
  125. $ref: '#/components/schemas/Comment.jsonhal'
  126. required: true
  127. deprecated: false
  128. parameters: []
  129. '/api/comments/{id}':
  130. get:
  131. operationId: api_comments_id_get
  132. tags:
  133. - Comment
  134. responses:
  135. 200:
  136. description: 'Comment resource'
  137. content:
  138. application/ld+json:
  139. schema:
  140. $ref: '#/components/schemas/Comment.jsonld'
  141. application/json:
  142. schema:
  143. $ref: '#/components/schemas/Comment'
  144. text/html:
  145. schema:
  146. $ref: '#/components/schemas/Comment'
  147. application/hal+json:
  148. schema:
  149. $ref: '#/components/schemas/Comment.jsonhal'
  150. 404:
  151. description: 'Resource not found'
  152. summary: 'Retrieves a Comment resource.'
  153. description: 'Retrieves a Comment resource.'
  154. parameters:
  155. -
  156. name: id
  157. in: path
  158. description: 'Comment identifier'
  159. required: true
  160. deprecated: false
  161. allowEmptyValue: false
  162. schema:
  163. type: string
  164. style: simple
  165. explode: false
  166. allowReserved: false
  167. deprecated: false
  168. delete:
  169. operationId: api_comments_id_delete
  170. tags:
  171. - Comment
  172. responses:
  173. 204:
  174. description: 'Comment resource deleted'
  175. 404:
  176. description: 'Resource not found'
  177. summary: 'Removes the Comment resource.'
  178. description: 'Removes the Comment resource.'
  179. parameters:
  180. -
  181. name: id
  182. in: path
  183. description: 'Comment identifier'
  184. required: true
  185. deprecated: false
  186. allowEmptyValue: false
  187. schema:
  188. type: string
  189. style: simple
  190. explode: false
  191. allowReserved: false
  192. deprecated: false
  193. patch:
  194. operationId: api_comments_id_patch
  195. tags:
  196. - Comment
  197. responses:
  198. 200:
  199. description: 'Comment resource updated'
  200. content:
  201. application/ld+json:
  202. schema:
  203. $ref: '#/components/schemas/Comment.jsonld'
  204. application/json:
  205. schema:
  206. $ref: '#/components/schemas/Comment'
  207. text/html:
  208. schema:
  209. $ref: '#/components/schemas/Comment'
  210. application/hal+json:
  211. schema:
  212. $ref: '#/components/schemas/Comment.jsonhal'
  213. links: { }
  214. 400:
  215. description: 'Invalid input'
  216. 422:
  217. description: 'Unprocessable entity'
  218. 404:
  219. description: 'Resource not found'
  220. summary: 'Updates the Comment resource.'
  221. description: 'Updates the Comment resource.'
  222. parameters:
  223. -
  224. name: id
  225. in: path
  226. description: 'Comment identifier'
  227. required: true
  228. deprecated: false
  229. allowEmptyValue: false
  230. schema:
  231. type: string
  232. style: simple
  233. explode: false
  234. allowReserved: false
  235. requestBody:
  236. description: 'The updated Comment resource'
  237. content:
  238. application/merge-patch+json:
  239. schema:
  240. $ref: '#/components/schemas/Comment'
  241. required: true
  242. deprecated: false
  243. parameters: []
  244. /api/contacts:
  245. get:
  246. operationId: api_contacts_get_collection
  247. tags:
  248. - Contact
  249. responses:
  250. 200:
  251. description: 'Contact collection'
  252. content:
  253. application/ld+json:
  254. schema:
  255. type: object
  256. properties:
  257. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.jsonld' } }
  258. 'hydra:totalItems': { type: integer, minimum: 0 }
  259. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  260. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  261. required:
  262. - 'hydra:member'
  263. application/json:
  264. schema:
  265. type: array
  266. items:
  267. $ref: '#/components/schemas/Contact'
  268. text/html:
  269. schema:
  270. type: array
  271. items:
  272. $ref: '#/components/schemas/Contact'
  273. application/hal+json:
  274. schema:
  275. type: object
  276. properties:
  277. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.jsonhal' } }
  278. totalItems: { type: integer, minimum: 0 }
  279. itemsPerPage: { type: integer, minimum: 0 }
  280. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  281. required:
  282. - _links
  283. - _embedded
  284. summary: 'Retrieves the collection of Contact resources.'
  285. description: 'Retrieves the collection of Contact resources.'
  286. parameters:
  287. -
  288. name: page
  289. in: query
  290. description: 'The collection page number'
  291. required: false
  292. deprecated: false
  293. allowEmptyValue: true
  294. schema:
  295. type: integer
  296. default: 1
  297. style: form
  298. explode: false
  299. allowReserved: false
  300. -
  301. name: itemsPerPage
  302. in: query
  303. description: 'The number of items per page'
  304. required: false
  305. deprecated: false
  306. allowEmptyValue: true
  307. schema:
  308. type: integer
  309. default: 10
  310. minimum: 0
  311. maximum: 50
  312. style: form
  313. explode: false
  314. allowReserved: false
  315. -
  316. name: partner
  317. in: query
  318. description: ''
  319. required: false
  320. deprecated: false
  321. allowEmptyValue: true
  322. schema:
  323. type: string
  324. style: form
  325. explode: false
  326. allowReserved: false
  327. -
  328. name: 'partner[]'
  329. in: query
  330. description: ''
  331. required: false
  332. deprecated: false
  333. allowEmptyValue: true
  334. schema:
  335. type: array
  336. items:
  337. type: string
  338. style: form
  339. explode: true
  340. allowReserved: false
  341. deprecated: false
  342. post:
  343. operationId: api_contacts_post
  344. tags:
  345. - Contact
  346. responses:
  347. 201:
  348. description: 'Contact resource created'
  349. content:
  350. application/ld+json:
  351. schema:
  352. $ref: '#/components/schemas/Contact.jsonld'
  353. application/json:
  354. schema:
  355. $ref: '#/components/schemas/Contact'
  356. text/html:
  357. schema:
  358. $ref: '#/components/schemas/Contact'
  359. application/hal+json:
  360. schema:
  361. $ref: '#/components/schemas/Contact.jsonhal'
  362. links: { }
  363. 400:
  364. description: 'Invalid input'
  365. 422:
  366. description: 'Unprocessable entity'
  367. summary: 'Creates a Contact resource.'
  368. description: 'Creates a Contact resource.'
  369. parameters: []
  370. requestBody:
  371. description: 'The new Contact resource'
  372. content:
  373. application/ld+json:
  374. schema:
  375. $ref: '#/components/schemas/Contact.jsonld'
  376. application/json:
  377. schema:
  378. $ref: '#/components/schemas/Contact'
  379. text/html:
  380. schema:
  381. $ref: '#/components/schemas/Contact'
  382. application/hal+json:
  383. schema:
  384. $ref: '#/components/schemas/Contact.jsonhal'
  385. required: true
  386. deprecated: false
  387. parameters: []
  388. '/api/contacts/{id}':
  389. get:
  390. operationId: api_contacts_id_get
  391. tags:
  392. - Contact
  393. responses:
  394. 200:
  395. description: 'Contact resource'
  396. content:
  397. application/ld+json:
  398. schema:
  399. $ref: '#/components/schemas/Contact.jsonld'
  400. application/json:
  401. schema:
  402. $ref: '#/components/schemas/Contact'
  403. text/html:
  404. schema:
  405. $ref: '#/components/schemas/Contact'
  406. application/hal+json:
  407. schema:
  408. $ref: '#/components/schemas/Contact.jsonhal'
  409. 404:
  410. description: 'Resource not found'
  411. summary: 'Retrieves a Contact resource.'
  412. description: 'Retrieves a Contact resource.'
  413. parameters:
  414. -
  415. name: id
  416. in: path
  417. description: 'Contact identifier'
  418. required: true
  419. deprecated: false
  420. allowEmptyValue: false
  421. schema:
  422. type: string
  423. style: simple
  424. explode: false
  425. allowReserved: false
  426. deprecated: false
  427. delete:
  428. operationId: api_contacts_id_delete
  429. tags:
  430. - Contact
  431. responses:
  432. 204:
  433. description: 'Contact resource deleted'
  434. 404:
  435. description: 'Resource not found'
  436. summary: 'Removes the Contact resource.'
  437. description: 'Removes the Contact resource.'
  438. parameters:
  439. -
  440. name: id
  441. in: path
  442. description: 'Contact identifier'
  443. required: true
  444. deprecated: false
  445. allowEmptyValue: false
  446. schema:
  447. type: string
  448. style: simple
  449. explode: false
  450. allowReserved: false
  451. deprecated: false
  452. patch:
  453. operationId: api_contacts_id_patch
  454. tags:
  455. - Contact
  456. responses:
  457. 200:
  458. description: 'Contact resource updated'
  459. content:
  460. application/ld+json:
  461. schema:
  462. $ref: '#/components/schemas/Contact.jsonld'
  463. application/json:
  464. schema:
  465. $ref: '#/components/schemas/Contact'
  466. text/html:
  467. schema:
  468. $ref: '#/components/schemas/Contact'
  469. application/hal+json:
  470. schema:
  471. $ref: '#/components/schemas/Contact.jsonhal'
  472. links: { }
  473. 400:
  474. description: 'Invalid input'
  475. 422:
  476. description: 'Unprocessable entity'
  477. 404:
  478. description: 'Resource not found'
  479. summary: 'Updates the Contact resource.'
  480. description: 'Updates the Contact resource.'
  481. parameters:
  482. -
  483. name: id
  484. in: path
  485. description: 'Contact identifier'
  486. required: true
  487. deprecated: false
  488. allowEmptyValue: false
  489. schema:
  490. type: string
  491. style: simple
  492. explode: false
  493. allowReserved: false
  494. requestBody:
  495. description: 'The updated Contact resource'
  496. content:
  497. application/merge-patch+json:
  498. schema:
  499. $ref: '#/components/schemas/Contact'
  500. required: true
  501. deprecated: false
  502. parameters: []
  503. /api/medias:
  504. get:
  505. operationId: api_medias_get_collection
  506. tags:
  507. - Media
  508. responses:
  509. 200:
  510. description: 'Media collection'
  511. content:
  512. application/ld+json:
  513. schema:
  514. type: object
  515. properties:
  516. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Media.jsonld-media_object.read' } }
  517. 'hydra:totalItems': { type: integer, minimum: 0 }
  518. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  519. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  520. required:
  521. - 'hydra:member'
  522. application/json:
  523. schema:
  524. type: array
  525. items:
  526. $ref: '#/components/schemas/Media-media_object.read'
  527. text/html:
  528. schema:
  529. type: array
  530. items:
  531. $ref: '#/components/schemas/Media-media_object.read'
  532. application/hal+json:
  533. schema:
  534. type: object
  535. properties:
  536. _embedded: { type: array, items: { $ref: '#/components/schemas/Media.jsonhal-media_object.read' } }
  537. totalItems: { type: integer, minimum: 0 }
  538. itemsPerPage: { type: integer, minimum: 0 }
  539. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  540. required:
  541. - _links
  542. - _embedded
  543. summary: 'Retrieves the collection of Media resources.'
  544. description: 'Retrieves the collection of Media resources.'
  545. parameters:
  546. -
  547. name: page
  548. in: query
  549. description: 'The collection page number'
  550. required: false
  551. deprecated: false
  552. allowEmptyValue: true
  553. schema:
  554. type: integer
  555. default: 1
  556. style: form
  557. explode: false
  558. allowReserved: false
  559. -
  560. name: itemsPerPage
  561. in: query
  562. description: 'The number of items per page'
  563. required: false
  564. deprecated: false
  565. allowEmptyValue: true
  566. schema:
  567. type: integer
  568. default: 10
  569. minimum: 0
  570. maximum: 50
  571. style: form
  572. explode: false
  573. allowReserved: false
  574. deprecated: false
  575. post:
  576. operationId: api_medias_post
  577. tags:
  578. - Media
  579. responses:
  580. 201:
  581. description: 'Media resource created'
  582. content:
  583. application/ld+json:
  584. schema:
  585. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  586. application/json:
  587. schema:
  588. $ref: '#/components/schemas/Media-media_object.read'
  589. text/html:
  590. schema:
  591. $ref: '#/components/schemas/Media-media_object.read'
  592. application/hal+json:
  593. schema:
  594. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  595. links: { }
  596. 400:
  597. description: 'Invalid input'
  598. 422:
  599. description: 'Unprocessable entity'
  600. summary: 'Creates a Media resource.'
  601. description: 'Creates a Media resource.'
  602. parameters: []
  603. requestBody:
  604. description: ''
  605. content:
  606. multipart/form-data:
  607. schema:
  608. type: object
  609. properties:
  610. file:
  611. type: string
  612. format: binary
  613. required: false
  614. deprecated: false
  615. parameters: []
  616. '/api/medias/{id}':
  617. get:
  618. operationId: api_medias_id_get
  619. tags:
  620. - Media
  621. responses:
  622. 200:
  623. description: 'Media resource'
  624. content:
  625. application/ld+json:
  626. schema:
  627. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  628. application/json:
  629. schema:
  630. $ref: '#/components/schemas/Media-media_object.read'
  631. text/html:
  632. schema:
  633. $ref: '#/components/schemas/Media-media_object.read'
  634. application/hal+json:
  635. schema:
  636. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  637. 404:
  638. description: 'Resource not found'
  639. summary: 'Retrieves a Media resource.'
  640. description: 'Retrieves a Media resource.'
  641. parameters:
  642. -
  643. name: id
  644. in: path
  645. description: 'Media identifier'
  646. required: true
  647. deprecated: false
  648. allowEmptyValue: false
  649. schema:
  650. type: string
  651. style: simple
  652. explode: false
  653. allowReserved: false
  654. deprecated: false
  655. delete:
  656. operationId: api_medias_id_delete
  657. tags:
  658. - Media
  659. responses:
  660. 204:
  661. description: 'Media resource deleted'
  662. 404:
  663. description: 'Resource not found'
  664. summary: 'Removes the Media resource.'
  665. description: 'Removes the Media resource.'
  666. parameters:
  667. -
  668. name: id
  669. in: path
  670. description: 'Media identifier'
  671. required: true
  672. deprecated: false
  673. allowEmptyValue: false
  674. schema:
  675. type: string
  676. style: simple
  677. explode: false
  678. allowReserved: false
  679. deprecated: false
  680. parameters: []
  681. /api/partners:
  682. get:
  683. operationId: api_partners_get_collection
  684. tags:
  685. - Partner
  686. responses:
  687. 200:
  688. description: 'Partner collection'
  689. content:
  690. application/ld+json:
  691. schema:
  692. type: object
  693. properties:
  694. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  695. 'hydra:totalItems': { type: integer, minimum: 0 }
  696. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  697. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  698. required:
  699. - 'hydra:member'
  700. application/json:
  701. schema:
  702. type: array
  703. items:
  704. $ref: '#/components/schemas/Partner'
  705. text/html:
  706. schema:
  707. type: array
  708. items:
  709. $ref: '#/components/schemas/Partner'
  710. application/hal+json:
  711. schema:
  712. type: object
  713. properties:
  714. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  715. totalItems: { type: integer, minimum: 0 }
  716. itemsPerPage: { type: integer, minimum: 0 }
  717. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  718. required:
  719. - _links
  720. - _embedded
  721. summary: 'Retrieves the collection of Partner resources.'
  722. description: 'Retrieves the collection of Partner resources.'
  723. parameters:
  724. -
  725. name: page
  726. in: query
  727. description: 'The collection page number'
  728. required: false
  729. deprecated: false
  730. allowEmptyValue: true
  731. schema:
  732. type: integer
  733. default: 1
  734. style: form
  735. explode: false
  736. allowReserved: false
  737. -
  738. name: itemsPerPage
  739. in: query
  740. description: 'The number of items per page'
  741. required: false
  742. deprecated: false
  743. allowEmptyValue: true
  744. schema:
  745. type: integer
  746. default: 10
  747. minimum: 0
  748. maximum: 50
  749. style: form
  750. explode: false
  751. allowReserved: false
  752. -
  753. name: type
  754. in: query
  755. description: ''
  756. required: false
  757. deprecated: false
  758. allowEmptyValue: true
  759. schema:
  760. type: string
  761. style: form
  762. explode: false
  763. allowReserved: false
  764. -
  765. name: 'type[]'
  766. in: query
  767. description: ''
  768. required: false
  769. deprecated: false
  770. allowEmptyValue: true
  771. schema:
  772. type: array
  773. items:
  774. type: string
  775. style: form
  776. explode: true
  777. allowReserved: false
  778. -
  779. name: 'order[name]'
  780. in: query
  781. description: ''
  782. required: false
  783. deprecated: false
  784. allowEmptyValue: true
  785. schema:
  786. type: string
  787. enum:
  788. - asc
  789. - desc
  790. style: form
  791. explode: false
  792. allowReserved: false
  793. -
  794. name: 'order[city]'
  795. in: query
  796. description: ''
  797. required: false
  798. deprecated: false
  799. allowEmptyValue: true
  800. schema:
  801. type: string
  802. enum:
  803. - asc
  804. - desc
  805. style: form
  806. explode: false
  807. allowReserved: false
  808. -
  809. name: 'order[website]'
  810. in: query
  811. description: ''
  812. required: false
  813. deprecated: false
  814. allowEmptyValue: true
  815. schema:
  816. type: string
  817. enum:
  818. - asc
  819. - desc
  820. style: form
  821. explode: false
  822. allowReserved: false
  823. deprecated: false
  824. post:
  825. operationId: api_partners_post
  826. tags:
  827. - Partner
  828. responses:
  829. 201:
  830. description: 'Partner resource created'
  831. content:
  832. application/ld+json:
  833. schema:
  834. $ref: '#/components/schemas/Partner.jsonld'
  835. application/json:
  836. schema:
  837. $ref: '#/components/schemas/Partner'
  838. text/html:
  839. schema:
  840. $ref: '#/components/schemas/Partner'
  841. application/hal+json:
  842. schema:
  843. $ref: '#/components/schemas/Partner.jsonhal'
  844. links: { }
  845. 400:
  846. description: 'Invalid input'
  847. 422:
  848. description: 'Unprocessable entity'
  849. summary: 'Creates a Partner resource.'
  850. description: 'Creates a Partner resource.'
  851. parameters: []
  852. requestBody:
  853. description: 'The new Partner resource'
  854. content:
  855. application/ld+json:
  856. schema:
  857. $ref: '#/components/schemas/Partner.jsonld'
  858. application/json:
  859. schema:
  860. $ref: '#/components/schemas/Partner'
  861. text/html:
  862. schema:
  863. $ref: '#/components/schemas/Partner'
  864. application/hal+json:
  865. schema:
  866. $ref: '#/components/schemas/Partner.jsonhal'
  867. required: true
  868. deprecated: false
  869. parameters: []
  870. '/api/partners/{id}':
  871. get:
  872. operationId: api_partners_id_get
  873. tags:
  874. - Partner
  875. responses:
  876. 200:
  877. description: 'Partner resource'
  878. content:
  879. application/ld+json:
  880. schema:
  881. $ref: '#/components/schemas/Partner.jsonld'
  882. application/json:
  883. schema:
  884. $ref: '#/components/schemas/Partner'
  885. text/html:
  886. schema:
  887. $ref: '#/components/schemas/Partner'
  888. application/hal+json:
  889. schema:
  890. $ref: '#/components/schemas/Partner.jsonhal'
  891. 404:
  892. description: 'Resource not found'
  893. summary: 'Retrieves a Partner resource.'
  894. description: 'Retrieves a Partner resource.'
  895. parameters:
  896. -
  897. name: id
  898. in: path
  899. description: 'Partner identifier'
  900. required: true
  901. deprecated: false
  902. allowEmptyValue: false
  903. schema:
  904. type: string
  905. style: simple
  906. explode: false
  907. allowReserved: false
  908. deprecated: false
  909. delete:
  910. operationId: api_partners_id_delete
  911. tags:
  912. - Partner
  913. responses:
  914. 204:
  915. description: 'Partner resource deleted'
  916. 404:
  917. description: 'Resource not found'
  918. summary: 'Removes the Partner resource.'
  919. description: 'Removes the Partner resource.'
  920. parameters:
  921. -
  922. name: id
  923. in: path
  924. description: 'Partner identifier'
  925. required: true
  926. deprecated: false
  927. allowEmptyValue: false
  928. schema:
  929. type: string
  930. style: simple
  931. explode: false
  932. allowReserved: false
  933. deprecated: false
  934. patch:
  935. operationId: api_partners_id_patch
  936. tags:
  937. - Partner
  938. responses:
  939. 200:
  940. description: 'Partner resource updated'
  941. content:
  942. application/ld+json:
  943. schema:
  944. $ref: '#/components/schemas/Partner.jsonld'
  945. application/json:
  946. schema:
  947. $ref: '#/components/schemas/Partner'
  948. text/html:
  949. schema:
  950. $ref: '#/components/schemas/Partner'
  951. application/hal+json:
  952. schema:
  953. $ref: '#/components/schemas/Partner.jsonhal'
  954. links: { }
  955. 400:
  956. description: 'Invalid input'
  957. 422:
  958. description: 'Unprocessable entity'
  959. 404:
  960. description: 'Resource not found'
  961. summary: 'Updates the Partner resource.'
  962. description: 'Updates the Partner resource.'
  963. parameters:
  964. -
  965. name: id
  966. in: path
  967. description: 'Partner identifier'
  968. required: true
  969. deprecated: false
  970. allowEmptyValue: false
  971. schema:
  972. type: string
  973. style: simple
  974. explode: false
  975. allowReserved: false
  976. requestBody:
  977. description: 'The updated Partner resource'
  978. content:
  979. application/merge-patch+json:
  980. schema:
  981. $ref: '#/components/schemas/Partner'
  982. required: true
  983. deprecated: false
  984. parameters: []
  985. /api/posts:
  986. get:
  987. operationId: api_posts_get_collection
  988. tags:
  989. - Post
  990. responses:
  991. 200:
  992. description: 'Post collection'
  993. content:
  994. application/ld+json:
  995. schema:
  996. type: object
  997. properties:
  998. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  999. 'hydra:totalItems': { type: integer, minimum: 0 }
  1000. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  1001. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1002. required:
  1003. - 'hydra:member'
  1004. application/json:
  1005. schema:
  1006. type: array
  1007. items:
  1008. $ref: '#/components/schemas/Post'
  1009. text/html:
  1010. schema:
  1011. type: array
  1012. items:
  1013. $ref: '#/components/schemas/Post'
  1014. application/hal+json:
  1015. schema:
  1016. type: object
  1017. properties:
  1018. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  1019. totalItems: { type: integer, minimum: 0 }
  1020. itemsPerPage: { type: integer, minimum: 0 }
  1021. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  1022. required:
  1023. - _links
  1024. - _embedded
  1025. summary: 'Retrieves the collection of Post resources.'
  1026. description: 'Retrieves the collection of Post resources.'
  1027. parameters:
  1028. -
  1029. name: page
  1030. in: query
  1031. description: 'The collection page number'
  1032. required: false
  1033. deprecated: false
  1034. allowEmptyValue: true
  1035. schema:
  1036. type: integer
  1037. default: 1
  1038. style: form
  1039. explode: false
  1040. allowReserved: false
  1041. -
  1042. name: itemsPerPage
  1043. in: query
  1044. description: 'The number of items per page'
  1045. required: false
  1046. deprecated: false
  1047. allowEmptyValue: true
  1048. schema:
  1049. type: integer
  1050. default: 10
  1051. minimum: 0
  1052. maximum: 50
  1053. style: form
  1054. explode: false
  1055. allowReserved: false
  1056. -
  1057. name: partner
  1058. in: query
  1059. description: ''
  1060. required: false
  1061. deprecated: false
  1062. allowEmptyValue: true
  1063. schema:
  1064. type: string
  1065. style: form
  1066. explode: false
  1067. allowReserved: false
  1068. -
  1069. name: 'partner[]'
  1070. in: query
  1071. description: ''
  1072. required: false
  1073. deprecated: false
  1074. allowEmptyValue: true
  1075. schema:
  1076. type: array
  1077. items:
  1078. type: string
  1079. style: form
  1080. explode: true
  1081. allowReserved: false
  1082. -
  1083. name: contact
  1084. in: query
  1085. description: ''
  1086. required: false
  1087. deprecated: false
  1088. allowEmptyValue: true
  1089. schema:
  1090. type: string
  1091. style: form
  1092. explode: false
  1093. allowReserved: false
  1094. -
  1095. name: 'contact[]'
  1096. in: query
  1097. description: ''
  1098. required: false
  1099. deprecated: false
  1100. allowEmptyValue: true
  1101. schema:
  1102. type: array
  1103. items:
  1104. type: string
  1105. style: form
  1106. explode: true
  1107. allowReserved: false
  1108. deprecated: false
  1109. post:
  1110. operationId: api_posts_post
  1111. tags:
  1112. - Post
  1113. responses:
  1114. 201:
  1115. description: 'Post resource created'
  1116. content:
  1117. application/ld+json:
  1118. schema:
  1119. $ref: '#/components/schemas/Post.jsonld'
  1120. application/json:
  1121. schema:
  1122. $ref: '#/components/schemas/Post'
  1123. text/html:
  1124. schema:
  1125. $ref: '#/components/schemas/Post'
  1126. application/hal+json:
  1127. schema:
  1128. $ref: '#/components/schemas/Post.jsonhal'
  1129. links: { }
  1130. 400:
  1131. description: 'Invalid input'
  1132. 422:
  1133. description: 'Unprocessable entity'
  1134. summary: 'Creates a Post resource.'
  1135. description: 'Creates a Post resource.'
  1136. parameters: []
  1137. requestBody:
  1138. description: 'The new Post resource'
  1139. content:
  1140. application/ld+json:
  1141. schema:
  1142. $ref: '#/components/schemas/Post.jsonld-posting.create'
  1143. application/json:
  1144. schema:
  1145. $ref: '#/components/schemas/Post-posting.create'
  1146. text/html:
  1147. schema:
  1148. $ref: '#/components/schemas/Post-posting.create'
  1149. application/hal+json:
  1150. schema:
  1151. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  1152. required: true
  1153. deprecated: false
  1154. parameters: []
  1155. '/api/posts/{id}':
  1156. get:
  1157. operationId: api_posts_id_get
  1158. tags:
  1159. - Post
  1160. responses:
  1161. 200:
  1162. description: 'Post resource'
  1163. content:
  1164. application/ld+json:
  1165. schema:
  1166. $ref: '#/components/schemas/Post.jsonld'
  1167. application/json:
  1168. schema:
  1169. $ref: '#/components/schemas/Post'
  1170. text/html:
  1171. schema:
  1172. $ref: '#/components/schemas/Post'
  1173. application/hal+json:
  1174. schema:
  1175. $ref: '#/components/schemas/Post.jsonhal'
  1176. 404:
  1177. description: 'Resource not found'
  1178. summary: 'Retrieves a Post resource.'
  1179. description: 'Retrieves a Post resource.'
  1180. parameters:
  1181. -
  1182. name: id
  1183. in: path
  1184. description: 'Post identifier'
  1185. required: true
  1186. deprecated: false
  1187. allowEmptyValue: false
  1188. schema:
  1189. type: string
  1190. style: simple
  1191. explode: false
  1192. allowReserved: false
  1193. deprecated: false
  1194. delete:
  1195. operationId: api_posts_id_delete
  1196. tags:
  1197. - Post
  1198. responses:
  1199. 204:
  1200. description: 'Post resource deleted'
  1201. 404:
  1202. description: 'Resource not found'
  1203. summary: 'Removes the Post resource.'
  1204. description: 'Removes the Post resource.'
  1205. parameters:
  1206. -
  1207. name: id
  1208. in: path
  1209. description: 'Post identifier'
  1210. required: true
  1211. deprecated: false
  1212. allowEmptyValue: false
  1213. schema:
  1214. type: string
  1215. style: simple
  1216. explode: false
  1217. allowReserved: false
  1218. deprecated: false
  1219. patch:
  1220. operationId: api_posts_id_patch
  1221. tags:
  1222. - Post
  1223. responses:
  1224. 200:
  1225. description: 'Post resource updated'
  1226. content:
  1227. application/ld+json:
  1228. schema:
  1229. $ref: '#/components/schemas/Post.jsonld'
  1230. application/json:
  1231. schema:
  1232. $ref: '#/components/schemas/Post'
  1233. text/html:
  1234. schema:
  1235. $ref: '#/components/schemas/Post'
  1236. application/hal+json:
  1237. schema:
  1238. $ref: '#/components/schemas/Post.jsonhal'
  1239. links: { }
  1240. 400:
  1241. description: 'Invalid input'
  1242. 422:
  1243. description: 'Unprocessable entity'
  1244. 404:
  1245. description: 'Resource not found'
  1246. summary: 'Updates the Post resource.'
  1247. description: 'Updates the Post resource.'
  1248. parameters:
  1249. -
  1250. name: id
  1251. in: path
  1252. description: 'Post identifier'
  1253. required: true
  1254. deprecated: false
  1255. allowEmptyValue: false
  1256. schema:
  1257. type: string
  1258. style: simple
  1259. explode: false
  1260. allowReserved: false
  1261. requestBody:
  1262. description: 'The updated Post resource'
  1263. content:
  1264. application/merge-patch+json:
  1265. schema:
  1266. $ref: '#/components/schemas/Post-posting.patch'
  1267. required: true
  1268. deprecated: false
  1269. parameters: []
  1270. /api/products:
  1271. get:
  1272. operationId: api_products_get_collection
  1273. tags:
  1274. - Product
  1275. responses:
  1276. 200:
  1277. description: 'Product collection'
  1278. content:
  1279. application/ld+json:
  1280. schema:
  1281. type: object
  1282. properties:
  1283. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  1284. 'hydra:totalItems': { type: integer, minimum: 0 }
  1285. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  1286. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1287. required:
  1288. - 'hydra:member'
  1289. application/json:
  1290. schema:
  1291. type: array
  1292. items:
  1293. $ref: '#/components/schemas/Product'
  1294. text/html:
  1295. schema:
  1296. type: array
  1297. items:
  1298. $ref: '#/components/schemas/Product'
  1299. application/hal+json:
  1300. schema:
  1301. type: object
  1302. properties:
  1303. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  1304. totalItems: { type: integer, minimum: 0 }
  1305. itemsPerPage: { type: integer, minimum: 0 }
  1306. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  1307. required:
  1308. - _links
  1309. - _embedded
  1310. summary: 'Retrieves the collection of Product resources.'
  1311. description: 'Retrieves the collection of Product resources.'
  1312. parameters:
  1313. -
  1314. name: page
  1315. in: query
  1316. description: 'The collection page number'
  1317. required: false
  1318. deprecated: false
  1319. allowEmptyValue: true
  1320. schema:
  1321. type: integer
  1322. default: 1
  1323. style: form
  1324. explode: false
  1325. allowReserved: false
  1326. -
  1327. name: itemsPerPage
  1328. in: query
  1329. description: 'The number of items per page'
  1330. required: false
  1331. deprecated: false
  1332. allowEmptyValue: true
  1333. schema:
  1334. type: integer
  1335. default: 10
  1336. minimum: 0
  1337. maximum: 50
  1338. style: form
  1339. explode: false
  1340. allowReserved: false
  1341. -
  1342. name: 'order[name]'
  1343. in: query
  1344. description: ''
  1345. required: false
  1346. deprecated: false
  1347. allowEmptyValue: true
  1348. schema:
  1349. type: string
  1350. enum:
  1351. - asc
  1352. - desc
  1353. style: form
  1354. explode: false
  1355. allowReserved: false
  1356. deprecated: false
  1357. post:
  1358. operationId: api_products_post
  1359. tags:
  1360. - Product
  1361. responses:
  1362. 201:
  1363. description: 'Product resource created'
  1364. content:
  1365. application/ld+json:
  1366. schema:
  1367. $ref: '#/components/schemas/Product.jsonld'
  1368. application/json:
  1369. schema:
  1370. $ref: '#/components/schemas/Product'
  1371. text/html:
  1372. schema:
  1373. $ref: '#/components/schemas/Product'
  1374. application/hal+json:
  1375. schema:
  1376. $ref: '#/components/schemas/Product.jsonhal'
  1377. links: { }
  1378. 400:
  1379. description: 'Invalid input'
  1380. 422:
  1381. description: 'Unprocessable entity'
  1382. summary: 'Creates a Product resource.'
  1383. description: 'Creates a Product resource.'
  1384. parameters: []
  1385. requestBody:
  1386. description: 'The new Product resource'
  1387. content:
  1388. application/ld+json:
  1389. schema:
  1390. $ref: '#/components/schemas/Product.jsonld'
  1391. application/json:
  1392. schema:
  1393. $ref: '#/components/schemas/Product'
  1394. text/html:
  1395. schema:
  1396. $ref: '#/components/schemas/Product'
  1397. application/hal+json:
  1398. schema:
  1399. $ref: '#/components/schemas/Product.jsonhal'
  1400. required: true
  1401. deprecated: false
  1402. parameters: []
  1403. '/api/products/{id}':
  1404. get:
  1405. operationId: api_products_id_get
  1406. tags:
  1407. - Product
  1408. responses:
  1409. 200:
  1410. description: 'Product resource'
  1411. content:
  1412. application/ld+json:
  1413. schema:
  1414. $ref: '#/components/schemas/Product.jsonld'
  1415. application/json:
  1416. schema:
  1417. $ref: '#/components/schemas/Product'
  1418. text/html:
  1419. schema:
  1420. $ref: '#/components/schemas/Product'
  1421. application/hal+json:
  1422. schema:
  1423. $ref: '#/components/schemas/Product.jsonhal'
  1424. 404:
  1425. description: 'Resource not found'
  1426. summary: 'Retrieves a Product resource.'
  1427. description: 'Retrieves a Product resource.'
  1428. parameters:
  1429. -
  1430. name: id
  1431. in: path
  1432. description: 'Product identifier'
  1433. required: true
  1434. deprecated: false
  1435. allowEmptyValue: false
  1436. schema:
  1437. type: string
  1438. style: simple
  1439. explode: false
  1440. allowReserved: false
  1441. deprecated: false
  1442. delete:
  1443. operationId: api_products_id_delete
  1444. tags:
  1445. - Product
  1446. responses:
  1447. 204:
  1448. description: 'Product resource deleted'
  1449. 404:
  1450. description: 'Resource not found'
  1451. summary: 'Removes the Product resource.'
  1452. description: 'Removes the Product resource.'
  1453. parameters:
  1454. -
  1455. name: id
  1456. in: path
  1457. description: 'Product identifier'
  1458. required: true
  1459. deprecated: false
  1460. allowEmptyValue: false
  1461. schema:
  1462. type: string
  1463. style: simple
  1464. explode: false
  1465. allowReserved: false
  1466. deprecated: false
  1467. patch:
  1468. operationId: api_products_id_patch
  1469. tags:
  1470. - Product
  1471. responses:
  1472. 200:
  1473. description: 'Product resource updated'
  1474. content:
  1475. application/ld+json:
  1476. schema:
  1477. $ref: '#/components/schemas/Product.jsonld'
  1478. application/json:
  1479. schema:
  1480. $ref: '#/components/schemas/Product'
  1481. text/html:
  1482. schema:
  1483. $ref: '#/components/schemas/Product'
  1484. application/hal+json:
  1485. schema:
  1486. $ref: '#/components/schemas/Product.jsonhal'
  1487. links: { }
  1488. 400:
  1489. description: 'Invalid input'
  1490. 422:
  1491. description: 'Unprocessable entity'
  1492. 404:
  1493. description: 'Resource not found'
  1494. summary: 'Updates the Product resource.'
  1495. description: 'Updates the Product resource.'
  1496. parameters:
  1497. -
  1498. name: id
  1499. in: path
  1500. description: 'Product identifier'
  1501. required: true
  1502. deprecated: false
  1503. allowEmptyValue: false
  1504. schema:
  1505. type: string
  1506. style: simple
  1507. explode: false
  1508. allowReserved: false
  1509. requestBody:
  1510. description: 'The updated Product resource'
  1511. content:
  1512. application/merge-patch+json:
  1513. schema:
  1514. $ref: '#/components/schemas/Product'
  1515. required: true
  1516. deprecated: false
  1517. parameters: []
  1518. /api/users:
  1519. get:
  1520. operationId: api_users_get_collection
  1521. tags:
  1522. - User
  1523. responses:
  1524. 200:
  1525. description: 'User collection'
  1526. content:
  1527. application/ld+json:
  1528. schema:
  1529. type: object
  1530. properties:
  1531. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1532. 'hydra:totalItems': { type: integer, minimum: 0 }
  1533. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  1534. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1535. required:
  1536. - 'hydra:member'
  1537. application/json:
  1538. schema:
  1539. type: array
  1540. items:
  1541. $ref: '#/components/schemas/User'
  1542. text/html:
  1543. schema:
  1544. type: array
  1545. items:
  1546. $ref: '#/components/schemas/User'
  1547. application/hal+json:
  1548. schema:
  1549. type: object
  1550. properties:
  1551. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  1552. totalItems: { type: integer, minimum: 0 }
  1553. itemsPerPage: { type: integer, minimum: 0 }
  1554. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  1555. required:
  1556. - _links
  1557. - _embedded
  1558. summary: 'Retrieves the collection of User resources.'
  1559. description: 'Retrieves the collection of User resources.'
  1560. parameters:
  1561. -
  1562. name: page
  1563. in: query
  1564. description: 'The collection page number'
  1565. required: false
  1566. deprecated: false
  1567. allowEmptyValue: true
  1568. schema:
  1569. type: integer
  1570. default: 1
  1571. style: form
  1572. explode: false
  1573. allowReserved: false
  1574. -
  1575. name: itemsPerPage
  1576. in: query
  1577. description: 'The number of items per page'
  1578. required: false
  1579. deprecated: false
  1580. allowEmptyValue: true
  1581. schema:
  1582. type: integer
  1583. default: 10
  1584. minimum: 0
  1585. maximum: 50
  1586. style: form
  1587. explode: false
  1588. allowReserved: false
  1589. deprecated: false
  1590. post:
  1591. operationId: api_users_post
  1592. tags:
  1593. - User
  1594. responses:
  1595. 201:
  1596. description: 'User resource created'
  1597. content:
  1598. application/ld+json:
  1599. schema:
  1600. $ref: '#/components/schemas/User.jsonld'
  1601. application/json:
  1602. schema:
  1603. $ref: '#/components/schemas/User'
  1604. text/html:
  1605. schema:
  1606. $ref: '#/components/schemas/User'
  1607. application/hal+json:
  1608. schema:
  1609. $ref: '#/components/schemas/User.jsonhal'
  1610. links: { }
  1611. 400:
  1612. description: 'Invalid input'
  1613. 422:
  1614. description: 'Unprocessable entity'
  1615. summary: 'Creates a User resource.'
  1616. description: 'Creates a User resource.'
  1617. parameters: []
  1618. requestBody:
  1619. description: 'The new User resource'
  1620. content:
  1621. application/ld+json:
  1622. schema:
  1623. $ref: '#/components/schemas/User.jsonld'
  1624. application/json:
  1625. schema:
  1626. $ref: '#/components/schemas/User'
  1627. text/html:
  1628. schema:
  1629. $ref: '#/components/schemas/User'
  1630. application/hal+json:
  1631. schema:
  1632. $ref: '#/components/schemas/User.jsonhal'
  1633. required: true
  1634. deprecated: false
  1635. parameters: []
  1636. '/api/users/{id}':
  1637. get:
  1638. operationId: api_users_id_get
  1639. tags:
  1640. - User
  1641. responses:
  1642. 200:
  1643. description: 'User resource'
  1644. content:
  1645. application/ld+json:
  1646. schema:
  1647. $ref: '#/components/schemas/User.jsonld'
  1648. application/json:
  1649. schema:
  1650. $ref: '#/components/schemas/User'
  1651. text/html:
  1652. schema:
  1653. $ref: '#/components/schemas/User'
  1654. application/hal+json:
  1655. schema:
  1656. $ref: '#/components/schemas/User.jsonhal'
  1657. 404:
  1658. description: 'Resource not found'
  1659. summary: 'Retrieves a User resource.'
  1660. description: 'Retrieves a User resource.'
  1661. parameters:
  1662. -
  1663. name: id
  1664. in: path
  1665. description: 'User identifier'
  1666. required: true
  1667. deprecated: false
  1668. allowEmptyValue: false
  1669. schema:
  1670. type: string
  1671. style: simple
  1672. explode: false
  1673. allowReserved: false
  1674. deprecated: false
  1675. patch:
  1676. operationId: api_users_id_patch
  1677. tags:
  1678. - User
  1679. responses:
  1680. 200:
  1681. description: 'User resource updated'
  1682. content:
  1683. application/ld+json:
  1684. schema:
  1685. $ref: '#/components/schemas/User.jsonld'
  1686. application/json:
  1687. schema:
  1688. $ref: '#/components/schemas/User'
  1689. text/html:
  1690. schema:
  1691. $ref: '#/components/schemas/User'
  1692. application/hal+json:
  1693. schema:
  1694. $ref: '#/components/schemas/User.jsonhal'
  1695. links: { }
  1696. 400:
  1697. description: 'Invalid input'
  1698. 422:
  1699. description: 'Unprocessable entity'
  1700. 404:
  1701. description: 'Resource not found'
  1702. summary: 'Updates the User resource.'
  1703. description: 'Updates the User resource.'
  1704. parameters:
  1705. -
  1706. name: id
  1707. in: path
  1708. description: 'User identifier'
  1709. required: true
  1710. deprecated: false
  1711. allowEmptyValue: false
  1712. schema:
  1713. type: string
  1714. style: simple
  1715. explode: false
  1716. allowReserved: false
  1717. requestBody:
  1718. description: 'The updated User resource'
  1719. content:
  1720. application/merge-patch+json:
  1721. schema:
  1722. $ref: '#/components/schemas/User'
  1723. required: true
  1724. deprecated: false
  1725. parameters: []
  1726. /auth:
  1727. post:
  1728. operationId: login_check_post
  1729. tags:
  1730. - 'Login Check'
  1731. responses:
  1732. 200:
  1733. description: 'User token created'
  1734. content:
  1735. application/json:
  1736. schema:
  1737. type: object
  1738. properties:
  1739. token: { readOnly: true, type: string, nullable: false }
  1740. required:
  1741. - token
  1742. summary: 'Creates a user token.'
  1743. description: 'Creates a user token.'
  1744. requestBody:
  1745. description: 'The login data'
  1746. content:
  1747. application/json:
  1748. schema:
  1749. type: object
  1750. properties:
  1751. email:
  1752. type: string
  1753. nullable: false
  1754. password:
  1755. type: string
  1756. nullable: false
  1757. required:
  1758. - email
  1759. - password
  1760. required: true
  1761. parameters: []
  1762. components:
  1763. schemas:
  1764. Comment:
  1765. type: object
  1766. description: ''
  1767. deprecated: false
  1768. required:
  1769. - message
  1770. properties:
  1771. message:
  1772. type:
  1773. - string
  1774. - 'null'
  1775. owner:
  1776. readOnly: true
  1777. type:
  1778. - string
  1779. - 'null'
  1780. format: iri-reference
  1781. example: 'https://example.com/'
  1782. ownerName:
  1783. readOnly: true
  1784. type:
  1785. - string
  1786. - 'null'
  1787. post:
  1788. type:
  1789. - string
  1790. - 'null'
  1791. format: iri-reference
  1792. example: 'https://example.com/'
  1793. createdAt:
  1794. readOnly: true
  1795. type:
  1796. - string
  1797. - 'null'
  1798. format: date-time
  1799. Comment.jsonhal:
  1800. type: object
  1801. description: ''
  1802. deprecated: false
  1803. required:
  1804. - message
  1805. properties:
  1806. _links:
  1807. type: object
  1808. properties:
  1809. self:
  1810. type: object
  1811. properties:
  1812. href:
  1813. type: string
  1814. format: iri-reference
  1815. message:
  1816. type:
  1817. - string
  1818. - 'null'
  1819. owner:
  1820. readOnly: true
  1821. type:
  1822. - string
  1823. - 'null'
  1824. format: iri-reference
  1825. example: 'https://example.com/'
  1826. ownerName:
  1827. readOnly: true
  1828. type:
  1829. - string
  1830. - 'null'
  1831. post:
  1832. type:
  1833. - string
  1834. - 'null'
  1835. format: iri-reference
  1836. example: 'https://example.com/'
  1837. createdAt:
  1838. readOnly: true
  1839. type:
  1840. - string
  1841. - 'null'
  1842. format: date-time
  1843. Comment.jsonld:
  1844. type: object
  1845. description: ''
  1846. deprecated: false
  1847. required:
  1848. - message
  1849. properties:
  1850. '@context':
  1851. readOnly: true
  1852. oneOf:
  1853. -
  1854. type: string
  1855. -
  1856. type: object
  1857. properties:
  1858. '@vocab':
  1859. type: string
  1860. hydra:
  1861. type: string
  1862. enum: ['http://www.w3.org/ns/hydra/core#']
  1863. required:
  1864. - '@vocab'
  1865. - hydra
  1866. additionalProperties: true
  1867. '@id':
  1868. readOnly: true
  1869. type: string
  1870. '@type':
  1871. readOnly: true
  1872. type: string
  1873. message:
  1874. type:
  1875. - string
  1876. - 'null'
  1877. owner:
  1878. readOnly: true
  1879. type:
  1880. - string
  1881. - 'null'
  1882. format: iri-reference
  1883. example: 'https://example.com/'
  1884. ownerName:
  1885. readOnly: true
  1886. type:
  1887. - string
  1888. - 'null'
  1889. post:
  1890. type:
  1891. - string
  1892. - 'null'
  1893. format: iri-reference
  1894. example: 'https://example.com/'
  1895. createdAt:
  1896. readOnly: true
  1897. type:
  1898. - string
  1899. - 'null'
  1900. format: date-time
  1901. Contact:
  1902. type: object
  1903. description: ''
  1904. deprecated: false
  1905. required:
  1906. - firstName
  1907. - lastName
  1908. - partner
  1909. properties:
  1910. firstName:
  1911. type:
  1912. - string
  1913. - 'null'
  1914. lastName:
  1915. type:
  1916. - string
  1917. - 'null'
  1918. partner:
  1919. type:
  1920. - string
  1921. - 'null'
  1922. format: iri-reference
  1923. example: 'https://example.com/'
  1924. birthday:
  1925. type:
  1926. - string
  1927. - 'null'
  1928. image:
  1929. type:
  1930. - string
  1931. - 'null'
  1932. format: iri-reference
  1933. example: 'https://example.com/'
  1934. imageUrl:
  1935. readOnly: true
  1936. type:
  1937. - string
  1938. - 'null'
  1939. position:
  1940. type:
  1941. - string
  1942. - 'null'
  1943. phone:
  1944. type:
  1945. - string
  1946. - 'null'
  1947. email:
  1948. format: email
  1949. externalDocs:
  1950. url: 'https://schema.org/email'
  1951. type:
  1952. - string
  1953. - 'null'
  1954. posts:
  1955. readOnly: true
  1956. type: array
  1957. items:
  1958. type: string
  1959. format: iri-reference
  1960. example: 'https://example.com/'
  1961. createdAt:
  1962. readOnly: true
  1963. type:
  1964. - string
  1965. - 'null'
  1966. format: date-time
  1967. Contact.jsonhal:
  1968. type: object
  1969. description: ''
  1970. deprecated: false
  1971. required:
  1972. - firstName
  1973. - lastName
  1974. - partner
  1975. properties:
  1976. _links:
  1977. type: object
  1978. properties:
  1979. self:
  1980. type: object
  1981. properties:
  1982. href:
  1983. type: string
  1984. format: iri-reference
  1985. firstName:
  1986. type:
  1987. - string
  1988. - 'null'
  1989. lastName:
  1990. type:
  1991. - string
  1992. - 'null'
  1993. partner:
  1994. type:
  1995. - string
  1996. - 'null'
  1997. format: iri-reference
  1998. example: 'https://example.com/'
  1999. birthday:
  2000. type:
  2001. - string
  2002. - 'null'
  2003. image:
  2004. type:
  2005. - string
  2006. - 'null'
  2007. format: iri-reference
  2008. example: 'https://example.com/'
  2009. imageUrl:
  2010. readOnly: true
  2011. type:
  2012. - string
  2013. - 'null'
  2014. position:
  2015. type:
  2016. - string
  2017. - 'null'
  2018. phone:
  2019. type:
  2020. - string
  2021. - 'null'
  2022. email:
  2023. format: email
  2024. externalDocs:
  2025. url: 'https://schema.org/email'
  2026. type:
  2027. - string
  2028. - 'null'
  2029. posts:
  2030. readOnly: true
  2031. type: array
  2032. items:
  2033. type: string
  2034. format: iri-reference
  2035. example: 'https://example.com/'
  2036. createdAt:
  2037. readOnly: true
  2038. type:
  2039. - string
  2040. - 'null'
  2041. format: date-time
  2042. Contact.jsonld:
  2043. type: object
  2044. description: ''
  2045. deprecated: false
  2046. required:
  2047. - firstName
  2048. - lastName
  2049. - partner
  2050. properties:
  2051. '@context':
  2052. readOnly: true
  2053. oneOf:
  2054. -
  2055. type: string
  2056. -
  2057. type: object
  2058. properties:
  2059. '@vocab':
  2060. type: string
  2061. hydra:
  2062. type: string
  2063. enum: ['http://www.w3.org/ns/hydra/core#']
  2064. required:
  2065. - '@vocab'
  2066. - hydra
  2067. additionalProperties: true
  2068. '@id':
  2069. readOnly: true
  2070. type: string
  2071. '@type':
  2072. readOnly: true
  2073. type: string
  2074. firstName:
  2075. type:
  2076. - string
  2077. - 'null'
  2078. lastName:
  2079. type:
  2080. - string
  2081. - 'null'
  2082. partner:
  2083. type:
  2084. - string
  2085. - 'null'
  2086. format: iri-reference
  2087. example: 'https://example.com/'
  2088. birthday:
  2089. type:
  2090. - string
  2091. - 'null'
  2092. image:
  2093. type:
  2094. - string
  2095. - 'null'
  2096. format: iri-reference
  2097. example: 'https://example.com/'
  2098. imageUrl:
  2099. readOnly: true
  2100. type:
  2101. - string
  2102. - 'null'
  2103. position:
  2104. type:
  2105. - string
  2106. - 'null'
  2107. phone:
  2108. type:
  2109. - string
  2110. - 'null'
  2111. email:
  2112. format: email
  2113. externalDocs:
  2114. url: 'https://schema.org/email'
  2115. type:
  2116. - string
  2117. - 'null'
  2118. posts:
  2119. readOnly: true
  2120. type: array
  2121. items:
  2122. type: string
  2123. format: iri-reference
  2124. example: 'https://example.com/'
  2125. createdAt:
  2126. readOnly: true
  2127. type:
  2128. - string
  2129. - 'null'
  2130. format: date-time
  2131. Media-media_object.read:
  2132. type: object
  2133. description: ''
  2134. deprecated: false
  2135. externalDocs:
  2136. url: 'https://schema.org/MediaObject'
  2137. properties:
  2138. contentUrl:
  2139. externalDocs:
  2140. url: 'https://schema.org/contentUrl'
  2141. type:
  2142. - string
  2143. - 'null'
  2144. Media.jsonhal-media_object.read:
  2145. type: object
  2146. description: ''
  2147. deprecated: false
  2148. externalDocs:
  2149. url: 'https://schema.org/MediaObject'
  2150. properties:
  2151. _links:
  2152. type: object
  2153. properties:
  2154. self:
  2155. type: object
  2156. properties:
  2157. href:
  2158. type: string
  2159. format: iri-reference
  2160. contentUrl:
  2161. externalDocs:
  2162. url: 'https://schema.org/contentUrl'
  2163. type:
  2164. - string
  2165. - 'null'
  2166. Media.jsonld-media_object.read:
  2167. type: object
  2168. description: ''
  2169. deprecated: false
  2170. externalDocs:
  2171. url: 'https://schema.org/MediaObject'
  2172. properties:
  2173. '@context':
  2174. readOnly: true
  2175. oneOf:
  2176. -
  2177. type: string
  2178. -
  2179. type: object
  2180. properties:
  2181. '@vocab':
  2182. type: string
  2183. hydra:
  2184. type: string
  2185. enum: ['http://www.w3.org/ns/hydra/core#']
  2186. required:
  2187. - '@vocab'
  2188. - hydra
  2189. additionalProperties: true
  2190. '@id':
  2191. readOnly: true
  2192. type: string
  2193. '@type':
  2194. readOnly: true
  2195. type: string
  2196. contentUrl:
  2197. externalDocs:
  2198. url: 'https://schema.org/contentUrl'
  2199. type:
  2200. - string
  2201. - 'null'
  2202. Partner:
  2203. type: object
  2204. description: ''
  2205. deprecated: false
  2206. required:
  2207. - name
  2208. - type
  2209. properties:
  2210. name:
  2211. type: string
  2212. type:
  2213. type: string
  2214. enum:
  2215. - customer
  2216. - supplier
  2217. - service
  2218. street:
  2219. type:
  2220. - string
  2221. - 'null'
  2222. streetNo:
  2223. type:
  2224. - string
  2225. - 'null'
  2226. zip:
  2227. type:
  2228. - string
  2229. - 'null'
  2230. city:
  2231. type:
  2232. - string
  2233. - 'null'
  2234. country:
  2235. type:
  2236. - string
  2237. - 'null'
  2238. website:
  2239. type:
  2240. - string
  2241. - 'null'
  2242. logo:
  2243. type:
  2244. - string
  2245. - 'null'
  2246. format: iri-reference
  2247. example: 'https://example.com/'
  2248. logoUrl:
  2249. readOnly: true
  2250. type:
  2251. - string
  2252. - 'null'
  2253. createdAt:
  2254. readOnly: true
  2255. type:
  2256. - string
  2257. - 'null'
  2258. format: date-time
  2259. contacts:
  2260. readOnly: true
  2261. type: array
  2262. items:
  2263. type: string
  2264. format: iri-reference
  2265. example: 'https://example.com/'
  2266. Partner.jsonhal:
  2267. type: object
  2268. description: ''
  2269. deprecated: false
  2270. required:
  2271. - name
  2272. - type
  2273. properties:
  2274. _links:
  2275. type: object
  2276. properties:
  2277. self:
  2278. type: object
  2279. properties:
  2280. href:
  2281. type: string
  2282. format: iri-reference
  2283. name:
  2284. type: string
  2285. type:
  2286. type: string
  2287. enum:
  2288. - customer
  2289. - supplier
  2290. - service
  2291. street:
  2292. type:
  2293. - string
  2294. - 'null'
  2295. streetNo:
  2296. type:
  2297. - string
  2298. - 'null'
  2299. zip:
  2300. type:
  2301. - string
  2302. - 'null'
  2303. city:
  2304. type:
  2305. - string
  2306. - 'null'
  2307. country:
  2308. type:
  2309. - string
  2310. - 'null'
  2311. website:
  2312. type:
  2313. - string
  2314. - 'null'
  2315. logo:
  2316. type:
  2317. - string
  2318. - 'null'
  2319. format: iri-reference
  2320. example: 'https://example.com/'
  2321. logoUrl:
  2322. readOnly: true
  2323. type:
  2324. - string
  2325. - 'null'
  2326. createdAt:
  2327. readOnly: true
  2328. type:
  2329. - string
  2330. - 'null'
  2331. format: date-time
  2332. contacts:
  2333. readOnly: true
  2334. type: array
  2335. items:
  2336. type: string
  2337. format: iri-reference
  2338. example: 'https://example.com/'
  2339. Partner.jsonld:
  2340. type: object
  2341. description: ''
  2342. deprecated: false
  2343. required:
  2344. - name
  2345. - type
  2346. properties:
  2347. '@context':
  2348. readOnly: true
  2349. oneOf:
  2350. -
  2351. type: string
  2352. -
  2353. type: object
  2354. properties:
  2355. '@vocab':
  2356. type: string
  2357. hydra:
  2358. type: string
  2359. enum: ['http://www.w3.org/ns/hydra/core#']
  2360. required:
  2361. - '@vocab'
  2362. - hydra
  2363. additionalProperties: true
  2364. '@id':
  2365. readOnly: true
  2366. type: string
  2367. '@type':
  2368. readOnly: true
  2369. type: string
  2370. name:
  2371. type: string
  2372. type:
  2373. type: string
  2374. enum:
  2375. - customer
  2376. - supplier
  2377. - service
  2378. street:
  2379. type:
  2380. - string
  2381. - 'null'
  2382. streetNo:
  2383. type:
  2384. - string
  2385. - 'null'
  2386. zip:
  2387. type:
  2388. - string
  2389. - 'null'
  2390. city:
  2391. type:
  2392. - string
  2393. - 'null'
  2394. country:
  2395. type:
  2396. - string
  2397. - 'null'
  2398. website:
  2399. type:
  2400. - string
  2401. - 'null'
  2402. logo:
  2403. type:
  2404. - string
  2405. - 'null'
  2406. format: iri-reference
  2407. example: 'https://example.com/'
  2408. logoUrl:
  2409. readOnly: true
  2410. type:
  2411. - string
  2412. - 'null'
  2413. createdAt:
  2414. readOnly: true
  2415. type:
  2416. - string
  2417. - 'null'
  2418. format: date-time
  2419. contacts:
  2420. readOnly: true
  2421. type: array
  2422. items:
  2423. type: string
  2424. format: iri-reference
  2425. example: 'https://example.com/'
  2426. Post:
  2427. type: object
  2428. description: ''
  2429. deprecated: false
  2430. required:
  2431. - headline
  2432. - message
  2433. properties:
  2434. headline:
  2435. type:
  2436. - string
  2437. - 'null'
  2438. message:
  2439. type:
  2440. - string
  2441. - 'null'
  2442. owner:
  2443. readOnly: true
  2444. type:
  2445. - string
  2446. - 'null'
  2447. format: iri-reference
  2448. example: 'https://example.com/'
  2449. ownerName:
  2450. readOnly: true
  2451. type:
  2452. - string
  2453. - 'null'
  2454. partner:
  2455. type:
  2456. - string
  2457. - 'null'
  2458. format: iri-reference
  2459. example: 'https://example.com/'
  2460. contact:
  2461. type:
  2462. - string
  2463. - 'null'
  2464. format: iri-reference
  2465. example: 'https://example.com/'
  2466. comments:
  2467. description: 'array<int, CommentApi>'
  2468. type: array
  2469. items:
  2470. $ref: '#/components/schemas/Comment'
  2471. createdAt:
  2472. readOnly: true
  2473. type:
  2474. - string
  2475. - 'null'
  2476. format: date-time
  2477. Post-posting.create:
  2478. type: object
  2479. description: ''
  2480. deprecated: false
  2481. required:
  2482. - headline
  2483. - message
  2484. properties:
  2485. headline:
  2486. type:
  2487. - string
  2488. - 'null'
  2489. message:
  2490. type:
  2491. - string
  2492. - 'null'
  2493. partner:
  2494. type:
  2495. - string
  2496. - 'null'
  2497. format: iri-reference
  2498. example: 'https://example.com/'
  2499. contact:
  2500. type:
  2501. - string
  2502. - 'null'
  2503. format: iri-reference
  2504. example: 'https://example.com/'
  2505. Post-posting.patch:
  2506. type: object
  2507. description: ''
  2508. deprecated: false
  2509. required:
  2510. - headline
  2511. - message
  2512. properties:
  2513. headline:
  2514. type:
  2515. - string
  2516. - 'null'
  2517. message:
  2518. type:
  2519. - string
  2520. - 'null'
  2521. Post.jsonhal:
  2522. type: object
  2523. description: ''
  2524. deprecated: false
  2525. required:
  2526. - headline
  2527. - message
  2528. properties:
  2529. _links:
  2530. type: object
  2531. properties:
  2532. self:
  2533. type: object
  2534. properties:
  2535. href:
  2536. type: string
  2537. format: iri-reference
  2538. headline:
  2539. type:
  2540. - string
  2541. - 'null'
  2542. message:
  2543. type:
  2544. - string
  2545. - 'null'
  2546. owner:
  2547. readOnly: true
  2548. type:
  2549. - string
  2550. - 'null'
  2551. format: iri-reference
  2552. example: 'https://example.com/'
  2553. ownerName:
  2554. readOnly: true
  2555. type:
  2556. - string
  2557. - 'null'
  2558. partner:
  2559. type:
  2560. - string
  2561. - 'null'
  2562. format: iri-reference
  2563. example: 'https://example.com/'
  2564. contact:
  2565. type:
  2566. - string
  2567. - 'null'
  2568. format: iri-reference
  2569. example: 'https://example.com/'
  2570. comments:
  2571. description: 'array<int, CommentApi>'
  2572. type: array
  2573. items:
  2574. $ref: '#/components/schemas/Comment.jsonhal'
  2575. createdAt:
  2576. readOnly: true
  2577. type:
  2578. - string
  2579. - 'null'
  2580. format: date-time
  2581. Post.jsonhal-posting.create:
  2582. type: object
  2583. description: ''
  2584. deprecated: false
  2585. required:
  2586. - headline
  2587. - message
  2588. properties:
  2589. _links:
  2590. type: object
  2591. properties:
  2592. self:
  2593. type: object
  2594. properties:
  2595. href:
  2596. type: string
  2597. format: iri-reference
  2598. headline:
  2599. type:
  2600. - string
  2601. - 'null'
  2602. message:
  2603. type:
  2604. - string
  2605. - 'null'
  2606. partner:
  2607. type:
  2608. - string
  2609. - 'null'
  2610. format: iri-reference
  2611. example: 'https://example.com/'
  2612. contact:
  2613. type:
  2614. - string
  2615. - 'null'
  2616. format: iri-reference
  2617. example: 'https://example.com/'
  2618. Post.jsonld:
  2619. type: object
  2620. description: ''
  2621. deprecated: false
  2622. required:
  2623. - headline
  2624. - message
  2625. properties:
  2626. '@context':
  2627. readOnly: true
  2628. oneOf:
  2629. -
  2630. type: string
  2631. -
  2632. type: object
  2633. properties:
  2634. '@vocab':
  2635. type: string
  2636. hydra:
  2637. type: string
  2638. enum: ['http://www.w3.org/ns/hydra/core#']
  2639. required:
  2640. - '@vocab'
  2641. - hydra
  2642. additionalProperties: true
  2643. '@id':
  2644. readOnly: true
  2645. type: string
  2646. '@type':
  2647. readOnly: true
  2648. type: string
  2649. headline:
  2650. type:
  2651. - string
  2652. - 'null'
  2653. message:
  2654. type:
  2655. - string
  2656. - 'null'
  2657. owner:
  2658. readOnly: true
  2659. type:
  2660. - string
  2661. - 'null'
  2662. format: iri-reference
  2663. example: 'https://example.com/'
  2664. ownerName:
  2665. readOnly: true
  2666. type:
  2667. - string
  2668. - 'null'
  2669. partner:
  2670. type:
  2671. - string
  2672. - 'null'
  2673. format: iri-reference
  2674. example: 'https://example.com/'
  2675. contact:
  2676. type:
  2677. - string
  2678. - 'null'
  2679. format: iri-reference
  2680. example: 'https://example.com/'
  2681. comments:
  2682. description: 'array<int, CommentApi>'
  2683. type: array
  2684. items:
  2685. $ref: '#/components/schemas/Comment.jsonld'
  2686. createdAt:
  2687. readOnly: true
  2688. type:
  2689. - string
  2690. - 'null'
  2691. format: date-time
  2692. Post.jsonld-posting.create:
  2693. type: object
  2694. description: ''
  2695. deprecated: false
  2696. required:
  2697. - headline
  2698. - message
  2699. properties:
  2700. headline:
  2701. type:
  2702. - string
  2703. - 'null'
  2704. message:
  2705. type:
  2706. - string
  2707. - 'null'
  2708. partner:
  2709. type:
  2710. - string
  2711. - 'null'
  2712. format: iri-reference
  2713. example: 'https://example.com/'
  2714. contact:
  2715. type:
  2716. - string
  2717. - 'null'
  2718. format: iri-reference
  2719. example: 'https://example.com/'
  2720. Product:
  2721. type: object
  2722. description: ''
  2723. deprecated: false
  2724. required:
  2725. - name
  2726. properties:
  2727. name:
  2728. type: string
  2729. description:
  2730. type:
  2731. - string
  2732. - 'null'
  2733. image:
  2734. type:
  2735. - string
  2736. - 'null'
  2737. format: iri-reference
  2738. example: 'https://example.com/'
  2739. imageUrl:
  2740. readOnly: true
  2741. type:
  2742. - string
  2743. - 'null'
  2744. createdAt:
  2745. type:
  2746. - string
  2747. - 'null'
  2748. format: date-time
  2749. Product.jsonhal:
  2750. type: object
  2751. description: ''
  2752. deprecated: false
  2753. required:
  2754. - name
  2755. properties:
  2756. _links:
  2757. type: object
  2758. properties:
  2759. self:
  2760. type: object
  2761. properties:
  2762. href:
  2763. type: string
  2764. format: iri-reference
  2765. name:
  2766. type: string
  2767. description:
  2768. type:
  2769. - string
  2770. - 'null'
  2771. image:
  2772. type:
  2773. - string
  2774. - 'null'
  2775. format: iri-reference
  2776. example: 'https://example.com/'
  2777. imageUrl:
  2778. readOnly: true
  2779. type:
  2780. - string
  2781. - 'null'
  2782. createdAt:
  2783. type:
  2784. - string
  2785. - 'null'
  2786. format: date-time
  2787. Product.jsonld:
  2788. type: object
  2789. description: ''
  2790. deprecated: false
  2791. required:
  2792. - name
  2793. properties:
  2794. '@context':
  2795. readOnly: true
  2796. oneOf:
  2797. -
  2798. type: string
  2799. -
  2800. type: object
  2801. properties:
  2802. '@vocab':
  2803. type: string
  2804. hydra:
  2805. type: string
  2806. enum: ['http://www.w3.org/ns/hydra/core#']
  2807. required:
  2808. - '@vocab'
  2809. - hydra
  2810. additionalProperties: true
  2811. '@id':
  2812. readOnly: true
  2813. type: string
  2814. '@type':
  2815. readOnly: true
  2816. type: string
  2817. name:
  2818. type: string
  2819. description:
  2820. type:
  2821. - string
  2822. - 'null'
  2823. image:
  2824. type:
  2825. - string
  2826. - 'null'
  2827. format: iri-reference
  2828. example: 'https://example.com/'
  2829. imageUrl:
  2830. readOnly: true
  2831. type:
  2832. - string
  2833. - 'null'
  2834. createdAt:
  2835. type:
  2836. - string
  2837. - 'null'
  2838. format: date-time
  2839. User:
  2840. type: object
  2841. description: ''
  2842. deprecated: false
  2843. required:
  2844. - email
  2845. - firstName
  2846. - lastName
  2847. properties:
  2848. email:
  2849. format: email
  2850. externalDocs:
  2851. url: 'https://schema.org/email'
  2852. type:
  2853. - string
  2854. - 'null'
  2855. firstName:
  2856. type:
  2857. - string
  2858. - 'null'
  2859. lastName:
  2860. type:
  2861. - string
  2862. - 'null'
  2863. image:
  2864. type:
  2865. - string
  2866. - 'null'
  2867. format: iri-reference
  2868. example: 'https://example.com/'
  2869. password:
  2870. writeOnly: true
  2871. description: 'The plaintext password when being set or changed.'
  2872. type:
  2873. - string
  2874. - 'null'
  2875. active:
  2876. type: boolean
  2877. createdAt:
  2878. readOnly: true
  2879. type:
  2880. - string
  2881. - 'null'
  2882. format: date-time
  2883. User.jsonhal:
  2884. type: object
  2885. description: ''
  2886. deprecated: false
  2887. required:
  2888. - email
  2889. - firstName
  2890. - lastName
  2891. properties:
  2892. _links:
  2893. type: object
  2894. properties:
  2895. self:
  2896. type: object
  2897. properties:
  2898. href:
  2899. type: string
  2900. format: iri-reference
  2901. email:
  2902. format: email
  2903. externalDocs:
  2904. url: 'https://schema.org/email'
  2905. type:
  2906. - string
  2907. - 'null'
  2908. firstName:
  2909. type:
  2910. - string
  2911. - 'null'
  2912. lastName:
  2913. type:
  2914. - string
  2915. - 'null'
  2916. image:
  2917. type:
  2918. - string
  2919. - 'null'
  2920. format: iri-reference
  2921. example: 'https://example.com/'
  2922. password:
  2923. writeOnly: true
  2924. description: 'The plaintext password when being set or changed.'
  2925. type:
  2926. - string
  2927. - 'null'
  2928. active:
  2929. type: boolean
  2930. createdAt:
  2931. readOnly: true
  2932. type:
  2933. - string
  2934. - 'null'
  2935. format: date-time
  2936. User.jsonld:
  2937. type: object
  2938. description: ''
  2939. deprecated: false
  2940. required:
  2941. - email
  2942. - firstName
  2943. - lastName
  2944. properties:
  2945. '@context':
  2946. readOnly: true
  2947. oneOf:
  2948. -
  2949. type: string
  2950. -
  2951. type: object
  2952. properties:
  2953. '@vocab':
  2954. type: string
  2955. hydra:
  2956. type: string
  2957. enum: ['http://www.w3.org/ns/hydra/core#']
  2958. required:
  2959. - '@vocab'
  2960. - hydra
  2961. additionalProperties: true
  2962. '@id':
  2963. readOnly: true
  2964. type: string
  2965. '@type':
  2966. readOnly: true
  2967. type: string
  2968. email:
  2969. format: email
  2970. externalDocs:
  2971. url: 'https://schema.org/email'
  2972. type:
  2973. - string
  2974. - 'null'
  2975. firstName:
  2976. type:
  2977. - string
  2978. - 'null'
  2979. lastName:
  2980. type:
  2981. - string
  2982. - 'null'
  2983. image:
  2984. type:
  2985. - string
  2986. - 'null'
  2987. format: iri-reference
  2988. example: 'https://example.com/'
  2989. password:
  2990. writeOnly: true
  2991. description: 'The plaintext password when being set or changed.'
  2992. type:
  2993. - string
  2994. - 'null'
  2995. active:
  2996. type: boolean
  2997. createdAt:
  2998. readOnly: true
  2999. type:
  3000. - string
  3001. - 'null'
  3002. format: date-time
  3003. responses: { }
  3004. parameters: { }
  3005. examples: { }
  3006. requestBodies: { }
  3007. headers: { }
  3008. securitySchemes:
  3009. JWT:
  3010. type: http
  3011. scheme: bearer
  3012. bearerFormat: JWT
  3013. security:
  3014. -
  3015. JWT: []
  3016. tags: []