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ů.
 
 
 
 

7516 řá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: excludeProductId
  2212. in: query
  2213. description: ''
  2214. required: false
  2215. deprecated: false
  2216. allowEmptyValue: true
  2217. schema:
  2218. type: string
  2219. style: form
  2220. explode: false
  2221. allowReserved: false
  2222. -
  2223. name: 'order[name]'
  2224. in: query
  2225. description: ''
  2226. required: false
  2227. deprecated: false
  2228. allowEmptyValue: true
  2229. schema:
  2230. type: string
  2231. enum:
  2232. - asc
  2233. - desc
  2234. style: form
  2235. explode: false
  2236. allowReserved: false
  2237. -
  2238. name: 'order[city]'
  2239. in: query
  2240. description: ''
  2241. required: false
  2242. deprecated: false
  2243. allowEmptyValue: true
  2244. schema:
  2245. type: string
  2246. enum:
  2247. - asc
  2248. - desc
  2249. style: form
  2250. explode: false
  2251. allowReserved: false
  2252. -
  2253. name: 'order[website]'
  2254. in: query
  2255. description: ''
  2256. required: false
  2257. deprecated: false
  2258. allowEmptyValue: true
  2259. schema:
  2260. type: string
  2261. enum:
  2262. - asc
  2263. - desc
  2264. style: form
  2265. explode: false
  2266. allowReserved: false
  2267. deprecated: false
  2268. post:
  2269. operationId: api_partners_post
  2270. tags:
  2271. - Partner
  2272. responses:
  2273. 201:
  2274. description: 'Partner resource created'
  2275. content:
  2276. application/ld+json:
  2277. schema:
  2278. $ref: '#/components/schemas/Partner.jsonld'
  2279. application/json:
  2280. schema:
  2281. $ref: '#/components/schemas/Partner'
  2282. text/html:
  2283. schema:
  2284. $ref: '#/components/schemas/Partner'
  2285. application/hal+json:
  2286. schema:
  2287. $ref: '#/components/schemas/Partner.jsonhal'
  2288. links: { }
  2289. 400:
  2290. description: 'Invalid input'
  2291. 422:
  2292. description: 'Unprocessable entity'
  2293. summary: 'Creates a Partner resource.'
  2294. description: 'Creates a Partner resource.'
  2295. parameters: []
  2296. requestBody:
  2297. description: 'The new Partner resource'
  2298. content:
  2299. application/ld+json:
  2300. schema:
  2301. $ref: '#/components/schemas/Partner.jsonld'
  2302. application/json:
  2303. schema:
  2304. $ref: '#/components/schemas/Partner'
  2305. text/html:
  2306. schema:
  2307. $ref: '#/components/schemas/Partner'
  2308. application/hal+json:
  2309. schema:
  2310. $ref: '#/components/schemas/Partner.jsonhal'
  2311. required: true
  2312. deprecated: false
  2313. parameters: []
  2314. '/api/partners/{id}':
  2315. get:
  2316. operationId: api_partners_id_get
  2317. tags:
  2318. - Partner
  2319. responses:
  2320. 200:
  2321. description: 'Partner resource'
  2322. content:
  2323. application/ld+json:
  2324. schema:
  2325. $ref: '#/components/schemas/Partner.jsonld'
  2326. application/json:
  2327. schema:
  2328. $ref: '#/components/schemas/Partner'
  2329. text/html:
  2330. schema:
  2331. $ref: '#/components/schemas/Partner'
  2332. application/hal+json:
  2333. schema:
  2334. $ref: '#/components/schemas/Partner.jsonhal'
  2335. 404:
  2336. description: 'Resource not found'
  2337. summary: 'Retrieves a Partner resource.'
  2338. description: 'Retrieves a Partner resource.'
  2339. parameters:
  2340. -
  2341. name: id
  2342. in: path
  2343. description: 'Partner identifier'
  2344. required: true
  2345. deprecated: false
  2346. allowEmptyValue: false
  2347. schema:
  2348. type: string
  2349. style: simple
  2350. explode: false
  2351. allowReserved: false
  2352. deprecated: false
  2353. patch:
  2354. operationId: api_partners_id_patch
  2355. tags:
  2356. - Partner
  2357. responses:
  2358. 200:
  2359. description: 'Partner resource updated'
  2360. content:
  2361. application/ld+json:
  2362. schema:
  2363. $ref: '#/components/schemas/Partner.jsonld'
  2364. application/json:
  2365. schema:
  2366. $ref: '#/components/schemas/Partner'
  2367. text/html:
  2368. schema:
  2369. $ref: '#/components/schemas/Partner'
  2370. application/hal+json:
  2371. schema:
  2372. $ref: '#/components/schemas/Partner.jsonhal'
  2373. links: { }
  2374. 400:
  2375. description: 'Invalid input'
  2376. 422:
  2377. description: 'Unprocessable entity'
  2378. 404:
  2379. description: 'Resource not found'
  2380. summary: 'Updates the Partner resource.'
  2381. description: 'Updates the Partner resource.'
  2382. parameters:
  2383. -
  2384. name: id
  2385. in: path
  2386. description: 'Partner identifier'
  2387. required: true
  2388. deprecated: false
  2389. allowEmptyValue: false
  2390. schema:
  2391. type: string
  2392. style: simple
  2393. explode: false
  2394. allowReserved: false
  2395. requestBody:
  2396. description: 'The updated Partner resource'
  2397. content:
  2398. application/merge-patch+json:
  2399. schema:
  2400. $ref: '#/components/schemas/Partner'
  2401. required: true
  2402. deprecated: false
  2403. parameters: []
  2404. /api/posts:
  2405. get:
  2406. operationId: api_posts_get_collection
  2407. tags:
  2408. - Post
  2409. responses:
  2410. 200:
  2411. description: 'Post collection'
  2412. content:
  2413. application/ld+json:
  2414. schema:
  2415. type: object
  2416. properties:
  2417. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  2418. 'hydra:totalItems': { type: integer, minimum: 0 }
  2419. '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 } }
  2420. '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 } } } } } }
  2421. required:
  2422. - 'hydra:member'
  2423. application/json:
  2424. schema:
  2425. type: array
  2426. items:
  2427. $ref: '#/components/schemas/Post'
  2428. text/html:
  2429. schema:
  2430. type: array
  2431. items:
  2432. $ref: '#/components/schemas/Post'
  2433. application/hal+json:
  2434. schema:
  2435. type: object
  2436. properties:
  2437. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  2438. totalItems: { type: integer, minimum: 0 }
  2439. itemsPerPage: { type: integer, minimum: 0 }
  2440. _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 } } } } }
  2441. required:
  2442. - _links
  2443. - _embedded
  2444. summary: 'Retrieves the collection of Post resources.'
  2445. description: 'Retrieves the collection of Post resources.'
  2446. parameters:
  2447. -
  2448. name: page
  2449. in: query
  2450. description: 'The collection page number'
  2451. required: false
  2452. deprecated: false
  2453. allowEmptyValue: true
  2454. schema:
  2455. type: integer
  2456. default: 1
  2457. style: form
  2458. explode: false
  2459. allowReserved: false
  2460. -
  2461. name: itemsPerPage
  2462. in: query
  2463. description: 'The number of items per page'
  2464. required: false
  2465. deprecated: false
  2466. allowEmptyValue: true
  2467. schema:
  2468. type: integer
  2469. default: 10
  2470. minimum: 0
  2471. maximum: 50
  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: string
  2484. style: form
  2485. explode: false
  2486. allowReserved: false
  2487. -
  2488. name: 'partner[]'
  2489. in: query
  2490. description: ''
  2491. required: false
  2492. deprecated: false
  2493. allowEmptyValue: true
  2494. schema:
  2495. type: array
  2496. items:
  2497. type: string
  2498. style: form
  2499. explode: true
  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: string
  2510. style: form
  2511. explode: false
  2512. allowReserved: false
  2513. -
  2514. name: 'contact[]'
  2515. in: query
  2516. description: ''
  2517. required: false
  2518. deprecated: false
  2519. allowEmptyValue: true
  2520. schema:
  2521. type: array
  2522. items:
  2523. type: string
  2524. style: form
  2525. explode: true
  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: string
  2536. style: form
  2537. explode: false
  2538. allowReserved: false
  2539. -
  2540. name: 'sale[]'
  2541. in: query
  2542. description: ''
  2543. required: false
  2544. deprecated: false
  2545. allowEmptyValue: true
  2546. schema:
  2547. type: array
  2548. items:
  2549. type: string
  2550. style: form
  2551. explode: true
  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: string
  2562. style: form
  2563. explode: false
  2564. allowReserved: false
  2565. -
  2566. name: 'owner[]'
  2567. in: query
  2568. description: ''
  2569. required: false
  2570. deprecated: false
  2571. allowEmptyValue: true
  2572. schema:
  2573. type: array
  2574. items:
  2575. type: string
  2576. style: form
  2577. explode: true
  2578. allowReserved: false
  2579. -
  2580. name: 'exists[contact]'
  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. -
  2592. name: 'exists[sale]'
  2593. in: query
  2594. description: ''
  2595. required: false
  2596. deprecated: false
  2597. allowEmptyValue: true
  2598. schema:
  2599. type: boolean
  2600. style: form
  2601. explode: false
  2602. allowReserved: false
  2603. deprecated: false
  2604. post:
  2605. operationId: api_posts_post
  2606. tags:
  2607. - Post
  2608. responses:
  2609. 201:
  2610. description: 'Post resource created'
  2611. content:
  2612. application/ld+json:
  2613. schema:
  2614. $ref: '#/components/schemas/Post.jsonld'
  2615. application/json:
  2616. schema:
  2617. $ref: '#/components/schemas/Post'
  2618. text/html:
  2619. schema:
  2620. $ref: '#/components/schemas/Post'
  2621. application/hal+json:
  2622. schema:
  2623. $ref: '#/components/schemas/Post.jsonhal'
  2624. links: { }
  2625. 400:
  2626. description: 'Invalid input'
  2627. 422:
  2628. description: 'Unprocessable entity'
  2629. summary: 'Creates a Post resource.'
  2630. description: 'Creates a Post resource.'
  2631. parameters: []
  2632. requestBody:
  2633. description: 'The new Post resource'
  2634. content:
  2635. application/ld+json:
  2636. schema:
  2637. $ref: '#/components/schemas/Post.jsonld-posting.create'
  2638. application/json:
  2639. schema:
  2640. $ref: '#/components/schemas/Post-posting.create'
  2641. text/html:
  2642. schema:
  2643. $ref: '#/components/schemas/Post-posting.create'
  2644. application/hal+json:
  2645. schema:
  2646. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  2647. required: true
  2648. deprecated: false
  2649. parameters: []
  2650. '/api/posts/{id}':
  2651. get:
  2652. operationId: api_posts_id_get
  2653. tags:
  2654. - Post
  2655. responses:
  2656. 200:
  2657. description: 'Post resource'
  2658. content:
  2659. application/ld+json:
  2660. schema:
  2661. $ref: '#/components/schemas/Post.jsonld'
  2662. application/json:
  2663. schema:
  2664. $ref: '#/components/schemas/Post'
  2665. text/html:
  2666. schema:
  2667. $ref: '#/components/schemas/Post'
  2668. application/hal+json:
  2669. schema:
  2670. $ref: '#/components/schemas/Post.jsonhal'
  2671. 404:
  2672. description: 'Resource not found'
  2673. summary: 'Retrieves a Post resource.'
  2674. description: 'Retrieves a Post resource.'
  2675. parameters:
  2676. -
  2677. name: id
  2678. in: path
  2679. description: 'Post identifier'
  2680. required: true
  2681. deprecated: false
  2682. allowEmptyValue: false
  2683. schema:
  2684. type: string
  2685. style: simple
  2686. explode: false
  2687. allowReserved: false
  2688. deprecated: false
  2689. patch:
  2690. operationId: api_posts_id_patch
  2691. tags:
  2692. - Post
  2693. responses:
  2694. 200:
  2695. description: 'Post resource updated'
  2696. content:
  2697. application/ld+json:
  2698. schema:
  2699. $ref: '#/components/schemas/Post.jsonld'
  2700. application/json:
  2701. schema:
  2702. $ref: '#/components/schemas/Post'
  2703. text/html:
  2704. schema:
  2705. $ref: '#/components/schemas/Post'
  2706. application/hal+json:
  2707. schema:
  2708. $ref: '#/components/schemas/Post.jsonhal'
  2709. links: { }
  2710. 400:
  2711. description: 'Invalid input'
  2712. 422:
  2713. description: 'Unprocessable entity'
  2714. 404:
  2715. description: 'Resource not found'
  2716. summary: 'Updates the Post resource.'
  2717. description: 'Updates the Post resource.'
  2718. parameters:
  2719. -
  2720. name: id
  2721. in: path
  2722. description: 'Post identifier'
  2723. required: true
  2724. deprecated: false
  2725. allowEmptyValue: false
  2726. schema:
  2727. type: string
  2728. style: simple
  2729. explode: false
  2730. allowReserved: false
  2731. requestBody:
  2732. description: 'The updated Post resource'
  2733. content:
  2734. application/merge-patch+json:
  2735. schema:
  2736. $ref: '#/components/schemas/Post-posting.patch'
  2737. required: true
  2738. deprecated: false
  2739. parameters: []
  2740. /api/products:
  2741. get:
  2742. operationId: api_products_get_collection
  2743. tags:
  2744. - Product
  2745. responses:
  2746. 200:
  2747. description: 'Product collection'
  2748. content:
  2749. application/ld+json:
  2750. schema:
  2751. type: object
  2752. properties:
  2753. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  2754. 'hydra:totalItems': { type: integer, minimum: 0 }
  2755. '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 } }
  2756. '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 } } } } } }
  2757. required:
  2758. - 'hydra:member'
  2759. application/json:
  2760. schema:
  2761. type: array
  2762. items:
  2763. $ref: '#/components/schemas/Product'
  2764. text/html:
  2765. schema:
  2766. type: array
  2767. items:
  2768. $ref: '#/components/schemas/Product'
  2769. application/hal+json:
  2770. schema:
  2771. type: object
  2772. properties:
  2773. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  2774. totalItems: { type: integer, minimum: 0 }
  2775. itemsPerPage: { type: integer, minimum: 0 }
  2776. _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 } } } } }
  2777. required:
  2778. - _links
  2779. - _embedded
  2780. summary: 'Retrieves the collection of Product resources.'
  2781. description: 'Retrieves the collection of Product resources.'
  2782. parameters:
  2783. -
  2784. name: page
  2785. in: query
  2786. description: 'The collection page number'
  2787. required: false
  2788. deprecated: false
  2789. allowEmptyValue: true
  2790. schema:
  2791. type: integer
  2792. default: 1
  2793. style: form
  2794. explode: false
  2795. allowReserved: false
  2796. -
  2797. name: itemsPerPage
  2798. in: query
  2799. description: 'The number of items per page'
  2800. required: false
  2801. deprecated: false
  2802. allowEmptyValue: true
  2803. schema:
  2804. type: integer
  2805. default: 10
  2806. minimum: 0
  2807. maximum: 50
  2808. style: form
  2809. explode: false
  2810. allowReserved: false
  2811. -
  2812. name: name
  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: excludePartnerId
  2825. in: query
  2826. description: ''
  2827. required: false
  2828. deprecated: false
  2829. allowEmptyValue: true
  2830. schema:
  2831. type: string
  2832. style: form
  2833. explode: false
  2834. allowReserved: false
  2835. -
  2836. name: 'order[name]'
  2837. in: query
  2838. description: ''
  2839. required: false
  2840. deprecated: false
  2841. allowEmptyValue: true
  2842. schema:
  2843. type: string
  2844. enum:
  2845. - asc
  2846. - desc
  2847. style: form
  2848. explode: false
  2849. allowReserved: false
  2850. deprecated: false
  2851. post:
  2852. operationId: api_products_post
  2853. tags:
  2854. - Product
  2855. responses:
  2856. 201:
  2857. description: 'Product resource created'
  2858. content:
  2859. application/ld+json:
  2860. schema:
  2861. $ref: '#/components/schemas/Product.jsonld'
  2862. application/json:
  2863. schema:
  2864. $ref: '#/components/schemas/Product'
  2865. text/html:
  2866. schema:
  2867. $ref: '#/components/schemas/Product'
  2868. application/hal+json:
  2869. schema:
  2870. $ref: '#/components/schemas/Product.jsonhal'
  2871. links: { }
  2872. 400:
  2873. description: 'Invalid input'
  2874. 422:
  2875. description: 'Unprocessable entity'
  2876. summary: 'Creates a Product resource.'
  2877. description: 'Creates a Product resource.'
  2878. parameters: []
  2879. requestBody:
  2880. description: 'The new Product resource'
  2881. content:
  2882. application/ld+json:
  2883. schema:
  2884. $ref: '#/components/schemas/Product.jsonld'
  2885. application/json:
  2886. schema:
  2887. $ref: '#/components/schemas/Product'
  2888. text/html:
  2889. schema:
  2890. $ref: '#/components/schemas/Product'
  2891. application/hal+json:
  2892. schema:
  2893. $ref: '#/components/schemas/Product.jsonhal'
  2894. required: true
  2895. deprecated: false
  2896. parameters: []
  2897. '/api/products/{id}':
  2898. get:
  2899. operationId: api_products_id_get
  2900. tags:
  2901. - Product
  2902. responses:
  2903. 200:
  2904. description: 'Product resource'
  2905. content:
  2906. application/ld+json:
  2907. schema:
  2908. $ref: '#/components/schemas/Product.jsonld'
  2909. application/json:
  2910. schema:
  2911. $ref: '#/components/schemas/Product'
  2912. text/html:
  2913. schema:
  2914. $ref: '#/components/schemas/Product'
  2915. application/hal+json:
  2916. schema:
  2917. $ref: '#/components/schemas/Product.jsonhal'
  2918. 404:
  2919. description: 'Resource not found'
  2920. summary: 'Retrieves a Product resource.'
  2921. description: 'Retrieves a Product resource.'
  2922. parameters:
  2923. -
  2924. name: id
  2925. in: path
  2926. description: 'Product identifier'
  2927. required: true
  2928. deprecated: false
  2929. allowEmptyValue: false
  2930. schema:
  2931. type: string
  2932. style: simple
  2933. explode: false
  2934. allowReserved: false
  2935. deprecated: false
  2936. patch:
  2937. operationId: api_products_id_patch
  2938. tags:
  2939. - Product
  2940. responses:
  2941. 200:
  2942. description: 'Product resource updated'
  2943. content:
  2944. application/ld+json:
  2945. schema:
  2946. $ref: '#/components/schemas/Product.jsonld'
  2947. application/json:
  2948. schema:
  2949. $ref: '#/components/schemas/Product'
  2950. text/html:
  2951. schema:
  2952. $ref: '#/components/schemas/Product'
  2953. application/hal+json:
  2954. schema:
  2955. $ref: '#/components/schemas/Product.jsonhal'
  2956. links: { }
  2957. 400:
  2958. description: 'Invalid input'
  2959. 422:
  2960. description: 'Unprocessable entity'
  2961. 404:
  2962. description: 'Resource not found'
  2963. summary: 'Updates the Product resource.'
  2964. description: 'Updates the Product resource.'
  2965. parameters:
  2966. -
  2967. name: id
  2968. in: path
  2969. description: 'Product identifier'
  2970. required: true
  2971. deprecated: false
  2972. allowEmptyValue: false
  2973. schema:
  2974. type: string
  2975. style: simple
  2976. explode: false
  2977. allowReserved: false
  2978. requestBody:
  2979. description: 'The updated Product resource'
  2980. content:
  2981. application/merge-patch+json:
  2982. schema:
  2983. $ref: '#/components/schemas/Product'
  2984. required: true
  2985. deprecated: false
  2986. parameters: []
  2987. /api/sale_summaries:
  2988. get:
  2989. operationId: api_sale_summaries_get_collection
  2990. tags:
  2991. - SaleSummary
  2992. responses:
  2993. 200:
  2994. description: 'SaleSummary collection'
  2995. content:
  2996. application/ld+json:
  2997. schema:
  2998. type: object
  2999. properties:
  3000. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonld' } }
  3001. 'hydra:totalItems': { type: integer, minimum: 0 }
  3002. '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 } }
  3003. '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 } } } } } }
  3004. required:
  3005. - 'hydra:member'
  3006. application/json:
  3007. schema:
  3008. type: array
  3009. items:
  3010. $ref: '#/components/schemas/SaleSummary'
  3011. text/html:
  3012. schema:
  3013. type: array
  3014. items:
  3015. $ref: '#/components/schemas/SaleSummary'
  3016. application/hal+json:
  3017. schema:
  3018. type: object
  3019. properties:
  3020. _embedded: { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonhal' } }
  3021. totalItems: { type: integer, minimum: 0 }
  3022. itemsPerPage: { type: integer, minimum: 0 }
  3023. _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 } } } } }
  3024. required:
  3025. - _links
  3026. - _embedded
  3027. summary: 'Retrieves the collection of SaleSummary resources.'
  3028. description: 'Retrieves the collection of SaleSummary resources.'
  3029. parameters:
  3030. -
  3031. name: page
  3032. in: query
  3033. description: 'The collection page number'
  3034. required: false
  3035. deprecated: false
  3036. allowEmptyValue: true
  3037. schema:
  3038. type: integer
  3039. default: 1
  3040. style: form
  3041. explode: false
  3042. allowReserved: false
  3043. -
  3044. name: itemsPerPage
  3045. in: query
  3046. description: 'The number of items per page'
  3047. required: false
  3048. deprecated: false
  3049. allowEmptyValue: true
  3050. schema:
  3051. type: integer
  3052. default: 10
  3053. minimum: 0
  3054. maximum: 50
  3055. style: form
  3056. explode: false
  3057. allowReserved: false
  3058. deprecated: false
  3059. parameters: []
  3060. '/api/sale_summaries/{userId}':
  3061. get:
  3062. operationId: api_sale_summaries_userId_get
  3063. tags:
  3064. - SaleSummary
  3065. responses:
  3066. 200:
  3067. description: 'SaleSummary resource'
  3068. content:
  3069. application/ld+json:
  3070. schema:
  3071. $ref: '#/components/schemas/SaleSummary.jsonld'
  3072. application/json:
  3073. schema:
  3074. $ref: '#/components/schemas/SaleSummary'
  3075. text/html:
  3076. schema:
  3077. $ref: '#/components/schemas/SaleSummary'
  3078. application/hal+json:
  3079. schema:
  3080. $ref: '#/components/schemas/SaleSummary.jsonhal'
  3081. 404:
  3082. description: 'Resource not found'
  3083. summary: 'Retrieves a SaleSummary resource.'
  3084. description: 'Retrieves a SaleSummary resource.'
  3085. parameters:
  3086. -
  3087. name: userId
  3088. in: path
  3089. description: 'SaleSummary identifier'
  3090. required: true
  3091. deprecated: false
  3092. allowEmptyValue: false
  3093. schema:
  3094. type: string
  3095. style: simple
  3096. explode: false
  3097. allowReserved: false
  3098. deprecated: false
  3099. parameters: []
  3100. /api/sales:
  3101. get:
  3102. operationId: api_sales_get_collection
  3103. tags:
  3104. - Sale
  3105. responses:
  3106. 200:
  3107. description: 'Sale collection'
  3108. content:
  3109. application/ld+json:
  3110. schema:
  3111. type: object
  3112. properties:
  3113. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Sale.jsonld' } }
  3114. 'hydra:totalItems': { type: integer, minimum: 0 }
  3115. '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 } }
  3116. '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 } } } } } }
  3117. required:
  3118. - 'hydra:member'
  3119. application/json:
  3120. schema:
  3121. type: array
  3122. items:
  3123. $ref: '#/components/schemas/Sale'
  3124. text/html:
  3125. schema:
  3126. type: array
  3127. items:
  3128. $ref: '#/components/schemas/Sale'
  3129. application/hal+json:
  3130. schema:
  3131. type: object
  3132. properties:
  3133. _embedded: { type: array, items: { $ref: '#/components/schemas/Sale.jsonhal' } }
  3134. totalItems: { type: integer, minimum: 0 }
  3135. itemsPerPage: { type: integer, minimum: 0 }
  3136. _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 } } } } }
  3137. required:
  3138. - _links
  3139. - _embedded
  3140. summary: 'Retrieves the collection of Sale resources.'
  3141. description: 'Retrieves the collection of Sale resources.'
  3142. parameters:
  3143. -
  3144. name: page
  3145. in: query
  3146. description: 'The collection page number'
  3147. required: false
  3148. deprecated: false
  3149. allowEmptyValue: true
  3150. schema:
  3151. type: integer
  3152. default: 1
  3153. style: form
  3154. explode: false
  3155. allowReserved: false
  3156. -
  3157. name: itemsPerPage
  3158. in: query
  3159. description: 'The number of items per page'
  3160. required: false
  3161. deprecated: false
  3162. allowEmptyValue: true
  3163. schema:
  3164. type: integer
  3165. default: 10
  3166. minimum: 0
  3167. maximum: 50
  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: string
  3180. style: form
  3181. explode: false
  3182. allowReserved: false
  3183. -
  3184. name: 'owner[]'
  3185. in: query
  3186. description: ''
  3187. required: false
  3188. deprecated: false
  3189. allowEmptyValue: true
  3190. schema:
  3191. type: array
  3192. items:
  3193. type: string
  3194. style: form
  3195. explode: true
  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: string
  3206. style: form
  3207. explode: false
  3208. allowReserved: false
  3209. -
  3210. name: 'partner[]'
  3211. in: query
  3212. description: ''
  3213. required: false
  3214. deprecated: false
  3215. allowEmptyValue: true
  3216. schema:
  3217. type: array
  3218. items:
  3219. type: string
  3220. style: form
  3221. explode: true
  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: string
  3232. style: form
  3233. explode: false
  3234. allowReserved: false
  3235. -
  3236. name: 'product[]'
  3237. in: query
  3238. description: ''
  3239. required: false
  3240. deprecated: false
  3241. allowEmptyValue: true
  3242. schema:
  3243. type: array
  3244. items:
  3245. type: string
  3246. style: form
  3247. explode: true
  3248. allowReserved: false
  3249. -
  3250. name: 'order[owner.lastName]'
  3251. in: query
  3252. description: ''
  3253. required: false
  3254. deprecated: false
  3255. allowEmptyValue: true
  3256. schema:
  3257. type: string
  3258. enum:
  3259. - asc
  3260. - desc
  3261. style: form
  3262. explode: false
  3263. allowReserved: false
  3264. -
  3265. name: 'order[partner.name]'
  3266. in: query
  3267. description: ''
  3268. required: false
  3269. deprecated: false
  3270. allowEmptyValue: true
  3271. schema:
  3272. type: string
  3273. enum:
  3274. - asc
  3275. - desc
  3276. style: form
  3277. explode: false
  3278. allowReserved: false
  3279. -
  3280. name: 'order[product.name]'
  3281. in: query
  3282. description: ''
  3283. required: false
  3284. deprecated: false
  3285. allowEmptyValue: true
  3286. schema:
  3287. type: string
  3288. enum:
  3289. - asc
  3290. - desc
  3291. style: form
  3292. explode: false
  3293. allowReserved: false
  3294. -
  3295. name: 'order[turnover]'
  3296. in: query
  3297. description: ''
  3298. required: false
  3299. deprecated: false
  3300. allowEmptyValue: true
  3301. schema:
  3302. type: string
  3303. enum:
  3304. - asc
  3305. - desc
  3306. style: form
  3307. explode: false
  3308. allowReserved: false
  3309. -
  3310. name: 'order[profit]'
  3311. in: query
  3312. description: ''
  3313. required: false
  3314. deprecated: false
  3315. allowEmptyValue: true
  3316. schema:
  3317. type: string
  3318. enum:
  3319. - asc
  3320. - desc
  3321. style: form
  3322. explode: false
  3323. allowReserved: false
  3324. -
  3325. name: 'order[createdAt]'
  3326. in: query
  3327. description: ''
  3328. required: false
  3329. deprecated: false
  3330. allowEmptyValue: true
  3331. schema:
  3332. type: string
  3333. enum:
  3334. - asc
  3335. - desc
  3336. style: form
  3337. explode: false
  3338. allowReserved: false
  3339. deprecated: false
  3340. post:
  3341. operationId: api_sales_post
  3342. tags:
  3343. - Sale
  3344. responses:
  3345. 201:
  3346. description: 'Sale resource created'
  3347. content:
  3348. application/ld+json:
  3349. schema:
  3350. $ref: '#/components/schemas/Sale.jsonld'
  3351. application/json:
  3352. schema:
  3353. $ref: '#/components/schemas/Sale'
  3354. text/html:
  3355. schema:
  3356. $ref: '#/components/schemas/Sale'
  3357. application/hal+json:
  3358. schema:
  3359. $ref: '#/components/schemas/Sale.jsonhal'
  3360. links: { }
  3361. 400:
  3362. description: 'Invalid input'
  3363. 422:
  3364. description: 'Unprocessable entity'
  3365. summary: 'Creates a Sale resource.'
  3366. description: 'Creates a Sale resource.'
  3367. parameters: []
  3368. requestBody:
  3369. description: 'The new Sale resource'
  3370. content:
  3371. application/ld+json:
  3372. schema:
  3373. $ref: '#/components/schemas/Sale.jsonld'
  3374. application/json:
  3375. schema:
  3376. $ref: '#/components/schemas/Sale'
  3377. text/html:
  3378. schema:
  3379. $ref: '#/components/schemas/Sale'
  3380. application/hal+json:
  3381. schema:
  3382. $ref: '#/components/schemas/Sale.jsonhal'
  3383. required: true
  3384. deprecated: false
  3385. parameters: []
  3386. '/api/sales/{id}':
  3387. get:
  3388. operationId: api_sales_id_get
  3389. tags:
  3390. - Sale
  3391. responses:
  3392. 200:
  3393. description: 'Sale resource'
  3394. content:
  3395. application/ld+json:
  3396. schema:
  3397. $ref: '#/components/schemas/Sale.jsonld'
  3398. application/json:
  3399. schema:
  3400. $ref: '#/components/schemas/Sale'
  3401. text/html:
  3402. schema:
  3403. $ref: '#/components/schemas/Sale'
  3404. application/hal+json:
  3405. schema:
  3406. $ref: '#/components/schemas/Sale.jsonhal'
  3407. 404:
  3408. description: 'Resource not found'
  3409. summary: 'Retrieves a Sale resource.'
  3410. description: 'Retrieves a Sale resource.'
  3411. parameters:
  3412. -
  3413. name: id
  3414. in: path
  3415. description: 'Sale identifier'
  3416. required: true
  3417. deprecated: false
  3418. allowEmptyValue: false
  3419. schema:
  3420. type: string
  3421. style: simple
  3422. explode: false
  3423. allowReserved: false
  3424. deprecated: false
  3425. patch:
  3426. operationId: api_sales_id_patch
  3427. tags:
  3428. - Sale
  3429. responses:
  3430. 200:
  3431. description: 'Sale resource updated'
  3432. content:
  3433. application/ld+json:
  3434. schema:
  3435. $ref: '#/components/schemas/Sale.jsonld'
  3436. application/json:
  3437. schema:
  3438. $ref: '#/components/schemas/Sale'
  3439. text/html:
  3440. schema:
  3441. $ref: '#/components/schemas/Sale'
  3442. application/hal+json:
  3443. schema:
  3444. $ref: '#/components/schemas/Sale.jsonhal'
  3445. links: { }
  3446. 400:
  3447. description: 'Invalid input'
  3448. 422:
  3449. description: 'Unprocessable entity'
  3450. 404:
  3451. description: 'Resource not found'
  3452. summary: 'Updates the Sale resource.'
  3453. description: 'Updates the Sale resource.'
  3454. parameters:
  3455. -
  3456. name: id
  3457. in: path
  3458. description: 'Sale identifier'
  3459. required: true
  3460. deprecated: false
  3461. allowEmptyValue: false
  3462. schema:
  3463. type: string
  3464. style: simple
  3465. explode: false
  3466. allowReserved: false
  3467. requestBody:
  3468. description: 'The updated Sale resource'
  3469. content:
  3470. application/merge-patch+json:
  3471. schema:
  3472. $ref: '#/components/schemas/Sale'
  3473. required: true
  3474. deprecated: false
  3475. parameters: []
  3476. /api/task_notes:
  3477. get:
  3478. operationId: api_task_notes_get_collection
  3479. tags:
  3480. - TaskNote
  3481. responses:
  3482. 200:
  3483. description: 'TaskNote collection'
  3484. content:
  3485. application/ld+json:
  3486. schema:
  3487. type: object
  3488. properties:
  3489. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonld' } }
  3490. 'hydra:totalItems': { type: integer, minimum: 0 }
  3491. '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 } }
  3492. '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 } } } } } }
  3493. required:
  3494. - 'hydra:member'
  3495. application/json:
  3496. schema:
  3497. type: array
  3498. items:
  3499. $ref: '#/components/schemas/TaskNote'
  3500. text/html:
  3501. schema:
  3502. type: array
  3503. items:
  3504. $ref: '#/components/schemas/TaskNote'
  3505. application/hal+json:
  3506. schema:
  3507. type: object
  3508. properties:
  3509. _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonhal' } }
  3510. totalItems: { type: integer, minimum: 0 }
  3511. itemsPerPage: { type: integer, minimum: 0 }
  3512. _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 } } } } }
  3513. required:
  3514. - _links
  3515. - _embedded
  3516. summary: 'Retrieves the collection of TaskNote resources.'
  3517. description: 'Retrieves the collection of TaskNote resources.'
  3518. parameters:
  3519. -
  3520. name: page
  3521. in: query
  3522. description: 'The collection page number'
  3523. required: false
  3524. deprecated: false
  3525. allowEmptyValue: true
  3526. schema:
  3527. type: integer
  3528. default: 1
  3529. style: form
  3530. explode: false
  3531. allowReserved: false
  3532. -
  3533. name: itemsPerPage
  3534. in: query
  3535. description: 'The number of items per page'
  3536. required: false
  3537. deprecated: false
  3538. allowEmptyValue: true
  3539. schema:
  3540. type: integer
  3541. default: 10
  3542. minimum: 0
  3543. maximum: 50
  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: string
  3556. style: form
  3557. explode: false
  3558. allowReserved: false
  3559. -
  3560. name: 'task[]'
  3561. in: query
  3562. description: ''
  3563. required: false
  3564. deprecated: false
  3565. allowEmptyValue: true
  3566. schema:
  3567. type: array
  3568. items:
  3569. type: string
  3570. style: form
  3571. explode: true
  3572. allowReserved: false
  3573. deprecated: false
  3574. post:
  3575. operationId: api_task_notes_post
  3576. tags:
  3577. - TaskNote
  3578. responses:
  3579. 201:
  3580. description: 'TaskNote resource created'
  3581. content:
  3582. application/ld+json:
  3583. schema:
  3584. $ref: '#/components/schemas/TaskNote.jsonld'
  3585. application/json:
  3586. schema:
  3587. $ref: '#/components/schemas/TaskNote'
  3588. text/html:
  3589. schema:
  3590. $ref: '#/components/schemas/TaskNote'
  3591. application/hal+json:
  3592. schema:
  3593. $ref: '#/components/schemas/TaskNote.jsonhal'
  3594. links: { }
  3595. 400:
  3596. description: 'Invalid input'
  3597. 422:
  3598. description: 'Unprocessable entity'
  3599. summary: 'Creates a TaskNote resource.'
  3600. description: 'Creates a TaskNote resource.'
  3601. parameters: []
  3602. requestBody:
  3603. description: 'The new TaskNote resource'
  3604. content:
  3605. application/ld+json:
  3606. schema:
  3607. $ref: '#/components/schemas/TaskNote.jsonld'
  3608. application/json:
  3609. schema:
  3610. $ref: '#/components/schemas/TaskNote'
  3611. text/html:
  3612. schema:
  3613. $ref: '#/components/schemas/TaskNote'
  3614. application/hal+json:
  3615. schema:
  3616. $ref: '#/components/schemas/TaskNote.jsonhal'
  3617. required: true
  3618. deprecated: false
  3619. parameters: []
  3620. '/api/task_notes/{id}':
  3621. get:
  3622. operationId: api_task_notes_id_get
  3623. tags:
  3624. - TaskNote
  3625. responses:
  3626. 200:
  3627. description: 'TaskNote resource'
  3628. content:
  3629. application/ld+json:
  3630. schema:
  3631. $ref: '#/components/schemas/TaskNote.jsonld'
  3632. application/json:
  3633. schema:
  3634. $ref: '#/components/schemas/TaskNote'
  3635. text/html:
  3636. schema:
  3637. $ref: '#/components/schemas/TaskNote'
  3638. application/hal+json:
  3639. schema:
  3640. $ref: '#/components/schemas/TaskNote.jsonhal'
  3641. 404:
  3642. description: 'Resource not found'
  3643. summary: 'Retrieves a TaskNote resource.'
  3644. description: 'Retrieves a TaskNote resource.'
  3645. parameters:
  3646. -
  3647. name: id
  3648. in: path
  3649. description: 'TaskNote identifier'
  3650. required: true
  3651. deprecated: false
  3652. allowEmptyValue: false
  3653. schema:
  3654. type: string
  3655. style: simple
  3656. explode: false
  3657. allowReserved: false
  3658. deprecated: false
  3659. patch:
  3660. operationId: api_task_notes_id_patch
  3661. tags:
  3662. - TaskNote
  3663. responses:
  3664. 200:
  3665. description: 'TaskNote resource updated'
  3666. content:
  3667. application/ld+json:
  3668. schema:
  3669. $ref: '#/components/schemas/TaskNote.jsonld'
  3670. application/json:
  3671. schema:
  3672. $ref: '#/components/schemas/TaskNote'
  3673. text/html:
  3674. schema:
  3675. $ref: '#/components/schemas/TaskNote'
  3676. application/hal+json:
  3677. schema:
  3678. $ref: '#/components/schemas/TaskNote.jsonhal'
  3679. links: { }
  3680. 400:
  3681. description: 'Invalid input'
  3682. 422:
  3683. description: 'Unprocessable entity'
  3684. 404:
  3685. description: 'Resource not found'
  3686. summary: 'Updates the TaskNote resource.'
  3687. description: 'Updates the TaskNote resource.'
  3688. parameters:
  3689. -
  3690. name: id
  3691. in: path
  3692. description: 'TaskNote identifier'
  3693. required: true
  3694. deprecated: false
  3695. allowEmptyValue: false
  3696. schema:
  3697. type: string
  3698. style: simple
  3699. explode: false
  3700. allowReserved: false
  3701. requestBody:
  3702. description: 'The updated TaskNote resource'
  3703. content:
  3704. application/merge-patch+json:
  3705. schema:
  3706. $ref: '#/components/schemas/TaskNote'
  3707. required: true
  3708. deprecated: false
  3709. parameters: []
  3710. /api/tasks:
  3711. get:
  3712. operationId: api_tasks_get_collection
  3713. tags:
  3714. - Task
  3715. responses:
  3716. 200:
  3717. description: 'Task collection'
  3718. content:
  3719. application/ld+json:
  3720. schema:
  3721. type: object
  3722. properties:
  3723. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  3724. 'hydra:totalItems': { type: integer, minimum: 0 }
  3725. '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 } }
  3726. '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 } } } } } }
  3727. required:
  3728. - 'hydra:member'
  3729. application/json:
  3730. schema:
  3731. type: array
  3732. items:
  3733. $ref: '#/components/schemas/Task'
  3734. text/html:
  3735. schema:
  3736. type: array
  3737. items:
  3738. $ref: '#/components/schemas/Task'
  3739. application/hal+json:
  3740. schema:
  3741. type: object
  3742. properties:
  3743. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  3744. totalItems: { type: integer, minimum: 0 }
  3745. itemsPerPage: { type: integer, minimum: 0 }
  3746. _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 } } } } }
  3747. required:
  3748. - _links
  3749. - _embedded
  3750. summary: 'Retrieves the collection of Task resources.'
  3751. description: 'Retrieves the collection of Task resources.'
  3752. parameters:
  3753. -
  3754. name: page
  3755. in: query
  3756. description: 'The collection page number'
  3757. required: false
  3758. deprecated: false
  3759. allowEmptyValue: true
  3760. schema:
  3761. type: integer
  3762. default: 1
  3763. style: form
  3764. explode: false
  3765. allowReserved: false
  3766. -
  3767. name: itemsPerPage
  3768. in: query
  3769. description: 'The number of items per page'
  3770. required: false
  3771. deprecated: false
  3772. allowEmptyValue: true
  3773. schema:
  3774. type: integer
  3775. default: 10
  3776. minimum: 0
  3777. maximum: 50
  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: string
  3790. style: form
  3791. explode: false
  3792. allowReserved: false
  3793. -
  3794. name: 'assignedTo[]'
  3795. in: query
  3796. description: ''
  3797. required: false
  3798. deprecated: false
  3799. allowEmptyValue: true
  3800. schema:
  3801. type: array
  3802. items:
  3803. type: string
  3804. style: form
  3805. explode: true
  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: string
  3816. style: form
  3817. explode: false
  3818. allowReserved: false
  3819. -
  3820. name: 'partner[]'
  3821. in: query
  3822. description: ''
  3823. required: false
  3824. deprecated: false
  3825. allowEmptyValue: true
  3826. schema:
  3827. type: array
  3828. items:
  3829. type: string
  3830. style: form
  3831. explode: true
  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: string
  3842. style: form
  3843. explode: false
  3844. allowReserved: false
  3845. -
  3846. name: 'contact[]'
  3847. in: query
  3848. description: ''
  3849. required: false
  3850. deprecated: false
  3851. allowEmptyValue: true
  3852. schema:
  3853. type: array
  3854. items:
  3855. type: string
  3856. style: form
  3857. explode: true
  3858. allowReserved: false
  3859. deprecated: false
  3860. post:
  3861. operationId: api_tasks_post
  3862. tags:
  3863. - Task
  3864. responses:
  3865. 201:
  3866. description: 'Task resource created'
  3867. content:
  3868. application/ld+json:
  3869. schema:
  3870. $ref: '#/components/schemas/Task.jsonld'
  3871. application/json:
  3872. schema:
  3873. $ref: '#/components/schemas/Task'
  3874. text/html:
  3875. schema:
  3876. $ref: '#/components/schemas/Task'
  3877. application/hal+json:
  3878. schema:
  3879. $ref: '#/components/schemas/Task.jsonhal'
  3880. links: { }
  3881. 400:
  3882. description: 'Invalid input'
  3883. 422:
  3884. description: 'Unprocessable entity'
  3885. summary: 'Creates a Task resource.'
  3886. description: 'Creates a Task resource.'
  3887. parameters: []
  3888. requestBody:
  3889. description: 'The new Task resource'
  3890. content:
  3891. application/ld+json:
  3892. schema:
  3893. $ref: '#/components/schemas/Task.jsonld'
  3894. application/json:
  3895. schema:
  3896. $ref: '#/components/schemas/Task'
  3897. text/html:
  3898. schema:
  3899. $ref: '#/components/schemas/Task'
  3900. application/hal+json:
  3901. schema:
  3902. $ref: '#/components/schemas/Task.jsonhal'
  3903. required: true
  3904. deprecated: false
  3905. parameters: []
  3906. '/api/tasks/{id}':
  3907. get:
  3908. operationId: api_tasks_id_get
  3909. tags:
  3910. - Task
  3911. responses:
  3912. 200:
  3913. description: 'Task resource'
  3914. content:
  3915. application/ld+json:
  3916. schema:
  3917. $ref: '#/components/schemas/Task.jsonld'
  3918. application/json:
  3919. schema:
  3920. $ref: '#/components/schemas/Task'
  3921. text/html:
  3922. schema:
  3923. $ref: '#/components/schemas/Task'
  3924. application/hal+json:
  3925. schema:
  3926. $ref: '#/components/schemas/Task.jsonhal'
  3927. 404:
  3928. description: 'Resource not found'
  3929. summary: 'Retrieves a Task resource.'
  3930. description: 'Retrieves a Task resource.'
  3931. parameters:
  3932. -
  3933. name: id
  3934. in: path
  3935. description: 'Task identifier'
  3936. required: true
  3937. deprecated: false
  3938. allowEmptyValue: false
  3939. schema:
  3940. type: string
  3941. style: simple
  3942. explode: false
  3943. allowReserved: false
  3944. deprecated: false
  3945. patch:
  3946. operationId: api_tasks_id_patch
  3947. tags:
  3948. - Task
  3949. responses:
  3950. 200:
  3951. description: 'Task resource updated'
  3952. content:
  3953. application/ld+json:
  3954. schema:
  3955. $ref: '#/components/schemas/Task.jsonld'
  3956. application/json:
  3957. schema:
  3958. $ref: '#/components/schemas/Task'
  3959. text/html:
  3960. schema:
  3961. $ref: '#/components/schemas/Task'
  3962. application/hal+json:
  3963. schema:
  3964. $ref: '#/components/schemas/Task.jsonhal'
  3965. links: { }
  3966. 400:
  3967. description: 'Invalid input'
  3968. 422:
  3969. description: 'Unprocessable entity'
  3970. 404:
  3971. description: 'Resource not found'
  3972. summary: 'Updates the Task resource.'
  3973. description: 'Updates the Task resource.'
  3974. parameters:
  3975. -
  3976. name: id
  3977. in: path
  3978. description: 'Task identifier'
  3979. required: true
  3980. deprecated: false
  3981. allowEmptyValue: false
  3982. schema:
  3983. type: string
  3984. style: simple
  3985. explode: false
  3986. allowReserved: false
  3987. requestBody:
  3988. description: 'The updated Task resource'
  3989. content:
  3990. application/merge-patch+json:
  3991. schema:
  3992. $ref: '#/components/schemas/Task'
  3993. required: true
  3994. deprecated: false
  3995. parameters: []
  3996. /api/user_products:
  3997. get:
  3998. operationId: api_user_products_get_collection
  3999. tags:
  4000. - UserProduct
  4001. responses:
  4002. 200:
  4003. description: 'UserProduct collection'
  4004. content:
  4005. application/ld+json:
  4006. schema:
  4007. type: object
  4008. properties:
  4009. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonld' } }
  4010. 'hydra:totalItems': { type: integer, minimum: 0 }
  4011. '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 } }
  4012. '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 } } } } } }
  4013. required:
  4014. - 'hydra:member'
  4015. application/json:
  4016. schema:
  4017. type: array
  4018. items:
  4019. $ref: '#/components/schemas/UserProduct'
  4020. text/html:
  4021. schema:
  4022. type: array
  4023. items:
  4024. $ref: '#/components/schemas/UserProduct'
  4025. application/hal+json:
  4026. schema:
  4027. type: object
  4028. properties:
  4029. _embedded: { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonhal' } }
  4030. totalItems: { type: integer, minimum: 0 }
  4031. itemsPerPage: { type: integer, minimum: 0 }
  4032. _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 } } } } }
  4033. required:
  4034. - _links
  4035. - _embedded
  4036. summary: 'Retrieves the collection of UserProduct resources.'
  4037. description: 'Retrieves the collection of UserProduct resources.'
  4038. parameters:
  4039. -
  4040. name: page
  4041. in: query
  4042. description: 'The collection page number'
  4043. required: false
  4044. deprecated: false
  4045. allowEmptyValue: true
  4046. schema:
  4047. type: integer
  4048. default: 1
  4049. style: form
  4050. explode: false
  4051. allowReserved: false
  4052. -
  4053. name: itemsPerPage
  4054. in: query
  4055. description: 'The number of items per page'
  4056. required: false
  4057. deprecated: false
  4058. allowEmptyValue: true
  4059. schema:
  4060. type: integer
  4061. default: 10
  4062. minimum: 0
  4063. maximum: 50
  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: string
  4076. style: form
  4077. explode: false
  4078. allowReserved: false
  4079. -
  4080. name: 'user[]'
  4081. in: query
  4082. description: ''
  4083. required: false
  4084. deprecated: false
  4085. allowEmptyValue: true
  4086. schema:
  4087. type: array
  4088. items:
  4089. type: string
  4090. style: form
  4091. explode: true
  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: string
  4102. style: form
  4103. explode: false
  4104. allowReserved: false
  4105. -
  4106. name: 'product[]'
  4107. in: query
  4108. description: ''
  4109. required: false
  4110. deprecated: false
  4111. allowEmptyValue: true
  4112. schema:
  4113. type: array
  4114. items:
  4115. type: string
  4116. style: form
  4117. explode: true
  4118. allowReserved: false
  4119. -
  4120. name: 'order[product.name]'
  4121. in: query
  4122. description: ''
  4123. required: false
  4124. deprecated: false
  4125. allowEmptyValue: true
  4126. schema:
  4127. type: string
  4128. enum:
  4129. - asc
  4130. - desc
  4131. style: form
  4132. explode: false
  4133. allowReserved: false
  4134. deprecated: false
  4135. post:
  4136. operationId: api_user_products_post
  4137. tags:
  4138. - UserProduct
  4139. responses:
  4140. 201:
  4141. description: 'UserProduct resource created'
  4142. content:
  4143. application/ld+json:
  4144. schema:
  4145. $ref: '#/components/schemas/UserProduct.jsonld'
  4146. application/json:
  4147. schema:
  4148. $ref: '#/components/schemas/UserProduct'
  4149. text/html:
  4150. schema:
  4151. $ref: '#/components/schemas/UserProduct'
  4152. application/hal+json:
  4153. schema:
  4154. $ref: '#/components/schemas/UserProduct.jsonhal'
  4155. links: { }
  4156. 400:
  4157. description: 'Invalid input'
  4158. 422:
  4159. description: 'Unprocessable entity'
  4160. summary: 'Creates a UserProduct resource.'
  4161. description: 'Creates a UserProduct resource.'
  4162. parameters: []
  4163. requestBody:
  4164. description: 'The new UserProduct resource'
  4165. content:
  4166. application/ld+json:
  4167. schema:
  4168. $ref: '#/components/schemas/UserProduct.jsonld'
  4169. application/json:
  4170. schema:
  4171. $ref: '#/components/schemas/UserProduct'
  4172. text/html:
  4173. schema:
  4174. $ref: '#/components/schemas/UserProduct'
  4175. application/hal+json:
  4176. schema:
  4177. $ref: '#/components/schemas/UserProduct.jsonhal'
  4178. required: true
  4179. deprecated: false
  4180. parameters: []
  4181. '/api/user_products/{id}':
  4182. get:
  4183. operationId: api_user_products_id_get
  4184. tags:
  4185. - UserProduct
  4186. responses:
  4187. 200:
  4188. description: 'UserProduct resource'
  4189. content:
  4190. application/ld+json:
  4191. schema:
  4192. $ref: '#/components/schemas/UserProduct.jsonld'
  4193. application/json:
  4194. schema:
  4195. $ref: '#/components/schemas/UserProduct'
  4196. text/html:
  4197. schema:
  4198. $ref: '#/components/schemas/UserProduct'
  4199. application/hal+json:
  4200. schema:
  4201. $ref: '#/components/schemas/UserProduct.jsonhal'
  4202. 404:
  4203. description: 'Resource not found'
  4204. summary: 'Retrieves a UserProduct resource.'
  4205. description: 'Retrieves a UserProduct resource.'
  4206. parameters:
  4207. -
  4208. name: id
  4209. in: path
  4210. description: 'UserProduct identifier'
  4211. required: true
  4212. deprecated: false
  4213. allowEmptyValue: false
  4214. schema:
  4215. type: string
  4216. style: simple
  4217. explode: false
  4218. allowReserved: false
  4219. deprecated: false
  4220. delete:
  4221. operationId: api_user_products_id_delete
  4222. tags:
  4223. - UserProduct
  4224. responses:
  4225. 204:
  4226. description: 'UserProduct resource deleted'
  4227. 404:
  4228. description: 'Resource not found'
  4229. summary: 'Removes the UserProduct resource.'
  4230. description: 'Removes the UserProduct resource.'
  4231. parameters:
  4232. -
  4233. name: id
  4234. in: path
  4235. description: 'UserProduct identifier'
  4236. required: true
  4237. deprecated: false
  4238. allowEmptyValue: false
  4239. schema:
  4240. type: string
  4241. style: simple
  4242. explode: false
  4243. allowReserved: false
  4244. deprecated: false
  4245. parameters: []
  4246. /api/users:
  4247. get:
  4248. operationId: api_users_get_collection
  4249. tags:
  4250. - User
  4251. responses:
  4252. 200:
  4253. description: 'User collection'
  4254. content:
  4255. application/ld+json:
  4256. schema:
  4257. type: object
  4258. properties:
  4259. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  4260. 'hydra:totalItems': { type: integer, minimum: 0 }
  4261. '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 } }
  4262. '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 } } } } } }
  4263. required:
  4264. - 'hydra:member'
  4265. application/json:
  4266. schema:
  4267. type: array
  4268. items:
  4269. $ref: '#/components/schemas/User'
  4270. text/html:
  4271. schema:
  4272. type: array
  4273. items:
  4274. $ref: '#/components/schemas/User'
  4275. application/hal+json:
  4276. schema:
  4277. type: object
  4278. properties:
  4279. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  4280. totalItems: { type: integer, minimum: 0 }
  4281. itemsPerPage: { type: integer, minimum: 0 }
  4282. _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 } } } } }
  4283. required:
  4284. - _links
  4285. - _embedded
  4286. summary: 'Retrieves the collection of User resources.'
  4287. description: 'Retrieves the collection of User resources.'
  4288. parameters:
  4289. -
  4290. name: page
  4291. in: query
  4292. description: 'The collection page number'
  4293. required: false
  4294. deprecated: false
  4295. allowEmptyValue: true
  4296. schema:
  4297. type: integer
  4298. default: 1
  4299. style: form
  4300. explode: false
  4301. allowReserved: false
  4302. -
  4303. name: itemsPerPage
  4304. in: query
  4305. description: 'The number of items per page'
  4306. required: false
  4307. deprecated: false
  4308. allowEmptyValue: true
  4309. schema:
  4310. type: integer
  4311. default: 10
  4312. minimum: 0
  4313. maximum: 50
  4314. style: form
  4315. explode: false
  4316. allowReserved: false
  4317. -
  4318. name: firstName
  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: lastName
  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: nameSearch
  4343. in: query
  4344. description: ''
  4345. required: false
  4346. deprecated: false
  4347. allowEmptyValue: true
  4348. schema:
  4349. type: string
  4350. style: form
  4351. explode: false
  4352. allowReserved: false
  4353. -
  4354. name: 'order[firstName]'
  4355. in: query
  4356. description: ''
  4357. required: false
  4358. deprecated: false
  4359. allowEmptyValue: true
  4360. schema:
  4361. type: string
  4362. enum:
  4363. - asc
  4364. - desc
  4365. style: form
  4366. explode: false
  4367. allowReserved: false
  4368. -
  4369. name: 'order[lastName]'
  4370. in: query
  4371. description: ''
  4372. required: false
  4373. deprecated: false
  4374. allowEmptyValue: true
  4375. schema:
  4376. type: string
  4377. enum:
  4378. - asc
  4379. - desc
  4380. style: form
  4381. explode: false
  4382. allowReserved: false
  4383. deprecated: false
  4384. post:
  4385. operationId: api_users_post
  4386. tags:
  4387. - User
  4388. responses:
  4389. 201:
  4390. description: 'User resource created'
  4391. content:
  4392. application/ld+json:
  4393. schema:
  4394. $ref: '#/components/schemas/User.jsonld'
  4395. application/json:
  4396. schema:
  4397. $ref: '#/components/schemas/User'
  4398. text/html:
  4399. schema:
  4400. $ref: '#/components/schemas/User'
  4401. application/hal+json:
  4402. schema:
  4403. $ref: '#/components/schemas/User.jsonhal'
  4404. links: { }
  4405. 400:
  4406. description: 'Invalid input'
  4407. 422:
  4408. description: 'Unprocessable entity'
  4409. summary: 'Creates a User resource.'
  4410. description: 'Creates a User resource.'
  4411. parameters: []
  4412. requestBody:
  4413. description: 'The new User resource'
  4414. content:
  4415. application/ld+json:
  4416. schema:
  4417. $ref: '#/components/schemas/User.jsonld'
  4418. application/json:
  4419. schema:
  4420. $ref: '#/components/schemas/User'
  4421. text/html:
  4422. schema:
  4423. $ref: '#/components/schemas/User'
  4424. application/hal+json:
  4425. schema:
  4426. $ref: '#/components/schemas/User.jsonhal'
  4427. required: true
  4428. deprecated: false
  4429. parameters: []
  4430. '/api/users/{id}':
  4431. get:
  4432. operationId: api_users_id_get
  4433. tags:
  4434. - User
  4435. responses:
  4436. 200:
  4437. description: 'User resource'
  4438. content:
  4439. application/ld+json:
  4440. schema:
  4441. $ref: '#/components/schemas/User.jsonld'
  4442. application/json:
  4443. schema:
  4444. $ref: '#/components/schemas/User'
  4445. text/html:
  4446. schema:
  4447. $ref: '#/components/schemas/User'
  4448. application/hal+json:
  4449. schema:
  4450. $ref: '#/components/schemas/User.jsonhal'
  4451. 404:
  4452. description: 'Resource not found'
  4453. summary: 'Retrieves a User resource.'
  4454. description: 'Retrieves a User resource.'
  4455. parameters:
  4456. -
  4457. name: id
  4458. in: path
  4459. description: 'User identifier'
  4460. required: true
  4461. deprecated: false
  4462. allowEmptyValue: false
  4463. schema:
  4464. type: string
  4465. style: simple
  4466. explode: false
  4467. allowReserved: false
  4468. deprecated: false
  4469. parameters: []
  4470. /auth:
  4471. post:
  4472. operationId: login_check_post
  4473. tags:
  4474. - 'Login Check'
  4475. responses:
  4476. 200:
  4477. description: 'User token created'
  4478. content:
  4479. application/json:
  4480. schema:
  4481. type: object
  4482. properties:
  4483. token: { readOnly: true, type: string, nullable: false }
  4484. required:
  4485. - token
  4486. summary: 'Creates a user token.'
  4487. description: 'Creates a user token.'
  4488. requestBody:
  4489. description: 'The login data'
  4490. content:
  4491. application/json:
  4492. schema:
  4493. type: object
  4494. properties:
  4495. email:
  4496. type: string
  4497. nullable: false
  4498. password:
  4499. type: string
  4500. nullable: false
  4501. required:
  4502. - email
  4503. - password
  4504. required: true
  4505. parameters: []
  4506. components:
  4507. schemas:
  4508. Comment:
  4509. type: object
  4510. description: ''
  4511. deprecated: false
  4512. required:
  4513. - message
  4514. properties:
  4515. message:
  4516. type:
  4517. - string
  4518. - 'null'
  4519. owner:
  4520. readOnly: true
  4521. description: '?UserApi'
  4522. $ref: '#/components/schemas/User'
  4523. postIri:
  4524. type:
  4525. - string
  4526. - 'null'
  4527. format: iri-reference
  4528. example: 'https://example.com/'
  4529. createdAt:
  4530. readOnly: true
  4531. type:
  4532. - string
  4533. - 'null'
  4534. format: date-time
  4535. Comment.jsonhal:
  4536. type: object
  4537. description: ''
  4538. deprecated: false
  4539. required:
  4540. - message
  4541. properties:
  4542. _links:
  4543. type: object
  4544. properties:
  4545. self:
  4546. type: object
  4547. properties:
  4548. href:
  4549. type: string
  4550. format: iri-reference
  4551. message:
  4552. type:
  4553. - string
  4554. - 'null'
  4555. owner:
  4556. readOnly: true
  4557. description: '?UserApi'
  4558. $ref: '#/components/schemas/User.jsonhal'
  4559. postIri:
  4560. type:
  4561. - string
  4562. - 'null'
  4563. format: iri-reference
  4564. example: 'https://example.com/'
  4565. createdAt:
  4566. readOnly: true
  4567. type:
  4568. - string
  4569. - 'null'
  4570. format: date-time
  4571. Comment.jsonld:
  4572. type: object
  4573. description: ''
  4574. deprecated: false
  4575. required:
  4576. - message
  4577. properties:
  4578. '@context':
  4579. readOnly: true
  4580. oneOf:
  4581. -
  4582. type: string
  4583. -
  4584. type: object
  4585. properties:
  4586. '@vocab':
  4587. type: string
  4588. hydra:
  4589. type: string
  4590. enum: ['http://www.w3.org/ns/hydra/core#']
  4591. required:
  4592. - '@vocab'
  4593. - hydra
  4594. additionalProperties: true
  4595. '@id':
  4596. readOnly: true
  4597. type: string
  4598. '@type':
  4599. readOnly: true
  4600. type: string
  4601. message:
  4602. type:
  4603. - string
  4604. - 'null'
  4605. owner:
  4606. readOnly: true
  4607. description: '?UserApi'
  4608. $ref: '#/components/schemas/User.jsonld'
  4609. postIri:
  4610. type:
  4611. - string
  4612. - 'null'
  4613. format: iri-reference
  4614. example: 'https://example.com/'
  4615. createdAt:
  4616. readOnly: true
  4617. type:
  4618. - string
  4619. - 'null'
  4620. format: date-time
  4621. Contact:
  4622. type: object
  4623. description: ''
  4624. deprecated: false
  4625. required:
  4626. - firstName
  4627. - lastName
  4628. - partnerIri
  4629. properties:
  4630. firstName:
  4631. type:
  4632. - string
  4633. - 'null'
  4634. lastName:
  4635. type:
  4636. - string
  4637. - 'null'
  4638. fullName:
  4639. type:
  4640. - string
  4641. - 'null'
  4642. partner:
  4643. readOnly: true
  4644. description: '?PartnerApi'
  4645. $ref: '#/components/schemas/Partner'
  4646. partnerIri:
  4647. type:
  4648. - string
  4649. - 'null'
  4650. format: iri-reference
  4651. example: 'https://example.com/'
  4652. birthday:
  4653. type:
  4654. - string
  4655. - 'null'
  4656. format: date-time
  4657. image:
  4658. type:
  4659. - string
  4660. - 'null'
  4661. format: iri-reference
  4662. example: 'https://example.com/'
  4663. imageUrl:
  4664. readOnly: true
  4665. type:
  4666. - string
  4667. - 'null'
  4668. position:
  4669. type:
  4670. - string
  4671. - 'null'
  4672. phone:
  4673. type:
  4674. - string
  4675. - 'null'
  4676. email:
  4677. format: email
  4678. externalDocs:
  4679. url: 'https://schema.org/email'
  4680. type:
  4681. - string
  4682. - 'null'
  4683. posts:
  4684. readOnly: true
  4685. type: array
  4686. items:
  4687. type: string
  4688. format: iri-reference
  4689. example: 'https://example.com/'
  4690. createdBy:
  4691. readOnly: true
  4692. description: '?UserApi'
  4693. $ref: '#/components/schemas/User'
  4694. createdAt:
  4695. readOnly: true
  4696. type:
  4697. - string
  4698. - 'null'
  4699. format: date-time
  4700. Contact.jsonhal:
  4701. type: object
  4702. description: ''
  4703. deprecated: false
  4704. required:
  4705. - firstName
  4706. - lastName
  4707. - partnerIri
  4708. properties:
  4709. _links:
  4710. type: object
  4711. properties:
  4712. self:
  4713. type: object
  4714. properties:
  4715. href:
  4716. type: string
  4717. format: iri-reference
  4718. firstName:
  4719. type:
  4720. - string
  4721. - 'null'
  4722. lastName:
  4723. type:
  4724. - string
  4725. - 'null'
  4726. fullName:
  4727. type:
  4728. - string
  4729. - 'null'
  4730. partner:
  4731. readOnly: true
  4732. description: '?PartnerApi'
  4733. $ref: '#/components/schemas/Partner.jsonhal'
  4734. partnerIri:
  4735. type:
  4736. - string
  4737. - 'null'
  4738. format: iri-reference
  4739. example: 'https://example.com/'
  4740. birthday:
  4741. type:
  4742. - string
  4743. - 'null'
  4744. format: date-time
  4745. image:
  4746. type:
  4747. - string
  4748. - 'null'
  4749. format: iri-reference
  4750. example: 'https://example.com/'
  4751. imageUrl:
  4752. readOnly: true
  4753. type:
  4754. - string
  4755. - 'null'
  4756. position:
  4757. type:
  4758. - string
  4759. - 'null'
  4760. phone:
  4761. type:
  4762. - string
  4763. - 'null'
  4764. email:
  4765. format: email
  4766. externalDocs:
  4767. url: 'https://schema.org/email'
  4768. type:
  4769. - string
  4770. - 'null'
  4771. posts:
  4772. readOnly: true
  4773. type: array
  4774. items:
  4775. type: string
  4776. format: iri-reference
  4777. example: 'https://example.com/'
  4778. createdBy:
  4779. readOnly: true
  4780. description: '?UserApi'
  4781. $ref: '#/components/schemas/User.jsonhal'
  4782. createdAt:
  4783. readOnly: true
  4784. type:
  4785. - string
  4786. - 'null'
  4787. format: date-time
  4788. Contact.jsonld:
  4789. type: object
  4790. description: ''
  4791. deprecated: false
  4792. required:
  4793. - firstName
  4794. - lastName
  4795. - partnerIri
  4796. properties:
  4797. '@context':
  4798. readOnly: true
  4799. oneOf:
  4800. -
  4801. type: string
  4802. -
  4803. type: object
  4804. properties:
  4805. '@vocab':
  4806. type: string
  4807. hydra:
  4808. type: string
  4809. enum: ['http://www.w3.org/ns/hydra/core#']
  4810. required:
  4811. - '@vocab'
  4812. - hydra
  4813. additionalProperties: true
  4814. '@id':
  4815. readOnly: true
  4816. type: string
  4817. '@type':
  4818. readOnly: true
  4819. type: string
  4820. firstName:
  4821. type:
  4822. - string
  4823. - 'null'
  4824. lastName:
  4825. type:
  4826. - string
  4827. - 'null'
  4828. fullName:
  4829. type:
  4830. - string
  4831. - 'null'
  4832. partner:
  4833. readOnly: true
  4834. description: '?PartnerApi'
  4835. $ref: '#/components/schemas/Partner.jsonld'
  4836. partnerIri:
  4837. type:
  4838. - string
  4839. - 'null'
  4840. format: iri-reference
  4841. example: 'https://example.com/'
  4842. birthday:
  4843. type:
  4844. - string
  4845. - 'null'
  4846. format: date-time
  4847. image:
  4848. type:
  4849. - string
  4850. - 'null'
  4851. format: iri-reference
  4852. example: 'https://example.com/'
  4853. imageUrl:
  4854. readOnly: true
  4855. type:
  4856. - string
  4857. - 'null'
  4858. position:
  4859. type:
  4860. - string
  4861. - 'null'
  4862. phone:
  4863. type:
  4864. - string
  4865. - 'null'
  4866. email:
  4867. format: email
  4868. externalDocs:
  4869. url: 'https://schema.org/email'
  4870. type:
  4871. - string
  4872. - 'null'
  4873. posts:
  4874. readOnly: true
  4875. type: array
  4876. items:
  4877. type: string
  4878. format: iri-reference
  4879. example: 'https://example.com/'
  4880. createdBy:
  4881. readOnly: true
  4882. description: '?UserApi'
  4883. $ref: '#/components/schemas/User.jsonld'
  4884. createdAt:
  4885. readOnly: true
  4886. type:
  4887. - string
  4888. - 'null'
  4889. format: date-time
  4890. ContactPartnerProduct:
  4891. type: object
  4892. description: ''
  4893. deprecated: false
  4894. required:
  4895. - contactIri
  4896. - partnerProductIri
  4897. properties:
  4898. contactIri:
  4899. type:
  4900. - string
  4901. - 'null'
  4902. format: iri-reference
  4903. example: 'https://example.com/'
  4904. partnerProductIri:
  4905. type:
  4906. - string
  4907. - 'null'
  4908. format: iri-reference
  4909. example: 'https://example.com/'
  4910. partnerProduct:
  4911. readOnly: true
  4912. description: '?PartnerProduct'
  4913. $ref: '#/components/schemas/PartnerProduct'
  4914. product:
  4915. readOnly: true
  4916. description: '?ProductApi'
  4917. $ref: '#/components/schemas/Product'
  4918. createdAt:
  4919. readOnly: true
  4920. type:
  4921. - string
  4922. - 'null'
  4923. format: date-time
  4924. ContactPartnerProduct.jsonhal:
  4925. type: object
  4926. description: ''
  4927. deprecated: false
  4928. required:
  4929. - contactIri
  4930. - partnerProductIri
  4931. properties:
  4932. _links:
  4933. type: object
  4934. properties:
  4935. self:
  4936. type: object
  4937. properties:
  4938. href:
  4939. type: string
  4940. format: iri-reference
  4941. contactIri:
  4942. type:
  4943. - string
  4944. - 'null'
  4945. format: iri-reference
  4946. example: 'https://example.com/'
  4947. partnerProductIri:
  4948. type:
  4949. - string
  4950. - 'null'
  4951. format: iri-reference
  4952. example: 'https://example.com/'
  4953. partnerProduct:
  4954. readOnly: true
  4955. description: '?PartnerProduct'
  4956. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  4957. product:
  4958. readOnly: true
  4959. description: '?ProductApi'
  4960. $ref: '#/components/schemas/Product.jsonhal'
  4961. createdAt:
  4962. readOnly: true
  4963. type:
  4964. - string
  4965. - 'null'
  4966. format: date-time
  4967. ContactPartnerProduct.jsonld:
  4968. type: object
  4969. description: ''
  4970. deprecated: false
  4971. required:
  4972. - contactIri
  4973. - partnerProductIri
  4974. properties:
  4975. '@context':
  4976. readOnly: true
  4977. oneOf:
  4978. -
  4979. type: string
  4980. -
  4981. type: object
  4982. properties:
  4983. '@vocab':
  4984. type: string
  4985. hydra:
  4986. type: string
  4987. enum: ['http://www.w3.org/ns/hydra/core#']
  4988. required:
  4989. - '@vocab'
  4990. - hydra
  4991. additionalProperties: true
  4992. '@id':
  4993. readOnly: true
  4994. type: string
  4995. '@type':
  4996. readOnly: true
  4997. type: string
  4998. contactIri:
  4999. type:
  5000. - string
  5001. - 'null'
  5002. format: iri-reference
  5003. example: 'https://example.com/'
  5004. partnerProductIri:
  5005. type:
  5006. - string
  5007. - 'null'
  5008. format: iri-reference
  5009. example: 'https://example.com/'
  5010. partnerProduct:
  5011. readOnly: true
  5012. description: '?PartnerProduct'
  5013. $ref: '#/components/schemas/PartnerProduct.jsonld'
  5014. product:
  5015. readOnly: true
  5016. description: '?ProductApi'
  5017. $ref: '#/components/schemas/Product.jsonld'
  5018. createdAt:
  5019. readOnly: true
  5020. type:
  5021. - string
  5022. - 'null'
  5023. format: date-time
  5024. Document:
  5025. type: object
  5026. description: ''
  5027. deprecated: false
  5028. required:
  5029. - name
  5030. - documentObject
  5031. properties:
  5032. name:
  5033. type:
  5034. - string
  5035. - 'null'
  5036. description:
  5037. type:
  5038. - string
  5039. - 'null'
  5040. partner:
  5041. readOnly: true
  5042. description: '?PartnerApi'
  5043. $ref: '#/components/schemas/Partner'
  5044. partnerIri:
  5045. type:
  5046. - string
  5047. - 'null'
  5048. format: iri-reference
  5049. example: 'https://example.com/'
  5050. product:
  5051. readOnly: true
  5052. description: '?ProductApi'
  5053. $ref: '#/components/schemas/Product'
  5054. productIri:
  5055. type:
  5056. - string
  5057. - 'null'
  5058. format: iri-reference
  5059. example: 'https://example.com/'
  5060. documentObject:
  5061. type:
  5062. - string
  5063. - 'null'
  5064. format: iri-reference
  5065. example: 'https://example.com/'
  5066. documentUrl:
  5067. readOnly: true
  5068. type:
  5069. - string
  5070. - 'null'
  5071. createdBy:
  5072. readOnly: true
  5073. description: '?UserApi'
  5074. $ref: '#/components/schemas/User'
  5075. createdAt:
  5076. readOnly: true
  5077. type:
  5078. - string
  5079. - 'null'
  5080. format: date-time
  5081. Document.jsonhal:
  5082. type: object
  5083. description: ''
  5084. deprecated: false
  5085. required:
  5086. - name
  5087. - documentObject
  5088. properties:
  5089. _links:
  5090. type: object
  5091. properties:
  5092. self:
  5093. type: object
  5094. properties:
  5095. href:
  5096. type: string
  5097. format: iri-reference
  5098. name:
  5099. type:
  5100. - string
  5101. - 'null'
  5102. description:
  5103. type:
  5104. - string
  5105. - 'null'
  5106. partner:
  5107. readOnly: true
  5108. description: '?PartnerApi'
  5109. $ref: '#/components/schemas/Partner.jsonhal'
  5110. partnerIri:
  5111. type:
  5112. - string
  5113. - 'null'
  5114. format: iri-reference
  5115. example: 'https://example.com/'
  5116. product:
  5117. readOnly: true
  5118. description: '?ProductApi'
  5119. $ref: '#/components/schemas/Product.jsonhal'
  5120. productIri:
  5121. type:
  5122. - string
  5123. - 'null'
  5124. format: iri-reference
  5125. example: 'https://example.com/'
  5126. documentObject:
  5127. type:
  5128. - string
  5129. - 'null'
  5130. format: iri-reference
  5131. example: 'https://example.com/'
  5132. documentUrl:
  5133. readOnly: true
  5134. type:
  5135. - string
  5136. - 'null'
  5137. createdBy:
  5138. readOnly: true
  5139. description: '?UserApi'
  5140. $ref: '#/components/schemas/User.jsonhal'
  5141. createdAt:
  5142. readOnly: true
  5143. type:
  5144. - string
  5145. - 'null'
  5146. format: date-time
  5147. Document.jsonld:
  5148. type: object
  5149. description: ''
  5150. deprecated: false
  5151. required:
  5152. - name
  5153. - documentObject
  5154. properties:
  5155. '@context':
  5156. readOnly: true
  5157. oneOf:
  5158. -
  5159. type: string
  5160. -
  5161. type: object
  5162. properties:
  5163. '@vocab':
  5164. type: string
  5165. hydra:
  5166. type: string
  5167. enum: ['http://www.w3.org/ns/hydra/core#']
  5168. required:
  5169. - '@vocab'
  5170. - hydra
  5171. additionalProperties: true
  5172. '@id':
  5173. readOnly: true
  5174. type: string
  5175. '@type':
  5176. readOnly: true
  5177. type: string
  5178. name:
  5179. type:
  5180. - string
  5181. - 'null'
  5182. description:
  5183. type:
  5184. - string
  5185. - 'null'
  5186. partner:
  5187. readOnly: true
  5188. description: '?PartnerApi'
  5189. $ref: '#/components/schemas/Partner.jsonld'
  5190. partnerIri:
  5191. type:
  5192. - string
  5193. - 'null'
  5194. format: iri-reference
  5195. example: 'https://example.com/'
  5196. product:
  5197. readOnly: true
  5198. description: '?ProductApi'
  5199. $ref: '#/components/schemas/Product.jsonld'
  5200. productIri:
  5201. type:
  5202. - string
  5203. - 'null'
  5204. format: iri-reference
  5205. example: 'https://example.com/'
  5206. documentObject:
  5207. type:
  5208. - string
  5209. - 'null'
  5210. format: iri-reference
  5211. example: 'https://example.com/'
  5212. documentUrl:
  5213. readOnly: true
  5214. type:
  5215. - string
  5216. - 'null'
  5217. createdBy:
  5218. readOnly: true
  5219. description: '?UserApi'
  5220. $ref: '#/components/schemas/User.jsonld'
  5221. createdAt:
  5222. readOnly: true
  5223. type:
  5224. - string
  5225. - 'null'
  5226. format: date-time
  5227. DocumentObject-document_object.read:
  5228. type: object
  5229. description: ''
  5230. deprecated: false
  5231. externalDocs:
  5232. url: 'https://schema.org/MediaObject'
  5233. properties:
  5234. contentUrl:
  5235. externalDocs:
  5236. url: 'https://schema.org/contentUrl'
  5237. type:
  5238. - string
  5239. - 'null'
  5240. DocumentObject.jsonhal-document_object.read:
  5241. type: object
  5242. description: ''
  5243. deprecated: false
  5244. externalDocs:
  5245. url: 'https://schema.org/MediaObject'
  5246. properties:
  5247. _links:
  5248. type: object
  5249. properties:
  5250. self:
  5251. type: object
  5252. properties:
  5253. href:
  5254. type: string
  5255. format: iri-reference
  5256. contentUrl:
  5257. externalDocs:
  5258. url: 'https://schema.org/contentUrl'
  5259. type:
  5260. - string
  5261. - 'null'
  5262. DocumentObject.jsonld-document_object.read:
  5263. type: object
  5264. description: ''
  5265. deprecated: false
  5266. externalDocs:
  5267. url: 'https://schema.org/MediaObject'
  5268. properties:
  5269. '@context':
  5270. readOnly: true
  5271. oneOf:
  5272. -
  5273. type: string
  5274. -
  5275. type: object
  5276. properties:
  5277. '@vocab':
  5278. type: string
  5279. hydra:
  5280. type: string
  5281. enum: ['http://www.w3.org/ns/hydra/core#']
  5282. required:
  5283. - '@vocab'
  5284. - hydra
  5285. additionalProperties: true
  5286. '@id':
  5287. readOnly: true
  5288. type: string
  5289. '@type':
  5290. readOnly: true
  5291. type: string
  5292. contentUrl:
  5293. externalDocs:
  5294. url: 'https://schema.org/contentUrl'
  5295. type:
  5296. - string
  5297. - 'null'
  5298. MediaObject-media_object.read:
  5299. type: object
  5300. description: ''
  5301. deprecated: false
  5302. externalDocs:
  5303. url: 'https://schema.org/MediaObject'
  5304. properties:
  5305. contentUrl:
  5306. externalDocs:
  5307. url: 'https://schema.org/contentUrl'
  5308. type:
  5309. - string
  5310. - 'null'
  5311. MediaObject.jsonhal-media_object.read:
  5312. type: object
  5313. description: ''
  5314. deprecated: false
  5315. externalDocs:
  5316. url: 'https://schema.org/MediaObject'
  5317. properties:
  5318. _links:
  5319. type: object
  5320. properties:
  5321. self:
  5322. type: object
  5323. properties:
  5324. href:
  5325. type: string
  5326. format: iri-reference
  5327. contentUrl:
  5328. externalDocs:
  5329. url: 'https://schema.org/contentUrl'
  5330. type:
  5331. - string
  5332. - 'null'
  5333. MediaObject.jsonld-media_object.read:
  5334. type: object
  5335. description: ''
  5336. deprecated: false
  5337. externalDocs:
  5338. url: 'https://schema.org/MediaObject'
  5339. properties:
  5340. '@context':
  5341. readOnly: true
  5342. oneOf:
  5343. -
  5344. type: string
  5345. -
  5346. type: object
  5347. properties:
  5348. '@vocab':
  5349. type: string
  5350. hydra:
  5351. type: string
  5352. enum: ['http://www.w3.org/ns/hydra/core#']
  5353. required:
  5354. - '@vocab'
  5355. - hydra
  5356. additionalProperties: true
  5357. '@id':
  5358. readOnly: true
  5359. type: string
  5360. '@type':
  5361. readOnly: true
  5362. type: string
  5363. contentUrl:
  5364. externalDocs:
  5365. url: 'https://schema.org/contentUrl'
  5366. type:
  5367. - string
  5368. - 'null'
  5369. Partner:
  5370. type: object
  5371. description: ''
  5372. deprecated: false
  5373. required:
  5374. - name
  5375. - partnerType
  5376. properties:
  5377. name:
  5378. type: string
  5379. partnerType:
  5380. type: string
  5381. enum:
  5382. - customer
  5383. - supplier
  5384. - service
  5385. description:
  5386. type:
  5387. - string
  5388. - 'null'
  5389. street:
  5390. type:
  5391. - string
  5392. - 'null'
  5393. streetNo:
  5394. type:
  5395. - string
  5396. - 'null'
  5397. zip:
  5398. type:
  5399. - string
  5400. - 'null'
  5401. city:
  5402. type:
  5403. - string
  5404. - 'null'
  5405. country:
  5406. type:
  5407. - string
  5408. - 'null'
  5409. website:
  5410. type:
  5411. - string
  5412. - 'null'
  5413. logo:
  5414. type:
  5415. - string
  5416. - 'null'
  5417. format: iri-reference
  5418. example: 'https://example.com/'
  5419. logoUrl:
  5420. readOnly: true
  5421. type:
  5422. - string
  5423. - 'null'
  5424. createdByIri:
  5425. readOnly: true
  5426. type:
  5427. - string
  5428. - 'null'
  5429. format: iri-reference
  5430. example: 'https://example.com/'
  5431. createdAt:
  5432. readOnly: true
  5433. type:
  5434. - string
  5435. - 'null'
  5436. format: date-time
  5437. Partner.jsonhal:
  5438. type: object
  5439. description: ''
  5440. deprecated: false
  5441. required:
  5442. - name
  5443. - partnerType
  5444. properties:
  5445. _links:
  5446. type: object
  5447. properties:
  5448. self:
  5449. type: object
  5450. properties:
  5451. href:
  5452. type: string
  5453. format: iri-reference
  5454. name:
  5455. type: string
  5456. partnerType:
  5457. type: string
  5458. enum:
  5459. - customer
  5460. - supplier
  5461. - service
  5462. description:
  5463. type:
  5464. - string
  5465. - 'null'
  5466. street:
  5467. type:
  5468. - string
  5469. - 'null'
  5470. streetNo:
  5471. type:
  5472. - string
  5473. - 'null'
  5474. zip:
  5475. type:
  5476. - string
  5477. - 'null'
  5478. city:
  5479. type:
  5480. - string
  5481. - 'null'
  5482. country:
  5483. type:
  5484. - string
  5485. - 'null'
  5486. website:
  5487. type:
  5488. - string
  5489. - 'null'
  5490. logo:
  5491. type:
  5492. - string
  5493. - 'null'
  5494. format: iri-reference
  5495. example: 'https://example.com/'
  5496. logoUrl:
  5497. readOnly: true
  5498. type:
  5499. - string
  5500. - 'null'
  5501. createdByIri:
  5502. readOnly: true
  5503. type:
  5504. - string
  5505. - 'null'
  5506. format: iri-reference
  5507. example: 'https://example.com/'
  5508. createdAt:
  5509. readOnly: true
  5510. type:
  5511. - string
  5512. - 'null'
  5513. format: date-time
  5514. Partner.jsonld:
  5515. type: object
  5516. description: ''
  5517. deprecated: false
  5518. required:
  5519. - name
  5520. - partnerType
  5521. properties:
  5522. '@context':
  5523. readOnly: true
  5524. oneOf:
  5525. -
  5526. type: string
  5527. -
  5528. type: object
  5529. properties:
  5530. '@vocab':
  5531. type: string
  5532. hydra:
  5533. type: string
  5534. enum: ['http://www.w3.org/ns/hydra/core#']
  5535. required:
  5536. - '@vocab'
  5537. - hydra
  5538. additionalProperties: true
  5539. '@id':
  5540. readOnly: true
  5541. type: string
  5542. '@type':
  5543. readOnly: true
  5544. type: string
  5545. name:
  5546. type: string
  5547. partnerType:
  5548. type: string
  5549. enum:
  5550. - customer
  5551. - supplier
  5552. - service
  5553. description:
  5554. type:
  5555. - string
  5556. - 'null'
  5557. street:
  5558. type:
  5559. - string
  5560. - 'null'
  5561. streetNo:
  5562. type:
  5563. - string
  5564. - 'null'
  5565. zip:
  5566. type:
  5567. - string
  5568. - 'null'
  5569. city:
  5570. type:
  5571. - string
  5572. - 'null'
  5573. country:
  5574. type:
  5575. - string
  5576. - 'null'
  5577. website:
  5578. type:
  5579. - string
  5580. - 'null'
  5581. logo:
  5582. type:
  5583. - string
  5584. - 'null'
  5585. format: iri-reference
  5586. example: 'https://example.com/'
  5587. logoUrl:
  5588. readOnly: true
  5589. type:
  5590. - string
  5591. - 'null'
  5592. createdByIri:
  5593. readOnly: true
  5594. type:
  5595. - string
  5596. - 'null'
  5597. format: iri-reference
  5598. example: 'https://example.com/'
  5599. createdAt:
  5600. readOnly: true
  5601. type:
  5602. - string
  5603. - 'null'
  5604. format: date-time
  5605. PartnerFollow:
  5606. type: object
  5607. description: ''
  5608. deprecated: false
  5609. properties:
  5610. userIri:
  5611. type:
  5612. - string
  5613. - 'null'
  5614. format: iri-reference
  5615. example: 'https://example.com/'
  5616. partner:
  5617. readOnly: true
  5618. description: '?PartnerApi'
  5619. $ref: '#/components/schemas/Partner'
  5620. partnerIri:
  5621. type:
  5622. - string
  5623. - 'null'
  5624. format: iri-reference
  5625. example: 'https://example.com/'
  5626. createdAt:
  5627. readOnly: true
  5628. type:
  5629. - string
  5630. - 'null'
  5631. format: date-time
  5632. owner:
  5633. readOnly: true
  5634. type:
  5635. - string
  5636. - 'null'
  5637. format: iri-reference
  5638. example: 'https://example.com/'
  5639. required:
  5640. - partnerIri
  5641. PartnerFollow.jsonhal:
  5642. type: object
  5643. description: ''
  5644. deprecated: false
  5645. properties:
  5646. _links:
  5647. type: object
  5648. properties:
  5649. self:
  5650. type: object
  5651. properties:
  5652. href:
  5653. type: string
  5654. format: iri-reference
  5655. userIri:
  5656. type:
  5657. - string
  5658. - 'null'
  5659. format: iri-reference
  5660. example: 'https://example.com/'
  5661. partner:
  5662. readOnly: true
  5663. description: '?PartnerApi'
  5664. $ref: '#/components/schemas/Partner.jsonhal'
  5665. partnerIri:
  5666. type:
  5667. - string
  5668. - 'null'
  5669. format: iri-reference
  5670. example: 'https://example.com/'
  5671. createdAt:
  5672. readOnly: true
  5673. type:
  5674. - string
  5675. - 'null'
  5676. format: date-time
  5677. owner:
  5678. readOnly: true
  5679. type:
  5680. - string
  5681. - 'null'
  5682. format: iri-reference
  5683. example: 'https://example.com/'
  5684. required:
  5685. - partnerIri
  5686. PartnerFollow.jsonld:
  5687. type: object
  5688. description: ''
  5689. deprecated: false
  5690. properties:
  5691. '@context':
  5692. readOnly: true
  5693. oneOf:
  5694. -
  5695. type: string
  5696. -
  5697. type: object
  5698. properties:
  5699. '@vocab':
  5700. type: string
  5701. hydra:
  5702. type: string
  5703. enum: ['http://www.w3.org/ns/hydra/core#']
  5704. required:
  5705. - '@vocab'
  5706. - hydra
  5707. additionalProperties: true
  5708. '@id':
  5709. readOnly: true
  5710. type: string
  5711. '@type':
  5712. readOnly: true
  5713. type: string
  5714. userIri:
  5715. type:
  5716. - string
  5717. - 'null'
  5718. format: iri-reference
  5719. example: 'https://example.com/'
  5720. partner:
  5721. readOnly: true
  5722. description: '?PartnerApi'
  5723. $ref: '#/components/schemas/Partner.jsonld'
  5724. partnerIri:
  5725. type:
  5726. - string
  5727. - 'null'
  5728. format: iri-reference
  5729. example: 'https://example.com/'
  5730. createdAt:
  5731. readOnly: true
  5732. type:
  5733. - string
  5734. - 'null'
  5735. format: date-time
  5736. owner:
  5737. readOnly: true
  5738. type:
  5739. - string
  5740. - 'null'
  5741. format: iri-reference
  5742. example: 'https://example.com/'
  5743. required:
  5744. - partnerIri
  5745. PartnerProduct:
  5746. type: object
  5747. description: ''
  5748. deprecated: false
  5749. properties:
  5750. partner:
  5751. readOnly: true
  5752. description: '?PartnerApi'
  5753. $ref: '#/components/schemas/Partner'
  5754. partnerIri:
  5755. type:
  5756. - string
  5757. - 'null'
  5758. format: iri-reference
  5759. example: 'https://example.com/'
  5760. product:
  5761. readOnly: true
  5762. description: '?ProductApi'
  5763. $ref: '#/components/schemas/Product'
  5764. productIri:
  5765. type:
  5766. - string
  5767. - 'null'
  5768. format: iri-reference
  5769. example: 'https://example.com/'
  5770. createdAt:
  5771. readOnly: true
  5772. type:
  5773. - string
  5774. - 'null'
  5775. format: date-time
  5776. required:
  5777. - partnerIri
  5778. - productIri
  5779. PartnerProduct.jsonhal:
  5780. type: object
  5781. description: ''
  5782. deprecated: false
  5783. properties:
  5784. _links:
  5785. type: object
  5786. properties:
  5787. self:
  5788. type: object
  5789. properties:
  5790. href:
  5791. type: string
  5792. format: iri-reference
  5793. partner:
  5794. readOnly: true
  5795. description: '?PartnerApi'
  5796. $ref: '#/components/schemas/Partner.jsonhal'
  5797. partnerIri:
  5798. type:
  5799. - string
  5800. - 'null'
  5801. format: iri-reference
  5802. example: 'https://example.com/'
  5803. product:
  5804. readOnly: true
  5805. description: '?ProductApi'
  5806. $ref: '#/components/schemas/Product.jsonhal'
  5807. productIri:
  5808. type:
  5809. - string
  5810. - 'null'
  5811. format: iri-reference
  5812. example: 'https://example.com/'
  5813. createdAt:
  5814. readOnly: true
  5815. type:
  5816. - string
  5817. - 'null'
  5818. format: date-time
  5819. required:
  5820. - partnerIri
  5821. - productIri
  5822. PartnerProduct.jsonld:
  5823. type: object
  5824. description: ''
  5825. deprecated: false
  5826. properties:
  5827. '@context':
  5828. readOnly: true
  5829. oneOf:
  5830. -
  5831. type: string
  5832. -
  5833. type: object
  5834. properties:
  5835. '@vocab':
  5836. type: string
  5837. hydra:
  5838. type: string
  5839. enum: ['http://www.w3.org/ns/hydra/core#']
  5840. required:
  5841. - '@vocab'
  5842. - hydra
  5843. additionalProperties: true
  5844. '@id':
  5845. readOnly: true
  5846. type: string
  5847. '@type':
  5848. readOnly: true
  5849. type: string
  5850. partner:
  5851. readOnly: true
  5852. description: '?PartnerApi'
  5853. $ref: '#/components/schemas/Partner.jsonld'
  5854. partnerIri:
  5855. type:
  5856. - string
  5857. - 'null'
  5858. format: iri-reference
  5859. example: 'https://example.com/'
  5860. product:
  5861. readOnly: true
  5862. description: '?ProductApi'
  5863. $ref: '#/components/schemas/Product.jsonld'
  5864. productIri:
  5865. type:
  5866. - string
  5867. - 'null'
  5868. format: iri-reference
  5869. example: 'https://example.com/'
  5870. createdAt:
  5871. readOnly: true
  5872. type:
  5873. - string
  5874. - 'null'
  5875. format: date-time
  5876. required:
  5877. - partnerIri
  5878. - productIri
  5879. Post:
  5880. type: object
  5881. description: ''
  5882. deprecated: false
  5883. required:
  5884. - headline
  5885. - message
  5886. properties:
  5887. headline:
  5888. type:
  5889. - string
  5890. - 'null'
  5891. message:
  5892. type:
  5893. - string
  5894. - 'null'
  5895. owner:
  5896. readOnly: true
  5897. description: '?UserApi'
  5898. $ref: '#/components/schemas/User'
  5899. partner:
  5900. readOnly: true
  5901. description: '?PartnerApi'
  5902. $ref: '#/components/schemas/Partner'
  5903. partnerIri:
  5904. type:
  5905. - string
  5906. - 'null'
  5907. format: iri-reference
  5908. example: 'https://example.com/'
  5909. product:
  5910. readOnly: true
  5911. description: '?ProductApi'
  5912. $ref: '#/components/schemas/Product'
  5913. productIri:
  5914. type:
  5915. - string
  5916. - 'null'
  5917. format: iri-reference
  5918. example: 'https://example.com/'
  5919. contact:
  5920. readOnly: true
  5921. description: '?ContactApi'
  5922. $ref: '#/components/schemas/Contact'
  5923. contactIri:
  5924. type:
  5925. - string
  5926. - 'null'
  5927. format: iri-reference
  5928. example: 'https://example.com/'
  5929. sale:
  5930. readOnly: true
  5931. description: '?SaleApi'
  5932. $ref: '#/components/schemas/Contact'
  5933. saleIri:
  5934. type:
  5935. - string
  5936. - 'null'
  5937. format: iri-reference
  5938. example: 'https://example.com/'
  5939. numComments:
  5940. readOnly: true
  5941. type:
  5942. - integer
  5943. - 'null'
  5944. createdAt:
  5945. readOnly: true
  5946. type:
  5947. - string
  5948. - 'null'
  5949. format: date-time
  5950. Post-posting.create:
  5951. type: object
  5952. description: ''
  5953. deprecated: false
  5954. required:
  5955. - headline
  5956. - message
  5957. properties:
  5958. headline:
  5959. type:
  5960. - string
  5961. - 'null'
  5962. message:
  5963. type:
  5964. - string
  5965. - 'null'
  5966. partnerIri:
  5967. type:
  5968. - string
  5969. - 'null'
  5970. format: iri-reference
  5971. example: 'https://example.com/'
  5972. productIri:
  5973. type:
  5974. - string
  5975. - 'null'
  5976. format: iri-reference
  5977. example: 'https://example.com/'
  5978. contactIri:
  5979. type:
  5980. - string
  5981. - 'null'
  5982. format: iri-reference
  5983. example: 'https://example.com/'
  5984. saleIri:
  5985. type:
  5986. - string
  5987. - 'null'
  5988. format: iri-reference
  5989. example: 'https://example.com/'
  5990. Post-posting.patch:
  5991. type: object
  5992. description: ''
  5993. deprecated: false
  5994. required:
  5995. - headline
  5996. - message
  5997. properties:
  5998. headline:
  5999. type:
  6000. - string
  6001. - 'null'
  6002. message:
  6003. type:
  6004. - string
  6005. - 'null'
  6006. Post.jsonhal:
  6007. type: object
  6008. description: ''
  6009. deprecated: false
  6010. required:
  6011. - headline
  6012. - message
  6013. properties:
  6014. _links:
  6015. type: object
  6016. properties:
  6017. self:
  6018. type: object
  6019. properties:
  6020. href:
  6021. type: string
  6022. format: iri-reference
  6023. headline:
  6024. type:
  6025. - string
  6026. - 'null'
  6027. message:
  6028. type:
  6029. - string
  6030. - 'null'
  6031. owner:
  6032. readOnly: true
  6033. description: '?UserApi'
  6034. $ref: '#/components/schemas/User.jsonhal'
  6035. partner:
  6036. readOnly: true
  6037. description: '?PartnerApi'
  6038. $ref: '#/components/schemas/Partner.jsonhal'
  6039. partnerIri:
  6040. type:
  6041. - string
  6042. - 'null'
  6043. format: iri-reference
  6044. example: 'https://example.com/'
  6045. product:
  6046. readOnly: true
  6047. description: '?ProductApi'
  6048. $ref: '#/components/schemas/Product.jsonhal'
  6049. productIri:
  6050. type:
  6051. - string
  6052. - 'null'
  6053. format: iri-reference
  6054. example: 'https://example.com/'
  6055. contact:
  6056. readOnly: true
  6057. description: '?ContactApi'
  6058. $ref: '#/components/schemas/Contact.jsonhal'
  6059. contactIri:
  6060. type:
  6061. - string
  6062. - 'null'
  6063. format: iri-reference
  6064. example: 'https://example.com/'
  6065. sale:
  6066. readOnly: true
  6067. description: '?SaleApi'
  6068. $ref: '#/components/schemas/Contact.jsonhal'
  6069. saleIri:
  6070. type:
  6071. - string
  6072. - 'null'
  6073. format: iri-reference
  6074. example: 'https://example.com/'
  6075. numComments:
  6076. readOnly: true
  6077. type:
  6078. - integer
  6079. - 'null'
  6080. createdAt:
  6081. readOnly: true
  6082. type:
  6083. - string
  6084. - 'null'
  6085. format: date-time
  6086. Post.jsonhal-posting.create:
  6087. type: object
  6088. description: ''
  6089. deprecated: false
  6090. required:
  6091. - headline
  6092. - message
  6093. properties:
  6094. _links:
  6095. type: object
  6096. properties:
  6097. self:
  6098. type: object
  6099. properties:
  6100. href:
  6101. type: string
  6102. format: iri-reference
  6103. headline:
  6104. type:
  6105. - string
  6106. - 'null'
  6107. message:
  6108. type:
  6109. - string
  6110. - 'null'
  6111. partnerIri:
  6112. type:
  6113. - string
  6114. - 'null'
  6115. format: iri-reference
  6116. example: 'https://example.com/'
  6117. productIri:
  6118. type:
  6119. - string
  6120. - 'null'
  6121. format: iri-reference
  6122. example: 'https://example.com/'
  6123. contactIri:
  6124. type:
  6125. - string
  6126. - 'null'
  6127. format: iri-reference
  6128. example: 'https://example.com/'
  6129. saleIri:
  6130. type:
  6131. - string
  6132. - 'null'
  6133. format: iri-reference
  6134. example: 'https://example.com/'
  6135. Post.jsonld:
  6136. type: object
  6137. description: ''
  6138. deprecated: false
  6139. required:
  6140. - headline
  6141. - message
  6142. properties:
  6143. '@context':
  6144. readOnly: true
  6145. oneOf:
  6146. -
  6147. type: string
  6148. -
  6149. type: object
  6150. properties:
  6151. '@vocab':
  6152. type: string
  6153. hydra:
  6154. type: string
  6155. enum: ['http://www.w3.org/ns/hydra/core#']
  6156. required:
  6157. - '@vocab'
  6158. - hydra
  6159. additionalProperties: true
  6160. '@id':
  6161. readOnly: true
  6162. type: string
  6163. '@type':
  6164. readOnly: true
  6165. type: string
  6166. headline:
  6167. type:
  6168. - string
  6169. - 'null'
  6170. message:
  6171. type:
  6172. - string
  6173. - 'null'
  6174. owner:
  6175. readOnly: true
  6176. description: '?UserApi'
  6177. $ref: '#/components/schemas/User.jsonld'
  6178. partner:
  6179. readOnly: true
  6180. description: '?PartnerApi'
  6181. $ref: '#/components/schemas/Partner.jsonld'
  6182. partnerIri:
  6183. type:
  6184. - string
  6185. - 'null'
  6186. format: iri-reference
  6187. example: 'https://example.com/'
  6188. product:
  6189. readOnly: true
  6190. description: '?ProductApi'
  6191. $ref: '#/components/schemas/Product.jsonld'
  6192. productIri:
  6193. type:
  6194. - string
  6195. - 'null'
  6196. format: iri-reference
  6197. example: 'https://example.com/'
  6198. contact:
  6199. readOnly: true
  6200. description: '?ContactApi'
  6201. $ref: '#/components/schemas/Contact.jsonld'
  6202. contactIri:
  6203. type:
  6204. - string
  6205. - 'null'
  6206. format: iri-reference
  6207. example: 'https://example.com/'
  6208. sale:
  6209. readOnly: true
  6210. description: '?SaleApi'
  6211. $ref: '#/components/schemas/Contact.jsonld'
  6212. saleIri:
  6213. type:
  6214. - string
  6215. - 'null'
  6216. format: iri-reference
  6217. example: 'https://example.com/'
  6218. numComments:
  6219. readOnly: true
  6220. type:
  6221. - integer
  6222. - 'null'
  6223. createdAt:
  6224. readOnly: true
  6225. type:
  6226. - string
  6227. - 'null'
  6228. format: date-time
  6229. Post.jsonld-posting.create:
  6230. type: object
  6231. description: ''
  6232. deprecated: false
  6233. required:
  6234. - headline
  6235. - message
  6236. properties:
  6237. headline:
  6238. type:
  6239. - string
  6240. - 'null'
  6241. message:
  6242. type:
  6243. - string
  6244. - 'null'
  6245. partnerIri:
  6246. type:
  6247. - string
  6248. - 'null'
  6249. format: iri-reference
  6250. example: 'https://example.com/'
  6251. productIri:
  6252. type:
  6253. - string
  6254. - 'null'
  6255. format: iri-reference
  6256. example: 'https://example.com/'
  6257. contactIri:
  6258. type:
  6259. - string
  6260. - 'null'
  6261. format: iri-reference
  6262. example: 'https://example.com/'
  6263. saleIri:
  6264. type:
  6265. - string
  6266. - 'null'
  6267. format: iri-reference
  6268. example: 'https://example.com/'
  6269. Product:
  6270. type: object
  6271. description: ''
  6272. deprecated: false
  6273. required:
  6274. - name
  6275. properties:
  6276. name:
  6277. type: string
  6278. description:
  6279. type:
  6280. - string
  6281. - 'null'
  6282. image:
  6283. type:
  6284. - string
  6285. - 'null'
  6286. format: iri-reference
  6287. example: 'https://example.com/'
  6288. imageUrl:
  6289. readOnly: true
  6290. type:
  6291. - string
  6292. - 'null'
  6293. createdBy:
  6294. readOnly: true
  6295. description: '?UserApi'
  6296. $ref: '#/components/schemas/User'
  6297. createdAt:
  6298. type:
  6299. - string
  6300. - 'null'
  6301. format: date-time
  6302. Product.jsonhal:
  6303. type: object
  6304. description: ''
  6305. deprecated: false
  6306. required:
  6307. - name
  6308. properties:
  6309. _links:
  6310. type: object
  6311. properties:
  6312. self:
  6313. type: object
  6314. properties:
  6315. href:
  6316. type: string
  6317. format: iri-reference
  6318. name:
  6319. type: string
  6320. description:
  6321. type:
  6322. - string
  6323. - 'null'
  6324. image:
  6325. type:
  6326. - string
  6327. - 'null'
  6328. format: iri-reference
  6329. example: 'https://example.com/'
  6330. imageUrl:
  6331. readOnly: true
  6332. type:
  6333. - string
  6334. - 'null'
  6335. createdBy:
  6336. readOnly: true
  6337. description: '?UserApi'
  6338. $ref: '#/components/schemas/User.jsonhal'
  6339. createdAt:
  6340. type:
  6341. - string
  6342. - 'null'
  6343. format: date-time
  6344. Product.jsonld:
  6345. type: object
  6346. description: ''
  6347. deprecated: false
  6348. required:
  6349. - name
  6350. properties:
  6351. '@context':
  6352. readOnly: true
  6353. oneOf:
  6354. -
  6355. type: string
  6356. -
  6357. type: object
  6358. properties:
  6359. '@vocab':
  6360. type: string
  6361. hydra:
  6362. type: string
  6363. enum: ['http://www.w3.org/ns/hydra/core#']
  6364. required:
  6365. - '@vocab'
  6366. - hydra
  6367. additionalProperties: true
  6368. '@id':
  6369. readOnly: true
  6370. type: string
  6371. '@type':
  6372. readOnly: true
  6373. type: string
  6374. name:
  6375. type: string
  6376. description:
  6377. type:
  6378. - string
  6379. - 'null'
  6380. image:
  6381. type:
  6382. - string
  6383. - 'null'
  6384. format: iri-reference
  6385. example: 'https://example.com/'
  6386. imageUrl:
  6387. readOnly: true
  6388. type:
  6389. - string
  6390. - 'null'
  6391. createdBy:
  6392. readOnly: true
  6393. description: '?UserApi'
  6394. $ref: '#/components/schemas/User.jsonld'
  6395. createdAt:
  6396. type:
  6397. - string
  6398. - 'null'
  6399. format: date-time
  6400. Sale:
  6401. type: object
  6402. description: ''
  6403. deprecated: false
  6404. properties:
  6405. owner:
  6406. readOnly: true
  6407. description: '?UserApi'
  6408. $ref: '#/components/schemas/User'
  6409. partner:
  6410. readOnly: true
  6411. description: '?PartnerApi'
  6412. $ref: '#/components/schemas/Partner'
  6413. partnerIri:
  6414. type:
  6415. - string
  6416. - 'null'
  6417. format: iri-reference
  6418. example: 'https://example.com/'
  6419. product:
  6420. readOnly: true
  6421. description: '?ProductApi'
  6422. $ref: '#/components/schemas/Product'
  6423. productIri:
  6424. type:
  6425. - string
  6426. - 'null'
  6427. format: iri-reference
  6428. example: 'https://example.com/'
  6429. turnover:
  6430. type:
  6431. - integer
  6432. - 'null'
  6433. profit:
  6434. type:
  6435. - integer
  6436. - 'null'
  6437. quantity:
  6438. type:
  6439. - integer
  6440. - 'null'
  6441. comment:
  6442. type:
  6443. - string
  6444. - 'null'
  6445. createdAt:
  6446. readOnly: true
  6447. type:
  6448. - string
  6449. - 'null'
  6450. format: date-time
  6451. required:
  6452. - partnerIri
  6453. - productIri
  6454. - turnover
  6455. - profit
  6456. - quantity
  6457. Sale.jsonhal:
  6458. type: object
  6459. description: ''
  6460. deprecated: false
  6461. properties:
  6462. _links:
  6463. type: object
  6464. properties:
  6465. self:
  6466. type: object
  6467. properties:
  6468. href:
  6469. type: string
  6470. format: iri-reference
  6471. owner:
  6472. readOnly: true
  6473. description: '?UserApi'
  6474. $ref: '#/components/schemas/User.jsonhal'
  6475. partner:
  6476. readOnly: true
  6477. description: '?PartnerApi'
  6478. $ref: '#/components/schemas/Partner.jsonhal'
  6479. partnerIri:
  6480. type:
  6481. - string
  6482. - 'null'
  6483. format: iri-reference
  6484. example: 'https://example.com/'
  6485. product:
  6486. readOnly: true
  6487. description: '?ProductApi'
  6488. $ref: '#/components/schemas/Product.jsonhal'
  6489. productIri:
  6490. type:
  6491. - string
  6492. - 'null'
  6493. format: iri-reference
  6494. example: 'https://example.com/'
  6495. turnover:
  6496. type:
  6497. - integer
  6498. - 'null'
  6499. profit:
  6500. type:
  6501. - integer
  6502. - 'null'
  6503. quantity:
  6504. type:
  6505. - integer
  6506. - 'null'
  6507. comment:
  6508. type:
  6509. - string
  6510. - 'null'
  6511. createdAt:
  6512. readOnly: true
  6513. type:
  6514. - string
  6515. - 'null'
  6516. format: date-time
  6517. required:
  6518. - partnerIri
  6519. - productIri
  6520. - turnover
  6521. - profit
  6522. - quantity
  6523. Sale.jsonld:
  6524. type: object
  6525. description: ''
  6526. deprecated: false
  6527. properties:
  6528. '@context':
  6529. readOnly: true
  6530. oneOf:
  6531. -
  6532. type: string
  6533. -
  6534. type: object
  6535. properties:
  6536. '@vocab':
  6537. type: string
  6538. hydra:
  6539. type: string
  6540. enum: ['http://www.w3.org/ns/hydra/core#']
  6541. required:
  6542. - '@vocab'
  6543. - hydra
  6544. additionalProperties: true
  6545. '@id':
  6546. readOnly: true
  6547. type: string
  6548. '@type':
  6549. readOnly: true
  6550. type: string
  6551. owner:
  6552. readOnly: true
  6553. description: '?UserApi'
  6554. $ref: '#/components/schemas/User.jsonld'
  6555. partner:
  6556. readOnly: true
  6557. description: '?PartnerApi'
  6558. $ref: '#/components/schemas/Partner.jsonld'
  6559. partnerIri:
  6560. type:
  6561. - string
  6562. - 'null'
  6563. format: iri-reference
  6564. example: 'https://example.com/'
  6565. product:
  6566. readOnly: true
  6567. description: '?ProductApi'
  6568. $ref: '#/components/schemas/Product.jsonld'
  6569. productIri:
  6570. type:
  6571. - string
  6572. - 'null'
  6573. format: iri-reference
  6574. example: 'https://example.com/'
  6575. turnover:
  6576. type:
  6577. - integer
  6578. - 'null'
  6579. profit:
  6580. type:
  6581. - integer
  6582. - 'null'
  6583. quantity:
  6584. type:
  6585. - integer
  6586. - 'null'
  6587. comment:
  6588. type:
  6589. - string
  6590. - 'null'
  6591. createdAt:
  6592. readOnly: true
  6593. type:
  6594. - string
  6595. - 'null'
  6596. format: date-time
  6597. required:
  6598. - partnerIri
  6599. - productIri
  6600. - turnover
  6601. - profit
  6602. - quantity
  6603. SaleSummary:
  6604. type: object
  6605. description: ''
  6606. deprecated: false
  6607. properties:
  6608. userId:
  6609. type: integer
  6610. owner:
  6611. readOnly: true
  6612. description: '?UserApi'
  6613. $ref: '#/components/schemas/User'
  6614. turnover:
  6615. type:
  6616. - integer
  6617. - 'null'
  6618. profit:
  6619. type:
  6620. - integer
  6621. - 'null'
  6622. SaleSummary.jsonhal:
  6623. type: object
  6624. description: ''
  6625. deprecated: false
  6626. properties:
  6627. _links:
  6628. type: object
  6629. properties:
  6630. self:
  6631. type: object
  6632. properties:
  6633. href:
  6634. type: string
  6635. format: iri-reference
  6636. userId:
  6637. type: integer
  6638. owner:
  6639. readOnly: true
  6640. description: '?UserApi'
  6641. $ref: '#/components/schemas/User.jsonhal'
  6642. turnover:
  6643. type:
  6644. - integer
  6645. - 'null'
  6646. profit:
  6647. type:
  6648. - integer
  6649. - 'null'
  6650. SaleSummary.jsonld:
  6651. type: object
  6652. description: ''
  6653. deprecated: false
  6654. properties:
  6655. '@id':
  6656. readOnly: true
  6657. type: string
  6658. '@type':
  6659. readOnly: true
  6660. type: string
  6661. '@context':
  6662. readOnly: true
  6663. oneOf:
  6664. -
  6665. type: string
  6666. -
  6667. type: object
  6668. properties:
  6669. '@vocab':
  6670. type: string
  6671. hydra:
  6672. type: string
  6673. enum: ['http://www.w3.org/ns/hydra/core#']
  6674. required:
  6675. - '@vocab'
  6676. - hydra
  6677. additionalProperties: true
  6678. userId:
  6679. type: integer
  6680. owner:
  6681. readOnly: true
  6682. description: '?UserApi'
  6683. $ref: '#/components/schemas/User.jsonld'
  6684. turnover:
  6685. type:
  6686. - integer
  6687. - 'null'
  6688. profit:
  6689. type:
  6690. - integer
  6691. - 'null'
  6692. Task:
  6693. type: object
  6694. description: ''
  6695. deprecated: false
  6696. required:
  6697. - headline
  6698. - assignedToIri
  6699. - dueAt
  6700. - productIri
  6701. - prio
  6702. - completed
  6703. properties:
  6704. headline:
  6705. type:
  6706. - string
  6707. - 'null'
  6708. description:
  6709. type:
  6710. - string
  6711. - 'null'
  6712. createdBy:
  6713. readOnly: true
  6714. description: '?UserApi'
  6715. $ref: '#/components/schemas/User'
  6716. assignedTo:
  6717. readOnly: true
  6718. description: '?UserApi'
  6719. $ref: '#/components/schemas/User'
  6720. assignedToIri:
  6721. type:
  6722. - string
  6723. - 'null'
  6724. format: iri-reference
  6725. example: 'https://example.com/'
  6726. dueAt:
  6727. type:
  6728. - string
  6729. - 'null'
  6730. format: date-time
  6731. partner:
  6732. readOnly: true
  6733. description: '?PartnerApi'
  6734. $ref: '#/components/schemas/Partner'
  6735. partnerIri:
  6736. type:
  6737. - string
  6738. - 'null'
  6739. format: iri-reference
  6740. example: 'https://example.com/'
  6741. product:
  6742. readOnly: true
  6743. description: '?ProductApi'
  6744. $ref: '#/components/schemas/Product'
  6745. productIri:
  6746. type:
  6747. - string
  6748. - 'null'
  6749. format: iri-reference
  6750. example: 'https://example.com/'
  6751. contact:
  6752. readOnly: true
  6753. description: '?ContactApi'
  6754. $ref: '#/components/schemas/Contact'
  6755. contactIri:
  6756. type:
  6757. - string
  6758. - 'null'
  6759. format: iri-reference
  6760. example: 'https://example.com/'
  6761. prio:
  6762. type: string
  6763. enum:
  6764. - low
  6765. - medium
  6766. - high
  6767. completed:
  6768. type:
  6769. - boolean
  6770. - 'null'
  6771. numTaskNotes:
  6772. readOnly: true
  6773. type:
  6774. - integer
  6775. - 'null'
  6776. createdAt:
  6777. readOnly: true
  6778. type:
  6779. - string
  6780. - 'null'
  6781. format: date-time
  6782. Task.jsonhal:
  6783. type: object
  6784. description: ''
  6785. deprecated: false
  6786. required:
  6787. - headline
  6788. - assignedToIri
  6789. - dueAt
  6790. - productIri
  6791. - prio
  6792. - completed
  6793. properties:
  6794. _links:
  6795. type: object
  6796. properties:
  6797. self:
  6798. type: object
  6799. properties:
  6800. href:
  6801. type: string
  6802. format: iri-reference
  6803. headline:
  6804. type:
  6805. - string
  6806. - 'null'
  6807. description:
  6808. type:
  6809. - string
  6810. - 'null'
  6811. createdBy:
  6812. readOnly: true
  6813. description: '?UserApi'
  6814. $ref: '#/components/schemas/User.jsonhal'
  6815. assignedTo:
  6816. readOnly: true
  6817. description: '?UserApi'
  6818. $ref: '#/components/schemas/User.jsonhal'
  6819. assignedToIri:
  6820. type:
  6821. - string
  6822. - 'null'
  6823. format: iri-reference
  6824. example: 'https://example.com/'
  6825. dueAt:
  6826. type:
  6827. - string
  6828. - 'null'
  6829. format: date-time
  6830. partner:
  6831. readOnly: true
  6832. description: '?PartnerApi'
  6833. $ref: '#/components/schemas/Partner.jsonhal'
  6834. partnerIri:
  6835. type:
  6836. - string
  6837. - 'null'
  6838. format: iri-reference
  6839. example: 'https://example.com/'
  6840. product:
  6841. readOnly: true
  6842. description: '?ProductApi'
  6843. $ref: '#/components/schemas/Product.jsonhal'
  6844. productIri:
  6845. type:
  6846. - string
  6847. - 'null'
  6848. format: iri-reference
  6849. example: 'https://example.com/'
  6850. contact:
  6851. readOnly: true
  6852. description: '?ContactApi'
  6853. $ref: '#/components/schemas/Contact.jsonhal'
  6854. contactIri:
  6855. type:
  6856. - string
  6857. - 'null'
  6858. format: iri-reference
  6859. example: 'https://example.com/'
  6860. prio:
  6861. type: string
  6862. enum:
  6863. - low
  6864. - medium
  6865. - high
  6866. completed:
  6867. type:
  6868. - boolean
  6869. - 'null'
  6870. numTaskNotes:
  6871. readOnly: true
  6872. type:
  6873. - integer
  6874. - 'null'
  6875. createdAt:
  6876. readOnly: true
  6877. type:
  6878. - string
  6879. - 'null'
  6880. format: date-time
  6881. Task.jsonld:
  6882. type: object
  6883. description: ''
  6884. deprecated: false
  6885. required:
  6886. - headline
  6887. - assignedToIri
  6888. - dueAt
  6889. - productIri
  6890. - prio
  6891. - completed
  6892. properties:
  6893. '@context':
  6894. readOnly: true
  6895. oneOf:
  6896. -
  6897. type: string
  6898. -
  6899. type: object
  6900. properties:
  6901. '@vocab':
  6902. type: string
  6903. hydra:
  6904. type: string
  6905. enum: ['http://www.w3.org/ns/hydra/core#']
  6906. required:
  6907. - '@vocab'
  6908. - hydra
  6909. additionalProperties: true
  6910. '@id':
  6911. readOnly: true
  6912. type: string
  6913. '@type':
  6914. readOnly: true
  6915. type: string
  6916. headline:
  6917. type:
  6918. - string
  6919. - 'null'
  6920. description:
  6921. type:
  6922. - string
  6923. - 'null'
  6924. createdBy:
  6925. readOnly: true
  6926. description: '?UserApi'
  6927. $ref: '#/components/schemas/User.jsonld'
  6928. assignedTo:
  6929. readOnly: true
  6930. description: '?UserApi'
  6931. $ref: '#/components/schemas/User.jsonld'
  6932. assignedToIri:
  6933. type:
  6934. - string
  6935. - 'null'
  6936. format: iri-reference
  6937. example: 'https://example.com/'
  6938. dueAt:
  6939. type:
  6940. - string
  6941. - 'null'
  6942. format: date-time
  6943. partner:
  6944. readOnly: true
  6945. description: '?PartnerApi'
  6946. $ref: '#/components/schemas/Partner.jsonld'
  6947. partnerIri:
  6948. type:
  6949. - string
  6950. - 'null'
  6951. format: iri-reference
  6952. example: 'https://example.com/'
  6953. product:
  6954. readOnly: true
  6955. description: '?ProductApi'
  6956. $ref: '#/components/schemas/Product.jsonld'
  6957. productIri:
  6958. type:
  6959. - string
  6960. - 'null'
  6961. format: iri-reference
  6962. example: 'https://example.com/'
  6963. contact:
  6964. readOnly: true
  6965. description: '?ContactApi'
  6966. $ref: '#/components/schemas/Contact.jsonld'
  6967. contactIri:
  6968. type:
  6969. - string
  6970. - 'null'
  6971. format: iri-reference
  6972. example: 'https://example.com/'
  6973. prio:
  6974. type: string
  6975. enum:
  6976. - low
  6977. - medium
  6978. - high
  6979. completed:
  6980. type:
  6981. - boolean
  6982. - 'null'
  6983. numTaskNotes:
  6984. readOnly: true
  6985. type:
  6986. - integer
  6987. - 'null'
  6988. createdAt:
  6989. readOnly: true
  6990. type:
  6991. - string
  6992. - 'null'
  6993. format: date-time
  6994. TaskNote:
  6995. type: object
  6996. description: ''
  6997. deprecated: false
  6998. required:
  6999. - message
  7000. - taskIri
  7001. - contactType
  7002. properties:
  7003. message:
  7004. type:
  7005. - string
  7006. - 'null'
  7007. owner:
  7008. readOnly: true
  7009. description: '?UserApi'
  7010. $ref: '#/components/schemas/User'
  7011. taskIri:
  7012. type:
  7013. - string
  7014. - 'null'
  7015. format: iri-reference
  7016. example: 'https://example.com/'
  7017. contact:
  7018. readOnly: true
  7019. description: '?ContactApi'
  7020. $ref: '#/components/schemas/Contact'
  7021. contactIri:
  7022. type:
  7023. - string
  7024. - 'null'
  7025. format: iri-reference
  7026. example: 'https://example.com/'
  7027. contactType:
  7028. type: string
  7029. enum:
  7030. - personal
  7031. - phone
  7032. - email
  7033. createdAt:
  7034. readOnly: true
  7035. type:
  7036. - string
  7037. - 'null'
  7038. format: date-time
  7039. TaskNote.jsonhal:
  7040. type: object
  7041. description: ''
  7042. deprecated: false
  7043. required:
  7044. - message
  7045. - taskIri
  7046. - contactType
  7047. properties:
  7048. _links:
  7049. type: object
  7050. properties:
  7051. self:
  7052. type: object
  7053. properties:
  7054. href:
  7055. type: string
  7056. format: iri-reference
  7057. message:
  7058. type:
  7059. - string
  7060. - 'null'
  7061. owner:
  7062. readOnly: true
  7063. description: '?UserApi'
  7064. $ref: '#/components/schemas/User.jsonhal'
  7065. taskIri:
  7066. type:
  7067. - string
  7068. - 'null'
  7069. format: iri-reference
  7070. example: 'https://example.com/'
  7071. contact:
  7072. readOnly: true
  7073. description: '?ContactApi'
  7074. $ref: '#/components/schemas/Contact.jsonhal'
  7075. contactIri:
  7076. type:
  7077. - string
  7078. - 'null'
  7079. format: iri-reference
  7080. example: 'https://example.com/'
  7081. contactType:
  7082. type: string
  7083. enum:
  7084. - personal
  7085. - phone
  7086. - email
  7087. createdAt:
  7088. readOnly: true
  7089. type:
  7090. - string
  7091. - 'null'
  7092. format: date-time
  7093. TaskNote.jsonld:
  7094. type: object
  7095. description: ''
  7096. deprecated: false
  7097. required:
  7098. - message
  7099. - taskIri
  7100. - contactType
  7101. properties:
  7102. '@context':
  7103. readOnly: true
  7104. oneOf:
  7105. -
  7106. type: string
  7107. -
  7108. type: object
  7109. properties:
  7110. '@vocab':
  7111. type: string
  7112. hydra:
  7113. type: string
  7114. enum: ['http://www.w3.org/ns/hydra/core#']
  7115. required:
  7116. - '@vocab'
  7117. - hydra
  7118. additionalProperties: true
  7119. '@id':
  7120. readOnly: true
  7121. type: string
  7122. '@type':
  7123. readOnly: true
  7124. type: string
  7125. message:
  7126. type:
  7127. - string
  7128. - 'null'
  7129. owner:
  7130. readOnly: true
  7131. description: '?UserApi'
  7132. $ref: '#/components/schemas/User.jsonld'
  7133. taskIri:
  7134. type:
  7135. - string
  7136. - 'null'
  7137. format: iri-reference
  7138. example: 'https://example.com/'
  7139. contact:
  7140. readOnly: true
  7141. description: '?ContactApi'
  7142. $ref: '#/components/schemas/Contact.jsonld'
  7143. contactIri:
  7144. type:
  7145. - string
  7146. - 'null'
  7147. format: iri-reference
  7148. example: 'https://example.com/'
  7149. contactType:
  7150. type: string
  7151. enum:
  7152. - personal
  7153. - phone
  7154. - email
  7155. createdAt:
  7156. readOnly: true
  7157. type:
  7158. - string
  7159. - 'null'
  7160. format: date-time
  7161. User:
  7162. type: object
  7163. description: ''
  7164. deprecated: false
  7165. required:
  7166. - email
  7167. - firstName
  7168. - lastName
  7169. properties:
  7170. email:
  7171. format: email
  7172. externalDocs:
  7173. url: 'https://schema.org/email'
  7174. type:
  7175. - string
  7176. - 'null'
  7177. firstName:
  7178. type:
  7179. - string
  7180. - 'null'
  7181. lastName:
  7182. type:
  7183. - string
  7184. - 'null'
  7185. goals:
  7186. type:
  7187. - string
  7188. - 'null'
  7189. image:
  7190. type:
  7191. - string
  7192. - 'null'
  7193. format: iri-reference
  7194. example: 'https://example.com/'
  7195. imageUrl:
  7196. readOnly: true
  7197. type:
  7198. - string
  7199. - 'null'
  7200. fullName:
  7201. readOnly: true
  7202. type:
  7203. - string
  7204. - 'null'
  7205. password:
  7206. writeOnly: true
  7207. description: 'The plaintext password when being set or changed.'
  7208. type:
  7209. - string
  7210. - 'null'
  7211. active:
  7212. type: boolean
  7213. createdAt:
  7214. readOnly: true
  7215. type:
  7216. - string
  7217. - 'null'
  7218. format: date-time
  7219. User.jsonhal:
  7220. type: object
  7221. description: ''
  7222. deprecated: false
  7223. required:
  7224. - email
  7225. - firstName
  7226. - lastName
  7227. properties:
  7228. _links:
  7229. type: object
  7230. properties:
  7231. self:
  7232. type: object
  7233. properties:
  7234. href:
  7235. type: string
  7236. format: iri-reference
  7237. email:
  7238. format: email
  7239. externalDocs:
  7240. url: 'https://schema.org/email'
  7241. type:
  7242. - string
  7243. - 'null'
  7244. firstName:
  7245. type:
  7246. - string
  7247. - 'null'
  7248. lastName:
  7249. type:
  7250. - string
  7251. - 'null'
  7252. goals:
  7253. type:
  7254. - string
  7255. - 'null'
  7256. image:
  7257. type:
  7258. - string
  7259. - 'null'
  7260. format: iri-reference
  7261. example: 'https://example.com/'
  7262. imageUrl:
  7263. readOnly: true
  7264. type:
  7265. - string
  7266. - 'null'
  7267. fullName:
  7268. readOnly: true
  7269. type:
  7270. - string
  7271. - 'null'
  7272. password:
  7273. writeOnly: true
  7274. description: 'The plaintext password when being set or changed.'
  7275. type:
  7276. - string
  7277. - 'null'
  7278. active:
  7279. type: boolean
  7280. createdAt:
  7281. readOnly: true
  7282. type:
  7283. - string
  7284. - 'null'
  7285. format: date-time
  7286. User.jsonld:
  7287. type: object
  7288. description: ''
  7289. deprecated: false
  7290. required:
  7291. - email
  7292. - firstName
  7293. - lastName
  7294. properties:
  7295. '@context':
  7296. readOnly: true
  7297. oneOf:
  7298. -
  7299. type: string
  7300. -
  7301. type: object
  7302. properties:
  7303. '@vocab':
  7304. type: string
  7305. hydra:
  7306. type: string
  7307. enum: ['http://www.w3.org/ns/hydra/core#']
  7308. required:
  7309. - '@vocab'
  7310. - hydra
  7311. additionalProperties: true
  7312. '@id':
  7313. readOnly: true
  7314. type: string
  7315. '@type':
  7316. readOnly: true
  7317. type: string
  7318. email:
  7319. format: email
  7320. externalDocs:
  7321. url: 'https://schema.org/email'
  7322. type:
  7323. - string
  7324. - 'null'
  7325. firstName:
  7326. type:
  7327. - string
  7328. - 'null'
  7329. lastName:
  7330. type:
  7331. - string
  7332. - 'null'
  7333. goals:
  7334. type:
  7335. - string
  7336. - 'null'
  7337. image:
  7338. type:
  7339. - string
  7340. - 'null'
  7341. format: iri-reference
  7342. example: 'https://example.com/'
  7343. imageUrl:
  7344. readOnly: true
  7345. type:
  7346. - string
  7347. - 'null'
  7348. fullName:
  7349. readOnly: true
  7350. type:
  7351. - string
  7352. - 'null'
  7353. password:
  7354. writeOnly: true
  7355. description: 'The plaintext password when being set or changed.'
  7356. type:
  7357. - string
  7358. - 'null'
  7359. active:
  7360. type: boolean
  7361. createdAt:
  7362. readOnly: true
  7363. type:
  7364. - string
  7365. - 'null'
  7366. format: date-time
  7367. UserProduct:
  7368. type: object
  7369. description: ''
  7370. deprecated: false
  7371. properties:
  7372. user:
  7373. readOnly: true
  7374. description: '?UserApi'
  7375. $ref: '#/components/schemas/User'
  7376. product:
  7377. readOnly: true
  7378. description: '?ProductApi'
  7379. $ref: '#/components/schemas/Product'
  7380. productIri:
  7381. type:
  7382. - string
  7383. - 'null'
  7384. format: iri-reference
  7385. example: 'https://example.com/'
  7386. createdAt:
  7387. readOnly: true
  7388. type:
  7389. - string
  7390. - 'null'
  7391. format: date-time
  7392. owner:
  7393. readOnly: true
  7394. type:
  7395. - string
  7396. - 'null'
  7397. format: iri-reference
  7398. example: 'https://example.com/'
  7399. required:
  7400. - productIri
  7401. UserProduct.jsonhal:
  7402. type: object
  7403. description: ''
  7404. deprecated: false
  7405. properties:
  7406. _links:
  7407. type: object
  7408. properties:
  7409. self:
  7410. type: object
  7411. properties:
  7412. href:
  7413. type: string
  7414. format: iri-reference
  7415. user:
  7416. readOnly: true
  7417. description: '?UserApi'
  7418. $ref: '#/components/schemas/User.jsonhal'
  7419. product:
  7420. readOnly: true
  7421. description: '?ProductApi'
  7422. $ref: '#/components/schemas/Product.jsonhal'
  7423. productIri:
  7424. type:
  7425. - string
  7426. - 'null'
  7427. format: iri-reference
  7428. example: 'https://example.com/'
  7429. createdAt:
  7430. readOnly: true
  7431. type:
  7432. - string
  7433. - 'null'
  7434. format: date-time
  7435. owner:
  7436. readOnly: true
  7437. type:
  7438. - string
  7439. - 'null'
  7440. format: iri-reference
  7441. example: 'https://example.com/'
  7442. required:
  7443. - productIri
  7444. UserProduct.jsonld:
  7445. type: object
  7446. description: ''
  7447. deprecated: false
  7448. properties:
  7449. '@context':
  7450. readOnly: true
  7451. oneOf:
  7452. -
  7453. type: string
  7454. -
  7455. type: object
  7456. properties:
  7457. '@vocab':
  7458. type: string
  7459. hydra:
  7460. type: string
  7461. enum: ['http://www.w3.org/ns/hydra/core#']
  7462. required:
  7463. - '@vocab'
  7464. - hydra
  7465. additionalProperties: true
  7466. '@id':
  7467. readOnly: true
  7468. type: string
  7469. '@type':
  7470. readOnly: true
  7471. type: string
  7472. user:
  7473. readOnly: true
  7474. description: '?UserApi'
  7475. $ref: '#/components/schemas/User.jsonld'
  7476. product:
  7477. readOnly: true
  7478. description: '?ProductApi'
  7479. $ref: '#/components/schemas/Product.jsonld'
  7480. productIri:
  7481. type:
  7482. - string
  7483. - 'null'
  7484. format: iri-reference
  7485. example: 'https://example.com/'
  7486. createdAt:
  7487. readOnly: true
  7488. type:
  7489. - string
  7490. - 'null'
  7491. format: date-time
  7492. owner:
  7493. readOnly: true
  7494. type:
  7495. - string
  7496. - 'null'
  7497. format: iri-reference
  7498. example: 'https://example.com/'
  7499. required:
  7500. - productIri
  7501. responses: { }
  7502. parameters: { }
  7503. examples: { }
  7504. requestBodies: { }
  7505. headers: { }
  7506. securitySchemes:
  7507. JWT:
  7508. type: http
  7509. scheme: bearer
  7510. bearerFormat: JWT
  7511. security:
  7512. -
  7513. JWT: []
  7514. tags: []