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

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