Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
 
 
 

7207 Zeilen
211 KiB

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