Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 
 

7075 wiersze
208 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. -
  83. name: posting
  84. in: query
  85. description: ''
  86. required: false
  87. deprecated: false
  88. allowEmptyValue: true
  89. schema:
  90. type: string
  91. style: form
  92. explode: false
  93. allowReserved: false
  94. -
  95. name: 'posting[]'
  96. in: query
  97. description: ''
  98. required: false
  99. deprecated: false
  100. allowEmptyValue: true
  101. schema:
  102. type: array
  103. items:
  104. type: string
  105. style: form
  106. explode: true
  107. allowReserved: false
  108. -
  109. name: owner
  110. in: query
  111. description: ''
  112. required: false
  113. deprecated: false
  114. allowEmptyValue: true
  115. schema:
  116. type: string
  117. style: form
  118. explode: false
  119. allowReserved: false
  120. -
  121. name: 'owner[]'
  122. in: query
  123. description: ''
  124. required: false
  125. deprecated: false
  126. allowEmptyValue: true
  127. schema:
  128. type: array
  129. items:
  130. type: string
  131. style: form
  132. explode: true
  133. allowReserved: false
  134. deprecated: false
  135. post:
  136. operationId: api_comments_post
  137. tags:
  138. - Comment
  139. responses:
  140. 201:
  141. description: 'Comment resource created'
  142. content:
  143. application/ld+json:
  144. schema:
  145. $ref: '#/components/schemas/Comment.jsonld'
  146. application/json:
  147. schema:
  148. $ref: '#/components/schemas/Comment'
  149. text/html:
  150. schema:
  151. $ref: '#/components/schemas/Comment'
  152. application/hal+json:
  153. schema:
  154. $ref: '#/components/schemas/Comment.jsonhal'
  155. links: { }
  156. 400:
  157. description: 'Invalid input'
  158. 422:
  159. description: 'Unprocessable entity'
  160. summary: 'Creates a Comment resource.'
  161. description: 'Creates a Comment resource.'
  162. parameters: []
  163. requestBody:
  164. description: 'The new Comment resource'
  165. content:
  166. application/ld+json:
  167. schema:
  168. $ref: '#/components/schemas/Comment.jsonld'
  169. application/json:
  170. schema:
  171. $ref: '#/components/schemas/Comment'
  172. text/html:
  173. schema:
  174. $ref: '#/components/schemas/Comment'
  175. application/hal+json:
  176. schema:
  177. $ref: '#/components/schemas/Comment.jsonhal'
  178. required: true
  179. deprecated: false
  180. parameters: []
  181. '/api/comments/{id}':
  182. get:
  183. operationId: api_comments_id_get
  184. tags:
  185. - Comment
  186. responses:
  187. 200:
  188. description: 'Comment resource'
  189. content:
  190. application/ld+json:
  191. schema:
  192. $ref: '#/components/schemas/Comment.jsonld'
  193. application/json:
  194. schema:
  195. $ref: '#/components/schemas/Comment'
  196. text/html:
  197. schema:
  198. $ref: '#/components/schemas/Comment'
  199. application/hal+json:
  200. schema:
  201. $ref: '#/components/schemas/Comment.jsonhal'
  202. 404:
  203. description: 'Resource not found'
  204. summary: 'Retrieves a Comment resource.'
  205. description: 'Retrieves a Comment resource.'
  206. parameters:
  207. -
  208. name: id
  209. in: path
  210. description: 'Comment identifier'
  211. required: true
  212. deprecated: false
  213. allowEmptyValue: false
  214. schema:
  215. type: string
  216. style: simple
  217. explode: false
  218. allowReserved: false
  219. deprecated: false
  220. patch:
  221. operationId: api_comments_id_patch
  222. tags:
  223. - Comment
  224. responses:
  225. 200:
  226. description: 'Comment resource updated'
  227. content:
  228. application/ld+json:
  229. schema:
  230. $ref: '#/components/schemas/Comment.jsonld'
  231. application/json:
  232. schema:
  233. $ref: '#/components/schemas/Comment'
  234. text/html:
  235. schema:
  236. $ref: '#/components/schemas/Comment'
  237. application/hal+json:
  238. schema:
  239. $ref: '#/components/schemas/Comment.jsonhal'
  240. links: { }
  241. 400:
  242. description: 'Invalid input'
  243. 422:
  244. description: 'Unprocessable entity'
  245. 404:
  246. description: 'Resource not found'
  247. summary: 'Updates the Comment resource.'
  248. description: 'Updates the Comment resource.'
  249. parameters:
  250. -
  251. name: id
  252. in: path
  253. description: 'Comment identifier'
  254. required: true
  255. deprecated: false
  256. allowEmptyValue: false
  257. schema:
  258. type: string
  259. style: simple
  260. explode: false
  261. allowReserved: false
  262. requestBody:
  263. description: 'The updated Comment resource'
  264. content:
  265. application/merge-patch+json:
  266. schema:
  267. $ref: '#/components/schemas/Comment'
  268. required: true
  269. deprecated: false
  270. parameters: []
  271. /api/contact_partner_products:
  272. get:
  273. operationId: api_contact_partner_products_get_collection
  274. tags:
  275. - ContactPartnerProduct
  276. responses:
  277. 200:
  278. description: 'ContactPartnerProduct collection'
  279. content:
  280. application/ld+json:
  281. schema:
  282. type: object
  283. properties:
  284. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/ContactPartnerProduct.jsonld' } }
  285. 'hydra:totalItems': { type: integer, minimum: 0 }
  286. '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 } }
  287. '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 } } } } } }
  288. required:
  289. - 'hydra:member'
  290. application/json:
  291. schema:
  292. type: array
  293. items:
  294. $ref: '#/components/schemas/ContactPartnerProduct'
  295. text/html:
  296. schema:
  297. type: array
  298. items:
  299. $ref: '#/components/schemas/ContactPartnerProduct'
  300. application/hal+json:
  301. schema:
  302. type: object
  303. properties:
  304. _embedded: { type: array, items: { $ref: '#/components/schemas/ContactPartnerProduct.jsonhal' } }
  305. totalItems: { type: integer, minimum: 0 }
  306. itemsPerPage: { type: integer, minimum: 0 }
  307. _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 } } } } }
  308. required:
  309. - _links
  310. - _embedded
  311. summary: 'Retrieves the collection of ContactPartnerProduct resources.'
  312. description: 'Retrieves the collection of ContactPartnerProduct resources.'
  313. parameters:
  314. -
  315. name: page
  316. in: query
  317. description: 'The collection page number'
  318. required: false
  319. deprecated: false
  320. allowEmptyValue: true
  321. schema:
  322. type: integer
  323. default: 1
  324. style: form
  325. explode: false
  326. allowReserved: false
  327. -
  328. name: itemsPerPage
  329. in: query
  330. description: 'The number of items per page'
  331. required: false
  332. deprecated: false
  333. allowEmptyValue: true
  334. schema:
  335. type: integer
  336. default: 10
  337. minimum: 0
  338. maximum: 50
  339. style: form
  340. explode: false
  341. allowReserved: false
  342. -
  343. name: contact
  344. in: query
  345. description: ''
  346. required: false
  347. deprecated: false
  348. allowEmptyValue: true
  349. schema:
  350. type: string
  351. style: form
  352. explode: false
  353. allowReserved: false
  354. -
  355. name: 'contact[]'
  356. in: query
  357. description: ''
  358. required: false
  359. deprecated: false
  360. allowEmptyValue: true
  361. schema:
  362. type: array
  363. items:
  364. type: string
  365. style: form
  366. explode: true
  367. allowReserved: false
  368. -
  369. name: partnerProduct.product.name
  370. in: query
  371. description: ''
  372. required: false
  373. deprecated: false
  374. allowEmptyValue: true
  375. schema:
  376. type: string
  377. style: form
  378. explode: false
  379. allowReserved: false
  380. deprecated: false
  381. post:
  382. operationId: api_contact_partner_products_post
  383. tags:
  384. - ContactPartnerProduct
  385. responses:
  386. 201:
  387. description: 'ContactPartnerProduct resource created'
  388. content:
  389. application/ld+json:
  390. schema:
  391. $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
  392. application/json:
  393. schema:
  394. $ref: '#/components/schemas/ContactPartnerProduct'
  395. text/html:
  396. schema:
  397. $ref: '#/components/schemas/ContactPartnerProduct'
  398. application/hal+json:
  399. schema:
  400. $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
  401. links: { }
  402. 400:
  403. description: 'Invalid input'
  404. 422:
  405. description: 'Unprocessable entity'
  406. summary: 'Creates a ContactPartnerProduct resource.'
  407. description: 'Creates a ContactPartnerProduct resource.'
  408. parameters: []
  409. requestBody:
  410. description: 'The new ContactPartnerProduct resource'
  411. content:
  412. application/ld+json:
  413. schema:
  414. $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
  415. application/json:
  416. schema:
  417. $ref: '#/components/schemas/ContactPartnerProduct'
  418. text/html:
  419. schema:
  420. $ref: '#/components/schemas/ContactPartnerProduct'
  421. application/hal+json:
  422. schema:
  423. $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
  424. required: true
  425. deprecated: false
  426. parameters: []
  427. '/api/contact_partner_products/{id}':
  428. get:
  429. operationId: api_contact_partner_products_id_get
  430. tags:
  431. - ContactPartnerProduct
  432. responses:
  433. 200:
  434. description: 'ContactPartnerProduct resource'
  435. content:
  436. application/ld+json:
  437. schema:
  438. $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
  439. application/json:
  440. schema:
  441. $ref: '#/components/schemas/ContactPartnerProduct'
  442. text/html:
  443. schema:
  444. $ref: '#/components/schemas/ContactPartnerProduct'
  445. application/hal+json:
  446. schema:
  447. $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
  448. 404:
  449. description: 'Resource not found'
  450. summary: 'Retrieves a ContactPartnerProduct resource.'
  451. description: 'Retrieves a ContactPartnerProduct resource.'
  452. parameters:
  453. -
  454. name: id
  455. in: path
  456. description: 'ContactPartnerProduct identifier'
  457. required: true
  458. deprecated: false
  459. allowEmptyValue: false
  460. schema:
  461. type: string
  462. style: simple
  463. explode: false
  464. allowReserved: false
  465. deprecated: false
  466. delete:
  467. operationId: api_contact_partner_products_id_delete
  468. tags:
  469. - ContactPartnerProduct
  470. responses:
  471. 204:
  472. description: 'ContactPartnerProduct resource deleted'
  473. 404:
  474. description: 'Resource not found'
  475. summary: 'Removes the ContactPartnerProduct resource.'
  476. description: 'Removes the ContactPartnerProduct resource.'
  477. parameters:
  478. -
  479. name: id
  480. in: path
  481. description: 'ContactPartnerProduct identifier'
  482. required: true
  483. deprecated: false
  484. allowEmptyValue: false
  485. schema:
  486. type: string
  487. style: simple
  488. explode: false
  489. allowReserved: false
  490. deprecated: false
  491. parameters: []
  492. /api/contacts:
  493. get:
  494. operationId: api_contacts_get_collection
  495. tags:
  496. - Contact
  497. responses:
  498. 200:
  499. description: 'Contact collection'
  500. content:
  501. application/ld+json:
  502. schema:
  503. type: object
  504. properties:
  505. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.jsonld' } }
  506. 'hydra:totalItems': { type: integer, minimum: 0 }
  507. '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 } }
  508. '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 } } } } } }
  509. required:
  510. - 'hydra:member'
  511. application/json:
  512. schema:
  513. type: array
  514. items:
  515. $ref: '#/components/schemas/Contact'
  516. text/html:
  517. schema:
  518. type: array
  519. items:
  520. $ref: '#/components/schemas/Contact'
  521. application/hal+json:
  522. schema:
  523. type: object
  524. properties:
  525. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.jsonhal' } }
  526. totalItems: { type: integer, minimum: 0 }
  527. itemsPerPage: { type: integer, minimum: 0 }
  528. _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 } } } } }
  529. required:
  530. - _links
  531. - _embedded
  532. summary: 'Retrieves the collection of Contact resources.'
  533. description: 'Retrieves the collection of Contact resources.'
  534. parameters:
  535. -
  536. name: page
  537. in: query
  538. description: 'The collection page number'
  539. required: false
  540. deprecated: false
  541. allowEmptyValue: true
  542. schema:
  543. type: integer
  544. default: 1
  545. style: form
  546. explode: false
  547. allowReserved: false
  548. -
  549. name: itemsPerPage
  550. in: query
  551. description: 'The number of items per page'
  552. required: false
  553. deprecated: false
  554. allowEmptyValue: true
  555. schema:
  556. type: integer
  557. default: 10
  558. minimum: 0
  559. maximum: 50
  560. style: form
  561. explode: false
  562. allowReserved: false
  563. -
  564. name: partner
  565. in: query
  566. description: ''
  567. required: false
  568. deprecated: false
  569. allowEmptyValue: true
  570. schema:
  571. type: string
  572. style: form
  573. explode: false
  574. allowReserved: false
  575. -
  576. name: 'partner[]'
  577. in: query
  578. description: ''
  579. required: false
  580. deprecated: false
  581. allowEmptyValue: true
  582. schema:
  583. type: array
  584. items:
  585. type: string
  586. style: form
  587. explode: true
  588. allowReserved: false
  589. deprecated: false
  590. post:
  591. operationId: api_contacts_post
  592. tags:
  593. - Contact
  594. responses:
  595. 201:
  596. description: 'Contact resource created'
  597. content:
  598. application/ld+json:
  599. schema:
  600. $ref: '#/components/schemas/Contact.jsonld'
  601. application/json:
  602. schema:
  603. $ref: '#/components/schemas/Contact'
  604. text/html:
  605. schema:
  606. $ref: '#/components/schemas/Contact'
  607. application/hal+json:
  608. schema:
  609. $ref: '#/components/schemas/Contact.jsonhal'
  610. links: { }
  611. 400:
  612. description: 'Invalid input'
  613. 422:
  614. description: 'Unprocessable entity'
  615. summary: 'Creates a Contact resource.'
  616. description: 'Creates a Contact resource.'
  617. parameters: []
  618. requestBody:
  619. description: 'The new Contact resource'
  620. content:
  621. application/ld+json:
  622. schema:
  623. $ref: '#/components/schemas/Contact.jsonld'
  624. application/json:
  625. schema:
  626. $ref: '#/components/schemas/Contact'
  627. text/html:
  628. schema:
  629. $ref: '#/components/schemas/Contact'
  630. application/hal+json:
  631. schema:
  632. $ref: '#/components/schemas/Contact.jsonhal'
  633. required: true
  634. deprecated: false
  635. parameters: []
  636. '/api/contacts/{id}':
  637. get:
  638. operationId: api_contacts_id_get
  639. tags:
  640. - Contact
  641. responses:
  642. 200:
  643. description: 'Contact resource'
  644. content:
  645. application/ld+json:
  646. schema:
  647. $ref: '#/components/schemas/Contact.jsonld'
  648. application/json:
  649. schema:
  650. $ref: '#/components/schemas/Contact'
  651. text/html:
  652. schema:
  653. $ref: '#/components/schemas/Contact'
  654. application/hal+json:
  655. schema:
  656. $ref: '#/components/schemas/Contact.jsonhal'
  657. 404:
  658. description: 'Resource not found'
  659. summary: 'Retrieves a Contact resource.'
  660. description: 'Retrieves a Contact resource.'
  661. parameters:
  662. -
  663. name: id
  664. in: path
  665. description: 'Contact identifier'
  666. required: true
  667. deprecated: false
  668. allowEmptyValue: false
  669. schema:
  670. type: string
  671. style: simple
  672. explode: false
  673. allowReserved: false
  674. deprecated: false
  675. patch:
  676. operationId: api_contacts_id_patch
  677. tags:
  678. - Contact
  679. responses:
  680. 200:
  681. description: 'Contact resource updated'
  682. content:
  683. application/ld+json:
  684. schema:
  685. $ref: '#/components/schemas/Contact.jsonld'
  686. application/json:
  687. schema:
  688. $ref: '#/components/schemas/Contact'
  689. text/html:
  690. schema:
  691. $ref: '#/components/schemas/Contact'
  692. application/hal+json:
  693. schema:
  694. $ref: '#/components/schemas/Contact.jsonhal'
  695. links: { }
  696. 400:
  697. description: 'Invalid input'
  698. 422:
  699. description: 'Unprocessable entity'
  700. 404:
  701. description: 'Resource not found'
  702. summary: 'Updates the Contact resource.'
  703. description: 'Updates the Contact resource.'
  704. parameters:
  705. -
  706. name: id
  707. in: path
  708. description: 'Contact identifier'
  709. required: true
  710. deprecated: false
  711. allowEmptyValue: false
  712. schema:
  713. type: string
  714. style: simple
  715. explode: false
  716. allowReserved: false
  717. requestBody:
  718. description: 'The updated Contact resource'
  719. content:
  720. application/merge-patch+json:
  721. schema:
  722. $ref: '#/components/schemas/Contact'
  723. required: true
  724. deprecated: false
  725. parameters: []
  726. /api/document_objects:
  727. get:
  728. operationId: api_document_objects_get_collection
  729. tags:
  730. - DocumentObject
  731. responses:
  732. 200:
  733. description: 'DocumentObject collection'
  734. content:
  735. application/ld+json:
  736. schema:
  737. type: object
  738. properties:
  739. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read' } }
  740. 'hydra:totalItems': { type: integer, minimum: 0 }
  741. '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 } }
  742. '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 } } } } } }
  743. required:
  744. - 'hydra:member'
  745. application/json:
  746. schema:
  747. type: array
  748. items:
  749. $ref: '#/components/schemas/DocumentObject-document_object.read'
  750. text/html:
  751. schema:
  752. type: array
  753. items:
  754. $ref: '#/components/schemas/DocumentObject-document_object.read'
  755. application/hal+json:
  756. schema:
  757. type: object
  758. properties:
  759. _embedded: { type: array, items: { $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read' } }
  760. totalItems: { type: integer, minimum: 0 }
  761. itemsPerPage: { type: integer, minimum: 0 }
  762. _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 } } } } }
  763. required:
  764. - _links
  765. - _embedded
  766. summary: 'Retrieves the collection of DocumentObject resources.'
  767. description: 'Retrieves the collection of DocumentObject resources.'
  768. parameters:
  769. -
  770. name: page
  771. in: query
  772. description: 'The collection page number'
  773. required: false
  774. deprecated: false
  775. allowEmptyValue: true
  776. schema:
  777. type: integer
  778. default: 1
  779. style: form
  780. explode: false
  781. allowReserved: false
  782. -
  783. name: itemsPerPage
  784. in: query
  785. description: 'The number of items per page'
  786. required: false
  787. deprecated: false
  788. allowEmptyValue: true
  789. schema:
  790. type: integer
  791. default: 10
  792. minimum: 0
  793. maximum: 50
  794. style: form
  795. explode: false
  796. allowReserved: false
  797. deprecated: false
  798. post:
  799. operationId: api_document_objects_post
  800. tags:
  801. - DocumentObject
  802. responses:
  803. 201:
  804. description: 'DocumentObject resource created'
  805. content:
  806. application/ld+json:
  807. schema:
  808. $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read'
  809. application/json:
  810. schema:
  811. $ref: '#/components/schemas/DocumentObject-document_object.read'
  812. text/html:
  813. schema:
  814. $ref: '#/components/schemas/DocumentObject-document_object.read'
  815. application/hal+json:
  816. schema:
  817. $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read'
  818. links: { }
  819. 400:
  820. description: 'Invalid input'
  821. 422:
  822. description: 'Unprocessable entity'
  823. summary: 'Creates a DocumentObject resource.'
  824. description: 'Creates a DocumentObject resource.'
  825. parameters: []
  826. requestBody:
  827. description: ''
  828. content:
  829. multipart/form-data:
  830. schema:
  831. type: object
  832. properties:
  833. file:
  834. type: string
  835. format: binary
  836. required: false
  837. deprecated: false
  838. parameters: []
  839. '/api/document_objects/{id}':
  840. get:
  841. operationId: api_document_objects_id_get
  842. tags:
  843. - DocumentObject
  844. responses:
  845. 200:
  846. description: 'DocumentObject resource'
  847. content:
  848. application/ld+json:
  849. schema:
  850. $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read'
  851. application/json:
  852. schema:
  853. $ref: '#/components/schemas/DocumentObject-document_object.read'
  854. text/html:
  855. schema:
  856. $ref: '#/components/schemas/DocumentObject-document_object.read'
  857. application/hal+json:
  858. schema:
  859. $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read'
  860. 404:
  861. description: 'Resource not found'
  862. summary: 'Retrieves a DocumentObject resource.'
  863. description: 'Retrieves a DocumentObject resource.'
  864. parameters:
  865. -
  866. name: id
  867. in: path
  868. description: 'DocumentObject identifier'
  869. required: true
  870. deprecated: false
  871. allowEmptyValue: false
  872. schema:
  873. type: string
  874. style: simple
  875. explode: false
  876. allowReserved: false
  877. deprecated: false
  878. delete:
  879. operationId: api_document_objects_id_delete
  880. tags:
  881. - DocumentObject
  882. responses:
  883. 204:
  884. description: 'DocumentObject resource deleted'
  885. 404:
  886. description: 'Resource not found'
  887. summary: 'Removes the DocumentObject resource.'
  888. description: 'Removes the DocumentObject resource.'
  889. parameters:
  890. -
  891. name: id
  892. in: path
  893. description: 'DocumentObject identifier'
  894. required: true
  895. deprecated: false
  896. allowEmptyValue: false
  897. schema:
  898. type: string
  899. style: simple
  900. explode: false
  901. allowReserved: false
  902. deprecated: false
  903. parameters: []
  904. /api/documents:
  905. get:
  906. operationId: api_documents_get_collection
  907. tags:
  908. - Document
  909. responses:
  910. 200:
  911. description: 'Document collection'
  912. content:
  913. application/ld+json:
  914. schema:
  915. type: object
  916. properties:
  917. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Document.jsonld' } }
  918. 'hydra:totalItems': { type: integer, minimum: 0 }
  919. '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 } }
  920. '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 } } } } } }
  921. required:
  922. - 'hydra:member'
  923. application/json:
  924. schema:
  925. type: array
  926. items:
  927. $ref: '#/components/schemas/Document'
  928. text/html:
  929. schema:
  930. type: array
  931. items:
  932. $ref: '#/components/schemas/Document'
  933. application/hal+json:
  934. schema:
  935. type: object
  936. properties:
  937. _embedded: { type: array, items: { $ref: '#/components/schemas/Document.jsonhal' } }
  938. totalItems: { type: integer, minimum: 0 }
  939. itemsPerPage: { type: integer, minimum: 0 }
  940. _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 } } } } }
  941. required:
  942. - _links
  943. - _embedded
  944. summary: 'Retrieves the collection of Document resources.'
  945. description: 'Retrieves the collection of Document resources.'
  946. parameters:
  947. -
  948. name: page
  949. in: query
  950. description: 'The collection page number'
  951. required: false
  952. deprecated: false
  953. allowEmptyValue: true
  954. schema:
  955. type: integer
  956. default: 1
  957. style: form
  958. explode: false
  959. allowReserved: false
  960. -
  961. name: itemsPerPage
  962. in: query
  963. description: 'The number of items per page'
  964. required: false
  965. deprecated: false
  966. allowEmptyValue: true
  967. schema:
  968. type: integer
  969. default: 10
  970. minimum: 0
  971. maximum: 50
  972. style: form
  973. explode: false
  974. allowReserved: false
  975. -
  976. name: createdBy
  977. in: query
  978. description: ''
  979. required: false
  980. deprecated: false
  981. allowEmptyValue: true
  982. schema:
  983. type: string
  984. style: form
  985. explode: false
  986. allowReserved: false
  987. -
  988. name: 'createdBy[]'
  989. in: query
  990. description: ''
  991. required: false
  992. deprecated: false
  993. allowEmptyValue: true
  994. schema:
  995. type: array
  996. items:
  997. type: string
  998. style: form
  999. explode: true
  1000. allowReserved: false
  1001. -
  1002. name: partner
  1003. in: query
  1004. description: ''
  1005. required: false
  1006. deprecated: false
  1007. allowEmptyValue: true
  1008. schema:
  1009. type: string
  1010. style: form
  1011. explode: false
  1012. allowReserved: false
  1013. -
  1014. name: 'partner[]'
  1015. in: query
  1016. description: ''
  1017. required: false
  1018. deprecated: false
  1019. allowEmptyValue: true
  1020. schema:
  1021. type: array
  1022. items:
  1023. type: string
  1024. style: form
  1025. explode: true
  1026. allowReserved: false
  1027. -
  1028. name: product
  1029. in: query
  1030. description: ''
  1031. required: false
  1032. deprecated: false
  1033. allowEmptyValue: true
  1034. schema:
  1035. type: string
  1036. style: form
  1037. explode: false
  1038. allowReserved: false
  1039. -
  1040. name: 'product[]'
  1041. in: query
  1042. description: ''
  1043. required: false
  1044. deprecated: false
  1045. allowEmptyValue: true
  1046. schema:
  1047. type: array
  1048. items:
  1049. type: string
  1050. style: form
  1051. explode: true
  1052. allowReserved: false
  1053. deprecated: false
  1054. post:
  1055. operationId: api_documents_post
  1056. tags:
  1057. - Document
  1058. responses:
  1059. 201:
  1060. description: 'Document resource created'
  1061. content:
  1062. application/ld+json:
  1063. schema:
  1064. $ref: '#/components/schemas/Document.jsonld'
  1065. application/json:
  1066. schema:
  1067. $ref: '#/components/schemas/Document'
  1068. text/html:
  1069. schema:
  1070. $ref: '#/components/schemas/Document'
  1071. application/hal+json:
  1072. schema:
  1073. $ref: '#/components/schemas/Document.jsonhal'
  1074. links: { }
  1075. 400:
  1076. description: 'Invalid input'
  1077. 422:
  1078. description: 'Unprocessable entity'
  1079. summary: 'Creates a Document resource.'
  1080. description: 'Creates a Document resource.'
  1081. parameters: []
  1082. requestBody:
  1083. description: 'The new Document resource'
  1084. content:
  1085. application/ld+json:
  1086. schema:
  1087. $ref: '#/components/schemas/Document.jsonld'
  1088. application/json:
  1089. schema:
  1090. $ref: '#/components/schemas/Document'
  1091. text/html:
  1092. schema:
  1093. $ref: '#/components/schemas/Document'
  1094. application/hal+json:
  1095. schema:
  1096. $ref: '#/components/schemas/Document.jsonhal'
  1097. required: true
  1098. deprecated: false
  1099. parameters: []
  1100. '/api/documents/{id}':
  1101. get:
  1102. operationId: api_documents_id_get
  1103. tags:
  1104. - Document
  1105. responses:
  1106. 200:
  1107. description: 'Document resource'
  1108. content:
  1109. application/ld+json:
  1110. schema:
  1111. $ref: '#/components/schemas/Document.jsonld'
  1112. application/json:
  1113. schema:
  1114. $ref: '#/components/schemas/Document'
  1115. text/html:
  1116. schema:
  1117. $ref: '#/components/schemas/Document'
  1118. application/hal+json:
  1119. schema:
  1120. $ref: '#/components/schemas/Document.jsonhal'
  1121. 404:
  1122. description: 'Resource not found'
  1123. summary: 'Retrieves a Document resource.'
  1124. description: 'Retrieves a Document resource.'
  1125. parameters:
  1126. -
  1127. name: id
  1128. in: path
  1129. description: 'Document identifier'
  1130. required: true
  1131. deprecated: false
  1132. allowEmptyValue: false
  1133. schema:
  1134. type: string
  1135. style: simple
  1136. explode: false
  1137. allowReserved: false
  1138. deprecated: false
  1139. patch:
  1140. operationId: api_documents_id_patch
  1141. tags:
  1142. - Document
  1143. responses:
  1144. 200:
  1145. description: 'Document resource updated'
  1146. content:
  1147. application/ld+json:
  1148. schema:
  1149. $ref: '#/components/schemas/Document.jsonld'
  1150. application/json:
  1151. schema:
  1152. $ref: '#/components/schemas/Document'
  1153. text/html:
  1154. schema:
  1155. $ref: '#/components/schemas/Document'
  1156. application/hal+json:
  1157. schema:
  1158. $ref: '#/components/schemas/Document.jsonhal'
  1159. links: { }
  1160. 400:
  1161. description: 'Invalid input'
  1162. 422:
  1163. description: 'Unprocessable entity'
  1164. 404:
  1165. description: 'Resource not found'
  1166. summary: 'Updates the Document resource.'
  1167. description: 'Updates the Document resource.'
  1168. parameters:
  1169. -
  1170. name: id
  1171. in: path
  1172. description: 'Document identifier'
  1173. required: true
  1174. deprecated: false
  1175. allowEmptyValue: false
  1176. schema:
  1177. type: string
  1178. style: simple
  1179. explode: false
  1180. allowReserved: false
  1181. requestBody:
  1182. description: 'The updated Document resource'
  1183. content:
  1184. application/merge-patch+json:
  1185. schema:
  1186. $ref: '#/components/schemas/Document'
  1187. required: true
  1188. deprecated: false
  1189. parameters: []
  1190. /api/media_objects:
  1191. get:
  1192. operationId: api_media_objects_get_collection
  1193. tags:
  1194. - MediaObject
  1195. responses:
  1196. 200:
  1197. description: 'MediaObject collection'
  1198. content:
  1199. application/ld+json:
  1200. schema:
  1201. type: object
  1202. properties:
  1203. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' } }
  1204. 'hydra:totalItems': { type: integer, minimum: 0 }
  1205. '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 } }
  1206. '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 } } } } } }
  1207. required:
  1208. - 'hydra:member'
  1209. application/json:
  1210. schema:
  1211. type: array
  1212. items:
  1213. $ref: '#/components/schemas/MediaObject-media_object.read'
  1214. text/html:
  1215. schema:
  1216. type: array
  1217. items:
  1218. $ref: '#/components/schemas/MediaObject-media_object.read'
  1219. application/hal+json:
  1220. schema:
  1221. type: object
  1222. properties:
  1223. _embedded: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read' } }
  1224. totalItems: { type: integer, minimum: 0 }
  1225. itemsPerPage: { type: integer, minimum: 0 }
  1226. _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 } } } } }
  1227. required:
  1228. - _links
  1229. - _embedded
  1230. summary: 'Retrieves the collection of MediaObject resources.'
  1231. description: 'Retrieves the collection of MediaObject resources.'
  1232. parameters:
  1233. -
  1234. name: page
  1235. in: query
  1236. description: 'The collection page number'
  1237. required: false
  1238. deprecated: false
  1239. allowEmptyValue: true
  1240. schema:
  1241. type: integer
  1242. default: 1
  1243. style: form
  1244. explode: false
  1245. allowReserved: false
  1246. -
  1247. name: itemsPerPage
  1248. in: query
  1249. description: 'The number of items per page'
  1250. required: false
  1251. deprecated: false
  1252. allowEmptyValue: true
  1253. schema:
  1254. type: integer
  1255. default: 10
  1256. minimum: 0
  1257. maximum: 50
  1258. style: form
  1259. explode: false
  1260. allowReserved: false
  1261. deprecated: false
  1262. post:
  1263. operationId: api_media_objects_post
  1264. tags:
  1265. - MediaObject
  1266. responses:
  1267. 201:
  1268. description: 'MediaObject resource created'
  1269. content:
  1270. application/ld+json:
  1271. schema:
  1272. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  1273. application/json:
  1274. schema:
  1275. $ref: '#/components/schemas/MediaObject-media_object.read'
  1276. text/html:
  1277. schema:
  1278. $ref: '#/components/schemas/MediaObject-media_object.read'
  1279. application/hal+json:
  1280. schema:
  1281. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  1282. links: { }
  1283. 400:
  1284. description: 'Invalid input'
  1285. 422:
  1286. description: 'Unprocessable entity'
  1287. summary: 'Creates a MediaObject resource.'
  1288. description: 'Creates a MediaObject resource.'
  1289. parameters: []
  1290. requestBody:
  1291. description: ''
  1292. content:
  1293. multipart/form-data:
  1294. schema:
  1295. type: object
  1296. properties:
  1297. file:
  1298. type: string
  1299. format: binary
  1300. required: false
  1301. deprecated: false
  1302. parameters: []
  1303. '/api/media_objects/{id}':
  1304. get:
  1305. operationId: api_media_objects_id_get
  1306. tags:
  1307. - MediaObject
  1308. responses:
  1309. 200:
  1310. description: 'MediaObject resource'
  1311. content:
  1312. application/ld+json:
  1313. schema:
  1314. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  1315. application/json:
  1316. schema:
  1317. $ref: '#/components/schemas/MediaObject-media_object.read'
  1318. text/html:
  1319. schema:
  1320. $ref: '#/components/schemas/MediaObject-media_object.read'
  1321. application/hal+json:
  1322. schema:
  1323. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  1324. 404:
  1325. description: 'Resource not found'
  1326. summary: 'Retrieves a MediaObject resource.'
  1327. description: 'Retrieves a MediaObject resource.'
  1328. parameters:
  1329. -
  1330. name: id
  1331. in: path
  1332. description: 'MediaObject identifier'
  1333. required: true
  1334. deprecated: false
  1335. allowEmptyValue: false
  1336. schema:
  1337. type: string
  1338. style: simple
  1339. explode: false
  1340. allowReserved: false
  1341. deprecated: false
  1342. delete:
  1343. operationId: api_media_objects_id_delete
  1344. tags:
  1345. - MediaObject
  1346. responses:
  1347. 204:
  1348. description: 'MediaObject resource deleted'
  1349. 404:
  1350. description: 'Resource not found'
  1351. summary: 'Removes the MediaObject resource.'
  1352. description: 'Removes the MediaObject resource.'
  1353. parameters:
  1354. -
  1355. name: id
  1356. in: path
  1357. description: 'MediaObject identifier'
  1358. required: true
  1359. deprecated: false
  1360. allowEmptyValue: false
  1361. schema:
  1362. type: string
  1363. style: simple
  1364. explode: false
  1365. allowReserved: false
  1366. deprecated: false
  1367. parameters: []
  1368. /api/partner_follows:
  1369. get:
  1370. operationId: api_partner_follows_get_collection
  1371. tags:
  1372. - PartnerFollow
  1373. responses:
  1374. 200:
  1375. description: 'PartnerFollow collection'
  1376. content:
  1377. application/ld+json:
  1378. schema:
  1379. type: object
  1380. properties:
  1381. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/PartnerFollow.jsonld' } }
  1382. 'hydra:totalItems': { type: integer, minimum: 0 }
  1383. '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 } }
  1384. '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 } } } } } }
  1385. required:
  1386. - 'hydra:member'
  1387. application/json:
  1388. schema:
  1389. type: array
  1390. items:
  1391. $ref: '#/components/schemas/PartnerFollow'
  1392. text/html:
  1393. schema:
  1394. type: array
  1395. items:
  1396. $ref: '#/components/schemas/PartnerFollow'
  1397. application/hal+json:
  1398. schema:
  1399. type: object
  1400. properties:
  1401. _embedded: { type: array, items: { $ref: '#/components/schemas/PartnerFollow.jsonhal' } }
  1402. totalItems: { type: integer, minimum: 0 }
  1403. itemsPerPage: { type: integer, minimum: 0 }
  1404. _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 } } } } }
  1405. required:
  1406. - _links
  1407. - _embedded
  1408. summary: 'Retrieves the collection of PartnerFollow resources.'
  1409. description: 'Retrieves the collection of PartnerFollow resources.'
  1410. parameters:
  1411. -
  1412. name: page
  1413. in: query
  1414. description: 'The collection page number'
  1415. required: false
  1416. deprecated: false
  1417. allowEmptyValue: true
  1418. schema:
  1419. type: integer
  1420. default: 1
  1421. style: form
  1422. explode: false
  1423. allowReserved: false
  1424. -
  1425. name: itemsPerPage
  1426. in: query
  1427. description: 'The number of items per page'
  1428. required: false
  1429. deprecated: false
  1430. allowEmptyValue: true
  1431. schema:
  1432. type: integer
  1433. default: 10
  1434. minimum: 0
  1435. maximum: 50
  1436. style: form
  1437. explode: false
  1438. allowReserved: false
  1439. -
  1440. name: partner
  1441. in: query
  1442. description: ''
  1443. required: false
  1444. deprecated: false
  1445. allowEmptyValue: true
  1446. schema:
  1447. type: string
  1448. style: form
  1449. explode: false
  1450. allowReserved: false
  1451. -
  1452. name: 'partner[]'
  1453. in: query
  1454. description: ''
  1455. required: false
  1456. deprecated: false
  1457. allowEmptyValue: true
  1458. schema:
  1459. type: array
  1460. items:
  1461. type: string
  1462. style: form
  1463. explode: true
  1464. allowReserved: false
  1465. -
  1466. name: user
  1467. in: query
  1468. description: ''
  1469. required: false
  1470. deprecated: false
  1471. allowEmptyValue: true
  1472. schema:
  1473. type: string
  1474. style: form
  1475. explode: false
  1476. allowReserved: false
  1477. -
  1478. name: 'user[]'
  1479. in: query
  1480. description: ''
  1481. required: false
  1482. deprecated: false
  1483. allowEmptyValue: true
  1484. schema:
  1485. type: array
  1486. items:
  1487. type: string
  1488. style: form
  1489. explode: true
  1490. allowReserved: false
  1491. -
  1492. name: partner.type
  1493. in: query
  1494. description: ''
  1495. required: false
  1496. deprecated: false
  1497. allowEmptyValue: true
  1498. schema:
  1499. type: string
  1500. style: form
  1501. explode: false
  1502. allowReserved: false
  1503. -
  1504. name: 'partner.type[]'
  1505. in: query
  1506. description: ''
  1507. required: false
  1508. deprecated: false
  1509. allowEmptyValue: true
  1510. schema:
  1511. type: array
  1512. items:
  1513. type: string
  1514. style: form
  1515. explode: true
  1516. allowReserved: false
  1517. deprecated: false
  1518. post:
  1519. operationId: api_partner_follows_post
  1520. tags:
  1521. - PartnerFollow
  1522. responses:
  1523. 201:
  1524. description: 'PartnerFollow resource created'
  1525. content:
  1526. application/ld+json:
  1527. schema:
  1528. $ref: '#/components/schemas/PartnerFollow.jsonld'
  1529. application/json:
  1530. schema:
  1531. $ref: '#/components/schemas/PartnerFollow'
  1532. text/html:
  1533. schema:
  1534. $ref: '#/components/schemas/PartnerFollow'
  1535. application/hal+json:
  1536. schema:
  1537. $ref: '#/components/schemas/PartnerFollow.jsonhal'
  1538. links: { }
  1539. 400:
  1540. description: 'Invalid input'
  1541. 422:
  1542. description: 'Unprocessable entity'
  1543. summary: 'Creates a PartnerFollow resource.'
  1544. description: 'Creates a PartnerFollow resource.'
  1545. parameters: []
  1546. requestBody:
  1547. description: 'The new PartnerFollow resource'
  1548. content:
  1549. application/ld+json:
  1550. schema:
  1551. $ref: '#/components/schemas/PartnerFollow.jsonld'
  1552. application/json:
  1553. schema:
  1554. $ref: '#/components/schemas/PartnerFollow'
  1555. text/html:
  1556. schema:
  1557. $ref: '#/components/schemas/PartnerFollow'
  1558. application/hal+json:
  1559. schema:
  1560. $ref: '#/components/schemas/PartnerFollow.jsonhal'
  1561. required: true
  1562. deprecated: false
  1563. parameters: []
  1564. '/api/partner_follows/{id}':
  1565. get:
  1566. operationId: api_partner_follows_id_get
  1567. tags:
  1568. - PartnerFollow
  1569. responses:
  1570. 200:
  1571. description: 'PartnerFollow resource'
  1572. content:
  1573. application/ld+json:
  1574. schema:
  1575. $ref: '#/components/schemas/PartnerFollow.jsonld'
  1576. application/json:
  1577. schema:
  1578. $ref: '#/components/schemas/PartnerFollow'
  1579. text/html:
  1580. schema:
  1581. $ref: '#/components/schemas/PartnerFollow'
  1582. application/hal+json:
  1583. schema:
  1584. $ref: '#/components/schemas/PartnerFollow.jsonhal'
  1585. 404:
  1586. description: 'Resource not found'
  1587. summary: 'Retrieves a PartnerFollow resource.'
  1588. description: 'Retrieves a PartnerFollow resource.'
  1589. parameters:
  1590. -
  1591. name: id
  1592. in: path
  1593. description: 'PartnerFollow identifier'
  1594. required: true
  1595. deprecated: false
  1596. allowEmptyValue: false
  1597. schema:
  1598. type: string
  1599. style: simple
  1600. explode: false
  1601. allowReserved: false
  1602. deprecated: false
  1603. delete:
  1604. operationId: api_partner_follows_id_delete
  1605. tags:
  1606. - PartnerFollow
  1607. responses:
  1608. 204:
  1609. description: 'PartnerFollow resource deleted'
  1610. 404:
  1611. description: 'Resource not found'
  1612. summary: 'Removes the PartnerFollow resource.'
  1613. description: 'Removes the PartnerFollow resource.'
  1614. parameters:
  1615. -
  1616. name: id
  1617. in: path
  1618. description: 'PartnerFollow identifier'
  1619. required: true
  1620. deprecated: false
  1621. allowEmptyValue: false
  1622. schema:
  1623. type: string
  1624. style: simple
  1625. explode: false
  1626. allowReserved: false
  1627. deprecated: false
  1628. parameters: []
  1629. /api/partner_products:
  1630. get:
  1631. operationId: api_partner_products_get_collection
  1632. tags:
  1633. - PartnerProduct
  1634. responses:
  1635. 200:
  1636. description: 'PartnerProduct collection'
  1637. content:
  1638. application/ld+json:
  1639. schema:
  1640. type: object
  1641. properties:
  1642. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/PartnerProduct.jsonld' } }
  1643. 'hydra:totalItems': { type: integer, minimum: 0 }
  1644. '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 } }
  1645. '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 } } } } } }
  1646. required:
  1647. - 'hydra:member'
  1648. application/json:
  1649. schema:
  1650. type: array
  1651. items:
  1652. $ref: '#/components/schemas/PartnerProduct'
  1653. text/html:
  1654. schema:
  1655. type: array
  1656. items:
  1657. $ref: '#/components/schemas/PartnerProduct'
  1658. application/hal+json:
  1659. schema:
  1660. type: object
  1661. properties:
  1662. _embedded: { type: array, items: { $ref: '#/components/schemas/PartnerProduct.jsonhal' } }
  1663. totalItems: { type: integer, minimum: 0 }
  1664. itemsPerPage: { type: integer, minimum: 0 }
  1665. _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 } } } } }
  1666. required:
  1667. - _links
  1668. - _embedded
  1669. summary: 'Retrieves the collection of PartnerProduct resources.'
  1670. description: 'Retrieves the collection of PartnerProduct resources.'
  1671. parameters:
  1672. -
  1673. name: page
  1674. in: query
  1675. description: 'The collection page number'
  1676. required: false
  1677. deprecated: false
  1678. allowEmptyValue: true
  1679. schema:
  1680. type: integer
  1681. default: 1
  1682. style: form
  1683. explode: false
  1684. allowReserved: false
  1685. -
  1686. name: itemsPerPage
  1687. in: query
  1688. description: 'The number of items per page'
  1689. required: false
  1690. deprecated: false
  1691. allowEmptyValue: true
  1692. schema:
  1693. type: integer
  1694. default: 10
  1695. minimum: 0
  1696. maximum: 50
  1697. style: form
  1698. explode: false
  1699. allowReserved: false
  1700. -
  1701. name: partner
  1702. in: query
  1703. description: ''
  1704. required: false
  1705. deprecated: false
  1706. allowEmptyValue: true
  1707. schema:
  1708. type: string
  1709. style: form
  1710. explode: false
  1711. allowReserved: false
  1712. -
  1713. name: 'partner[]'
  1714. in: query
  1715. description: ''
  1716. required: false
  1717. deprecated: false
  1718. allowEmptyValue: true
  1719. schema:
  1720. type: array
  1721. items:
  1722. type: string
  1723. style: form
  1724. explode: true
  1725. allowReserved: false
  1726. -
  1727. name: product
  1728. in: query
  1729. description: ''
  1730. required: false
  1731. deprecated: false
  1732. allowEmptyValue: true
  1733. schema:
  1734. type: string
  1735. style: form
  1736. explode: false
  1737. allowReserved: false
  1738. -
  1739. name: 'product[]'
  1740. in: query
  1741. description: ''
  1742. required: false
  1743. deprecated: false
  1744. allowEmptyValue: true
  1745. schema:
  1746. type: array
  1747. items:
  1748. type: string
  1749. style: form
  1750. explode: true
  1751. allowReserved: false
  1752. -
  1753. name: product.name
  1754. in: query
  1755. description: ''
  1756. required: false
  1757. deprecated: false
  1758. allowEmptyValue: true
  1759. schema:
  1760. type: string
  1761. style: form
  1762. explode: false
  1763. allowReserved: false
  1764. -
  1765. name: partner.type
  1766. in: query
  1767. description: ''
  1768. required: false
  1769. deprecated: false
  1770. allowEmptyValue: true
  1771. schema:
  1772. type: string
  1773. style: form
  1774. explode: false
  1775. allowReserved: false
  1776. -
  1777. name: 'partner.type[]'
  1778. in: query
  1779. description: ''
  1780. required: false
  1781. deprecated: false
  1782. allowEmptyValue: true
  1783. schema:
  1784. type: array
  1785. items:
  1786. type: string
  1787. style: form
  1788. explode: true
  1789. allowReserved: false
  1790. deprecated: false
  1791. post:
  1792. operationId: api_partner_products_post
  1793. tags:
  1794. - PartnerProduct
  1795. responses:
  1796. 201:
  1797. description: 'PartnerProduct resource created'
  1798. content:
  1799. application/ld+json:
  1800. schema:
  1801. $ref: '#/components/schemas/PartnerProduct.jsonld'
  1802. application/json:
  1803. schema:
  1804. $ref: '#/components/schemas/PartnerProduct'
  1805. text/html:
  1806. schema:
  1807. $ref: '#/components/schemas/PartnerProduct'
  1808. application/hal+json:
  1809. schema:
  1810. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  1811. links: { }
  1812. 400:
  1813. description: 'Invalid input'
  1814. 422:
  1815. description: 'Unprocessable entity'
  1816. summary: 'Creates a PartnerProduct resource.'
  1817. description: 'Creates a PartnerProduct resource.'
  1818. parameters: []
  1819. requestBody:
  1820. description: 'The new PartnerProduct resource'
  1821. content:
  1822. application/ld+json:
  1823. schema:
  1824. $ref: '#/components/schemas/PartnerProduct.jsonld'
  1825. application/json:
  1826. schema:
  1827. $ref: '#/components/schemas/PartnerProduct'
  1828. text/html:
  1829. schema:
  1830. $ref: '#/components/schemas/PartnerProduct'
  1831. application/hal+json:
  1832. schema:
  1833. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  1834. required: true
  1835. deprecated: false
  1836. parameters: []
  1837. '/api/partner_products/{id}':
  1838. get:
  1839. operationId: api_partner_products_id_get
  1840. tags:
  1841. - PartnerProduct
  1842. responses:
  1843. 200:
  1844. description: 'PartnerProduct resource'
  1845. content:
  1846. application/ld+json:
  1847. schema:
  1848. $ref: '#/components/schemas/PartnerProduct.jsonld'
  1849. application/json:
  1850. schema:
  1851. $ref: '#/components/schemas/PartnerProduct'
  1852. text/html:
  1853. schema:
  1854. $ref: '#/components/schemas/PartnerProduct'
  1855. application/hal+json:
  1856. schema:
  1857. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  1858. 404:
  1859. description: 'Resource not found'
  1860. summary: 'Retrieves a PartnerProduct resource.'
  1861. description: 'Retrieves a PartnerProduct resource.'
  1862. parameters:
  1863. -
  1864. name: id
  1865. in: path
  1866. description: 'PartnerProduct identifier'
  1867. required: true
  1868. deprecated: false
  1869. allowEmptyValue: false
  1870. schema:
  1871. type: string
  1872. style: simple
  1873. explode: false
  1874. allowReserved: false
  1875. deprecated: false
  1876. delete:
  1877. operationId: api_partner_products_id_delete
  1878. tags:
  1879. - PartnerProduct
  1880. responses:
  1881. 204:
  1882. description: 'PartnerProduct resource deleted'
  1883. 404:
  1884. description: 'Resource not found'
  1885. summary: 'Removes the PartnerProduct resource.'
  1886. description: 'Removes the PartnerProduct resource.'
  1887. parameters:
  1888. -
  1889. name: id
  1890. in: path
  1891. description: 'PartnerProduct identifier'
  1892. required: true
  1893. deprecated: false
  1894. allowEmptyValue: false
  1895. schema:
  1896. type: string
  1897. style: simple
  1898. explode: false
  1899. allowReserved: false
  1900. deprecated: false
  1901. parameters: []
  1902. /api/partners:
  1903. get:
  1904. operationId: api_partners_get_collection
  1905. tags:
  1906. - Partner
  1907. responses:
  1908. 200:
  1909. description: 'Partner collection'
  1910. content:
  1911. application/ld+json:
  1912. schema:
  1913. type: object
  1914. properties:
  1915. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  1916. 'hydra:totalItems': { type: integer, minimum: 0 }
  1917. '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 } }
  1918. '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 } } } } } }
  1919. required:
  1920. - 'hydra:member'
  1921. application/json:
  1922. schema:
  1923. type: array
  1924. items:
  1925. $ref: '#/components/schemas/Partner'
  1926. text/html:
  1927. schema:
  1928. type: array
  1929. items:
  1930. $ref: '#/components/schemas/Partner'
  1931. application/hal+json:
  1932. schema:
  1933. type: object
  1934. properties:
  1935. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  1936. totalItems: { type: integer, minimum: 0 }
  1937. itemsPerPage: { type: integer, minimum: 0 }
  1938. _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 } } } } }
  1939. required:
  1940. - _links
  1941. - _embedded
  1942. summary: 'Retrieves the collection of Partner resources.'
  1943. description: 'Retrieves the collection of Partner resources.'
  1944. parameters:
  1945. -
  1946. name: page
  1947. in: query
  1948. description: 'The collection page number'
  1949. required: false
  1950. deprecated: false
  1951. allowEmptyValue: true
  1952. schema:
  1953. type: integer
  1954. default: 1
  1955. style: form
  1956. explode: false
  1957. allowReserved: false
  1958. -
  1959. name: itemsPerPage
  1960. in: query
  1961. description: 'The number of items per page'
  1962. required: false
  1963. deprecated: false
  1964. allowEmptyValue: true
  1965. schema:
  1966. type: integer
  1967. default: 10
  1968. minimum: 0
  1969. maximum: 50
  1970. style: form
  1971. explode: false
  1972. allowReserved: false
  1973. -
  1974. name: type
  1975. in: query
  1976. description: ''
  1977. required: false
  1978. deprecated: false
  1979. allowEmptyValue: true
  1980. schema:
  1981. type: string
  1982. style: form
  1983. explode: false
  1984. allowReserved: false
  1985. -
  1986. name: 'type[]'
  1987. in: query
  1988. description: ''
  1989. required: false
  1990. deprecated: false
  1991. allowEmptyValue: true
  1992. schema:
  1993. type: array
  1994. items:
  1995. type: string
  1996. style: form
  1997. explode: true
  1998. allowReserved: false
  1999. -
  2000. name: name
  2001. in: query
  2002. description: ''
  2003. required: false
  2004. deprecated: false
  2005. allowEmptyValue: true
  2006. schema:
  2007. type: string
  2008. style: form
  2009. explode: false
  2010. allowReserved: false
  2011. -
  2012. name: 'order[name]'
  2013. in: query
  2014. description: ''
  2015. required: false
  2016. deprecated: false
  2017. allowEmptyValue: true
  2018. schema:
  2019. type: string
  2020. enum:
  2021. - asc
  2022. - desc
  2023. style: form
  2024. explode: false
  2025. allowReserved: false
  2026. -
  2027. name: 'order[city]'
  2028. in: query
  2029. description: ''
  2030. required: false
  2031. deprecated: false
  2032. allowEmptyValue: true
  2033. schema:
  2034. type: string
  2035. enum:
  2036. - asc
  2037. - desc
  2038. style: form
  2039. explode: false
  2040. allowReserved: false
  2041. -
  2042. name: 'order[website]'
  2043. in: query
  2044. description: ''
  2045. required: false
  2046. deprecated: false
  2047. allowEmptyValue: true
  2048. schema:
  2049. type: string
  2050. enum:
  2051. - asc
  2052. - desc
  2053. style: form
  2054. explode: false
  2055. allowReserved: false
  2056. deprecated: false
  2057. post:
  2058. operationId: api_partners_post
  2059. tags:
  2060. - Partner
  2061. responses:
  2062. 201:
  2063. description: 'Partner resource created'
  2064. content:
  2065. application/ld+json:
  2066. schema:
  2067. $ref: '#/components/schemas/Partner.jsonld'
  2068. application/json:
  2069. schema:
  2070. $ref: '#/components/schemas/Partner'
  2071. text/html:
  2072. schema:
  2073. $ref: '#/components/schemas/Partner'
  2074. application/hal+json:
  2075. schema:
  2076. $ref: '#/components/schemas/Partner.jsonhal'
  2077. links: { }
  2078. 400:
  2079. description: 'Invalid input'
  2080. 422:
  2081. description: 'Unprocessable entity'
  2082. summary: 'Creates a Partner resource.'
  2083. description: 'Creates a Partner resource.'
  2084. parameters: []
  2085. requestBody:
  2086. description: 'The new Partner resource'
  2087. content:
  2088. application/ld+json:
  2089. schema:
  2090. $ref: '#/components/schemas/Partner.jsonld'
  2091. application/json:
  2092. schema:
  2093. $ref: '#/components/schemas/Partner'
  2094. text/html:
  2095. schema:
  2096. $ref: '#/components/schemas/Partner'
  2097. application/hal+json:
  2098. schema:
  2099. $ref: '#/components/schemas/Partner.jsonhal'
  2100. required: true
  2101. deprecated: false
  2102. parameters: []
  2103. '/api/partners/{id}':
  2104. get:
  2105. operationId: api_partners_id_get
  2106. tags:
  2107. - Partner
  2108. responses:
  2109. 200:
  2110. description: 'Partner resource'
  2111. content:
  2112. application/ld+json:
  2113. schema:
  2114. $ref: '#/components/schemas/Partner.jsonld'
  2115. application/json:
  2116. schema:
  2117. $ref: '#/components/schemas/Partner'
  2118. text/html:
  2119. schema:
  2120. $ref: '#/components/schemas/Partner'
  2121. application/hal+json:
  2122. schema:
  2123. $ref: '#/components/schemas/Partner.jsonhal'
  2124. 404:
  2125. description: 'Resource not found'
  2126. summary: 'Retrieves a Partner resource.'
  2127. description: 'Retrieves a Partner resource.'
  2128. parameters:
  2129. -
  2130. name: id
  2131. in: path
  2132. description: 'Partner identifier'
  2133. required: true
  2134. deprecated: false
  2135. allowEmptyValue: false
  2136. schema:
  2137. type: string
  2138. style: simple
  2139. explode: false
  2140. allowReserved: false
  2141. deprecated: false
  2142. patch:
  2143. operationId: api_partners_id_patch
  2144. tags:
  2145. - Partner
  2146. responses:
  2147. 200:
  2148. description: 'Partner resource updated'
  2149. content:
  2150. application/ld+json:
  2151. schema:
  2152. $ref: '#/components/schemas/Partner.jsonld'
  2153. application/json:
  2154. schema:
  2155. $ref: '#/components/schemas/Partner'
  2156. text/html:
  2157. schema:
  2158. $ref: '#/components/schemas/Partner'
  2159. application/hal+json:
  2160. schema:
  2161. $ref: '#/components/schemas/Partner.jsonhal'
  2162. links: { }
  2163. 400:
  2164. description: 'Invalid input'
  2165. 422:
  2166. description: 'Unprocessable entity'
  2167. 404:
  2168. description: 'Resource not found'
  2169. summary: 'Updates the Partner resource.'
  2170. description: 'Updates the Partner resource.'
  2171. parameters:
  2172. -
  2173. name: id
  2174. in: path
  2175. description: 'Partner identifier'
  2176. required: true
  2177. deprecated: false
  2178. allowEmptyValue: false
  2179. schema:
  2180. type: string
  2181. style: simple
  2182. explode: false
  2183. allowReserved: false
  2184. requestBody:
  2185. description: 'The updated Partner resource'
  2186. content:
  2187. application/merge-patch+json:
  2188. schema:
  2189. $ref: '#/components/schemas/Partner'
  2190. required: true
  2191. deprecated: false
  2192. parameters: []
  2193. /api/posts:
  2194. get:
  2195. operationId: api_posts_get_collection
  2196. tags:
  2197. - Post
  2198. responses:
  2199. 200:
  2200. description: 'Post collection'
  2201. content:
  2202. application/ld+json:
  2203. schema:
  2204. type: object
  2205. properties:
  2206. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  2207. 'hydra:totalItems': { type: integer, minimum: 0 }
  2208. '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 } }
  2209. '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 } } } } } }
  2210. required:
  2211. - 'hydra:member'
  2212. application/json:
  2213. schema:
  2214. type: array
  2215. items:
  2216. $ref: '#/components/schemas/Post'
  2217. text/html:
  2218. schema:
  2219. type: array
  2220. items:
  2221. $ref: '#/components/schemas/Post'
  2222. application/hal+json:
  2223. schema:
  2224. type: object
  2225. properties:
  2226. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  2227. totalItems: { type: integer, minimum: 0 }
  2228. itemsPerPage: { type: integer, minimum: 0 }
  2229. _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 } } } } }
  2230. required:
  2231. - _links
  2232. - _embedded
  2233. summary: 'Retrieves the collection of Post resources.'
  2234. description: 'Retrieves the collection of Post resources.'
  2235. parameters:
  2236. -
  2237. name: page
  2238. in: query
  2239. description: 'The collection page number'
  2240. required: false
  2241. deprecated: false
  2242. allowEmptyValue: true
  2243. schema:
  2244. type: integer
  2245. default: 1
  2246. style: form
  2247. explode: false
  2248. allowReserved: false
  2249. -
  2250. name: itemsPerPage
  2251. in: query
  2252. description: 'The number of items per page'
  2253. required: false
  2254. deprecated: false
  2255. allowEmptyValue: true
  2256. schema:
  2257. type: integer
  2258. default: 10
  2259. minimum: 0
  2260. maximum: 50
  2261. style: form
  2262. explode: false
  2263. allowReserved: false
  2264. -
  2265. name: partner
  2266. in: query
  2267. description: ''
  2268. required: false
  2269. deprecated: false
  2270. allowEmptyValue: true
  2271. schema:
  2272. type: string
  2273. style: form
  2274. explode: false
  2275. allowReserved: false
  2276. -
  2277. name: 'partner[]'
  2278. in: query
  2279. description: ''
  2280. required: false
  2281. deprecated: false
  2282. allowEmptyValue: true
  2283. schema:
  2284. type: array
  2285. items:
  2286. type: string
  2287. style: form
  2288. explode: true
  2289. allowReserved: false
  2290. -
  2291. name: contact
  2292. in: query
  2293. description: ''
  2294. required: false
  2295. deprecated: false
  2296. allowEmptyValue: true
  2297. schema:
  2298. type: string
  2299. style: form
  2300. explode: false
  2301. allowReserved: false
  2302. -
  2303. name: 'contact[]'
  2304. in: query
  2305. description: ''
  2306. required: false
  2307. deprecated: false
  2308. allowEmptyValue: true
  2309. schema:
  2310. type: array
  2311. items:
  2312. type: string
  2313. style: form
  2314. explode: true
  2315. allowReserved: false
  2316. -
  2317. name: sale
  2318. in: query
  2319. description: ''
  2320. required: false
  2321. deprecated: false
  2322. allowEmptyValue: true
  2323. schema:
  2324. type: string
  2325. style: form
  2326. explode: false
  2327. allowReserved: false
  2328. -
  2329. name: 'sale[]'
  2330. in: query
  2331. description: ''
  2332. required: false
  2333. deprecated: false
  2334. allowEmptyValue: true
  2335. schema:
  2336. type: array
  2337. items:
  2338. type: string
  2339. style: form
  2340. explode: true
  2341. allowReserved: false
  2342. -
  2343. name: owner
  2344. in: query
  2345. description: ''
  2346. required: false
  2347. deprecated: false
  2348. allowEmptyValue: true
  2349. schema:
  2350. type: string
  2351. style: form
  2352. explode: false
  2353. allowReserved: false
  2354. -
  2355. name: 'owner[]'
  2356. in: query
  2357. description: ''
  2358. required: false
  2359. deprecated: false
  2360. allowEmptyValue: true
  2361. schema:
  2362. type: array
  2363. items:
  2364. type: string
  2365. style: form
  2366. explode: true
  2367. allowReserved: false
  2368. -
  2369. name: 'exists[contact]'
  2370. in: query
  2371. description: ''
  2372. required: false
  2373. deprecated: false
  2374. allowEmptyValue: true
  2375. schema:
  2376. type: boolean
  2377. style: form
  2378. explode: false
  2379. allowReserved: false
  2380. -
  2381. name: 'exists[sale]'
  2382. in: query
  2383. description: ''
  2384. required: false
  2385. deprecated: false
  2386. allowEmptyValue: true
  2387. schema:
  2388. type: boolean
  2389. style: form
  2390. explode: false
  2391. allowReserved: false
  2392. deprecated: false
  2393. post:
  2394. operationId: api_posts_post
  2395. tags:
  2396. - Post
  2397. responses:
  2398. 201:
  2399. description: 'Post resource created'
  2400. content:
  2401. application/ld+json:
  2402. schema:
  2403. $ref: '#/components/schemas/Post.jsonld'
  2404. application/json:
  2405. schema:
  2406. $ref: '#/components/schemas/Post'
  2407. text/html:
  2408. schema:
  2409. $ref: '#/components/schemas/Post'
  2410. application/hal+json:
  2411. schema:
  2412. $ref: '#/components/schemas/Post.jsonhal'
  2413. links: { }
  2414. 400:
  2415. description: 'Invalid input'
  2416. 422:
  2417. description: 'Unprocessable entity'
  2418. summary: 'Creates a Post resource.'
  2419. description: 'Creates a Post resource.'
  2420. parameters: []
  2421. requestBody:
  2422. description: 'The new Post resource'
  2423. content:
  2424. application/ld+json:
  2425. schema:
  2426. $ref: '#/components/schemas/Post.jsonld-posting.create'
  2427. application/json:
  2428. schema:
  2429. $ref: '#/components/schemas/Post-posting.create'
  2430. text/html:
  2431. schema:
  2432. $ref: '#/components/schemas/Post-posting.create'
  2433. application/hal+json:
  2434. schema:
  2435. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  2436. required: true
  2437. deprecated: false
  2438. parameters: []
  2439. '/api/posts/{id}':
  2440. get:
  2441. operationId: api_posts_id_get
  2442. tags:
  2443. - Post
  2444. responses:
  2445. 200:
  2446. description: 'Post resource'
  2447. content:
  2448. application/ld+json:
  2449. schema:
  2450. $ref: '#/components/schemas/Post.jsonld'
  2451. application/json:
  2452. schema:
  2453. $ref: '#/components/schemas/Post'
  2454. text/html:
  2455. schema:
  2456. $ref: '#/components/schemas/Post'
  2457. application/hal+json:
  2458. schema:
  2459. $ref: '#/components/schemas/Post.jsonhal'
  2460. 404:
  2461. description: 'Resource not found'
  2462. summary: 'Retrieves a Post resource.'
  2463. description: 'Retrieves a Post resource.'
  2464. parameters:
  2465. -
  2466. name: id
  2467. in: path
  2468. description: 'Post identifier'
  2469. required: true
  2470. deprecated: false
  2471. allowEmptyValue: false
  2472. schema:
  2473. type: string
  2474. style: simple
  2475. explode: false
  2476. allowReserved: false
  2477. deprecated: false
  2478. patch:
  2479. operationId: api_posts_id_patch
  2480. tags:
  2481. - Post
  2482. responses:
  2483. 200:
  2484. description: 'Post resource updated'
  2485. content:
  2486. application/ld+json:
  2487. schema:
  2488. $ref: '#/components/schemas/Post.jsonld'
  2489. application/json:
  2490. schema:
  2491. $ref: '#/components/schemas/Post'
  2492. text/html:
  2493. schema:
  2494. $ref: '#/components/schemas/Post'
  2495. application/hal+json:
  2496. schema:
  2497. $ref: '#/components/schemas/Post.jsonhal'
  2498. links: { }
  2499. 400:
  2500. description: 'Invalid input'
  2501. 422:
  2502. description: 'Unprocessable entity'
  2503. 404:
  2504. description: 'Resource not found'
  2505. summary: 'Updates the Post resource.'
  2506. description: 'Updates the Post resource.'
  2507. parameters:
  2508. -
  2509. name: id
  2510. in: path
  2511. description: 'Post identifier'
  2512. required: true
  2513. deprecated: false
  2514. allowEmptyValue: false
  2515. schema:
  2516. type: string
  2517. style: simple
  2518. explode: false
  2519. allowReserved: false
  2520. requestBody:
  2521. description: 'The updated Post resource'
  2522. content:
  2523. application/merge-patch+json:
  2524. schema:
  2525. $ref: '#/components/schemas/Post-posting.patch'
  2526. required: true
  2527. deprecated: false
  2528. parameters: []
  2529. /api/products:
  2530. get:
  2531. operationId: api_products_get_collection
  2532. tags:
  2533. - Product
  2534. responses:
  2535. 200:
  2536. description: 'Product collection'
  2537. content:
  2538. application/ld+json:
  2539. schema:
  2540. type: object
  2541. properties:
  2542. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  2543. 'hydra:totalItems': { type: integer, minimum: 0 }
  2544. '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 } }
  2545. '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 } } } } } }
  2546. required:
  2547. - 'hydra:member'
  2548. application/json:
  2549. schema:
  2550. type: array
  2551. items:
  2552. $ref: '#/components/schemas/Product'
  2553. text/html:
  2554. schema:
  2555. type: array
  2556. items:
  2557. $ref: '#/components/schemas/Product'
  2558. application/hal+json:
  2559. schema:
  2560. type: object
  2561. properties:
  2562. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  2563. totalItems: { type: integer, minimum: 0 }
  2564. itemsPerPage: { type: integer, minimum: 0 }
  2565. _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 } } } } }
  2566. required:
  2567. - _links
  2568. - _embedded
  2569. summary: 'Retrieves the collection of Product resources.'
  2570. description: 'Retrieves the collection of Product resources.'
  2571. parameters:
  2572. -
  2573. name: page
  2574. in: query
  2575. description: 'The collection page number'
  2576. required: false
  2577. deprecated: false
  2578. allowEmptyValue: true
  2579. schema:
  2580. type: integer
  2581. default: 1
  2582. style: form
  2583. explode: false
  2584. allowReserved: false
  2585. -
  2586. name: itemsPerPage
  2587. in: query
  2588. description: 'The number of items per page'
  2589. required: false
  2590. deprecated: false
  2591. allowEmptyValue: true
  2592. schema:
  2593. type: integer
  2594. default: 10
  2595. minimum: 0
  2596. maximum: 50
  2597. style: form
  2598. explode: false
  2599. allowReserved: false
  2600. -
  2601. name: name
  2602. in: query
  2603. description: ''
  2604. required: false
  2605. deprecated: false
  2606. allowEmptyValue: true
  2607. schema:
  2608. type: string
  2609. style: form
  2610. explode: false
  2611. allowReserved: false
  2612. -
  2613. name: 'order[name]'
  2614. in: query
  2615. description: ''
  2616. required: false
  2617. deprecated: false
  2618. allowEmptyValue: true
  2619. schema:
  2620. type: string
  2621. enum:
  2622. - asc
  2623. - desc
  2624. style: form
  2625. explode: false
  2626. allowReserved: false
  2627. deprecated: false
  2628. post:
  2629. operationId: api_products_post
  2630. tags:
  2631. - Product
  2632. responses:
  2633. 201:
  2634. description: 'Product resource created'
  2635. content:
  2636. application/ld+json:
  2637. schema:
  2638. $ref: '#/components/schemas/Product.jsonld'
  2639. application/json:
  2640. schema:
  2641. $ref: '#/components/schemas/Product'
  2642. text/html:
  2643. schema:
  2644. $ref: '#/components/schemas/Product'
  2645. application/hal+json:
  2646. schema:
  2647. $ref: '#/components/schemas/Product.jsonhal'
  2648. links: { }
  2649. 400:
  2650. description: 'Invalid input'
  2651. 422:
  2652. description: 'Unprocessable entity'
  2653. summary: 'Creates a Product resource.'
  2654. description: 'Creates a Product resource.'
  2655. parameters: []
  2656. requestBody:
  2657. description: 'The new Product resource'
  2658. content:
  2659. application/ld+json:
  2660. schema:
  2661. $ref: '#/components/schemas/Product.jsonld'
  2662. application/json:
  2663. schema:
  2664. $ref: '#/components/schemas/Product'
  2665. text/html:
  2666. schema:
  2667. $ref: '#/components/schemas/Product'
  2668. application/hal+json:
  2669. schema:
  2670. $ref: '#/components/schemas/Product.jsonhal'
  2671. required: true
  2672. deprecated: false
  2673. parameters: []
  2674. '/api/products/{id}':
  2675. get:
  2676. operationId: api_products_id_get
  2677. tags:
  2678. - Product
  2679. responses:
  2680. 200:
  2681. description: 'Product resource'
  2682. content:
  2683. application/ld+json:
  2684. schema:
  2685. $ref: '#/components/schemas/Product.jsonld'
  2686. application/json:
  2687. schema:
  2688. $ref: '#/components/schemas/Product'
  2689. text/html:
  2690. schema:
  2691. $ref: '#/components/schemas/Product'
  2692. application/hal+json:
  2693. schema:
  2694. $ref: '#/components/schemas/Product.jsonhal'
  2695. 404:
  2696. description: 'Resource not found'
  2697. summary: 'Retrieves a Product resource.'
  2698. description: 'Retrieves a Product resource.'
  2699. parameters:
  2700. -
  2701. name: id
  2702. in: path
  2703. description: 'Product identifier'
  2704. required: true
  2705. deprecated: false
  2706. allowEmptyValue: false
  2707. schema:
  2708. type: string
  2709. style: simple
  2710. explode: false
  2711. allowReserved: false
  2712. deprecated: false
  2713. patch:
  2714. operationId: api_products_id_patch
  2715. tags:
  2716. - Product
  2717. responses:
  2718. 200:
  2719. description: 'Product resource updated'
  2720. content:
  2721. application/ld+json:
  2722. schema:
  2723. $ref: '#/components/schemas/Product.jsonld'
  2724. application/json:
  2725. schema:
  2726. $ref: '#/components/schemas/Product'
  2727. text/html:
  2728. schema:
  2729. $ref: '#/components/schemas/Product'
  2730. application/hal+json:
  2731. schema:
  2732. $ref: '#/components/schemas/Product.jsonhal'
  2733. links: { }
  2734. 400:
  2735. description: 'Invalid input'
  2736. 422:
  2737. description: 'Unprocessable entity'
  2738. 404:
  2739. description: 'Resource not found'
  2740. summary: 'Updates the Product resource.'
  2741. description: 'Updates the Product resource.'
  2742. parameters:
  2743. -
  2744. name: id
  2745. in: path
  2746. description: 'Product identifier'
  2747. required: true
  2748. deprecated: false
  2749. allowEmptyValue: false
  2750. schema:
  2751. type: string
  2752. style: simple
  2753. explode: false
  2754. allowReserved: false
  2755. requestBody:
  2756. description: 'The updated Product resource'
  2757. content:
  2758. application/merge-patch+json:
  2759. schema:
  2760. $ref: '#/components/schemas/Product'
  2761. required: true
  2762. deprecated: false
  2763. parameters: []
  2764. /api/sale_summaries:
  2765. get:
  2766. operationId: api_sale_summaries_get_collection
  2767. tags:
  2768. - SaleSummary
  2769. responses:
  2770. 200:
  2771. description: 'SaleSummary collection'
  2772. content:
  2773. application/ld+json:
  2774. schema:
  2775. type: object
  2776. properties:
  2777. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonld' } }
  2778. 'hydra:totalItems': { type: integer, minimum: 0 }
  2779. '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 } }
  2780. '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 } } } } } }
  2781. required:
  2782. - 'hydra:member'
  2783. application/json:
  2784. schema:
  2785. type: array
  2786. items:
  2787. $ref: '#/components/schemas/SaleSummary'
  2788. text/html:
  2789. schema:
  2790. type: array
  2791. items:
  2792. $ref: '#/components/schemas/SaleSummary'
  2793. application/hal+json:
  2794. schema:
  2795. type: object
  2796. properties:
  2797. _embedded: { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonhal' } }
  2798. totalItems: { type: integer, minimum: 0 }
  2799. itemsPerPage: { type: integer, minimum: 0 }
  2800. _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 } } } } }
  2801. required:
  2802. - _links
  2803. - _embedded
  2804. summary: 'Retrieves the collection of SaleSummary resources.'
  2805. description: 'Retrieves the collection of SaleSummary resources.'
  2806. parameters:
  2807. -
  2808. name: page
  2809. in: query
  2810. description: 'The collection page number'
  2811. required: false
  2812. deprecated: false
  2813. allowEmptyValue: true
  2814. schema:
  2815. type: integer
  2816. default: 1
  2817. style: form
  2818. explode: false
  2819. allowReserved: false
  2820. -
  2821. name: itemsPerPage
  2822. in: query
  2823. description: 'The number of items per page'
  2824. required: false
  2825. deprecated: false
  2826. allowEmptyValue: true
  2827. schema:
  2828. type: integer
  2829. default: 10
  2830. minimum: 0
  2831. maximum: 50
  2832. style: form
  2833. explode: false
  2834. allowReserved: false
  2835. deprecated: false
  2836. parameters: []
  2837. '/api/sale_summaries/{userId}':
  2838. get:
  2839. operationId: api_sale_summaries_userId_get
  2840. tags:
  2841. - SaleSummary
  2842. responses:
  2843. 200:
  2844. description: 'SaleSummary resource'
  2845. content:
  2846. application/ld+json:
  2847. schema:
  2848. $ref: '#/components/schemas/SaleSummary.jsonld'
  2849. application/json:
  2850. schema:
  2851. $ref: '#/components/schemas/SaleSummary'
  2852. text/html:
  2853. schema:
  2854. $ref: '#/components/schemas/SaleSummary'
  2855. application/hal+json:
  2856. schema:
  2857. $ref: '#/components/schemas/SaleSummary.jsonhal'
  2858. 404:
  2859. description: 'Resource not found'
  2860. summary: 'Retrieves a SaleSummary resource.'
  2861. description: 'Retrieves a SaleSummary resource.'
  2862. parameters:
  2863. -
  2864. name: userId
  2865. in: path
  2866. description: 'SaleSummary identifier'
  2867. required: true
  2868. deprecated: false
  2869. allowEmptyValue: false
  2870. schema:
  2871. type: string
  2872. style: simple
  2873. explode: false
  2874. allowReserved: false
  2875. deprecated: false
  2876. parameters: []
  2877. /api/sales:
  2878. get:
  2879. operationId: api_sales_get_collection
  2880. tags:
  2881. - Sale
  2882. responses:
  2883. 200:
  2884. description: 'Sale collection'
  2885. content:
  2886. application/ld+json:
  2887. schema:
  2888. type: object
  2889. properties:
  2890. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Sale.jsonld' } }
  2891. 'hydra:totalItems': { type: integer, minimum: 0 }
  2892. '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 } }
  2893. '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 } } } } } }
  2894. required:
  2895. - 'hydra:member'
  2896. application/json:
  2897. schema:
  2898. type: array
  2899. items:
  2900. $ref: '#/components/schemas/Sale'
  2901. text/html:
  2902. schema:
  2903. type: array
  2904. items:
  2905. $ref: '#/components/schemas/Sale'
  2906. application/hal+json:
  2907. schema:
  2908. type: object
  2909. properties:
  2910. _embedded: { type: array, items: { $ref: '#/components/schemas/Sale.jsonhal' } }
  2911. totalItems: { type: integer, minimum: 0 }
  2912. itemsPerPage: { type: integer, minimum: 0 }
  2913. _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 } } } } }
  2914. required:
  2915. - _links
  2916. - _embedded
  2917. summary: 'Retrieves the collection of Sale resources.'
  2918. description: 'Retrieves the collection of Sale resources.'
  2919. parameters:
  2920. -
  2921. name: page
  2922. in: query
  2923. description: 'The collection page number'
  2924. required: false
  2925. deprecated: false
  2926. allowEmptyValue: true
  2927. schema:
  2928. type: integer
  2929. default: 1
  2930. style: form
  2931. explode: false
  2932. allowReserved: false
  2933. -
  2934. name: itemsPerPage
  2935. in: query
  2936. description: 'The number of items per page'
  2937. required: false
  2938. deprecated: false
  2939. allowEmptyValue: true
  2940. schema:
  2941. type: integer
  2942. default: 10
  2943. minimum: 0
  2944. maximum: 50
  2945. style: form
  2946. explode: false
  2947. allowReserved: false
  2948. -
  2949. name: owner
  2950. in: query
  2951. description: ''
  2952. required: false
  2953. deprecated: false
  2954. allowEmptyValue: true
  2955. schema:
  2956. type: string
  2957. style: form
  2958. explode: false
  2959. allowReserved: false
  2960. -
  2961. name: 'owner[]'
  2962. in: query
  2963. description: ''
  2964. required: false
  2965. deprecated: false
  2966. allowEmptyValue: true
  2967. schema:
  2968. type: array
  2969. items:
  2970. type: string
  2971. style: form
  2972. explode: true
  2973. allowReserved: false
  2974. -
  2975. name: partner
  2976. in: query
  2977. description: ''
  2978. required: false
  2979. deprecated: false
  2980. allowEmptyValue: true
  2981. schema:
  2982. type: string
  2983. style: form
  2984. explode: false
  2985. allowReserved: false
  2986. -
  2987. name: 'partner[]'
  2988. in: query
  2989. description: ''
  2990. required: false
  2991. deprecated: false
  2992. allowEmptyValue: true
  2993. schema:
  2994. type: array
  2995. items:
  2996. type: string
  2997. style: form
  2998. explode: true
  2999. allowReserved: false
  3000. deprecated: false
  3001. post:
  3002. operationId: api_sales_post
  3003. tags:
  3004. - Sale
  3005. responses:
  3006. 201:
  3007. description: 'Sale resource created'
  3008. content:
  3009. application/ld+json:
  3010. schema:
  3011. $ref: '#/components/schemas/Sale.jsonld'
  3012. application/json:
  3013. schema:
  3014. $ref: '#/components/schemas/Sale'
  3015. text/html:
  3016. schema:
  3017. $ref: '#/components/schemas/Sale'
  3018. application/hal+json:
  3019. schema:
  3020. $ref: '#/components/schemas/Sale.jsonhal'
  3021. links: { }
  3022. 400:
  3023. description: 'Invalid input'
  3024. 422:
  3025. description: 'Unprocessable entity'
  3026. summary: 'Creates a Sale resource.'
  3027. description: 'Creates a Sale resource.'
  3028. parameters: []
  3029. requestBody:
  3030. description: 'The new Sale resource'
  3031. content:
  3032. application/ld+json:
  3033. schema:
  3034. $ref: '#/components/schemas/Sale.jsonld'
  3035. application/json:
  3036. schema:
  3037. $ref: '#/components/schemas/Sale'
  3038. text/html:
  3039. schema:
  3040. $ref: '#/components/schemas/Sale'
  3041. application/hal+json:
  3042. schema:
  3043. $ref: '#/components/schemas/Sale.jsonhal'
  3044. required: true
  3045. deprecated: false
  3046. parameters: []
  3047. '/api/sales/{id}':
  3048. get:
  3049. operationId: api_sales_id_get
  3050. tags:
  3051. - Sale
  3052. responses:
  3053. 200:
  3054. description: 'Sale resource'
  3055. content:
  3056. application/ld+json:
  3057. schema:
  3058. $ref: '#/components/schemas/Sale.jsonld'
  3059. application/json:
  3060. schema:
  3061. $ref: '#/components/schemas/Sale'
  3062. text/html:
  3063. schema:
  3064. $ref: '#/components/schemas/Sale'
  3065. application/hal+json:
  3066. schema:
  3067. $ref: '#/components/schemas/Sale.jsonhal'
  3068. 404:
  3069. description: 'Resource not found'
  3070. summary: 'Retrieves a Sale resource.'
  3071. description: 'Retrieves a Sale resource.'
  3072. parameters:
  3073. -
  3074. name: id
  3075. in: path
  3076. description: 'Sale identifier'
  3077. required: true
  3078. deprecated: false
  3079. allowEmptyValue: false
  3080. schema:
  3081. type: string
  3082. style: simple
  3083. explode: false
  3084. allowReserved: false
  3085. deprecated: false
  3086. patch:
  3087. operationId: api_sales_id_patch
  3088. tags:
  3089. - Sale
  3090. responses:
  3091. 200:
  3092. description: 'Sale resource updated'
  3093. content:
  3094. application/ld+json:
  3095. schema:
  3096. $ref: '#/components/schemas/Sale.jsonld'
  3097. application/json:
  3098. schema:
  3099. $ref: '#/components/schemas/Sale'
  3100. text/html:
  3101. schema:
  3102. $ref: '#/components/schemas/Sale'
  3103. application/hal+json:
  3104. schema:
  3105. $ref: '#/components/schemas/Sale.jsonhal'
  3106. links: { }
  3107. 400:
  3108. description: 'Invalid input'
  3109. 422:
  3110. description: 'Unprocessable entity'
  3111. 404:
  3112. description: 'Resource not found'
  3113. summary: 'Updates the Sale resource.'
  3114. description: 'Updates the Sale resource.'
  3115. parameters:
  3116. -
  3117. name: id
  3118. in: path
  3119. description: 'Sale identifier'
  3120. required: true
  3121. deprecated: false
  3122. allowEmptyValue: false
  3123. schema:
  3124. type: string
  3125. style: simple
  3126. explode: false
  3127. allowReserved: false
  3128. requestBody:
  3129. description: 'The updated Sale resource'
  3130. content:
  3131. application/merge-patch+json:
  3132. schema:
  3133. $ref: '#/components/schemas/Sale'
  3134. required: true
  3135. deprecated: false
  3136. parameters: []
  3137. /api/task_notes:
  3138. get:
  3139. operationId: api_task_notes_get_collection
  3140. tags:
  3141. - TaskNote
  3142. responses:
  3143. 200:
  3144. description: 'TaskNote collection'
  3145. content:
  3146. application/ld+json:
  3147. schema:
  3148. type: object
  3149. properties:
  3150. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonld' } }
  3151. 'hydra:totalItems': { type: integer, minimum: 0 }
  3152. '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 } }
  3153. '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 } } } } } }
  3154. required:
  3155. - 'hydra:member'
  3156. application/json:
  3157. schema:
  3158. type: array
  3159. items:
  3160. $ref: '#/components/schemas/TaskNote'
  3161. text/html:
  3162. schema:
  3163. type: array
  3164. items:
  3165. $ref: '#/components/schemas/TaskNote'
  3166. application/hal+json:
  3167. schema:
  3168. type: object
  3169. properties:
  3170. _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonhal' } }
  3171. totalItems: { type: integer, minimum: 0 }
  3172. itemsPerPage: { type: integer, minimum: 0 }
  3173. _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 } } } } }
  3174. required:
  3175. - _links
  3176. - _embedded
  3177. summary: 'Retrieves the collection of TaskNote resources.'
  3178. description: 'Retrieves the collection of TaskNote resources.'
  3179. parameters:
  3180. -
  3181. name: page
  3182. in: query
  3183. description: 'The collection page number'
  3184. required: false
  3185. deprecated: false
  3186. allowEmptyValue: true
  3187. schema:
  3188. type: integer
  3189. default: 1
  3190. style: form
  3191. explode: false
  3192. allowReserved: false
  3193. -
  3194. name: itemsPerPage
  3195. in: query
  3196. description: 'The number of items per page'
  3197. required: false
  3198. deprecated: false
  3199. allowEmptyValue: true
  3200. schema:
  3201. type: integer
  3202. default: 10
  3203. minimum: 0
  3204. maximum: 50
  3205. style: form
  3206. explode: false
  3207. allowReserved: false
  3208. -
  3209. name: task
  3210. in: query
  3211. description: ''
  3212. required: false
  3213. deprecated: false
  3214. allowEmptyValue: true
  3215. schema:
  3216. type: string
  3217. style: form
  3218. explode: false
  3219. allowReserved: false
  3220. -
  3221. name: 'task[]'
  3222. in: query
  3223. description: ''
  3224. required: false
  3225. deprecated: false
  3226. allowEmptyValue: true
  3227. schema:
  3228. type: array
  3229. items:
  3230. type: string
  3231. style: form
  3232. explode: true
  3233. allowReserved: false
  3234. deprecated: false
  3235. post:
  3236. operationId: api_task_notes_post
  3237. tags:
  3238. - TaskNote
  3239. responses:
  3240. 201:
  3241. description: 'TaskNote resource created'
  3242. content:
  3243. application/ld+json:
  3244. schema:
  3245. $ref: '#/components/schemas/TaskNote.jsonld'
  3246. application/json:
  3247. schema:
  3248. $ref: '#/components/schemas/TaskNote'
  3249. text/html:
  3250. schema:
  3251. $ref: '#/components/schemas/TaskNote'
  3252. application/hal+json:
  3253. schema:
  3254. $ref: '#/components/schemas/TaskNote.jsonhal'
  3255. links: { }
  3256. 400:
  3257. description: 'Invalid input'
  3258. 422:
  3259. description: 'Unprocessable entity'
  3260. summary: 'Creates a TaskNote resource.'
  3261. description: 'Creates a TaskNote resource.'
  3262. parameters: []
  3263. requestBody:
  3264. description: 'The new TaskNote resource'
  3265. content:
  3266. application/ld+json:
  3267. schema:
  3268. $ref: '#/components/schemas/TaskNote.jsonld'
  3269. application/json:
  3270. schema:
  3271. $ref: '#/components/schemas/TaskNote'
  3272. text/html:
  3273. schema:
  3274. $ref: '#/components/schemas/TaskNote'
  3275. application/hal+json:
  3276. schema:
  3277. $ref: '#/components/schemas/TaskNote.jsonhal'
  3278. required: true
  3279. deprecated: false
  3280. parameters: []
  3281. '/api/task_notes/{id}':
  3282. get:
  3283. operationId: api_task_notes_id_get
  3284. tags:
  3285. - TaskNote
  3286. responses:
  3287. 200:
  3288. description: 'TaskNote resource'
  3289. content:
  3290. application/ld+json:
  3291. schema:
  3292. $ref: '#/components/schemas/TaskNote.jsonld'
  3293. application/json:
  3294. schema:
  3295. $ref: '#/components/schemas/TaskNote'
  3296. text/html:
  3297. schema:
  3298. $ref: '#/components/schemas/TaskNote'
  3299. application/hal+json:
  3300. schema:
  3301. $ref: '#/components/schemas/TaskNote.jsonhal'
  3302. 404:
  3303. description: 'Resource not found'
  3304. summary: 'Retrieves a TaskNote resource.'
  3305. description: 'Retrieves a TaskNote resource.'
  3306. parameters:
  3307. -
  3308. name: id
  3309. in: path
  3310. description: 'TaskNote identifier'
  3311. required: true
  3312. deprecated: false
  3313. allowEmptyValue: false
  3314. schema:
  3315. type: string
  3316. style: simple
  3317. explode: false
  3318. allowReserved: false
  3319. deprecated: false
  3320. patch:
  3321. operationId: api_task_notes_id_patch
  3322. tags:
  3323. - TaskNote
  3324. responses:
  3325. 200:
  3326. description: 'TaskNote resource updated'
  3327. content:
  3328. application/ld+json:
  3329. schema:
  3330. $ref: '#/components/schemas/TaskNote.jsonld'
  3331. application/json:
  3332. schema:
  3333. $ref: '#/components/schemas/TaskNote'
  3334. text/html:
  3335. schema:
  3336. $ref: '#/components/schemas/TaskNote'
  3337. application/hal+json:
  3338. schema:
  3339. $ref: '#/components/schemas/TaskNote.jsonhal'
  3340. links: { }
  3341. 400:
  3342. description: 'Invalid input'
  3343. 422:
  3344. description: 'Unprocessable entity'
  3345. 404:
  3346. description: 'Resource not found'
  3347. summary: 'Updates the TaskNote resource.'
  3348. description: 'Updates the TaskNote resource.'
  3349. parameters:
  3350. -
  3351. name: id
  3352. in: path
  3353. description: 'TaskNote identifier'
  3354. required: true
  3355. deprecated: false
  3356. allowEmptyValue: false
  3357. schema:
  3358. type: string
  3359. style: simple
  3360. explode: false
  3361. allowReserved: false
  3362. requestBody:
  3363. description: 'The updated TaskNote resource'
  3364. content:
  3365. application/merge-patch+json:
  3366. schema:
  3367. $ref: '#/components/schemas/TaskNote'
  3368. required: true
  3369. deprecated: false
  3370. parameters: []
  3371. /api/tasks:
  3372. get:
  3373. operationId: api_tasks_get_collection
  3374. tags:
  3375. - Task
  3376. responses:
  3377. 200:
  3378. description: 'Task collection'
  3379. content:
  3380. application/ld+json:
  3381. schema:
  3382. type: object
  3383. properties:
  3384. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  3385. 'hydra:totalItems': { type: integer, minimum: 0 }
  3386. '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 } }
  3387. '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 } } } } } }
  3388. required:
  3389. - 'hydra:member'
  3390. application/json:
  3391. schema:
  3392. type: array
  3393. items:
  3394. $ref: '#/components/schemas/Task'
  3395. text/html:
  3396. schema:
  3397. type: array
  3398. items:
  3399. $ref: '#/components/schemas/Task'
  3400. application/hal+json:
  3401. schema:
  3402. type: object
  3403. properties:
  3404. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  3405. totalItems: { type: integer, minimum: 0 }
  3406. itemsPerPage: { type: integer, minimum: 0 }
  3407. _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 } } } } }
  3408. required:
  3409. - _links
  3410. - _embedded
  3411. summary: 'Retrieves the collection of Task resources.'
  3412. description: 'Retrieves the collection of Task resources.'
  3413. parameters:
  3414. -
  3415. name: page
  3416. in: query
  3417. description: 'The collection page number'
  3418. required: false
  3419. deprecated: false
  3420. allowEmptyValue: true
  3421. schema:
  3422. type: integer
  3423. default: 1
  3424. style: form
  3425. explode: false
  3426. allowReserved: false
  3427. -
  3428. name: itemsPerPage
  3429. in: query
  3430. description: 'The number of items per page'
  3431. required: false
  3432. deprecated: false
  3433. allowEmptyValue: true
  3434. schema:
  3435. type: integer
  3436. default: 10
  3437. minimum: 0
  3438. maximum: 50
  3439. style: form
  3440. explode: false
  3441. allowReserved: false
  3442. -
  3443. name: assignedTo
  3444. in: query
  3445. description: ''
  3446. required: false
  3447. deprecated: false
  3448. allowEmptyValue: true
  3449. schema:
  3450. type: string
  3451. style: form
  3452. explode: false
  3453. allowReserved: false
  3454. -
  3455. name: 'assignedTo[]'
  3456. in: query
  3457. description: ''
  3458. required: false
  3459. deprecated: false
  3460. allowEmptyValue: true
  3461. schema:
  3462. type: array
  3463. items:
  3464. type: string
  3465. style: form
  3466. explode: true
  3467. allowReserved: false
  3468. -
  3469. name: partner
  3470. in: query
  3471. description: ''
  3472. required: false
  3473. deprecated: false
  3474. allowEmptyValue: true
  3475. schema:
  3476. type: string
  3477. style: form
  3478. explode: false
  3479. allowReserved: false
  3480. -
  3481. name: 'partner[]'
  3482. in: query
  3483. description: ''
  3484. required: false
  3485. deprecated: false
  3486. allowEmptyValue: true
  3487. schema:
  3488. type: array
  3489. items:
  3490. type: string
  3491. style: form
  3492. explode: true
  3493. allowReserved: false
  3494. -
  3495. name: contact
  3496. in: query
  3497. description: ''
  3498. required: false
  3499. deprecated: false
  3500. allowEmptyValue: true
  3501. schema:
  3502. type: string
  3503. style: form
  3504. explode: false
  3505. allowReserved: false
  3506. -
  3507. name: 'contact[]'
  3508. in: query
  3509. description: ''
  3510. required: false
  3511. deprecated: false
  3512. allowEmptyValue: true
  3513. schema:
  3514. type: array
  3515. items:
  3516. type: string
  3517. style: form
  3518. explode: true
  3519. allowReserved: false
  3520. deprecated: false
  3521. post:
  3522. operationId: api_tasks_post
  3523. tags:
  3524. - Task
  3525. responses:
  3526. 201:
  3527. description: 'Task resource created'
  3528. content:
  3529. application/ld+json:
  3530. schema:
  3531. $ref: '#/components/schemas/Task.jsonld'
  3532. application/json:
  3533. schema:
  3534. $ref: '#/components/schemas/Task'
  3535. text/html:
  3536. schema:
  3537. $ref: '#/components/schemas/Task'
  3538. application/hal+json:
  3539. schema:
  3540. $ref: '#/components/schemas/Task.jsonhal'
  3541. links: { }
  3542. 400:
  3543. description: 'Invalid input'
  3544. 422:
  3545. description: 'Unprocessable entity'
  3546. summary: 'Creates a Task resource.'
  3547. description: 'Creates a Task resource.'
  3548. parameters: []
  3549. requestBody:
  3550. description: 'The new Task resource'
  3551. content:
  3552. application/ld+json:
  3553. schema:
  3554. $ref: '#/components/schemas/Task.jsonld'
  3555. application/json:
  3556. schema:
  3557. $ref: '#/components/schemas/Task'
  3558. text/html:
  3559. schema:
  3560. $ref: '#/components/schemas/Task'
  3561. application/hal+json:
  3562. schema:
  3563. $ref: '#/components/schemas/Task.jsonhal'
  3564. required: true
  3565. deprecated: false
  3566. parameters: []
  3567. '/api/tasks/{id}':
  3568. get:
  3569. operationId: api_tasks_id_get
  3570. tags:
  3571. - Task
  3572. responses:
  3573. 200:
  3574. description: 'Task resource'
  3575. content:
  3576. application/ld+json:
  3577. schema:
  3578. $ref: '#/components/schemas/Task.jsonld'
  3579. application/json:
  3580. schema:
  3581. $ref: '#/components/schemas/Task'
  3582. text/html:
  3583. schema:
  3584. $ref: '#/components/schemas/Task'
  3585. application/hal+json:
  3586. schema:
  3587. $ref: '#/components/schemas/Task.jsonhal'
  3588. 404:
  3589. description: 'Resource not found'
  3590. summary: 'Retrieves a Task resource.'
  3591. description: 'Retrieves a Task resource.'
  3592. parameters:
  3593. -
  3594. name: id
  3595. in: path
  3596. description: 'Task identifier'
  3597. required: true
  3598. deprecated: false
  3599. allowEmptyValue: false
  3600. schema:
  3601. type: string
  3602. style: simple
  3603. explode: false
  3604. allowReserved: false
  3605. deprecated: false
  3606. patch:
  3607. operationId: api_tasks_id_patch
  3608. tags:
  3609. - Task
  3610. responses:
  3611. 200:
  3612. description: 'Task resource updated'
  3613. content:
  3614. application/ld+json:
  3615. schema:
  3616. $ref: '#/components/schemas/Task.jsonld'
  3617. application/json:
  3618. schema:
  3619. $ref: '#/components/schemas/Task'
  3620. text/html:
  3621. schema:
  3622. $ref: '#/components/schemas/Task'
  3623. application/hal+json:
  3624. schema:
  3625. $ref: '#/components/schemas/Task.jsonhal'
  3626. links: { }
  3627. 400:
  3628. description: 'Invalid input'
  3629. 422:
  3630. description: 'Unprocessable entity'
  3631. 404:
  3632. description: 'Resource not found'
  3633. summary: 'Updates the Task resource.'
  3634. description: 'Updates the Task resource.'
  3635. parameters:
  3636. -
  3637. name: id
  3638. in: path
  3639. description: 'Task identifier'
  3640. required: true
  3641. deprecated: false
  3642. allowEmptyValue: false
  3643. schema:
  3644. type: string
  3645. style: simple
  3646. explode: false
  3647. allowReserved: false
  3648. requestBody:
  3649. description: 'The updated Task resource'
  3650. content:
  3651. application/merge-patch+json:
  3652. schema:
  3653. $ref: '#/components/schemas/Task'
  3654. required: true
  3655. deprecated: false
  3656. parameters: []
  3657. /api/user_products:
  3658. get:
  3659. operationId: api_user_products_get_collection
  3660. tags:
  3661. - UserProduct
  3662. responses:
  3663. 200:
  3664. description: 'UserProduct collection'
  3665. content:
  3666. application/ld+json:
  3667. schema:
  3668. type: object
  3669. properties:
  3670. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonld' } }
  3671. 'hydra:totalItems': { type: integer, minimum: 0 }
  3672. '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 } }
  3673. '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 } } } } } }
  3674. required:
  3675. - 'hydra:member'
  3676. application/json:
  3677. schema:
  3678. type: array
  3679. items:
  3680. $ref: '#/components/schemas/UserProduct'
  3681. text/html:
  3682. schema:
  3683. type: array
  3684. items:
  3685. $ref: '#/components/schemas/UserProduct'
  3686. application/hal+json:
  3687. schema:
  3688. type: object
  3689. properties:
  3690. _embedded: { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonhal' } }
  3691. totalItems: { type: integer, minimum: 0 }
  3692. itemsPerPage: { type: integer, minimum: 0 }
  3693. _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 } } } } }
  3694. required:
  3695. - _links
  3696. - _embedded
  3697. summary: 'Retrieves the collection of UserProduct resources.'
  3698. description: 'Retrieves the collection of UserProduct resources.'
  3699. parameters:
  3700. -
  3701. name: page
  3702. in: query
  3703. description: 'The collection page number'
  3704. required: false
  3705. deprecated: false
  3706. allowEmptyValue: true
  3707. schema:
  3708. type: integer
  3709. default: 1
  3710. style: form
  3711. explode: false
  3712. allowReserved: false
  3713. -
  3714. name: itemsPerPage
  3715. in: query
  3716. description: 'The number of items per page'
  3717. required: false
  3718. deprecated: false
  3719. allowEmptyValue: true
  3720. schema:
  3721. type: integer
  3722. default: 10
  3723. minimum: 0
  3724. maximum: 50
  3725. style: form
  3726. explode: false
  3727. allowReserved: false
  3728. -
  3729. name: user
  3730. in: query
  3731. description: ''
  3732. required: false
  3733. deprecated: false
  3734. allowEmptyValue: true
  3735. schema:
  3736. type: string
  3737. style: form
  3738. explode: false
  3739. allowReserved: false
  3740. -
  3741. name: 'user[]'
  3742. in: query
  3743. description: ''
  3744. required: false
  3745. deprecated: false
  3746. allowEmptyValue: true
  3747. schema:
  3748. type: array
  3749. items:
  3750. type: string
  3751. style: form
  3752. explode: true
  3753. allowReserved: false
  3754. -
  3755. name: product
  3756. in: query
  3757. description: ''
  3758. required: false
  3759. deprecated: false
  3760. allowEmptyValue: true
  3761. schema:
  3762. type: string
  3763. style: form
  3764. explode: false
  3765. allowReserved: false
  3766. -
  3767. name: 'product[]'
  3768. in: query
  3769. description: ''
  3770. required: false
  3771. deprecated: false
  3772. allowEmptyValue: true
  3773. schema:
  3774. type: array
  3775. items:
  3776. type: string
  3777. style: form
  3778. explode: true
  3779. allowReserved: false
  3780. -
  3781. name: 'order[product.name]'
  3782. in: query
  3783. description: ''
  3784. required: false
  3785. deprecated: false
  3786. allowEmptyValue: true
  3787. schema:
  3788. type: string
  3789. enum:
  3790. - asc
  3791. - desc
  3792. style: form
  3793. explode: false
  3794. allowReserved: false
  3795. deprecated: false
  3796. post:
  3797. operationId: api_user_products_post
  3798. tags:
  3799. - UserProduct
  3800. responses:
  3801. 201:
  3802. description: 'UserProduct resource created'
  3803. content:
  3804. application/ld+json:
  3805. schema:
  3806. $ref: '#/components/schemas/UserProduct.jsonld'
  3807. application/json:
  3808. schema:
  3809. $ref: '#/components/schemas/UserProduct'
  3810. text/html:
  3811. schema:
  3812. $ref: '#/components/schemas/UserProduct'
  3813. application/hal+json:
  3814. schema:
  3815. $ref: '#/components/schemas/UserProduct.jsonhal'
  3816. links: { }
  3817. 400:
  3818. description: 'Invalid input'
  3819. 422:
  3820. description: 'Unprocessable entity'
  3821. summary: 'Creates a UserProduct resource.'
  3822. description: 'Creates a UserProduct resource.'
  3823. parameters: []
  3824. requestBody:
  3825. description: 'The new UserProduct resource'
  3826. content:
  3827. application/ld+json:
  3828. schema:
  3829. $ref: '#/components/schemas/UserProduct.jsonld'
  3830. application/json:
  3831. schema:
  3832. $ref: '#/components/schemas/UserProduct'
  3833. text/html:
  3834. schema:
  3835. $ref: '#/components/schemas/UserProduct'
  3836. application/hal+json:
  3837. schema:
  3838. $ref: '#/components/schemas/UserProduct.jsonhal'
  3839. required: true
  3840. deprecated: false
  3841. parameters: []
  3842. '/api/user_products/{id}':
  3843. get:
  3844. operationId: api_user_products_id_get
  3845. tags:
  3846. - UserProduct
  3847. responses:
  3848. 200:
  3849. description: 'UserProduct resource'
  3850. content:
  3851. application/ld+json:
  3852. schema:
  3853. $ref: '#/components/schemas/UserProduct.jsonld'
  3854. application/json:
  3855. schema:
  3856. $ref: '#/components/schemas/UserProduct'
  3857. text/html:
  3858. schema:
  3859. $ref: '#/components/schemas/UserProduct'
  3860. application/hal+json:
  3861. schema:
  3862. $ref: '#/components/schemas/UserProduct.jsonhal'
  3863. 404:
  3864. description: 'Resource not found'
  3865. summary: 'Retrieves a UserProduct resource.'
  3866. description: 'Retrieves a UserProduct resource.'
  3867. parameters:
  3868. -
  3869. name: id
  3870. in: path
  3871. description: 'UserProduct identifier'
  3872. required: true
  3873. deprecated: false
  3874. allowEmptyValue: false
  3875. schema:
  3876. type: string
  3877. style: simple
  3878. explode: false
  3879. allowReserved: false
  3880. deprecated: false
  3881. delete:
  3882. operationId: api_user_products_id_delete
  3883. tags:
  3884. - UserProduct
  3885. responses:
  3886. 204:
  3887. description: 'UserProduct resource deleted'
  3888. 404:
  3889. description: 'Resource not found'
  3890. summary: 'Removes the UserProduct resource.'
  3891. description: 'Removes the UserProduct resource.'
  3892. parameters:
  3893. -
  3894. name: id
  3895. in: path
  3896. description: 'UserProduct identifier'
  3897. required: true
  3898. deprecated: false
  3899. allowEmptyValue: false
  3900. schema:
  3901. type: string
  3902. style: simple
  3903. explode: false
  3904. allowReserved: false
  3905. deprecated: false
  3906. parameters: []
  3907. /api/users:
  3908. get:
  3909. operationId: api_users_get_collection
  3910. tags:
  3911. - User
  3912. responses:
  3913. 200:
  3914. description: 'User collection'
  3915. content:
  3916. application/ld+json:
  3917. schema:
  3918. type: object
  3919. properties:
  3920. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  3921. 'hydra:totalItems': { type: integer, minimum: 0 }
  3922. '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 } }
  3923. '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 } } } } } }
  3924. required:
  3925. - 'hydra:member'
  3926. application/json:
  3927. schema:
  3928. type: array
  3929. items:
  3930. $ref: '#/components/schemas/User'
  3931. text/html:
  3932. schema:
  3933. type: array
  3934. items:
  3935. $ref: '#/components/schemas/User'
  3936. application/hal+json:
  3937. schema:
  3938. type: object
  3939. properties:
  3940. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  3941. totalItems: { type: integer, minimum: 0 }
  3942. itemsPerPage: { type: integer, minimum: 0 }
  3943. _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 } } } } }
  3944. required:
  3945. - _links
  3946. - _embedded
  3947. summary: 'Retrieves the collection of User resources.'
  3948. description: 'Retrieves the collection of User resources.'
  3949. parameters:
  3950. -
  3951. name: page
  3952. in: query
  3953. description: 'The collection page number'
  3954. required: false
  3955. deprecated: false
  3956. allowEmptyValue: true
  3957. schema:
  3958. type: integer
  3959. default: 1
  3960. style: form
  3961. explode: false
  3962. allowReserved: false
  3963. -
  3964. name: itemsPerPage
  3965. in: query
  3966. description: 'The number of items per page'
  3967. required: false
  3968. deprecated: false
  3969. allowEmptyValue: true
  3970. schema:
  3971. type: integer
  3972. default: 10
  3973. minimum: 0
  3974. maximum: 50
  3975. style: form
  3976. explode: false
  3977. allowReserved: false
  3978. -
  3979. name: firstName
  3980. in: query
  3981. description: ''
  3982. required: false
  3983. deprecated: false
  3984. allowEmptyValue: true
  3985. schema:
  3986. type: string
  3987. style: form
  3988. explode: false
  3989. allowReserved: false
  3990. -
  3991. name: lastName
  3992. in: query
  3993. description: ''
  3994. required: false
  3995. deprecated: false
  3996. allowEmptyValue: true
  3997. schema:
  3998. type: string
  3999. style: form
  4000. explode: false
  4001. allowReserved: false
  4002. deprecated: false
  4003. post:
  4004. operationId: api_users_post
  4005. tags:
  4006. - User
  4007. responses:
  4008. 201:
  4009. description: 'User resource created'
  4010. content:
  4011. application/ld+json:
  4012. schema:
  4013. $ref: '#/components/schemas/User.jsonld'
  4014. application/json:
  4015. schema:
  4016. $ref: '#/components/schemas/User'
  4017. text/html:
  4018. schema:
  4019. $ref: '#/components/schemas/User'
  4020. application/hal+json:
  4021. schema:
  4022. $ref: '#/components/schemas/User.jsonhal'
  4023. links: { }
  4024. 400:
  4025. description: 'Invalid input'
  4026. 422:
  4027. description: 'Unprocessable entity'
  4028. summary: 'Creates a User resource.'
  4029. description: 'Creates a User resource.'
  4030. parameters: []
  4031. requestBody:
  4032. description: 'The new User resource'
  4033. content:
  4034. application/ld+json:
  4035. schema:
  4036. $ref: '#/components/schemas/User.jsonld'
  4037. application/json:
  4038. schema:
  4039. $ref: '#/components/schemas/User'
  4040. text/html:
  4041. schema:
  4042. $ref: '#/components/schemas/User'
  4043. application/hal+json:
  4044. schema:
  4045. $ref: '#/components/schemas/User.jsonhal'
  4046. required: true
  4047. deprecated: false
  4048. parameters: []
  4049. '/api/users/{id}':
  4050. get:
  4051. operationId: api_users_id_get
  4052. tags:
  4053. - User
  4054. responses:
  4055. 200:
  4056. description: 'User resource'
  4057. content:
  4058. application/ld+json:
  4059. schema:
  4060. $ref: '#/components/schemas/User.jsonld'
  4061. application/json:
  4062. schema:
  4063. $ref: '#/components/schemas/User'
  4064. text/html:
  4065. schema:
  4066. $ref: '#/components/schemas/User'
  4067. application/hal+json:
  4068. schema:
  4069. $ref: '#/components/schemas/User.jsonhal'
  4070. 404:
  4071. description: 'Resource not found'
  4072. summary: 'Retrieves a User resource.'
  4073. description: 'Retrieves a User resource.'
  4074. parameters:
  4075. -
  4076. name: id
  4077. in: path
  4078. description: 'User identifier'
  4079. required: true
  4080. deprecated: false
  4081. allowEmptyValue: false
  4082. schema:
  4083. type: string
  4084. style: simple
  4085. explode: false
  4086. allowReserved: false
  4087. deprecated: false
  4088. parameters: []
  4089. /auth:
  4090. post:
  4091. operationId: login_check_post
  4092. tags:
  4093. - 'Login Check'
  4094. responses:
  4095. 200:
  4096. description: 'User token created'
  4097. content:
  4098. application/json:
  4099. schema:
  4100. type: object
  4101. properties:
  4102. token: { readOnly: true, type: string, nullable: false }
  4103. required:
  4104. - token
  4105. summary: 'Creates a user token.'
  4106. description: 'Creates a user token.'
  4107. requestBody:
  4108. description: 'The login data'
  4109. content:
  4110. application/json:
  4111. schema:
  4112. type: object
  4113. properties:
  4114. email:
  4115. type: string
  4116. nullable: false
  4117. password:
  4118. type: string
  4119. nullable: false
  4120. required:
  4121. - email
  4122. - password
  4123. required: true
  4124. parameters: []
  4125. components:
  4126. schemas:
  4127. Comment:
  4128. type: object
  4129. description: ''
  4130. deprecated: false
  4131. required:
  4132. - message
  4133. properties:
  4134. message:
  4135. type:
  4136. - string
  4137. - 'null'
  4138. owner:
  4139. readOnly: true
  4140. description: '?UserApi'
  4141. $ref: '#/components/schemas/User'
  4142. postIri:
  4143. type:
  4144. - string
  4145. - 'null'
  4146. format: iri-reference
  4147. example: 'https://example.com/'
  4148. createdAt:
  4149. readOnly: true
  4150. type:
  4151. - string
  4152. - 'null'
  4153. format: date-time
  4154. Comment.jsonhal:
  4155. type: object
  4156. description: ''
  4157. deprecated: false
  4158. required:
  4159. - message
  4160. properties:
  4161. _links:
  4162. type: object
  4163. properties:
  4164. self:
  4165. type: object
  4166. properties:
  4167. href:
  4168. type: string
  4169. format: iri-reference
  4170. message:
  4171. type:
  4172. - string
  4173. - 'null'
  4174. owner:
  4175. readOnly: true
  4176. description: '?UserApi'
  4177. $ref: '#/components/schemas/User.jsonhal'
  4178. postIri:
  4179. type:
  4180. - string
  4181. - 'null'
  4182. format: iri-reference
  4183. example: 'https://example.com/'
  4184. createdAt:
  4185. readOnly: true
  4186. type:
  4187. - string
  4188. - 'null'
  4189. format: date-time
  4190. Comment.jsonld:
  4191. type: object
  4192. description: ''
  4193. deprecated: false
  4194. required:
  4195. - message
  4196. properties:
  4197. '@context':
  4198. readOnly: true
  4199. oneOf:
  4200. -
  4201. type: string
  4202. -
  4203. type: object
  4204. properties:
  4205. '@vocab':
  4206. type: string
  4207. hydra:
  4208. type: string
  4209. enum: ['http://www.w3.org/ns/hydra/core#']
  4210. required:
  4211. - '@vocab'
  4212. - hydra
  4213. additionalProperties: true
  4214. '@id':
  4215. readOnly: true
  4216. type: string
  4217. '@type':
  4218. readOnly: true
  4219. type: string
  4220. message:
  4221. type:
  4222. - string
  4223. - 'null'
  4224. owner:
  4225. readOnly: true
  4226. description: '?UserApi'
  4227. $ref: '#/components/schemas/User.jsonld'
  4228. postIri:
  4229. type:
  4230. - string
  4231. - 'null'
  4232. format: iri-reference
  4233. example: 'https://example.com/'
  4234. createdAt:
  4235. readOnly: true
  4236. type:
  4237. - string
  4238. - 'null'
  4239. format: date-time
  4240. Contact:
  4241. type: object
  4242. description: ''
  4243. deprecated: false
  4244. required:
  4245. - firstName
  4246. - lastName
  4247. - partnerIri
  4248. properties:
  4249. firstName:
  4250. type:
  4251. - string
  4252. - 'null'
  4253. lastName:
  4254. type:
  4255. - string
  4256. - 'null'
  4257. fullName:
  4258. type:
  4259. - string
  4260. - 'null'
  4261. partner:
  4262. readOnly: true
  4263. description: '?PartnerApi'
  4264. $ref: '#/components/schemas/Partner'
  4265. partnerIri:
  4266. type:
  4267. - string
  4268. - 'null'
  4269. format: iri-reference
  4270. example: 'https://example.com/'
  4271. birthday:
  4272. type:
  4273. - string
  4274. - 'null'
  4275. format: date-time
  4276. image:
  4277. type:
  4278. - string
  4279. - 'null'
  4280. format: iri-reference
  4281. example: 'https://example.com/'
  4282. imageUrl:
  4283. readOnly: true
  4284. type:
  4285. - string
  4286. - 'null'
  4287. position:
  4288. type:
  4289. - string
  4290. - 'null'
  4291. phone:
  4292. type:
  4293. - string
  4294. - 'null'
  4295. email:
  4296. format: email
  4297. externalDocs:
  4298. url: 'https://schema.org/email'
  4299. type:
  4300. - string
  4301. - 'null'
  4302. posts:
  4303. readOnly: true
  4304. type: array
  4305. items:
  4306. type: string
  4307. format: iri-reference
  4308. example: 'https://example.com/'
  4309. createdBy:
  4310. readOnly: true
  4311. description: '?UserApi'
  4312. $ref: '#/components/schemas/User'
  4313. createdAt:
  4314. readOnly: true
  4315. type:
  4316. - string
  4317. - 'null'
  4318. format: date-time
  4319. Contact.jsonhal:
  4320. type: object
  4321. description: ''
  4322. deprecated: false
  4323. required:
  4324. - firstName
  4325. - lastName
  4326. - partnerIri
  4327. properties:
  4328. _links:
  4329. type: object
  4330. properties:
  4331. self:
  4332. type: object
  4333. properties:
  4334. href:
  4335. type: string
  4336. format: iri-reference
  4337. firstName:
  4338. type:
  4339. - string
  4340. - 'null'
  4341. lastName:
  4342. type:
  4343. - string
  4344. - 'null'
  4345. fullName:
  4346. type:
  4347. - string
  4348. - 'null'
  4349. partner:
  4350. readOnly: true
  4351. description: '?PartnerApi'
  4352. $ref: '#/components/schemas/Partner.jsonhal'
  4353. partnerIri:
  4354. type:
  4355. - string
  4356. - 'null'
  4357. format: iri-reference
  4358. example: 'https://example.com/'
  4359. birthday:
  4360. type:
  4361. - string
  4362. - 'null'
  4363. format: date-time
  4364. image:
  4365. type:
  4366. - string
  4367. - 'null'
  4368. format: iri-reference
  4369. example: 'https://example.com/'
  4370. imageUrl:
  4371. readOnly: true
  4372. type:
  4373. - string
  4374. - 'null'
  4375. position:
  4376. type:
  4377. - string
  4378. - 'null'
  4379. phone:
  4380. type:
  4381. - string
  4382. - 'null'
  4383. email:
  4384. format: email
  4385. externalDocs:
  4386. url: 'https://schema.org/email'
  4387. type:
  4388. - string
  4389. - 'null'
  4390. posts:
  4391. readOnly: true
  4392. type: array
  4393. items:
  4394. type: string
  4395. format: iri-reference
  4396. example: 'https://example.com/'
  4397. createdBy:
  4398. readOnly: true
  4399. description: '?UserApi'
  4400. $ref: '#/components/schemas/User.jsonhal'
  4401. createdAt:
  4402. readOnly: true
  4403. type:
  4404. - string
  4405. - 'null'
  4406. format: date-time
  4407. Contact.jsonld:
  4408. type: object
  4409. description: ''
  4410. deprecated: false
  4411. required:
  4412. - firstName
  4413. - lastName
  4414. - partnerIri
  4415. properties:
  4416. '@context':
  4417. readOnly: true
  4418. oneOf:
  4419. -
  4420. type: string
  4421. -
  4422. type: object
  4423. properties:
  4424. '@vocab':
  4425. type: string
  4426. hydra:
  4427. type: string
  4428. enum: ['http://www.w3.org/ns/hydra/core#']
  4429. required:
  4430. - '@vocab'
  4431. - hydra
  4432. additionalProperties: true
  4433. '@id':
  4434. readOnly: true
  4435. type: string
  4436. '@type':
  4437. readOnly: true
  4438. type: string
  4439. firstName:
  4440. type:
  4441. - string
  4442. - 'null'
  4443. lastName:
  4444. type:
  4445. - string
  4446. - 'null'
  4447. fullName:
  4448. type:
  4449. - string
  4450. - 'null'
  4451. partner:
  4452. readOnly: true
  4453. description: '?PartnerApi'
  4454. $ref: '#/components/schemas/Partner.jsonld'
  4455. partnerIri:
  4456. type:
  4457. - string
  4458. - 'null'
  4459. format: iri-reference
  4460. example: 'https://example.com/'
  4461. birthday:
  4462. type:
  4463. - string
  4464. - 'null'
  4465. format: date-time
  4466. image:
  4467. type:
  4468. - string
  4469. - 'null'
  4470. format: iri-reference
  4471. example: 'https://example.com/'
  4472. imageUrl:
  4473. readOnly: true
  4474. type:
  4475. - string
  4476. - 'null'
  4477. position:
  4478. type:
  4479. - string
  4480. - 'null'
  4481. phone:
  4482. type:
  4483. - string
  4484. - 'null'
  4485. email:
  4486. format: email
  4487. externalDocs:
  4488. url: 'https://schema.org/email'
  4489. type:
  4490. - string
  4491. - 'null'
  4492. posts:
  4493. readOnly: true
  4494. type: array
  4495. items:
  4496. type: string
  4497. format: iri-reference
  4498. example: 'https://example.com/'
  4499. createdBy:
  4500. readOnly: true
  4501. description: '?UserApi'
  4502. $ref: '#/components/schemas/User.jsonld'
  4503. createdAt:
  4504. readOnly: true
  4505. type:
  4506. - string
  4507. - 'null'
  4508. format: date-time
  4509. ContactPartnerProduct:
  4510. type: object
  4511. description: ''
  4512. deprecated: false
  4513. required:
  4514. - contactIri
  4515. - partnerProductIri
  4516. properties:
  4517. contactIri:
  4518. type:
  4519. - string
  4520. - 'null'
  4521. format: iri-reference
  4522. example: 'https://example.com/'
  4523. partnerProductIri:
  4524. type:
  4525. - string
  4526. - 'null'
  4527. format: iri-reference
  4528. example: 'https://example.com/'
  4529. partnerProduct:
  4530. readOnly: true
  4531. description: '?PartnerProduct'
  4532. $ref: '#/components/schemas/PartnerProduct'
  4533. product:
  4534. readOnly: true
  4535. description: '?ProductApi'
  4536. $ref: '#/components/schemas/Product'
  4537. createdAt:
  4538. readOnly: true
  4539. type:
  4540. - string
  4541. - 'null'
  4542. format: date-time
  4543. ContactPartnerProduct.jsonhal:
  4544. type: object
  4545. description: ''
  4546. deprecated: false
  4547. required:
  4548. - contactIri
  4549. - partnerProductIri
  4550. properties:
  4551. _links:
  4552. type: object
  4553. properties:
  4554. self:
  4555. type: object
  4556. properties:
  4557. href:
  4558. type: string
  4559. format: iri-reference
  4560. contactIri:
  4561. type:
  4562. - string
  4563. - 'null'
  4564. format: iri-reference
  4565. example: 'https://example.com/'
  4566. partnerProductIri:
  4567. type:
  4568. - string
  4569. - 'null'
  4570. format: iri-reference
  4571. example: 'https://example.com/'
  4572. partnerProduct:
  4573. readOnly: true
  4574. description: '?PartnerProduct'
  4575. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  4576. product:
  4577. readOnly: true
  4578. description: '?ProductApi'
  4579. $ref: '#/components/schemas/Product.jsonhal'
  4580. createdAt:
  4581. readOnly: true
  4582. type:
  4583. - string
  4584. - 'null'
  4585. format: date-time
  4586. ContactPartnerProduct.jsonld:
  4587. type: object
  4588. description: ''
  4589. deprecated: false
  4590. required:
  4591. - contactIri
  4592. - partnerProductIri
  4593. properties:
  4594. '@context':
  4595. readOnly: true
  4596. oneOf:
  4597. -
  4598. type: string
  4599. -
  4600. type: object
  4601. properties:
  4602. '@vocab':
  4603. type: string
  4604. hydra:
  4605. type: string
  4606. enum: ['http://www.w3.org/ns/hydra/core#']
  4607. required:
  4608. - '@vocab'
  4609. - hydra
  4610. additionalProperties: true
  4611. '@id':
  4612. readOnly: true
  4613. type: string
  4614. '@type':
  4615. readOnly: true
  4616. type: string
  4617. contactIri:
  4618. type:
  4619. - string
  4620. - 'null'
  4621. format: iri-reference
  4622. example: 'https://example.com/'
  4623. partnerProductIri:
  4624. type:
  4625. - string
  4626. - 'null'
  4627. format: iri-reference
  4628. example: 'https://example.com/'
  4629. partnerProduct:
  4630. readOnly: true
  4631. description: '?PartnerProduct'
  4632. $ref: '#/components/schemas/PartnerProduct.jsonld'
  4633. product:
  4634. readOnly: true
  4635. description: '?ProductApi'
  4636. $ref: '#/components/schemas/Product.jsonld'
  4637. createdAt:
  4638. readOnly: true
  4639. type:
  4640. - string
  4641. - 'null'
  4642. format: date-time
  4643. Document:
  4644. type: object
  4645. description: ''
  4646. deprecated: false
  4647. required:
  4648. - name
  4649. - documentObject
  4650. properties:
  4651. name:
  4652. type:
  4653. - string
  4654. - 'null'
  4655. description:
  4656. type:
  4657. - string
  4658. - 'null'
  4659. partner:
  4660. readOnly: true
  4661. description: '?PartnerApi'
  4662. $ref: '#/components/schemas/Partner'
  4663. partnerIri:
  4664. type:
  4665. - string
  4666. - 'null'
  4667. format: iri-reference
  4668. example: 'https://example.com/'
  4669. product:
  4670. readOnly: true
  4671. description: '?ProductApi'
  4672. $ref: '#/components/schemas/Product'
  4673. productIri:
  4674. type:
  4675. - string
  4676. - 'null'
  4677. format: iri-reference
  4678. example: 'https://example.com/'
  4679. documentObject:
  4680. type:
  4681. - string
  4682. - 'null'
  4683. format: iri-reference
  4684. example: 'https://example.com/'
  4685. documentUrl:
  4686. readOnly: true
  4687. type:
  4688. - string
  4689. - 'null'
  4690. createdBy:
  4691. readOnly: true
  4692. description: '?UserApi'
  4693. $ref: '#/components/schemas/User'
  4694. createdAt:
  4695. readOnly: true
  4696. type:
  4697. - string
  4698. - 'null'
  4699. format: date-time
  4700. Document.jsonhal:
  4701. type: object
  4702. description: ''
  4703. deprecated: false
  4704. required:
  4705. - name
  4706. - documentObject
  4707. properties:
  4708. _links:
  4709. type: object
  4710. properties:
  4711. self:
  4712. type: object
  4713. properties:
  4714. href:
  4715. type: string
  4716. format: iri-reference
  4717. name:
  4718. type:
  4719. - string
  4720. - 'null'
  4721. description:
  4722. type:
  4723. - string
  4724. - 'null'
  4725. partner:
  4726. readOnly: true
  4727. description: '?PartnerApi'
  4728. $ref: '#/components/schemas/Partner.jsonhal'
  4729. partnerIri:
  4730. type:
  4731. - string
  4732. - 'null'
  4733. format: iri-reference
  4734. example: 'https://example.com/'
  4735. product:
  4736. readOnly: true
  4737. description: '?ProductApi'
  4738. $ref: '#/components/schemas/Product.jsonhal'
  4739. productIri:
  4740. type:
  4741. - string
  4742. - 'null'
  4743. format: iri-reference
  4744. example: 'https://example.com/'
  4745. documentObject:
  4746. type:
  4747. - string
  4748. - 'null'
  4749. format: iri-reference
  4750. example: 'https://example.com/'
  4751. documentUrl:
  4752. readOnly: true
  4753. type:
  4754. - string
  4755. - 'null'
  4756. createdBy:
  4757. readOnly: true
  4758. description: '?UserApi'
  4759. $ref: '#/components/schemas/User.jsonhal'
  4760. createdAt:
  4761. readOnly: true
  4762. type:
  4763. - string
  4764. - 'null'
  4765. format: date-time
  4766. Document.jsonld:
  4767. type: object
  4768. description: ''
  4769. deprecated: false
  4770. required:
  4771. - name
  4772. - documentObject
  4773. properties:
  4774. '@context':
  4775. readOnly: true
  4776. oneOf:
  4777. -
  4778. type: string
  4779. -
  4780. type: object
  4781. properties:
  4782. '@vocab':
  4783. type: string
  4784. hydra:
  4785. type: string
  4786. enum: ['http://www.w3.org/ns/hydra/core#']
  4787. required:
  4788. - '@vocab'
  4789. - hydra
  4790. additionalProperties: true
  4791. '@id':
  4792. readOnly: true
  4793. type: string
  4794. '@type':
  4795. readOnly: true
  4796. type: string
  4797. name:
  4798. type:
  4799. - string
  4800. - 'null'
  4801. description:
  4802. type:
  4803. - string
  4804. - 'null'
  4805. partner:
  4806. readOnly: true
  4807. description: '?PartnerApi'
  4808. $ref: '#/components/schemas/Partner.jsonld'
  4809. partnerIri:
  4810. type:
  4811. - string
  4812. - 'null'
  4813. format: iri-reference
  4814. example: 'https://example.com/'
  4815. product:
  4816. readOnly: true
  4817. description: '?ProductApi'
  4818. $ref: '#/components/schemas/Product.jsonld'
  4819. productIri:
  4820. type:
  4821. - string
  4822. - 'null'
  4823. format: iri-reference
  4824. example: 'https://example.com/'
  4825. documentObject:
  4826. type:
  4827. - string
  4828. - 'null'
  4829. format: iri-reference
  4830. example: 'https://example.com/'
  4831. documentUrl:
  4832. readOnly: true
  4833. type:
  4834. - string
  4835. - 'null'
  4836. createdBy:
  4837. readOnly: true
  4838. description: '?UserApi'
  4839. $ref: '#/components/schemas/User.jsonld'
  4840. createdAt:
  4841. readOnly: true
  4842. type:
  4843. - string
  4844. - 'null'
  4845. format: date-time
  4846. DocumentObject-document_object.read:
  4847. type: object
  4848. description: ''
  4849. deprecated: false
  4850. externalDocs:
  4851. url: 'https://schema.org/MediaObject'
  4852. properties:
  4853. contentUrl:
  4854. externalDocs:
  4855. url: 'https://schema.org/contentUrl'
  4856. type:
  4857. - string
  4858. - 'null'
  4859. DocumentObject.jsonhal-document_object.read:
  4860. type: object
  4861. description: ''
  4862. deprecated: false
  4863. externalDocs:
  4864. url: 'https://schema.org/MediaObject'
  4865. properties:
  4866. _links:
  4867. type: object
  4868. properties:
  4869. self:
  4870. type: object
  4871. properties:
  4872. href:
  4873. type: string
  4874. format: iri-reference
  4875. contentUrl:
  4876. externalDocs:
  4877. url: 'https://schema.org/contentUrl'
  4878. type:
  4879. - string
  4880. - 'null'
  4881. DocumentObject.jsonld-document_object.read:
  4882. type: object
  4883. description: ''
  4884. deprecated: false
  4885. externalDocs:
  4886. url: 'https://schema.org/MediaObject'
  4887. properties:
  4888. '@context':
  4889. readOnly: true
  4890. oneOf:
  4891. -
  4892. type: string
  4893. -
  4894. type: object
  4895. properties:
  4896. '@vocab':
  4897. type: string
  4898. hydra:
  4899. type: string
  4900. enum: ['http://www.w3.org/ns/hydra/core#']
  4901. required:
  4902. - '@vocab'
  4903. - hydra
  4904. additionalProperties: true
  4905. '@id':
  4906. readOnly: true
  4907. type: string
  4908. '@type':
  4909. readOnly: true
  4910. type: string
  4911. contentUrl:
  4912. externalDocs:
  4913. url: 'https://schema.org/contentUrl'
  4914. type:
  4915. - string
  4916. - 'null'
  4917. MediaObject-media_object.read:
  4918. type: object
  4919. description: ''
  4920. deprecated: false
  4921. externalDocs:
  4922. url: 'https://schema.org/MediaObject'
  4923. properties:
  4924. contentUrl:
  4925. externalDocs:
  4926. url: 'https://schema.org/contentUrl'
  4927. type:
  4928. - string
  4929. - 'null'
  4930. MediaObject.jsonhal-media_object.read:
  4931. type: object
  4932. description: ''
  4933. deprecated: false
  4934. externalDocs:
  4935. url: 'https://schema.org/MediaObject'
  4936. properties:
  4937. _links:
  4938. type: object
  4939. properties:
  4940. self:
  4941. type: object
  4942. properties:
  4943. href:
  4944. type: string
  4945. format: iri-reference
  4946. contentUrl:
  4947. externalDocs:
  4948. url: 'https://schema.org/contentUrl'
  4949. type:
  4950. - string
  4951. - 'null'
  4952. MediaObject.jsonld-media_object.read:
  4953. type: object
  4954. description: ''
  4955. deprecated: false
  4956. externalDocs:
  4957. url: 'https://schema.org/MediaObject'
  4958. properties:
  4959. '@context':
  4960. readOnly: true
  4961. oneOf:
  4962. -
  4963. type: string
  4964. -
  4965. type: object
  4966. properties:
  4967. '@vocab':
  4968. type: string
  4969. hydra:
  4970. type: string
  4971. enum: ['http://www.w3.org/ns/hydra/core#']
  4972. required:
  4973. - '@vocab'
  4974. - hydra
  4975. additionalProperties: true
  4976. '@id':
  4977. readOnly: true
  4978. type: string
  4979. '@type':
  4980. readOnly: true
  4981. type: string
  4982. contentUrl:
  4983. externalDocs:
  4984. url: 'https://schema.org/contentUrl'
  4985. type:
  4986. - string
  4987. - 'null'
  4988. Partner:
  4989. type: object
  4990. description: ''
  4991. deprecated: false
  4992. required:
  4993. - name
  4994. - partnerType
  4995. properties:
  4996. name:
  4997. type: string
  4998. partnerType:
  4999. type: string
  5000. enum:
  5001. - customer
  5002. - supplier
  5003. - service
  5004. description:
  5005. type:
  5006. - string
  5007. - 'null'
  5008. street:
  5009. type:
  5010. - string
  5011. - 'null'
  5012. streetNo:
  5013. type:
  5014. - string
  5015. - 'null'
  5016. zip:
  5017. type:
  5018. - string
  5019. - 'null'
  5020. city:
  5021. type:
  5022. - string
  5023. - 'null'
  5024. country:
  5025. type:
  5026. - string
  5027. - 'null'
  5028. website:
  5029. type:
  5030. - string
  5031. - 'null'
  5032. logo:
  5033. type:
  5034. - string
  5035. - 'null'
  5036. format: iri-reference
  5037. example: 'https://example.com/'
  5038. logoUrl:
  5039. readOnly: true
  5040. type:
  5041. - string
  5042. - 'null'
  5043. createdByIri:
  5044. readOnly: true
  5045. type:
  5046. - string
  5047. - 'null'
  5048. format: iri-reference
  5049. example: 'https://example.com/'
  5050. createdAt:
  5051. readOnly: true
  5052. type:
  5053. - string
  5054. - 'null'
  5055. format: date-time
  5056. Partner.jsonhal:
  5057. type: object
  5058. description: ''
  5059. deprecated: false
  5060. required:
  5061. - name
  5062. - partnerType
  5063. properties:
  5064. _links:
  5065. type: object
  5066. properties:
  5067. self:
  5068. type: object
  5069. properties:
  5070. href:
  5071. type: string
  5072. format: iri-reference
  5073. name:
  5074. type: string
  5075. partnerType:
  5076. type: string
  5077. enum:
  5078. - customer
  5079. - supplier
  5080. - service
  5081. description:
  5082. type:
  5083. - string
  5084. - 'null'
  5085. street:
  5086. type:
  5087. - string
  5088. - 'null'
  5089. streetNo:
  5090. type:
  5091. - string
  5092. - 'null'
  5093. zip:
  5094. type:
  5095. - string
  5096. - 'null'
  5097. city:
  5098. type:
  5099. - string
  5100. - 'null'
  5101. country:
  5102. type:
  5103. - string
  5104. - 'null'
  5105. website:
  5106. type:
  5107. - string
  5108. - 'null'
  5109. logo:
  5110. type:
  5111. - string
  5112. - 'null'
  5113. format: iri-reference
  5114. example: 'https://example.com/'
  5115. logoUrl:
  5116. readOnly: true
  5117. type:
  5118. - string
  5119. - 'null'
  5120. createdByIri:
  5121. readOnly: true
  5122. type:
  5123. - string
  5124. - 'null'
  5125. format: iri-reference
  5126. example: 'https://example.com/'
  5127. createdAt:
  5128. readOnly: true
  5129. type:
  5130. - string
  5131. - 'null'
  5132. format: date-time
  5133. Partner.jsonld:
  5134. type: object
  5135. description: ''
  5136. deprecated: false
  5137. required:
  5138. - name
  5139. - partnerType
  5140. properties:
  5141. '@context':
  5142. readOnly: true
  5143. oneOf:
  5144. -
  5145. type: string
  5146. -
  5147. type: object
  5148. properties:
  5149. '@vocab':
  5150. type: string
  5151. hydra:
  5152. type: string
  5153. enum: ['http://www.w3.org/ns/hydra/core#']
  5154. required:
  5155. - '@vocab'
  5156. - hydra
  5157. additionalProperties: true
  5158. '@id':
  5159. readOnly: true
  5160. type: string
  5161. '@type':
  5162. readOnly: true
  5163. type: string
  5164. name:
  5165. type: string
  5166. partnerType:
  5167. type: string
  5168. enum:
  5169. - customer
  5170. - supplier
  5171. - service
  5172. description:
  5173. type:
  5174. - string
  5175. - 'null'
  5176. street:
  5177. type:
  5178. - string
  5179. - 'null'
  5180. streetNo:
  5181. type:
  5182. - string
  5183. - 'null'
  5184. zip:
  5185. type:
  5186. - string
  5187. - 'null'
  5188. city:
  5189. type:
  5190. - string
  5191. - 'null'
  5192. country:
  5193. type:
  5194. - string
  5195. - 'null'
  5196. website:
  5197. type:
  5198. - string
  5199. - 'null'
  5200. logo:
  5201. type:
  5202. - string
  5203. - 'null'
  5204. format: iri-reference
  5205. example: 'https://example.com/'
  5206. logoUrl:
  5207. readOnly: true
  5208. type:
  5209. - string
  5210. - 'null'
  5211. createdByIri:
  5212. readOnly: true
  5213. type:
  5214. - string
  5215. - 'null'
  5216. format: iri-reference
  5217. example: 'https://example.com/'
  5218. createdAt:
  5219. readOnly: true
  5220. type:
  5221. - string
  5222. - 'null'
  5223. format: date-time
  5224. PartnerFollow:
  5225. type: object
  5226. description: ''
  5227. deprecated: false
  5228. properties:
  5229. userIri:
  5230. type:
  5231. - string
  5232. - 'null'
  5233. format: iri-reference
  5234. example: 'https://example.com/'
  5235. partner:
  5236. readOnly: true
  5237. description: '?PartnerApi'
  5238. $ref: '#/components/schemas/Partner'
  5239. partnerIri:
  5240. type:
  5241. - string
  5242. - 'null'
  5243. format: iri-reference
  5244. example: 'https://example.com/'
  5245. createdAt:
  5246. readOnly: true
  5247. type:
  5248. - string
  5249. - 'null'
  5250. format: date-time
  5251. owner:
  5252. readOnly: true
  5253. type:
  5254. - string
  5255. - 'null'
  5256. format: iri-reference
  5257. example: 'https://example.com/'
  5258. required:
  5259. - partnerIri
  5260. PartnerFollow.jsonhal:
  5261. type: object
  5262. description: ''
  5263. deprecated: false
  5264. properties:
  5265. _links:
  5266. type: object
  5267. properties:
  5268. self:
  5269. type: object
  5270. properties:
  5271. href:
  5272. type: string
  5273. format: iri-reference
  5274. userIri:
  5275. type:
  5276. - string
  5277. - 'null'
  5278. format: iri-reference
  5279. example: 'https://example.com/'
  5280. partner:
  5281. readOnly: true
  5282. description: '?PartnerApi'
  5283. $ref: '#/components/schemas/Partner.jsonhal'
  5284. partnerIri:
  5285. type:
  5286. - string
  5287. - 'null'
  5288. format: iri-reference
  5289. example: 'https://example.com/'
  5290. createdAt:
  5291. readOnly: true
  5292. type:
  5293. - string
  5294. - 'null'
  5295. format: date-time
  5296. owner:
  5297. readOnly: true
  5298. type:
  5299. - string
  5300. - 'null'
  5301. format: iri-reference
  5302. example: 'https://example.com/'
  5303. required:
  5304. - partnerIri
  5305. PartnerFollow.jsonld:
  5306. type: object
  5307. description: ''
  5308. deprecated: false
  5309. properties:
  5310. '@context':
  5311. readOnly: true
  5312. oneOf:
  5313. -
  5314. type: string
  5315. -
  5316. type: object
  5317. properties:
  5318. '@vocab':
  5319. type: string
  5320. hydra:
  5321. type: string
  5322. enum: ['http://www.w3.org/ns/hydra/core#']
  5323. required:
  5324. - '@vocab'
  5325. - hydra
  5326. additionalProperties: true
  5327. '@id':
  5328. readOnly: true
  5329. type: string
  5330. '@type':
  5331. readOnly: true
  5332. type: string
  5333. userIri:
  5334. type:
  5335. - string
  5336. - 'null'
  5337. format: iri-reference
  5338. example: 'https://example.com/'
  5339. partner:
  5340. readOnly: true
  5341. description: '?PartnerApi'
  5342. $ref: '#/components/schemas/Partner.jsonld'
  5343. partnerIri:
  5344. type:
  5345. - string
  5346. - 'null'
  5347. format: iri-reference
  5348. example: 'https://example.com/'
  5349. createdAt:
  5350. readOnly: true
  5351. type:
  5352. - string
  5353. - 'null'
  5354. format: date-time
  5355. owner:
  5356. readOnly: true
  5357. type:
  5358. - string
  5359. - 'null'
  5360. format: iri-reference
  5361. example: 'https://example.com/'
  5362. required:
  5363. - partnerIri
  5364. PartnerProduct:
  5365. type: object
  5366. description: ''
  5367. deprecated: false
  5368. properties:
  5369. partner:
  5370. readOnly: true
  5371. description: '?PartnerApi'
  5372. $ref: '#/components/schemas/Partner'
  5373. partnerIri:
  5374. type:
  5375. - string
  5376. - 'null'
  5377. format: iri-reference
  5378. example: 'https://example.com/'
  5379. product:
  5380. readOnly: true
  5381. description: '?ProductApi'
  5382. $ref: '#/components/schemas/Product'
  5383. productIri:
  5384. type:
  5385. - string
  5386. - 'null'
  5387. format: iri-reference
  5388. example: 'https://example.com/'
  5389. createdAt:
  5390. readOnly: true
  5391. type:
  5392. - string
  5393. - 'null'
  5394. format: date-time
  5395. required:
  5396. - partnerIri
  5397. - productIri
  5398. PartnerProduct.jsonhal:
  5399. type: object
  5400. description: ''
  5401. deprecated: false
  5402. properties:
  5403. _links:
  5404. type: object
  5405. properties:
  5406. self:
  5407. type: object
  5408. properties:
  5409. href:
  5410. type: string
  5411. format: iri-reference
  5412. partner:
  5413. readOnly: true
  5414. description: '?PartnerApi'
  5415. $ref: '#/components/schemas/Partner.jsonhal'
  5416. partnerIri:
  5417. type:
  5418. - string
  5419. - 'null'
  5420. format: iri-reference
  5421. example: 'https://example.com/'
  5422. product:
  5423. readOnly: true
  5424. description: '?ProductApi'
  5425. $ref: '#/components/schemas/Product.jsonhal'
  5426. productIri:
  5427. type:
  5428. - string
  5429. - 'null'
  5430. format: iri-reference
  5431. example: 'https://example.com/'
  5432. createdAt:
  5433. readOnly: true
  5434. type:
  5435. - string
  5436. - 'null'
  5437. format: date-time
  5438. required:
  5439. - partnerIri
  5440. - productIri
  5441. PartnerProduct.jsonld:
  5442. type: object
  5443. description: ''
  5444. deprecated: false
  5445. properties:
  5446. '@context':
  5447. readOnly: true
  5448. oneOf:
  5449. -
  5450. type: string
  5451. -
  5452. type: object
  5453. properties:
  5454. '@vocab':
  5455. type: string
  5456. hydra:
  5457. type: string
  5458. enum: ['http://www.w3.org/ns/hydra/core#']
  5459. required:
  5460. - '@vocab'
  5461. - hydra
  5462. additionalProperties: true
  5463. '@id':
  5464. readOnly: true
  5465. type: string
  5466. '@type':
  5467. readOnly: true
  5468. type: string
  5469. partner:
  5470. readOnly: true
  5471. description: '?PartnerApi'
  5472. $ref: '#/components/schemas/Partner.jsonld'
  5473. partnerIri:
  5474. type:
  5475. - string
  5476. - 'null'
  5477. format: iri-reference
  5478. example: 'https://example.com/'
  5479. product:
  5480. readOnly: true
  5481. description: '?ProductApi'
  5482. $ref: '#/components/schemas/Product.jsonld'
  5483. productIri:
  5484. type:
  5485. - string
  5486. - 'null'
  5487. format: iri-reference
  5488. example: 'https://example.com/'
  5489. createdAt:
  5490. readOnly: true
  5491. type:
  5492. - string
  5493. - 'null'
  5494. format: date-time
  5495. required:
  5496. - partnerIri
  5497. - productIri
  5498. Post:
  5499. type: object
  5500. description: ''
  5501. deprecated: false
  5502. required:
  5503. - headline
  5504. - message
  5505. properties:
  5506. headline:
  5507. type:
  5508. - string
  5509. - 'null'
  5510. message:
  5511. type:
  5512. - string
  5513. - 'null'
  5514. owner:
  5515. readOnly: true
  5516. description: '?UserApi'
  5517. $ref: '#/components/schemas/User'
  5518. partner:
  5519. readOnly: true
  5520. description: '?PartnerApi'
  5521. $ref: '#/components/schemas/Partner'
  5522. partnerIri:
  5523. type:
  5524. - string
  5525. - 'null'
  5526. format: iri-reference
  5527. example: 'https://example.com/'
  5528. product:
  5529. readOnly: true
  5530. description: '?ProductApi'
  5531. $ref: '#/components/schemas/Product'
  5532. productIri:
  5533. type:
  5534. - string
  5535. - 'null'
  5536. format: iri-reference
  5537. example: 'https://example.com/'
  5538. contact:
  5539. readOnly: true
  5540. description: '?ContactApi'
  5541. $ref: '#/components/schemas/Contact'
  5542. contactIri:
  5543. type:
  5544. - string
  5545. - 'null'
  5546. format: iri-reference
  5547. example: 'https://example.com/'
  5548. sale:
  5549. readOnly: true
  5550. description: '?SaleApi'
  5551. $ref: '#/components/schemas/Contact'
  5552. saleIri:
  5553. type:
  5554. - string
  5555. - 'null'
  5556. format: iri-reference
  5557. example: 'https://example.com/'
  5558. numComments:
  5559. readOnly: true
  5560. type:
  5561. - integer
  5562. - 'null'
  5563. createdAt:
  5564. readOnly: true
  5565. type:
  5566. - string
  5567. - 'null'
  5568. format: date-time
  5569. Post-posting.create:
  5570. type: object
  5571. description: ''
  5572. deprecated: false
  5573. required:
  5574. - headline
  5575. - message
  5576. properties:
  5577. headline:
  5578. type:
  5579. - string
  5580. - 'null'
  5581. message:
  5582. type:
  5583. - string
  5584. - 'null'
  5585. partnerIri:
  5586. type:
  5587. - string
  5588. - 'null'
  5589. format: iri-reference
  5590. example: 'https://example.com/'
  5591. productIri:
  5592. type:
  5593. - string
  5594. - 'null'
  5595. format: iri-reference
  5596. example: 'https://example.com/'
  5597. contactIri:
  5598. type:
  5599. - string
  5600. - 'null'
  5601. format: iri-reference
  5602. example: 'https://example.com/'
  5603. saleIri:
  5604. type:
  5605. - string
  5606. - 'null'
  5607. format: iri-reference
  5608. example: 'https://example.com/'
  5609. Post-posting.patch:
  5610. type: object
  5611. description: ''
  5612. deprecated: false
  5613. required:
  5614. - headline
  5615. - message
  5616. properties:
  5617. headline:
  5618. type:
  5619. - string
  5620. - 'null'
  5621. message:
  5622. type:
  5623. - string
  5624. - 'null'
  5625. Post.jsonhal:
  5626. type: object
  5627. description: ''
  5628. deprecated: false
  5629. required:
  5630. - headline
  5631. - message
  5632. properties:
  5633. _links:
  5634. type: object
  5635. properties:
  5636. self:
  5637. type: object
  5638. properties:
  5639. href:
  5640. type: string
  5641. format: iri-reference
  5642. headline:
  5643. type:
  5644. - string
  5645. - 'null'
  5646. message:
  5647. type:
  5648. - string
  5649. - 'null'
  5650. owner:
  5651. readOnly: true
  5652. description: '?UserApi'
  5653. $ref: '#/components/schemas/User.jsonhal'
  5654. partner:
  5655. readOnly: true
  5656. description: '?PartnerApi'
  5657. $ref: '#/components/schemas/Partner.jsonhal'
  5658. partnerIri:
  5659. type:
  5660. - string
  5661. - 'null'
  5662. format: iri-reference
  5663. example: 'https://example.com/'
  5664. product:
  5665. readOnly: true
  5666. description: '?ProductApi'
  5667. $ref: '#/components/schemas/Product.jsonhal'
  5668. productIri:
  5669. type:
  5670. - string
  5671. - 'null'
  5672. format: iri-reference
  5673. example: 'https://example.com/'
  5674. contact:
  5675. readOnly: true
  5676. description: '?ContactApi'
  5677. $ref: '#/components/schemas/Contact.jsonhal'
  5678. contactIri:
  5679. type:
  5680. - string
  5681. - 'null'
  5682. format: iri-reference
  5683. example: 'https://example.com/'
  5684. sale:
  5685. readOnly: true
  5686. description: '?SaleApi'
  5687. $ref: '#/components/schemas/Contact.jsonhal'
  5688. saleIri:
  5689. type:
  5690. - string
  5691. - 'null'
  5692. format: iri-reference
  5693. example: 'https://example.com/'
  5694. numComments:
  5695. readOnly: true
  5696. type:
  5697. - integer
  5698. - 'null'
  5699. createdAt:
  5700. readOnly: true
  5701. type:
  5702. - string
  5703. - 'null'
  5704. format: date-time
  5705. Post.jsonhal-posting.create:
  5706. type: object
  5707. description: ''
  5708. deprecated: false
  5709. required:
  5710. - headline
  5711. - message
  5712. properties:
  5713. _links:
  5714. type: object
  5715. properties:
  5716. self:
  5717. type: object
  5718. properties:
  5719. href:
  5720. type: string
  5721. format: iri-reference
  5722. headline:
  5723. type:
  5724. - string
  5725. - 'null'
  5726. message:
  5727. type:
  5728. - string
  5729. - 'null'
  5730. partnerIri:
  5731. type:
  5732. - string
  5733. - 'null'
  5734. format: iri-reference
  5735. example: 'https://example.com/'
  5736. productIri:
  5737. type:
  5738. - string
  5739. - 'null'
  5740. format: iri-reference
  5741. example: 'https://example.com/'
  5742. contactIri:
  5743. type:
  5744. - string
  5745. - 'null'
  5746. format: iri-reference
  5747. example: 'https://example.com/'
  5748. saleIri:
  5749. type:
  5750. - string
  5751. - 'null'
  5752. format: iri-reference
  5753. example: 'https://example.com/'
  5754. Post.jsonld:
  5755. type: object
  5756. description: ''
  5757. deprecated: false
  5758. required:
  5759. - headline
  5760. - message
  5761. properties:
  5762. '@context':
  5763. readOnly: true
  5764. oneOf:
  5765. -
  5766. type: string
  5767. -
  5768. type: object
  5769. properties:
  5770. '@vocab':
  5771. type: string
  5772. hydra:
  5773. type: string
  5774. enum: ['http://www.w3.org/ns/hydra/core#']
  5775. required:
  5776. - '@vocab'
  5777. - hydra
  5778. additionalProperties: true
  5779. '@id':
  5780. readOnly: true
  5781. type: string
  5782. '@type':
  5783. readOnly: true
  5784. type: string
  5785. headline:
  5786. type:
  5787. - string
  5788. - 'null'
  5789. message:
  5790. type:
  5791. - string
  5792. - 'null'
  5793. owner:
  5794. readOnly: true
  5795. description: '?UserApi'
  5796. $ref: '#/components/schemas/User.jsonld'
  5797. partner:
  5798. readOnly: true
  5799. description: '?PartnerApi'
  5800. $ref: '#/components/schemas/Partner.jsonld'
  5801. partnerIri:
  5802. type:
  5803. - string
  5804. - 'null'
  5805. format: iri-reference
  5806. example: 'https://example.com/'
  5807. product:
  5808. readOnly: true
  5809. description: '?ProductApi'
  5810. $ref: '#/components/schemas/Product.jsonld'
  5811. productIri:
  5812. type:
  5813. - string
  5814. - 'null'
  5815. format: iri-reference
  5816. example: 'https://example.com/'
  5817. contact:
  5818. readOnly: true
  5819. description: '?ContactApi'
  5820. $ref: '#/components/schemas/Contact.jsonld'
  5821. contactIri:
  5822. type:
  5823. - string
  5824. - 'null'
  5825. format: iri-reference
  5826. example: 'https://example.com/'
  5827. sale:
  5828. readOnly: true
  5829. description: '?SaleApi'
  5830. $ref: '#/components/schemas/Contact.jsonld'
  5831. saleIri:
  5832. type:
  5833. - string
  5834. - 'null'
  5835. format: iri-reference
  5836. example: 'https://example.com/'
  5837. numComments:
  5838. readOnly: true
  5839. type:
  5840. - integer
  5841. - 'null'
  5842. createdAt:
  5843. readOnly: true
  5844. type:
  5845. - string
  5846. - 'null'
  5847. format: date-time
  5848. Post.jsonld-posting.create:
  5849. type: object
  5850. description: ''
  5851. deprecated: false
  5852. required:
  5853. - headline
  5854. - message
  5855. properties:
  5856. headline:
  5857. type:
  5858. - string
  5859. - 'null'
  5860. message:
  5861. type:
  5862. - string
  5863. - 'null'
  5864. partnerIri:
  5865. type:
  5866. - string
  5867. - 'null'
  5868. format: iri-reference
  5869. example: 'https://example.com/'
  5870. productIri:
  5871. type:
  5872. - string
  5873. - 'null'
  5874. format: iri-reference
  5875. example: 'https://example.com/'
  5876. contactIri:
  5877. type:
  5878. - string
  5879. - 'null'
  5880. format: iri-reference
  5881. example: 'https://example.com/'
  5882. saleIri:
  5883. type:
  5884. - string
  5885. - 'null'
  5886. format: iri-reference
  5887. example: 'https://example.com/'
  5888. Product:
  5889. type: object
  5890. description: ''
  5891. deprecated: false
  5892. required:
  5893. - name
  5894. properties:
  5895. name:
  5896. type: string
  5897. description:
  5898. type:
  5899. - string
  5900. - 'null'
  5901. image:
  5902. type:
  5903. - string
  5904. - 'null'
  5905. format: iri-reference
  5906. example: 'https://example.com/'
  5907. imageUrl:
  5908. readOnly: true
  5909. type:
  5910. - string
  5911. - 'null'
  5912. createdBy:
  5913. readOnly: true
  5914. description: '?UserApi'
  5915. $ref: '#/components/schemas/User'
  5916. createdAt:
  5917. type:
  5918. - string
  5919. - 'null'
  5920. format: date-time
  5921. Product.jsonhal:
  5922. type: object
  5923. description: ''
  5924. deprecated: false
  5925. required:
  5926. - name
  5927. properties:
  5928. _links:
  5929. type: object
  5930. properties:
  5931. self:
  5932. type: object
  5933. properties:
  5934. href:
  5935. type: string
  5936. format: iri-reference
  5937. name:
  5938. type: string
  5939. description:
  5940. type:
  5941. - string
  5942. - 'null'
  5943. image:
  5944. type:
  5945. - string
  5946. - 'null'
  5947. format: iri-reference
  5948. example: 'https://example.com/'
  5949. imageUrl:
  5950. readOnly: true
  5951. type:
  5952. - string
  5953. - 'null'
  5954. createdBy:
  5955. readOnly: true
  5956. description: '?UserApi'
  5957. $ref: '#/components/schemas/User.jsonhal'
  5958. createdAt:
  5959. type:
  5960. - string
  5961. - 'null'
  5962. format: date-time
  5963. Product.jsonld:
  5964. type: object
  5965. description: ''
  5966. deprecated: false
  5967. required:
  5968. - name
  5969. properties:
  5970. '@context':
  5971. readOnly: true
  5972. oneOf:
  5973. -
  5974. type: string
  5975. -
  5976. type: object
  5977. properties:
  5978. '@vocab':
  5979. type: string
  5980. hydra:
  5981. type: string
  5982. enum: ['http://www.w3.org/ns/hydra/core#']
  5983. required:
  5984. - '@vocab'
  5985. - hydra
  5986. additionalProperties: true
  5987. '@id':
  5988. readOnly: true
  5989. type: string
  5990. '@type':
  5991. readOnly: true
  5992. type: string
  5993. name:
  5994. type: string
  5995. description:
  5996. type:
  5997. - string
  5998. - 'null'
  5999. image:
  6000. type:
  6001. - string
  6002. - 'null'
  6003. format: iri-reference
  6004. example: 'https://example.com/'
  6005. imageUrl:
  6006. readOnly: true
  6007. type:
  6008. - string
  6009. - 'null'
  6010. createdBy:
  6011. readOnly: true
  6012. description: '?UserApi'
  6013. $ref: '#/components/schemas/User.jsonld'
  6014. createdAt:
  6015. type:
  6016. - string
  6017. - 'null'
  6018. format: date-time
  6019. Sale:
  6020. type: object
  6021. description: ''
  6022. deprecated: false
  6023. properties:
  6024. owner:
  6025. readOnly: true
  6026. description: '?UserApi'
  6027. $ref: '#/components/schemas/User'
  6028. partner:
  6029. readOnly: true
  6030. description: '?PartnerApi'
  6031. $ref: '#/components/schemas/Partner'
  6032. partnerIri:
  6033. type:
  6034. - string
  6035. - 'null'
  6036. format: iri-reference
  6037. example: 'https://example.com/'
  6038. product:
  6039. readOnly: true
  6040. description: '?ProductApi'
  6041. $ref: '#/components/schemas/Product'
  6042. productIri:
  6043. type:
  6044. - string
  6045. - 'null'
  6046. format: iri-reference
  6047. example: 'https://example.com/'
  6048. turnover:
  6049. type:
  6050. - integer
  6051. - 'null'
  6052. profit:
  6053. type:
  6054. - integer
  6055. - 'null'
  6056. quantity:
  6057. type:
  6058. - integer
  6059. - 'null'
  6060. comment:
  6061. type:
  6062. - string
  6063. - 'null'
  6064. createdAt:
  6065. readOnly: true
  6066. type:
  6067. - string
  6068. - 'null'
  6069. format: date-time
  6070. required:
  6071. - partnerIri
  6072. - productIri
  6073. - turnover
  6074. - profit
  6075. - quantity
  6076. Sale.jsonhal:
  6077. type: object
  6078. description: ''
  6079. deprecated: false
  6080. properties:
  6081. _links:
  6082. type: object
  6083. properties:
  6084. self:
  6085. type: object
  6086. properties:
  6087. href:
  6088. type: string
  6089. format: iri-reference
  6090. owner:
  6091. readOnly: true
  6092. description: '?UserApi'
  6093. $ref: '#/components/schemas/User.jsonhal'
  6094. partner:
  6095. readOnly: true
  6096. description: '?PartnerApi'
  6097. $ref: '#/components/schemas/Partner.jsonhal'
  6098. partnerIri:
  6099. type:
  6100. - string
  6101. - 'null'
  6102. format: iri-reference
  6103. example: 'https://example.com/'
  6104. product:
  6105. readOnly: true
  6106. description: '?ProductApi'
  6107. $ref: '#/components/schemas/Product.jsonhal'
  6108. productIri:
  6109. type:
  6110. - string
  6111. - 'null'
  6112. format: iri-reference
  6113. example: 'https://example.com/'
  6114. turnover:
  6115. type:
  6116. - integer
  6117. - 'null'
  6118. profit:
  6119. type:
  6120. - integer
  6121. - 'null'
  6122. quantity:
  6123. type:
  6124. - integer
  6125. - 'null'
  6126. comment:
  6127. type:
  6128. - string
  6129. - 'null'
  6130. createdAt:
  6131. readOnly: true
  6132. type:
  6133. - string
  6134. - 'null'
  6135. format: date-time
  6136. required:
  6137. - partnerIri
  6138. - productIri
  6139. - turnover
  6140. - profit
  6141. - quantity
  6142. Sale.jsonld:
  6143. type: object
  6144. description: ''
  6145. deprecated: false
  6146. properties:
  6147. '@context':
  6148. readOnly: true
  6149. oneOf:
  6150. -
  6151. type: string
  6152. -
  6153. type: object
  6154. properties:
  6155. '@vocab':
  6156. type: string
  6157. hydra:
  6158. type: string
  6159. enum: ['http://www.w3.org/ns/hydra/core#']
  6160. required:
  6161. - '@vocab'
  6162. - hydra
  6163. additionalProperties: true
  6164. '@id':
  6165. readOnly: true
  6166. type: string
  6167. '@type':
  6168. readOnly: true
  6169. type: string
  6170. owner:
  6171. readOnly: true
  6172. description: '?UserApi'
  6173. $ref: '#/components/schemas/User.jsonld'
  6174. partner:
  6175. readOnly: true
  6176. description: '?PartnerApi'
  6177. $ref: '#/components/schemas/Partner.jsonld'
  6178. partnerIri:
  6179. type:
  6180. - string
  6181. - 'null'
  6182. format: iri-reference
  6183. example: 'https://example.com/'
  6184. product:
  6185. readOnly: true
  6186. description: '?ProductApi'
  6187. $ref: '#/components/schemas/Product.jsonld'
  6188. productIri:
  6189. type:
  6190. - string
  6191. - 'null'
  6192. format: iri-reference
  6193. example: 'https://example.com/'
  6194. turnover:
  6195. type:
  6196. - integer
  6197. - 'null'
  6198. profit:
  6199. type:
  6200. - integer
  6201. - 'null'
  6202. quantity:
  6203. type:
  6204. - integer
  6205. - 'null'
  6206. comment:
  6207. type:
  6208. - string
  6209. - 'null'
  6210. createdAt:
  6211. readOnly: true
  6212. type:
  6213. - string
  6214. - 'null'
  6215. format: date-time
  6216. required:
  6217. - partnerIri
  6218. - productIri
  6219. - turnover
  6220. - profit
  6221. - quantity
  6222. SaleSummary:
  6223. type: object
  6224. description: ''
  6225. deprecated: false
  6226. properties:
  6227. userId:
  6228. type: integer
  6229. owner:
  6230. readOnly: true
  6231. description: '?UserApi'
  6232. $ref: '#/components/schemas/User'
  6233. turnover:
  6234. type:
  6235. - integer
  6236. - 'null'
  6237. profit:
  6238. type:
  6239. - integer
  6240. - 'null'
  6241. SaleSummary.jsonhal:
  6242. type: object
  6243. description: ''
  6244. deprecated: false
  6245. properties:
  6246. _links:
  6247. type: object
  6248. properties:
  6249. self:
  6250. type: object
  6251. properties:
  6252. href:
  6253. type: string
  6254. format: iri-reference
  6255. userId:
  6256. type: integer
  6257. owner:
  6258. readOnly: true
  6259. description: '?UserApi'
  6260. $ref: '#/components/schemas/User.jsonhal'
  6261. turnover:
  6262. type:
  6263. - integer
  6264. - 'null'
  6265. profit:
  6266. type:
  6267. - integer
  6268. - 'null'
  6269. SaleSummary.jsonld:
  6270. type: object
  6271. description: ''
  6272. deprecated: false
  6273. properties:
  6274. '@id':
  6275. readOnly: true
  6276. type: string
  6277. '@type':
  6278. readOnly: true
  6279. type: string
  6280. '@context':
  6281. readOnly: true
  6282. oneOf:
  6283. -
  6284. type: string
  6285. -
  6286. type: object
  6287. properties:
  6288. '@vocab':
  6289. type: string
  6290. hydra:
  6291. type: string
  6292. enum: ['http://www.w3.org/ns/hydra/core#']
  6293. required:
  6294. - '@vocab'
  6295. - hydra
  6296. additionalProperties: true
  6297. userId:
  6298. type: integer
  6299. owner:
  6300. readOnly: true
  6301. description: '?UserApi'
  6302. $ref: '#/components/schemas/User.jsonld'
  6303. turnover:
  6304. type:
  6305. - integer
  6306. - 'null'
  6307. profit:
  6308. type:
  6309. - integer
  6310. - 'null'
  6311. Task:
  6312. type: object
  6313. description: ''
  6314. deprecated: false
  6315. required:
  6316. - headline
  6317. - description
  6318. - assignedToIri
  6319. - dueAt
  6320. - productIri
  6321. - prio
  6322. - completed
  6323. properties:
  6324. headline:
  6325. type:
  6326. - string
  6327. - 'null'
  6328. description:
  6329. type:
  6330. - string
  6331. - 'null'
  6332. createdBy:
  6333. readOnly: true
  6334. description: '?UserApi'
  6335. $ref: '#/components/schemas/User'
  6336. assignedTo:
  6337. readOnly: true
  6338. description: '?UserApi'
  6339. $ref: '#/components/schemas/User'
  6340. assignedToIri:
  6341. type:
  6342. - string
  6343. - 'null'
  6344. format: iri-reference
  6345. example: 'https://example.com/'
  6346. dueAt:
  6347. type:
  6348. - string
  6349. - 'null'
  6350. format: date-time
  6351. partner:
  6352. readOnly: true
  6353. description: '?PartnerApi'
  6354. $ref: '#/components/schemas/Partner'
  6355. partnerIri:
  6356. type:
  6357. - string
  6358. - 'null'
  6359. format: iri-reference
  6360. example: 'https://example.com/'
  6361. product:
  6362. readOnly: true
  6363. description: '?ProductApi'
  6364. $ref: '#/components/schemas/Product'
  6365. productIri:
  6366. type:
  6367. - string
  6368. - 'null'
  6369. format: iri-reference
  6370. example: 'https://example.com/'
  6371. contact:
  6372. readOnly: true
  6373. description: '?ContactApi'
  6374. $ref: '#/components/schemas/Contact'
  6375. contactIri:
  6376. type:
  6377. - string
  6378. - 'null'
  6379. format: iri-reference
  6380. example: 'https://example.com/'
  6381. prio:
  6382. type: string
  6383. enum:
  6384. - low
  6385. - medium
  6386. - high
  6387. completed:
  6388. type:
  6389. - boolean
  6390. - 'null'
  6391. numTaskNotes:
  6392. readOnly: true
  6393. type:
  6394. - integer
  6395. - 'null'
  6396. createdAt:
  6397. readOnly: true
  6398. type:
  6399. - string
  6400. - 'null'
  6401. format: date-time
  6402. Task.jsonhal:
  6403. type: object
  6404. description: ''
  6405. deprecated: false
  6406. required:
  6407. - headline
  6408. - description
  6409. - assignedToIri
  6410. - dueAt
  6411. - productIri
  6412. - prio
  6413. - completed
  6414. properties:
  6415. _links:
  6416. type: object
  6417. properties:
  6418. self:
  6419. type: object
  6420. properties:
  6421. href:
  6422. type: string
  6423. format: iri-reference
  6424. headline:
  6425. type:
  6426. - string
  6427. - 'null'
  6428. description:
  6429. type:
  6430. - string
  6431. - 'null'
  6432. createdBy:
  6433. readOnly: true
  6434. description: '?UserApi'
  6435. $ref: '#/components/schemas/User.jsonhal'
  6436. assignedTo:
  6437. readOnly: true
  6438. description: '?UserApi'
  6439. $ref: '#/components/schemas/User.jsonhal'
  6440. assignedToIri:
  6441. type:
  6442. - string
  6443. - 'null'
  6444. format: iri-reference
  6445. example: 'https://example.com/'
  6446. dueAt:
  6447. type:
  6448. - string
  6449. - 'null'
  6450. format: date-time
  6451. partner:
  6452. readOnly: true
  6453. description: '?PartnerApi'
  6454. $ref: '#/components/schemas/Partner.jsonhal'
  6455. partnerIri:
  6456. type:
  6457. - string
  6458. - 'null'
  6459. format: iri-reference
  6460. example: 'https://example.com/'
  6461. product:
  6462. readOnly: true
  6463. description: '?ProductApi'
  6464. $ref: '#/components/schemas/Product.jsonhal'
  6465. productIri:
  6466. type:
  6467. - string
  6468. - 'null'
  6469. format: iri-reference
  6470. example: 'https://example.com/'
  6471. contact:
  6472. readOnly: true
  6473. description: '?ContactApi'
  6474. $ref: '#/components/schemas/Contact.jsonhal'
  6475. contactIri:
  6476. type:
  6477. - string
  6478. - 'null'
  6479. format: iri-reference
  6480. example: 'https://example.com/'
  6481. prio:
  6482. type: string
  6483. enum:
  6484. - low
  6485. - medium
  6486. - high
  6487. completed:
  6488. type:
  6489. - boolean
  6490. - 'null'
  6491. numTaskNotes:
  6492. readOnly: true
  6493. type:
  6494. - integer
  6495. - 'null'
  6496. createdAt:
  6497. readOnly: true
  6498. type:
  6499. - string
  6500. - 'null'
  6501. format: date-time
  6502. Task.jsonld:
  6503. type: object
  6504. description: ''
  6505. deprecated: false
  6506. required:
  6507. - headline
  6508. - description
  6509. - assignedToIri
  6510. - dueAt
  6511. - productIri
  6512. - prio
  6513. - completed
  6514. properties:
  6515. '@context':
  6516. readOnly: true
  6517. oneOf:
  6518. -
  6519. type: string
  6520. -
  6521. type: object
  6522. properties:
  6523. '@vocab':
  6524. type: string
  6525. hydra:
  6526. type: string
  6527. enum: ['http://www.w3.org/ns/hydra/core#']
  6528. required:
  6529. - '@vocab'
  6530. - hydra
  6531. additionalProperties: true
  6532. '@id':
  6533. readOnly: true
  6534. type: string
  6535. '@type':
  6536. readOnly: true
  6537. type: string
  6538. headline:
  6539. type:
  6540. - string
  6541. - 'null'
  6542. description:
  6543. type:
  6544. - string
  6545. - 'null'
  6546. createdBy:
  6547. readOnly: true
  6548. description: '?UserApi'
  6549. $ref: '#/components/schemas/User.jsonld'
  6550. assignedTo:
  6551. readOnly: true
  6552. description: '?UserApi'
  6553. $ref: '#/components/schemas/User.jsonld'
  6554. assignedToIri:
  6555. type:
  6556. - string
  6557. - 'null'
  6558. format: iri-reference
  6559. example: 'https://example.com/'
  6560. dueAt:
  6561. type:
  6562. - string
  6563. - 'null'
  6564. format: date-time
  6565. partner:
  6566. readOnly: true
  6567. description: '?PartnerApi'
  6568. $ref: '#/components/schemas/Partner.jsonld'
  6569. partnerIri:
  6570. type:
  6571. - string
  6572. - 'null'
  6573. format: iri-reference
  6574. example: 'https://example.com/'
  6575. product:
  6576. readOnly: true
  6577. description: '?ProductApi'
  6578. $ref: '#/components/schemas/Product.jsonld'
  6579. productIri:
  6580. type:
  6581. - string
  6582. - 'null'
  6583. format: iri-reference
  6584. example: 'https://example.com/'
  6585. contact:
  6586. readOnly: true
  6587. description: '?ContactApi'
  6588. $ref: '#/components/schemas/Contact.jsonld'
  6589. contactIri:
  6590. type:
  6591. - string
  6592. - 'null'
  6593. format: iri-reference
  6594. example: 'https://example.com/'
  6595. prio:
  6596. type: string
  6597. enum:
  6598. - low
  6599. - medium
  6600. - high
  6601. completed:
  6602. type:
  6603. - boolean
  6604. - 'null'
  6605. numTaskNotes:
  6606. readOnly: true
  6607. type:
  6608. - integer
  6609. - 'null'
  6610. createdAt:
  6611. readOnly: true
  6612. type:
  6613. - string
  6614. - 'null'
  6615. format: date-time
  6616. TaskNote:
  6617. type: object
  6618. description: ''
  6619. deprecated: false
  6620. required:
  6621. - message
  6622. - taskIri
  6623. properties:
  6624. message:
  6625. type:
  6626. - string
  6627. - 'null'
  6628. owner:
  6629. readOnly: true
  6630. description: '?UserApi'
  6631. $ref: '#/components/schemas/User'
  6632. taskIri:
  6633. type:
  6634. - string
  6635. - 'null'
  6636. format: iri-reference
  6637. example: 'https://example.com/'
  6638. createdAt:
  6639. readOnly: true
  6640. type:
  6641. - string
  6642. - 'null'
  6643. format: date-time
  6644. TaskNote.jsonhal:
  6645. type: object
  6646. description: ''
  6647. deprecated: false
  6648. required:
  6649. - message
  6650. - taskIri
  6651. properties:
  6652. _links:
  6653. type: object
  6654. properties:
  6655. self:
  6656. type: object
  6657. properties:
  6658. href:
  6659. type: string
  6660. format: iri-reference
  6661. message:
  6662. type:
  6663. - string
  6664. - 'null'
  6665. owner:
  6666. readOnly: true
  6667. description: '?UserApi'
  6668. $ref: '#/components/schemas/User.jsonhal'
  6669. taskIri:
  6670. type:
  6671. - string
  6672. - 'null'
  6673. format: iri-reference
  6674. example: 'https://example.com/'
  6675. createdAt:
  6676. readOnly: true
  6677. type:
  6678. - string
  6679. - 'null'
  6680. format: date-time
  6681. TaskNote.jsonld:
  6682. type: object
  6683. description: ''
  6684. deprecated: false
  6685. required:
  6686. - message
  6687. - taskIri
  6688. properties:
  6689. '@context':
  6690. readOnly: true
  6691. oneOf:
  6692. -
  6693. type: string
  6694. -
  6695. type: object
  6696. properties:
  6697. '@vocab':
  6698. type: string
  6699. hydra:
  6700. type: string
  6701. enum: ['http://www.w3.org/ns/hydra/core#']
  6702. required:
  6703. - '@vocab'
  6704. - hydra
  6705. additionalProperties: true
  6706. '@id':
  6707. readOnly: true
  6708. type: string
  6709. '@type':
  6710. readOnly: true
  6711. type: string
  6712. message:
  6713. type:
  6714. - string
  6715. - 'null'
  6716. owner:
  6717. readOnly: true
  6718. description: '?UserApi'
  6719. $ref: '#/components/schemas/User.jsonld'
  6720. taskIri:
  6721. type:
  6722. - string
  6723. - 'null'
  6724. format: iri-reference
  6725. example: 'https://example.com/'
  6726. createdAt:
  6727. readOnly: true
  6728. type:
  6729. - string
  6730. - 'null'
  6731. format: date-time
  6732. User:
  6733. type: object
  6734. description: ''
  6735. deprecated: false
  6736. required:
  6737. - email
  6738. - firstName
  6739. - lastName
  6740. properties:
  6741. email:
  6742. format: email
  6743. externalDocs:
  6744. url: 'https://schema.org/email'
  6745. type:
  6746. - string
  6747. - 'null'
  6748. firstName:
  6749. type:
  6750. - string
  6751. - 'null'
  6752. lastName:
  6753. type:
  6754. - string
  6755. - 'null'
  6756. image:
  6757. type:
  6758. - string
  6759. - 'null'
  6760. format: iri-reference
  6761. example: 'https://example.com/'
  6762. imageUrl:
  6763. readOnly: true
  6764. type:
  6765. - string
  6766. - 'null'
  6767. fullName:
  6768. readOnly: true
  6769. type:
  6770. - string
  6771. - 'null'
  6772. password:
  6773. writeOnly: true
  6774. description: 'The plaintext password when being set or changed.'
  6775. type:
  6776. - string
  6777. - 'null'
  6778. active:
  6779. type: boolean
  6780. createdAt:
  6781. readOnly: true
  6782. type:
  6783. - string
  6784. - 'null'
  6785. format: date-time
  6786. User.jsonhal:
  6787. type: object
  6788. description: ''
  6789. deprecated: false
  6790. required:
  6791. - email
  6792. - firstName
  6793. - lastName
  6794. properties:
  6795. _links:
  6796. type: object
  6797. properties:
  6798. self:
  6799. type: object
  6800. properties:
  6801. href:
  6802. type: string
  6803. format: iri-reference
  6804. email:
  6805. format: email
  6806. externalDocs:
  6807. url: 'https://schema.org/email'
  6808. type:
  6809. - string
  6810. - 'null'
  6811. firstName:
  6812. type:
  6813. - string
  6814. - 'null'
  6815. lastName:
  6816. type:
  6817. - string
  6818. - 'null'
  6819. image:
  6820. type:
  6821. - string
  6822. - 'null'
  6823. format: iri-reference
  6824. example: 'https://example.com/'
  6825. imageUrl:
  6826. readOnly: true
  6827. type:
  6828. - string
  6829. - 'null'
  6830. fullName:
  6831. readOnly: true
  6832. type:
  6833. - string
  6834. - 'null'
  6835. password:
  6836. writeOnly: true
  6837. description: 'The plaintext password when being set or changed.'
  6838. type:
  6839. - string
  6840. - 'null'
  6841. active:
  6842. type: boolean
  6843. createdAt:
  6844. readOnly: true
  6845. type:
  6846. - string
  6847. - 'null'
  6848. format: date-time
  6849. User.jsonld:
  6850. type: object
  6851. description: ''
  6852. deprecated: false
  6853. required:
  6854. - email
  6855. - firstName
  6856. - lastName
  6857. properties:
  6858. '@context':
  6859. readOnly: true
  6860. oneOf:
  6861. -
  6862. type: string
  6863. -
  6864. type: object
  6865. properties:
  6866. '@vocab':
  6867. type: string
  6868. hydra:
  6869. type: string
  6870. enum: ['http://www.w3.org/ns/hydra/core#']
  6871. required:
  6872. - '@vocab'
  6873. - hydra
  6874. additionalProperties: true
  6875. '@id':
  6876. readOnly: true
  6877. type: string
  6878. '@type':
  6879. readOnly: true
  6880. type: string
  6881. email:
  6882. format: email
  6883. externalDocs:
  6884. url: 'https://schema.org/email'
  6885. type:
  6886. - string
  6887. - 'null'
  6888. firstName:
  6889. type:
  6890. - string
  6891. - 'null'
  6892. lastName:
  6893. type:
  6894. - string
  6895. - 'null'
  6896. image:
  6897. type:
  6898. - string
  6899. - 'null'
  6900. format: iri-reference
  6901. example: 'https://example.com/'
  6902. imageUrl:
  6903. readOnly: true
  6904. type:
  6905. - string
  6906. - 'null'
  6907. fullName:
  6908. readOnly: true
  6909. type:
  6910. - string
  6911. - 'null'
  6912. password:
  6913. writeOnly: true
  6914. description: 'The plaintext password when being set or changed.'
  6915. type:
  6916. - string
  6917. - 'null'
  6918. active:
  6919. type: boolean
  6920. createdAt:
  6921. readOnly: true
  6922. type:
  6923. - string
  6924. - 'null'
  6925. format: date-time
  6926. UserProduct:
  6927. type: object
  6928. description: ''
  6929. deprecated: false
  6930. properties:
  6931. user:
  6932. readOnly: true
  6933. description: '?UserApi'
  6934. $ref: '#/components/schemas/User'
  6935. product:
  6936. readOnly: true
  6937. description: '?ProductApi'
  6938. $ref: '#/components/schemas/Product'
  6939. productIri:
  6940. type:
  6941. - string
  6942. - 'null'
  6943. format: iri-reference
  6944. example: 'https://example.com/'
  6945. createdAt:
  6946. readOnly: true
  6947. type:
  6948. - string
  6949. - 'null'
  6950. format: date-time
  6951. owner:
  6952. readOnly: true
  6953. type:
  6954. - string
  6955. - 'null'
  6956. format: iri-reference
  6957. example: 'https://example.com/'
  6958. required:
  6959. - productIri
  6960. UserProduct.jsonhal:
  6961. type: object
  6962. description: ''
  6963. deprecated: false
  6964. properties:
  6965. _links:
  6966. type: object
  6967. properties:
  6968. self:
  6969. type: object
  6970. properties:
  6971. href:
  6972. type: string
  6973. format: iri-reference
  6974. user:
  6975. readOnly: true
  6976. description: '?UserApi'
  6977. $ref: '#/components/schemas/User.jsonhal'
  6978. product:
  6979. readOnly: true
  6980. description: '?ProductApi'
  6981. $ref: '#/components/schemas/Product.jsonhal'
  6982. productIri:
  6983. type:
  6984. - string
  6985. - 'null'
  6986. format: iri-reference
  6987. example: 'https://example.com/'
  6988. createdAt:
  6989. readOnly: true
  6990. type:
  6991. - string
  6992. - 'null'
  6993. format: date-time
  6994. owner:
  6995. readOnly: true
  6996. type:
  6997. - string
  6998. - 'null'
  6999. format: iri-reference
  7000. example: 'https://example.com/'
  7001. required:
  7002. - productIri
  7003. UserProduct.jsonld:
  7004. type: object
  7005. description: ''
  7006. deprecated: false
  7007. properties:
  7008. '@context':
  7009. readOnly: true
  7010. oneOf:
  7011. -
  7012. type: string
  7013. -
  7014. type: object
  7015. properties:
  7016. '@vocab':
  7017. type: string
  7018. hydra:
  7019. type: string
  7020. enum: ['http://www.w3.org/ns/hydra/core#']
  7021. required:
  7022. - '@vocab'
  7023. - hydra
  7024. additionalProperties: true
  7025. '@id':
  7026. readOnly: true
  7027. type: string
  7028. '@type':
  7029. readOnly: true
  7030. type: string
  7031. user:
  7032. readOnly: true
  7033. description: '?UserApi'
  7034. $ref: '#/components/schemas/User.jsonld'
  7035. product:
  7036. readOnly: true
  7037. description: '?ProductApi'
  7038. $ref: '#/components/schemas/Product.jsonld'
  7039. productIri:
  7040. type:
  7041. - string
  7042. - 'null'
  7043. format: iri-reference
  7044. example: 'https://example.com/'
  7045. createdAt:
  7046. readOnly: true
  7047. type:
  7048. - string
  7049. - 'null'
  7050. format: date-time
  7051. owner:
  7052. readOnly: true
  7053. type:
  7054. - string
  7055. - 'null'
  7056. format: iri-reference
  7057. example: 'https://example.com/'
  7058. required:
  7059. - productIri
  7060. responses: { }
  7061. parameters: { }
  7062. examples: { }
  7063. requestBodies: { }
  7064. headers: { }
  7065. securitySchemes:
  7066. JWT:
  7067. type: http
  7068. scheme: bearer
  7069. bearerFormat: JWT
  7070. security:
  7071. -
  7072. JWT: []
  7073. tags: []