You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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