Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
 
 
 
 

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