No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 
 

7233 líneas
212 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: excludeContactId
  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: excludePartnerId
  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. -
  3061. name: product
  3062. in: query
  3063. description: ''
  3064. required: false
  3065. deprecated: false
  3066. allowEmptyValue: true
  3067. schema:
  3068. type: string
  3069. style: form
  3070. explode: false
  3071. allowReserved: false
  3072. -
  3073. name: 'product[]'
  3074. in: query
  3075. description: ''
  3076. required: false
  3077. deprecated: false
  3078. allowEmptyValue: true
  3079. schema:
  3080. type: array
  3081. items:
  3082. type: string
  3083. style: form
  3084. explode: true
  3085. allowReserved: false
  3086. deprecated: false
  3087. post:
  3088. operationId: api_sales_post
  3089. tags:
  3090. - Sale
  3091. responses:
  3092. 201:
  3093. description: 'Sale resource created'
  3094. content:
  3095. application/ld+json:
  3096. schema:
  3097. $ref: '#/components/schemas/Sale.jsonld'
  3098. application/json:
  3099. schema:
  3100. $ref: '#/components/schemas/Sale'
  3101. text/html:
  3102. schema:
  3103. $ref: '#/components/schemas/Sale'
  3104. application/hal+json:
  3105. schema:
  3106. $ref: '#/components/schemas/Sale.jsonhal'
  3107. links: { }
  3108. 400:
  3109. description: 'Invalid input'
  3110. 422:
  3111. description: 'Unprocessable entity'
  3112. summary: 'Creates a Sale resource.'
  3113. description: 'Creates a Sale resource.'
  3114. parameters: []
  3115. requestBody:
  3116. description: 'The new Sale resource'
  3117. content:
  3118. application/ld+json:
  3119. schema:
  3120. $ref: '#/components/schemas/Sale.jsonld'
  3121. application/json:
  3122. schema:
  3123. $ref: '#/components/schemas/Sale'
  3124. text/html:
  3125. schema:
  3126. $ref: '#/components/schemas/Sale'
  3127. application/hal+json:
  3128. schema:
  3129. $ref: '#/components/schemas/Sale.jsonhal'
  3130. required: true
  3131. deprecated: false
  3132. parameters: []
  3133. '/api/sales/{id}':
  3134. get:
  3135. operationId: api_sales_id_get
  3136. tags:
  3137. - Sale
  3138. responses:
  3139. 200:
  3140. description: 'Sale resource'
  3141. content:
  3142. application/ld+json:
  3143. schema:
  3144. $ref: '#/components/schemas/Sale.jsonld'
  3145. application/json:
  3146. schema:
  3147. $ref: '#/components/schemas/Sale'
  3148. text/html:
  3149. schema:
  3150. $ref: '#/components/schemas/Sale'
  3151. application/hal+json:
  3152. schema:
  3153. $ref: '#/components/schemas/Sale.jsonhal'
  3154. 404:
  3155. description: 'Resource not found'
  3156. summary: 'Retrieves a Sale resource.'
  3157. description: 'Retrieves a Sale resource.'
  3158. parameters:
  3159. -
  3160. name: id
  3161. in: path
  3162. description: 'Sale identifier'
  3163. required: true
  3164. deprecated: false
  3165. allowEmptyValue: false
  3166. schema:
  3167. type: string
  3168. style: simple
  3169. explode: false
  3170. allowReserved: false
  3171. deprecated: false
  3172. patch:
  3173. operationId: api_sales_id_patch
  3174. tags:
  3175. - Sale
  3176. responses:
  3177. 200:
  3178. description: 'Sale resource updated'
  3179. content:
  3180. application/ld+json:
  3181. schema:
  3182. $ref: '#/components/schemas/Sale.jsonld'
  3183. application/json:
  3184. schema:
  3185. $ref: '#/components/schemas/Sale'
  3186. text/html:
  3187. schema:
  3188. $ref: '#/components/schemas/Sale'
  3189. application/hal+json:
  3190. schema:
  3191. $ref: '#/components/schemas/Sale.jsonhal'
  3192. links: { }
  3193. 400:
  3194. description: 'Invalid input'
  3195. 422:
  3196. description: 'Unprocessable entity'
  3197. 404:
  3198. description: 'Resource not found'
  3199. summary: 'Updates the Sale resource.'
  3200. description: 'Updates the Sale resource.'
  3201. parameters:
  3202. -
  3203. name: id
  3204. in: path
  3205. description: 'Sale identifier'
  3206. required: true
  3207. deprecated: false
  3208. allowEmptyValue: false
  3209. schema:
  3210. type: string
  3211. style: simple
  3212. explode: false
  3213. allowReserved: false
  3214. requestBody:
  3215. description: 'The updated Sale resource'
  3216. content:
  3217. application/merge-patch+json:
  3218. schema:
  3219. $ref: '#/components/schemas/Sale'
  3220. required: true
  3221. deprecated: false
  3222. parameters: []
  3223. /api/task_notes:
  3224. get:
  3225. operationId: api_task_notes_get_collection
  3226. tags:
  3227. - TaskNote
  3228. responses:
  3229. 200:
  3230. description: 'TaskNote collection'
  3231. content:
  3232. application/ld+json:
  3233. schema:
  3234. type: object
  3235. properties:
  3236. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonld' } }
  3237. 'hydra:totalItems': { type: integer, minimum: 0 }
  3238. '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 } }
  3239. '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 } } } } } }
  3240. required:
  3241. - 'hydra:member'
  3242. application/json:
  3243. schema:
  3244. type: array
  3245. items:
  3246. $ref: '#/components/schemas/TaskNote'
  3247. text/html:
  3248. schema:
  3249. type: array
  3250. items:
  3251. $ref: '#/components/schemas/TaskNote'
  3252. application/hal+json:
  3253. schema:
  3254. type: object
  3255. properties:
  3256. _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonhal' } }
  3257. totalItems: { type: integer, minimum: 0 }
  3258. itemsPerPage: { type: integer, minimum: 0 }
  3259. _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 } } } } }
  3260. required:
  3261. - _links
  3262. - _embedded
  3263. summary: 'Retrieves the collection of TaskNote resources.'
  3264. description: 'Retrieves the collection of TaskNote resources.'
  3265. parameters:
  3266. -
  3267. name: page
  3268. in: query
  3269. description: 'The collection page number'
  3270. required: false
  3271. deprecated: false
  3272. allowEmptyValue: true
  3273. schema:
  3274. type: integer
  3275. default: 1
  3276. style: form
  3277. explode: false
  3278. allowReserved: false
  3279. -
  3280. name: itemsPerPage
  3281. in: query
  3282. description: 'The number of items per page'
  3283. required: false
  3284. deprecated: false
  3285. allowEmptyValue: true
  3286. schema:
  3287. type: integer
  3288. default: 10
  3289. minimum: 0
  3290. maximum: 50
  3291. style: form
  3292. explode: false
  3293. allowReserved: false
  3294. -
  3295. name: task
  3296. in: query
  3297. description: ''
  3298. required: false
  3299. deprecated: false
  3300. allowEmptyValue: true
  3301. schema:
  3302. type: string
  3303. style: form
  3304. explode: false
  3305. allowReserved: false
  3306. -
  3307. name: 'task[]'
  3308. in: query
  3309. description: ''
  3310. required: false
  3311. deprecated: false
  3312. allowEmptyValue: true
  3313. schema:
  3314. type: array
  3315. items:
  3316. type: string
  3317. style: form
  3318. explode: true
  3319. allowReserved: false
  3320. deprecated: false
  3321. post:
  3322. operationId: api_task_notes_post
  3323. tags:
  3324. - TaskNote
  3325. responses:
  3326. 201:
  3327. description: 'TaskNote resource created'
  3328. content:
  3329. application/ld+json:
  3330. schema:
  3331. $ref: '#/components/schemas/TaskNote.jsonld'
  3332. application/json:
  3333. schema:
  3334. $ref: '#/components/schemas/TaskNote'
  3335. text/html:
  3336. schema:
  3337. $ref: '#/components/schemas/TaskNote'
  3338. application/hal+json:
  3339. schema:
  3340. $ref: '#/components/schemas/TaskNote.jsonhal'
  3341. links: { }
  3342. 400:
  3343. description: 'Invalid input'
  3344. 422:
  3345. description: 'Unprocessable entity'
  3346. summary: 'Creates a TaskNote resource.'
  3347. description: 'Creates a TaskNote resource.'
  3348. parameters: []
  3349. requestBody:
  3350. description: 'The new TaskNote resource'
  3351. content:
  3352. application/ld+json:
  3353. schema:
  3354. $ref: '#/components/schemas/TaskNote.jsonld'
  3355. application/json:
  3356. schema:
  3357. $ref: '#/components/schemas/TaskNote'
  3358. text/html:
  3359. schema:
  3360. $ref: '#/components/schemas/TaskNote'
  3361. application/hal+json:
  3362. schema:
  3363. $ref: '#/components/schemas/TaskNote.jsonhal'
  3364. required: true
  3365. deprecated: false
  3366. parameters: []
  3367. '/api/task_notes/{id}':
  3368. get:
  3369. operationId: api_task_notes_id_get
  3370. tags:
  3371. - TaskNote
  3372. responses:
  3373. 200:
  3374. description: 'TaskNote resource'
  3375. content:
  3376. application/ld+json:
  3377. schema:
  3378. $ref: '#/components/schemas/TaskNote.jsonld'
  3379. application/json:
  3380. schema:
  3381. $ref: '#/components/schemas/TaskNote'
  3382. text/html:
  3383. schema:
  3384. $ref: '#/components/schemas/TaskNote'
  3385. application/hal+json:
  3386. schema:
  3387. $ref: '#/components/schemas/TaskNote.jsonhal'
  3388. 404:
  3389. description: 'Resource not found'
  3390. summary: 'Retrieves a TaskNote resource.'
  3391. description: 'Retrieves a TaskNote resource.'
  3392. parameters:
  3393. -
  3394. name: id
  3395. in: path
  3396. description: 'TaskNote identifier'
  3397. required: true
  3398. deprecated: false
  3399. allowEmptyValue: false
  3400. schema:
  3401. type: string
  3402. style: simple
  3403. explode: false
  3404. allowReserved: false
  3405. deprecated: false
  3406. patch:
  3407. operationId: api_task_notes_id_patch
  3408. tags:
  3409. - TaskNote
  3410. responses:
  3411. 200:
  3412. description: 'TaskNote resource updated'
  3413. content:
  3414. application/ld+json:
  3415. schema:
  3416. $ref: '#/components/schemas/TaskNote.jsonld'
  3417. application/json:
  3418. schema:
  3419. $ref: '#/components/schemas/TaskNote'
  3420. text/html:
  3421. schema:
  3422. $ref: '#/components/schemas/TaskNote'
  3423. application/hal+json:
  3424. schema:
  3425. $ref: '#/components/schemas/TaskNote.jsonhal'
  3426. links: { }
  3427. 400:
  3428. description: 'Invalid input'
  3429. 422:
  3430. description: 'Unprocessable entity'
  3431. 404:
  3432. description: 'Resource not found'
  3433. summary: 'Updates the TaskNote resource.'
  3434. description: 'Updates the TaskNote resource.'
  3435. parameters:
  3436. -
  3437. name: id
  3438. in: path
  3439. description: 'TaskNote identifier'
  3440. required: true
  3441. deprecated: false
  3442. allowEmptyValue: false
  3443. schema:
  3444. type: string
  3445. style: simple
  3446. explode: false
  3447. allowReserved: false
  3448. requestBody:
  3449. description: 'The updated TaskNote resource'
  3450. content:
  3451. application/merge-patch+json:
  3452. schema:
  3453. $ref: '#/components/schemas/TaskNote'
  3454. required: true
  3455. deprecated: false
  3456. parameters: []
  3457. /api/tasks:
  3458. get:
  3459. operationId: api_tasks_get_collection
  3460. tags:
  3461. - Task
  3462. responses:
  3463. 200:
  3464. description: 'Task collection'
  3465. content:
  3466. application/ld+json:
  3467. schema:
  3468. type: object
  3469. properties:
  3470. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  3471. 'hydra:totalItems': { type: integer, minimum: 0 }
  3472. '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 } }
  3473. '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 } } } } } }
  3474. required:
  3475. - 'hydra:member'
  3476. application/json:
  3477. schema:
  3478. type: array
  3479. items:
  3480. $ref: '#/components/schemas/Task'
  3481. text/html:
  3482. schema:
  3483. type: array
  3484. items:
  3485. $ref: '#/components/schemas/Task'
  3486. application/hal+json:
  3487. schema:
  3488. type: object
  3489. properties:
  3490. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  3491. totalItems: { type: integer, minimum: 0 }
  3492. itemsPerPage: { type: integer, minimum: 0 }
  3493. _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 } } } } }
  3494. required:
  3495. - _links
  3496. - _embedded
  3497. summary: 'Retrieves the collection of Task resources.'
  3498. description: 'Retrieves the collection of Task resources.'
  3499. parameters:
  3500. -
  3501. name: page
  3502. in: query
  3503. description: 'The collection page number'
  3504. required: false
  3505. deprecated: false
  3506. allowEmptyValue: true
  3507. schema:
  3508. type: integer
  3509. default: 1
  3510. style: form
  3511. explode: false
  3512. allowReserved: false
  3513. -
  3514. name: itemsPerPage
  3515. in: query
  3516. description: 'The number of items per page'
  3517. required: false
  3518. deprecated: false
  3519. allowEmptyValue: true
  3520. schema:
  3521. type: integer
  3522. default: 10
  3523. minimum: 0
  3524. maximum: 50
  3525. style: form
  3526. explode: false
  3527. allowReserved: false
  3528. -
  3529. name: assignedTo
  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: 'assignedTo[]'
  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: partner
  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: 'partner[]'
  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. -
  3581. name: contact
  3582. in: query
  3583. description: ''
  3584. required: false
  3585. deprecated: false
  3586. allowEmptyValue: true
  3587. schema:
  3588. type: string
  3589. style: form
  3590. explode: false
  3591. allowReserved: false
  3592. -
  3593. name: 'contact[]'
  3594. in: query
  3595. description: ''
  3596. required: false
  3597. deprecated: false
  3598. allowEmptyValue: true
  3599. schema:
  3600. type: array
  3601. items:
  3602. type: string
  3603. style: form
  3604. explode: true
  3605. allowReserved: false
  3606. deprecated: false
  3607. post:
  3608. operationId: api_tasks_post
  3609. tags:
  3610. - Task
  3611. responses:
  3612. 201:
  3613. description: 'Task resource created'
  3614. content:
  3615. application/ld+json:
  3616. schema:
  3617. $ref: '#/components/schemas/Task.jsonld'
  3618. application/json:
  3619. schema:
  3620. $ref: '#/components/schemas/Task'
  3621. text/html:
  3622. schema:
  3623. $ref: '#/components/schemas/Task'
  3624. application/hal+json:
  3625. schema:
  3626. $ref: '#/components/schemas/Task.jsonhal'
  3627. links: { }
  3628. 400:
  3629. description: 'Invalid input'
  3630. 422:
  3631. description: 'Unprocessable entity'
  3632. summary: 'Creates a Task resource.'
  3633. description: 'Creates a Task resource.'
  3634. parameters: []
  3635. requestBody:
  3636. description: 'The new Task resource'
  3637. content:
  3638. application/ld+json:
  3639. schema:
  3640. $ref: '#/components/schemas/Task.jsonld'
  3641. application/json:
  3642. schema:
  3643. $ref: '#/components/schemas/Task'
  3644. text/html:
  3645. schema:
  3646. $ref: '#/components/schemas/Task'
  3647. application/hal+json:
  3648. schema:
  3649. $ref: '#/components/schemas/Task.jsonhal'
  3650. required: true
  3651. deprecated: false
  3652. parameters: []
  3653. '/api/tasks/{id}':
  3654. get:
  3655. operationId: api_tasks_id_get
  3656. tags:
  3657. - Task
  3658. responses:
  3659. 200:
  3660. description: 'Task resource'
  3661. content:
  3662. application/ld+json:
  3663. schema:
  3664. $ref: '#/components/schemas/Task.jsonld'
  3665. application/json:
  3666. schema:
  3667. $ref: '#/components/schemas/Task'
  3668. text/html:
  3669. schema:
  3670. $ref: '#/components/schemas/Task'
  3671. application/hal+json:
  3672. schema:
  3673. $ref: '#/components/schemas/Task.jsonhal'
  3674. 404:
  3675. description: 'Resource not found'
  3676. summary: 'Retrieves a Task resource.'
  3677. description: 'Retrieves a Task resource.'
  3678. parameters:
  3679. -
  3680. name: id
  3681. in: path
  3682. description: 'Task identifier'
  3683. required: true
  3684. deprecated: false
  3685. allowEmptyValue: false
  3686. schema:
  3687. type: string
  3688. style: simple
  3689. explode: false
  3690. allowReserved: false
  3691. deprecated: false
  3692. patch:
  3693. operationId: api_tasks_id_patch
  3694. tags:
  3695. - Task
  3696. responses:
  3697. 200:
  3698. description: 'Task resource updated'
  3699. content:
  3700. application/ld+json:
  3701. schema:
  3702. $ref: '#/components/schemas/Task.jsonld'
  3703. application/json:
  3704. schema:
  3705. $ref: '#/components/schemas/Task'
  3706. text/html:
  3707. schema:
  3708. $ref: '#/components/schemas/Task'
  3709. application/hal+json:
  3710. schema:
  3711. $ref: '#/components/schemas/Task.jsonhal'
  3712. links: { }
  3713. 400:
  3714. description: 'Invalid input'
  3715. 422:
  3716. description: 'Unprocessable entity'
  3717. 404:
  3718. description: 'Resource not found'
  3719. summary: 'Updates the Task resource.'
  3720. description: 'Updates the Task resource.'
  3721. parameters:
  3722. -
  3723. name: id
  3724. in: path
  3725. description: 'Task identifier'
  3726. required: true
  3727. deprecated: false
  3728. allowEmptyValue: false
  3729. schema:
  3730. type: string
  3731. style: simple
  3732. explode: false
  3733. allowReserved: false
  3734. requestBody:
  3735. description: 'The updated Task resource'
  3736. content:
  3737. application/merge-patch+json:
  3738. schema:
  3739. $ref: '#/components/schemas/Task'
  3740. required: true
  3741. deprecated: false
  3742. parameters: []
  3743. /api/user_products:
  3744. get:
  3745. operationId: api_user_products_get_collection
  3746. tags:
  3747. - UserProduct
  3748. responses:
  3749. 200:
  3750. description: 'UserProduct collection'
  3751. content:
  3752. application/ld+json:
  3753. schema:
  3754. type: object
  3755. properties:
  3756. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonld' } }
  3757. 'hydra:totalItems': { type: integer, minimum: 0 }
  3758. '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 } }
  3759. '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 } } } } } }
  3760. required:
  3761. - 'hydra:member'
  3762. application/json:
  3763. schema:
  3764. type: array
  3765. items:
  3766. $ref: '#/components/schemas/UserProduct'
  3767. text/html:
  3768. schema:
  3769. type: array
  3770. items:
  3771. $ref: '#/components/schemas/UserProduct'
  3772. application/hal+json:
  3773. schema:
  3774. type: object
  3775. properties:
  3776. _embedded: { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonhal' } }
  3777. totalItems: { type: integer, minimum: 0 }
  3778. itemsPerPage: { type: integer, minimum: 0 }
  3779. _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 } } } } }
  3780. required:
  3781. - _links
  3782. - _embedded
  3783. summary: 'Retrieves the collection of UserProduct resources.'
  3784. description: 'Retrieves the collection of UserProduct resources.'
  3785. parameters:
  3786. -
  3787. name: page
  3788. in: query
  3789. description: 'The collection page number'
  3790. required: false
  3791. deprecated: false
  3792. allowEmptyValue: true
  3793. schema:
  3794. type: integer
  3795. default: 1
  3796. style: form
  3797. explode: false
  3798. allowReserved: false
  3799. -
  3800. name: itemsPerPage
  3801. in: query
  3802. description: 'The number of items per page'
  3803. required: false
  3804. deprecated: false
  3805. allowEmptyValue: true
  3806. schema:
  3807. type: integer
  3808. default: 10
  3809. minimum: 0
  3810. maximum: 50
  3811. style: form
  3812. explode: false
  3813. allowReserved: false
  3814. -
  3815. name: user
  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: 'user[]'
  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: product
  3842. in: query
  3843. description: ''
  3844. required: false
  3845. deprecated: false
  3846. allowEmptyValue: true
  3847. schema:
  3848. type: string
  3849. style: form
  3850. explode: false
  3851. allowReserved: false
  3852. -
  3853. name: 'product[]'
  3854. in: query
  3855. description: ''
  3856. required: false
  3857. deprecated: false
  3858. allowEmptyValue: true
  3859. schema:
  3860. type: array
  3861. items:
  3862. type: string
  3863. style: form
  3864. explode: true
  3865. allowReserved: false
  3866. -
  3867. name: 'order[product.name]'
  3868. in: query
  3869. description: ''
  3870. required: false
  3871. deprecated: false
  3872. allowEmptyValue: true
  3873. schema:
  3874. type: string
  3875. enum:
  3876. - asc
  3877. - desc
  3878. style: form
  3879. explode: false
  3880. allowReserved: false
  3881. deprecated: false
  3882. post:
  3883. operationId: api_user_products_post
  3884. tags:
  3885. - UserProduct
  3886. responses:
  3887. 201:
  3888. description: 'UserProduct resource created'
  3889. content:
  3890. application/ld+json:
  3891. schema:
  3892. $ref: '#/components/schemas/UserProduct.jsonld'
  3893. application/json:
  3894. schema:
  3895. $ref: '#/components/schemas/UserProduct'
  3896. text/html:
  3897. schema:
  3898. $ref: '#/components/schemas/UserProduct'
  3899. application/hal+json:
  3900. schema:
  3901. $ref: '#/components/schemas/UserProduct.jsonhal'
  3902. links: { }
  3903. 400:
  3904. description: 'Invalid input'
  3905. 422:
  3906. description: 'Unprocessable entity'
  3907. summary: 'Creates a UserProduct resource.'
  3908. description: 'Creates a UserProduct resource.'
  3909. parameters: []
  3910. requestBody:
  3911. description: 'The new UserProduct resource'
  3912. content:
  3913. application/ld+json:
  3914. schema:
  3915. $ref: '#/components/schemas/UserProduct.jsonld'
  3916. application/json:
  3917. schema:
  3918. $ref: '#/components/schemas/UserProduct'
  3919. text/html:
  3920. schema:
  3921. $ref: '#/components/schemas/UserProduct'
  3922. application/hal+json:
  3923. schema:
  3924. $ref: '#/components/schemas/UserProduct.jsonhal'
  3925. required: true
  3926. deprecated: false
  3927. parameters: []
  3928. '/api/user_products/{id}':
  3929. get:
  3930. operationId: api_user_products_id_get
  3931. tags:
  3932. - UserProduct
  3933. responses:
  3934. 200:
  3935. description: 'UserProduct resource'
  3936. content:
  3937. application/ld+json:
  3938. schema:
  3939. $ref: '#/components/schemas/UserProduct.jsonld'
  3940. application/json:
  3941. schema:
  3942. $ref: '#/components/schemas/UserProduct'
  3943. text/html:
  3944. schema:
  3945. $ref: '#/components/schemas/UserProduct'
  3946. application/hal+json:
  3947. schema:
  3948. $ref: '#/components/schemas/UserProduct.jsonhal'
  3949. 404:
  3950. description: 'Resource not found'
  3951. summary: 'Retrieves a UserProduct resource.'
  3952. description: 'Retrieves a UserProduct resource.'
  3953. parameters:
  3954. -
  3955. name: id
  3956. in: path
  3957. description: 'UserProduct identifier'
  3958. required: true
  3959. deprecated: false
  3960. allowEmptyValue: false
  3961. schema:
  3962. type: string
  3963. style: simple
  3964. explode: false
  3965. allowReserved: false
  3966. deprecated: false
  3967. delete:
  3968. operationId: api_user_products_id_delete
  3969. tags:
  3970. - UserProduct
  3971. responses:
  3972. 204:
  3973. description: 'UserProduct resource deleted'
  3974. 404:
  3975. description: 'Resource not found'
  3976. summary: 'Removes the UserProduct resource.'
  3977. description: 'Removes the UserProduct resource.'
  3978. parameters:
  3979. -
  3980. name: id
  3981. in: path
  3982. description: 'UserProduct identifier'
  3983. required: true
  3984. deprecated: false
  3985. allowEmptyValue: false
  3986. schema:
  3987. type: string
  3988. style: simple
  3989. explode: false
  3990. allowReserved: false
  3991. deprecated: false
  3992. parameters: []
  3993. /api/users:
  3994. get:
  3995. operationId: api_users_get_collection
  3996. tags:
  3997. - User
  3998. responses:
  3999. 200:
  4000. description: 'User collection'
  4001. content:
  4002. application/ld+json:
  4003. schema:
  4004. type: object
  4005. properties:
  4006. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  4007. 'hydra:totalItems': { type: integer, minimum: 0 }
  4008. '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 } }
  4009. '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 } } } } } }
  4010. required:
  4011. - 'hydra:member'
  4012. application/json:
  4013. schema:
  4014. type: array
  4015. items:
  4016. $ref: '#/components/schemas/User'
  4017. text/html:
  4018. schema:
  4019. type: array
  4020. items:
  4021. $ref: '#/components/schemas/User'
  4022. application/hal+json:
  4023. schema:
  4024. type: object
  4025. properties:
  4026. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  4027. totalItems: { type: integer, minimum: 0 }
  4028. itemsPerPage: { type: integer, minimum: 0 }
  4029. _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 } } } } }
  4030. required:
  4031. - _links
  4032. - _embedded
  4033. summary: 'Retrieves the collection of User resources.'
  4034. description: 'Retrieves the collection of User resources.'
  4035. parameters:
  4036. -
  4037. name: page
  4038. in: query
  4039. description: 'The collection page number'
  4040. required: false
  4041. deprecated: false
  4042. allowEmptyValue: true
  4043. schema:
  4044. type: integer
  4045. default: 1
  4046. style: form
  4047. explode: false
  4048. allowReserved: false
  4049. -
  4050. name: itemsPerPage
  4051. in: query
  4052. description: 'The number of items per page'
  4053. required: false
  4054. deprecated: false
  4055. allowEmptyValue: true
  4056. schema:
  4057. type: integer
  4058. default: 10
  4059. minimum: 0
  4060. maximum: 50
  4061. style: form
  4062. explode: false
  4063. allowReserved: false
  4064. -
  4065. name: firstName
  4066. in: query
  4067. description: ''
  4068. required: false
  4069. deprecated: false
  4070. allowEmptyValue: true
  4071. schema:
  4072. type: string
  4073. style: form
  4074. explode: false
  4075. allowReserved: false
  4076. -
  4077. name: lastName
  4078. in: query
  4079. description: ''
  4080. required: false
  4081. deprecated: false
  4082. allowEmptyValue: true
  4083. schema:
  4084. type: string
  4085. style: form
  4086. explode: false
  4087. allowReserved: false
  4088. -
  4089. name: nameSearch
  4090. in: query
  4091. description: ''
  4092. required: false
  4093. deprecated: false
  4094. allowEmptyValue: true
  4095. schema:
  4096. type: string
  4097. style: form
  4098. explode: false
  4099. allowReserved: false
  4100. deprecated: false
  4101. post:
  4102. operationId: api_users_post
  4103. tags:
  4104. - User
  4105. responses:
  4106. 201:
  4107. description: 'User resource created'
  4108. content:
  4109. application/ld+json:
  4110. schema:
  4111. $ref: '#/components/schemas/User.jsonld'
  4112. application/json:
  4113. schema:
  4114. $ref: '#/components/schemas/User'
  4115. text/html:
  4116. schema:
  4117. $ref: '#/components/schemas/User'
  4118. application/hal+json:
  4119. schema:
  4120. $ref: '#/components/schemas/User.jsonhal'
  4121. links: { }
  4122. 400:
  4123. description: 'Invalid input'
  4124. 422:
  4125. description: 'Unprocessable entity'
  4126. summary: 'Creates a User resource.'
  4127. description: 'Creates a User resource.'
  4128. parameters: []
  4129. requestBody:
  4130. description: 'The new User resource'
  4131. content:
  4132. application/ld+json:
  4133. schema:
  4134. $ref: '#/components/schemas/User.jsonld'
  4135. application/json:
  4136. schema:
  4137. $ref: '#/components/schemas/User'
  4138. text/html:
  4139. schema:
  4140. $ref: '#/components/schemas/User'
  4141. application/hal+json:
  4142. schema:
  4143. $ref: '#/components/schemas/User.jsonhal'
  4144. required: true
  4145. deprecated: false
  4146. parameters: []
  4147. '/api/users/{id}':
  4148. get:
  4149. operationId: api_users_id_get
  4150. tags:
  4151. - User
  4152. responses:
  4153. 200:
  4154. description: 'User resource'
  4155. content:
  4156. application/ld+json:
  4157. schema:
  4158. $ref: '#/components/schemas/User.jsonld'
  4159. application/json:
  4160. schema:
  4161. $ref: '#/components/schemas/User'
  4162. text/html:
  4163. schema:
  4164. $ref: '#/components/schemas/User'
  4165. application/hal+json:
  4166. schema:
  4167. $ref: '#/components/schemas/User.jsonhal'
  4168. 404:
  4169. description: 'Resource not found'
  4170. summary: 'Retrieves a User resource.'
  4171. description: 'Retrieves a User resource.'
  4172. parameters:
  4173. -
  4174. name: id
  4175. in: path
  4176. description: 'User identifier'
  4177. required: true
  4178. deprecated: false
  4179. allowEmptyValue: false
  4180. schema:
  4181. type: string
  4182. style: simple
  4183. explode: false
  4184. allowReserved: false
  4185. deprecated: false
  4186. parameters: []
  4187. /auth:
  4188. post:
  4189. operationId: login_check_post
  4190. tags:
  4191. - 'Login Check'
  4192. responses:
  4193. 200:
  4194. description: 'User token created'
  4195. content:
  4196. application/json:
  4197. schema:
  4198. type: object
  4199. properties:
  4200. token: { readOnly: true, type: string, nullable: false }
  4201. required:
  4202. - token
  4203. summary: 'Creates a user token.'
  4204. description: 'Creates a user token.'
  4205. requestBody:
  4206. description: 'The login data'
  4207. content:
  4208. application/json:
  4209. schema:
  4210. type: object
  4211. properties:
  4212. email:
  4213. type: string
  4214. nullable: false
  4215. password:
  4216. type: string
  4217. nullable: false
  4218. required:
  4219. - email
  4220. - password
  4221. required: true
  4222. parameters: []
  4223. components:
  4224. schemas:
  4225. Comment:
  4226. type: object
  4227. description: ''
  4228. deprecated: false
  4229. required:
  4230. - message
  4231. properties:
  4232. message:
  4233. type:
  4234. - string
  4235. - 'null'
  4236. owner:
  4237. readOnly: true
  4238. description: '?UserApi'
  4239. $ref: '#/components/schemas/User'
  4240. postIri:
  4241. type:
  4242. - string
  4243. - 'null'
  4244. format: iri-reference
  4245. example: 'https://example.com/'
  4246. createdAt:
  4247. readOnly: true
  4248. type:
  4249. - string
  4250. - 'null'
  4251. format: date-time
  4252. Comment.jsonhal:
  4253. type: object
  4254. description: ''
  4255. deprecated: false
  4256. required:
  4257. - message
  4258. properties:
  4259. _links:
  4260. type: object
  4261. properties:
  4262. self:
  4263. type: object
  4264. properties:
  4265. href:
  4266. type: string
  4267. format: iri-reference
  4268. message:
  4269. type:
  4270. - string
  4271. - 'null'
  4272. owner:
  4273. readOnly: true
  4274. description: '?UserApi'
  4275. $ref: '#/components/schemas/User.jsonhal'
  4276. postIri:
  4277. type:
  4278. - string
  4279. - 'null'
  4280. format: iri-reference
  4281. example: 'https://example.com/'
  4282. createdAt:
  4283. readOnly: true
  4284. type:
  4285. - string
  4286. - 'null'
  4287. format: date-time
  4288. Comment.jsonld:
  4289. type: object
  4290. description: ''
  4291. deprecated: false
  4292. required:
  4293. - message
  4294. properties:
  4295. '@context':
  4296. readOnly: true
  4297. oneOf:
  4298. -
  4299. type: string
  4300. -
  4301. type: object
  4302. properties:
  4303. '@vocab':
  4304. type: string
  4305. hydra:
  4306. type: string
  4307. enum: ['http://www.w3.org/ns/hydra/core#']
  4308. required:
  4309. - '@vocab'
  4310. - hydra
  4311. additionalProperties: true
  4312. '@id':
  4313. readOnly: true
  4314. type: string
  4315. '@type':
  4316. readOnly: true
  4317. type: string
  4318. message:
  4319. type:
  4320. - string
  4321. - 'null'
  4322. owner:
  4323. readOnly: true
  4324. description: '?UserApi'
  4325. $ref: '#/components/schemas/User.jsonld'
  4326. postIri:
  4327. type:
  4328. - string
  4329. - 'null'
  4330. format: iri-reference
  4331. example: 'https://example.com/'
  4332. createdAt:
  4333. readOnly: true
  4334. type:
  4335. - string
  4336. - 'null'
  4337. format: date-time
  4338. Contact:
  4339. type: object
  4340. description: ''
  4341. deprecated: false
  4342. required:
  4343. - firstName
  4344. - lastName
  4345. - partnerIri
  4346. properties:
  4347. firstName:
  4348. type:
  4349. - string
  4350. - 'null'
  4351. lastName:
  4352. type:
  4353. - string
  4354. - 'null'
  4355. fullName:
  4356. type:
  4357. - string
  4358. - 'null'
  4359. partner:
  4360. readOnly: true
  4361. description: '?PartnerApi'
  4362. $ref: '#/components/schemas/Partner'
  4363. partnerIri:
  4364. type:
  4365. - string
  4366. - 'null'
  4367. format: iri-reference
  4368. example: 'https://example.com/'
  4369. birthday:
  4370. type:
  4371. - string
  4372. - 'null'
  4373. format: date-time
  4374. image:
  4375. type:
  4376. - string
  4377. - 'null'
  4378. format: iri-reference
  4379. example: 'https://example.com/'
  4380. imageUrl:
  4381. readOnly: true
  4382. type:
  4383. - string
  4384. - 'null'
  4385. position:
  4386. type:
  4387. - string
  4388. - 'null'
  4389. phone:
  4390. type:
  4391. - string
  4392. - 'null'
  4393. email:
  4394. format: email
  4395. externalDocs:
  4396. url: 'https://schema.org/email'
  4397. type:
  4398. - string
  4399. - 'null'
  4400. posts:
  4401. readOnly: true
  4402. type: array
  4403. items:
  4404. type: string
  4405. format: iri-reference
  4406. example: 'https://example.com/'
  4407. createdBy:
  4408. readOnly: true
  4409. description: '?UserApi'
  4410. $ref: '#/components/schemas/User'
  4411. createdAt:
  4412. readOnly: true
  4413. type:
  4414. - string
  4415. - 'null'
  4416. format: date-time
  4417. Contact.jsonhal:
  4418. type: object
  4419. description: ''
  4420. deprecated: false
  4421. required:
  4422. - firstName
  4423. - lastName
  4424. - partnerIri
  4425. properties:
  4426. _links:
  4427. type: object
  4428. properties:
  4429. self:
  4430. type: object
  4431. properties:
  4432. href:
  4433. type: string
  4434. format: iri-reference
  4435. firstName:
  4436. type:
  4437. - string
  4438. - 'null'
  4439. lastName:
  4440. type:
  4441. - string
  4442. - 'null'
  4443. fullName:
  4444. type:
  4445. - string
  4446. - 'null'
  4447. partner:
  4448. readOnly: true
  4449. description: '?PartnerApi'
  4450. $ref: '#/components/schemas/Partner.jsonhal'
  4451. partnerIri:
  4452. type:
  4453. - string
  4454. - 'null'
  4455. format: iri-reference
  4456. example: 'https://example.com/'
  4457. birthday:
  4458. type:
  4459. - string
  4460. - 'null'
  4461. format: date-time
  4462. image:
  4463. type:
  4464. - string
  4465. - 'null'
  4466. format: iri-reference
  4467. example: 'https://example.com/'
  4468. imageUrl:
  4469. readOnly: true
  4470. type:
  4471. - string
  4472. - 'null'
  4473. position:
  4474. type:
  4475. - string
  4476. - 'null'
  4477. phone:
  4478. type:
  4479. - string
  4480. - 'null'
  4481. email:
  4482. format: email
  4483. externalDocs:
  4484. url: 'https://schema.org/email'
  4485. type:
  4486. - string
  4487. - 'null'
  4488. posts:
  4489. readOnly: true
  4490. type: array
  4491. items:
  4492. type: string
  4493. format: iri-reference
  4494. example: 'https://example.com/'
  4495. createdBy:
  4496. readOnly: true
  4497. description: '?UserApi'
  4498. $ref: '#/components/schemas/User.jsonhal'
  4499. createdAt:
  4500. readOnly: true
  4501. type:
  4502. - string
  4503. - 'null'
  4504. format: date-time
  4505. Contact.jsonld:
  4506. type: object
  4507. description: ''
  4508. deprecated: false
  4509. required:
  4510. - firstName
  4511. - lastName
  4512. - partnerIri
  4513. properties:
  4514. '@context':
  4515. readOnly: true
  4516. oneOf:
  4517. -
  4518. type: string
  4519. -
  4520. type: object
  4521. properties:
  4522. '@vocab':
  4523. type: string
  4524. hydra:
  4525. type: string
  4526. enum: ['http://www.w3.org/ns/hydra/core#']
  4527. required:
  4528. - '@vocab'
  4529. - hydra
  4530. additionalProperties: true
  4531. '@id':
  4532. readOnly: true
  4533. type: string
  4534. '@type':
  4535. readOnly: true
  4536. type: string
  4537. firstName:
  4538. type:
  4539. - string
  4540. - 'null'
  4541. lastName:
  4542. type:
  4543. - string
  4544. - 'null'
  4545. fullName:
  4546. type:
  4547. - string
  4548. - 'null'
  4549. partner:
  4550. readOnly: true
  4551. description: '?PartnerApi'
  4552. $ref: '#/components/schemas/Partner.jsonld'
  4553. partnerIri:
  4554. type:
  4555. - string
  4556. - 'null'
  4557. format: iri-reference
  4558. example: 'https://example.com/'
  4559. birthday:
  4560. type:
  4561. - string
  4562. - 'null'
  4563. format: date-time
  4564. image:
  4565. type:
  4566. - string
  4567. - 'null'
  4568. format: iri-reference
  4569. example: 'https://example.com/'
  4570. imageUrl:
  4571. readOnly: true
  4572. type:
  4573. - string
  4574. - 'null'
  4575. position:
  4576. type:
  4577. - string
  4578. - 'null'
  4579. phone:
  4580. type:
  4581. - string
  4582. - 'null'
  4583. email:
  4584. format: email
  4585. externalDocs:
  4586. url: 'https://schema.org/email'
  4587. type:
  4588. - string
  4589. - 'null'
  4590. posts:
  4591. readOnly: true
  4592. type: array
  4593. items:
  4594. type: string
  4595. format: iri-reference
  4596. example: 'https://example.com/'
  4597. createdBy:
  4598. readOnly: true
  4599. description: '?UserApi'
  4600. $ref: '#/components/schemas/User.jsonld'
  4601. createdAt:
  4602. readOnly: true
  4603. type:
  4604. - string
  4605. - 'null'
  4606. format: date-time
  4607. ContactPartnerProduct:
  4608. type: object
  4609. description: ''
  4610. deprecated: false
  4611. required:
  4612. - contactIri
  4613. - partnerProductIri
  4614. properties:
  4615. contactIri:
  4616. type:
  4617. - string
  4618. - 'null'
  4619. format: iri-reference
  4620. example: 'https://example.com/'
  4621. partnerProductIri:
  4622. type:
  4623. - string
  4624. - 'null'
  4625. format: iri-reference
  4626. example: 'https://example.com/'
  4627. partnerProduct:
  4628. readOnly: true
  4629. description: '?PartnerProduct'
  4630. $ref: '#/components/schemas/PartnerProduct'
  4631. product:
  4632. readOnly: true
  4633. description: '?ProductApi'
  4634. $ref: '#/components/schemas/Product'
  4635. createdAt:
  4636. readOnly: true
  4637. type:
  4638. - string
  4639. - 'null'
  4640. format: date-time
  4641. ContactPartnerProduct.jsonhal:
  4642. type: object
  4643. description: ''
  4644. deprecated: false
  4645. required:
  4646. - contactIri
  4647. - partnerProductIri
  4648. properties:
  4649. _links:
  4650. type: object
  4651. properties:
  4652. self:
  4653. type: object
  4654. properties:
  4655. href:
  4656. type: string
  4657. format: iri-reference
  4658. contactIri:
  4659. type:
  4660. - string
  4661. - 'null'
  4662. format: iri-reference
  4663. example: 'https://example.com/'
  4664. partnerProductIri:
  4665. type:
  4666. - string
  4667. - 'null'
  4668. format: iri-reference
  4669. example: 'https://example.com/'
  4670. partnerProduct:
  4671. readOnly: true
  4672. description: '?PartnerProduct'
  4673. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  4674. product:
  4675. readOnly: true
  4676. description: '?ProductApi'
  4677. $ref: '#/components/schemas/Product.jsonhal'
  4678. createdAt:
  4679. readOnly: true
  4680. type:
  4681. - string
  4682. - 'null'
  4683. format: date-time
  4684. ContactPartnerProduct.jsonld:
  4685. type: object
  4686. description: ''
  4687. deprecated: false
  4688. required:
  4689. - contactIri
  4690. - partnerProductIri
  4691. properties:
  4692. '@context':
  4693. readOnly: true
  4694. oneOf:
  4695. -
  4696. type: string
  4697. -
  4698. type: object
  4699. properties:
  4700. '@vocab':
  4701. type: string
  4702. hydra:
  4703. type: string
  4704. enum: ['http://www.w3.org/ns/hydra/core#']
  4705. required:
  4706. - '@vocab'
  4707. - hydra
  4708. additionalProperties: true
  4709. '@id':
  4710. readOnly: true
  4711. type: string
  4712. '@type':
  4713. readOnly: true
  4714. type: string
  4715. contactIri:
  4716. type:
  4717. - string
  4718. - 'null'
  4719. format: iri-reference
  4720. example: 'https://example.com/'
  4721. partnerProductIri:
  4722. type:
  4723. - string
  4724. - 'null'
  4725. format: iri-reference
  4726. example: 'https://example.com/'
  4727. partnerProduct:
  4728. readOnly: true
  4729. description: '?PartnerProduct'
  4730. $ref: '#/components/schemas/PartnerProduct.jsonld'
  4731. product:
  4732. readOnly: true
  4733. description: '?ProductApi'
  4734. $ref: '#/components/schemas/Product.jsonld'
  4735. createdAt:
  4736. readOnly: true
  4737. type:
  4738. - string
  4739. - 'null'
  4740. format: date-time
  4741. Document:
  4742. type: object
  4743. description: ''
  4744. deprecated: false
  4745. required:
  4746. - name
  4747. - documentObject
  4748. properties:
  4749. name:
  4750. type:
  4751. - string
  4752. - 'null'
  4753. description:
  4754. type:
  4755. - string
  4756. - 'null'
  4757. partner:
  4758. readOnly: true
  4759. description: '?PartnerApi'
  4760. $ref: '#/components/schemas/Partner'
  4761. partnerIri:
  4762. type:
  4763. - string
  4764. - 'null'
  4765. format: iri-reference
  4766. example: 'https://example.com/'
  4767. product:
  4768. readOnly: true
  4769. description: '?ProductApi'
  4770. $ref: '#/components/schemas/Product'
  4771. productIri:
  4772. type:
  4773. - string
  4774. - 'null'
  4775. format: iri-reference
  4776. example: 'https://example.com/'
  4777. documentObject:
  4778. type:
  4779. - string
  4780. - 'null'
  4781. format: iri-reference
  4782. example: 'https://example.com/'
  4783. documentUrl:
  4784. readOnly: true
  4785. type:
  4786. - string
  4787. - 'null'
  4788. createdBy:
  4789. readOnly: true
  4790. description: '?UserApi'
  4791. $ref: '#/components/schemas/User'
  4792. createdAt:
  4793. readOnly: true
  4794. type:
  4795. - string
  4796. - 'null'
  4797. format: date-time
  4798. Document.jsonhal:
  4799. type: object
  4800. description: ''
  4801. deprecated: false
  4802. required:
  4803. - name
  4804. - documentObject
  4805. properties:
  4806. _links:
  4807. type: object
  4808. properties:
  4809. self:
  4810. type: object
  4811. properties:
  4812. href:
  4813. type: string
  4814. format: iri-reference
  4815. name:
  4816. type:
  4817. - string
  4818. - 'null'
  4819. description:
  4820. type:
  4821. - string
  4822. - 'null'
  4823. partner:
  4824. readOnly: true
  4825. description: '?PartnerApi'
  4826. $ref: '#/components/schemas/Partner.jsonhal'
  4827. partnerIri:
  4828. type:
  4829. - string
  4830. - 'null'
  4831. format: iri-reference
  4832. example: 'https://example.com/'
  4833. product:
  4834. readOnly: true
  4835. description: '?ProductApi'
  4836. $ref: '#/components/schemas/Product.jsonhal'
  4837. productIri:
  4838. type:
  4839. - string
  4840. - 'null'
  4841. format: iri-reference
  4842. example: 'https://example.com/'
  4843. documentObject:
  4844. type:
  4845. - string
  4846. - 'null'
  4847. format: iri-reference
  4848. example: 'https://example.com/'
  4849. documentUrl:
  4850. readOnly: true
  4851. type:
  4852. - string
  4853. - 'null'
  4854. createdBy:
  4855. readOnly: true
  4856. description: '?UserApi'
  4857. $ref: '#/components/schemas/User.jsonhal'
  4858. createdAt:
  4859. readOnly: true
  4860. type:
  4861. - string
  4862. - 'null'
  4863. format: date-time
  4864. Document.jsonld:
  4865. type: object
  4866. description: ''
  4867. deprecated: false
  4868. required:
  4869. - name
  4870. - documentObject
  4871. properties:
  4872. '@context':
  4873. readOnly: true
  4874. oneOf:
  4875. -
  4876. type: string
  4877. -
  4878. type: object
  4879. properties:
  4880. '@vocab':
  4881. type: string
  4882. hydra:
  4883. type: string
  4884. enum: ['http://www.w3.org/ns/hydra/core#']
  4885. required:
  4886. - '@vocab'
  4887. - hydra
  4888. additionalProperties: true
  4889. '@id':
  4890. readOnly: true
  4891. type: string
  4892. '@type':
  4893. readOnly: true
  4894. type: string
  4895. name:
  4896. type:
  4897. - string
  4898. - 'null'
  4899. description:
  4900. type:
  4901. - string
  4902. - 'null'
  4903. partner:
  4904. readOnly: true
  4905. description: '?PartnerApi'
  4906. $ref: '#/components/schemas/Partner.jsonld'
  4907. partnerIri:
  4908. type:
  4909. - string
  4910. - 'null'
  4911. format: iri-reference
  4912. example: 'https://example.com/'
  4913. product:
  4914. readOnly: true
  4915. description: '?ProductApi'
  4916. $ref: '#/components/schemas/Product.jsonld'
  4917. productIri:
  4918. type:
  4919. - string
  4920. - 'null'
  4921. format: iri-reference
  4922. example: 'https://example.com/'
  4923. documentObject:
  4924. type:
  4925. - string
  4926. - 'null'
  4927. format: iri-reference
  4928. example: 'https://example.com/'
  4929. documentUrl:
  4930. readOnly: true
  4931. type:
  4932. - string
  4933. - 'null'
  4934. createdBy:
  4935. readOnly: true
  4936. description: '?UserApi'
  4937. $ref: '#/components/schemas/User.jsonld'
  4938. createdAt:
  4939. readOnly: true
  4940. type:
  4941. - string
  4942. - 'null'
  4943. format: date-time
  4944. DocumentObject-document_object.read:
  4945. type: object
  4946. description: ''
  4947. deprecated: false
  4948. externalDocs:
  4949. url: 'https://schema.org/MediaObject'
  4950. properties:
  4951. contentUrl:
  4952. externalDocs:
  4953. url: 'https://schema.org/contentUrl'
  4954. type:
  4955. - string
  4956. - 'null'
  4957. DocumentObject.jsonhal-document_object.read:
  4958. type: object
  4959. description: ''
  4960. deprecated: false
  4961. externalDocs:
  4962. url: 'https://schema.org/MediaObject'
  4963. properties:
  4964. _links:
  4965. type: object
  4966. properties:
  4967. self:
  4968. type: object
  4969. properties:
  4970. href:
  4971. type: string
  4972. format: iri-reference
  4973. contentUrl:
  4974. externalDocs:
  4975. url: 'https://schema.org/contentUrl'
  4976. type:
  4977. - string
  4978. - 'null'
  4979. DocumentObject.jsonld-document_object.read:
  4980. type: object
  4981. description: ''
  4982. deprecated: false
  4983. externalDocs:
  4984. url: 'https://schema.org/MediaObject'
  4985. properties:
  4986. '@context':
  4987. readOnly: true
  4988. oneOf:
  4989. -
  4990. type: string
  4991. -
  4992. type: object
  4993. properties:
  4994. '@vocab':
  4995. type: string
  4996. hydra:
  4997. type: string
  4998. enum: ['http://www.w3.org/ns/hydra/core#']
  4999. required:
  5000. - '@vocab'
  5001. - hydra
  5002. additionalProperties: true
  5003. '@id':
  5004. readOnly: true
  5005. type: string
  5006. '@type':
  5007. readOnly: true
  5008. type: string
  5009. contentUrl:
  5010. externalDocs:
  5011. url: 'https://schema.org/contentUrl'
  5012. type:
  5013. - string
  5014. - 'null'
  5015. MediaObject-media_object.read:
  5016. type: object
  5017. description: ''
  5018. deprecated: false
  5019. externalDocs:
  5020. url: 'https://schema.org/MediaObject'
  5021. properties:
  5022. contentUrl:
  5023. externalDocs:
  5024. url: 'https://schema.org/contentUrl'
  5025. type:
  5026. - string
  5027. - 'null'
  5028. MediaObject.jsonhal-media_object.read:
  5029. type: object
  5030. description: ''
  5031. deprecated: false
  5032. externalDocs:
  5033. url: 'https://schema.org/MediaObject'
  5034. properties:
  5035. _links:
  5036. type: object
  5037. properties:
  5038. self:
  5039. type: object
  5040. properties:
  5041. href:
  5042. type: string
  5043. format: iri-reference
  5044. contentUrl:
  5045. externalDocs:
  5046. url: 'https://schema.org/contentUrl'
  5047. type:
  5048. - string
  5049. - 'null'
  5050. MediaObject.jsonld-media_object.read:
  5051. type: object
  5052. description: ''
  5053. deprecated: false
  5054. externalDocs:
  5055. url: 'https://schema.org/MediaObject'
  5056. properties:
  5057. '@context':
  5058. readOnly: true
  5059. oneOf:
  5060. -
  5061. type: string
  5062. -
  5063. type: object
  5064. properties:
  5065. '@vocab':
  5066. type: string
  5067. hydra:
  5068. type: string
  5069. enum: ['http://www.w3.org/ns/hydra/core#']
  5070. required:
  5071. - '@vocab'
  5072. - hydra
  5073. additionalProperties: true
  5074. '@id':
  5075. readOnly: true
  5076. type: string
  5077. '@type':
  5078. readOnly: true
  5079. type: string
  5080. contentUrl:
  5081. externalDocs:
  5082. url: 'https://schema.org/contentUrl'
  5083. type:
  5084. - string
  5085. - 'null'
  5086. Partner:
  5087. type: object
  5088. description: ''
  5089. deprecated: false
  5090. required:
  5091. - name
  5092. - partnerType
  5093. properties:
  5094. name:
  5095. type: string
  5096. partnerType:
  5097. type: string
  5098. enum:
  5099. - customer
  5100. - supplier
  5101. - service
  5102. description:
  5103. type:
  5104. - string
  5105. - 'null'
  5106. street:
  5107. type:
  5108. - string
  5109. - 'null'
  5110. streetNo:
  5111. type:
  5112. - string
  5113. - 'null'
  5114. zip:
  5115. type:
  5116. - string
  5117. - 'null'
  5118. city:
  5119. type:
  5120. - string
  5121. - 'null'
  5122. country:
  5123. type:
  5124. - string
  5125. - 'null'
  5126. website:
  5127. type:
  5128. - string
  5129. - 'null'
  5130. logo:
  5131. type:
  5132. - string
  5133. - 'null'
  5134. format: iri-reference
  5135. example: 'https://example.com/'
  5136. logoUrl:
  5137. readOnly: true
  5138. type:
  5139. - string
  5140. - 'null'
  5141. createdByIri:
  5142. readOnly: true
  5143. type:
  5144. - string
  5145. - 'null'
  5146. format: iri-reference
  5147. example: 'https://example.com/'
  5148. createdAt:
  5149. readOnly: true
  5150. type:
  5151. - string
  5152. - 'null'
  5153. format: date-time
  5154. Partner.jsonhal:
  5155. type: object
  5156. description: ''
  5157. deprecated: false
  5158. required:
  5159. - name
  5160. - partnerType
  5161. properties:
  5162. _links:
  5163. type: object
  5164. properties:
  5165. self:
  5166. type: object
  5167. properties:
  5168. href:
  5169. type: string
  5170. format: iri-reference
  5171. name:
  5172. type: string
  5173. partnerType:
  5174. type: string
  5175. enum:
  5176. - customer
  5177. - supplier
  5178. - service
  5179. description:
  5180. type:
  5181. - string
  5182. - 'null'
  5183. street:
  5184. type:
  5185. - string
  5186. - 'null'
  5187. streetNo:
  5188. type:
  5189. - string
  5190. - 'null'
  5191. zip:
  5192. type:
  5193. - string
  5194. - 'null'
  5195. city:
  5196. type:
  5197. - string
  5198. - 'null'
  5199. country:
  5200. type:
  5201. - string
  5202. - 'null'
  5203. website:
  5204. type:
  5205. - string
  5206. - 'null'
  5207. logo:
  5208. type:
  5209. - string
  5210. - 'null'
  5211. format: iri-reference
  5212. example: 'https://example.com/'
  5213. logoUrl:
  5214. readOnly: true
  5215. type:
  5216. - string
  5217. - 'null'
  5218. createdByIri:
  5219. readOnly: true
  5220. type:
  5221. - string
  5222. - 'null'
  5223. format: iri-reference
  5224. example: 'https://example.com/'
  5225. createdAt:
  5226. readOnly: true
  5227. type:
  5228. - string
  5229. - 'null'
  5230. format: date-time
  5231. Partner.jsonld:
  5232. type: object
  5233. description: ''
  5234. deprecated: false
  5235. required:
  5236. - name
  5237. - partnerType
  5238. properties:
  5239. '@context':
  5240. readOnly: true
  5241. oneOf:
  5242. -
  5243. type: string
  5244. -
  5245. type: object
  5246. properties:
  5247. '@vocab':
  5248. type: string
  5249. hydra:
  5250. type: string
  5251. enum: ['http://www.w3.org/ns/hydra/core#']
  5252. required:
  5253. - '@vocab'
  5254. - hydra
  5255. additionalProperties: true
  5256. '@id':
  5257. readOnly: true
  5258. type: string
  5259. '@type':
  5260. readOnly: true
  5261. type: string
  5262. name:
  5263. type: string
  5264. partnerType:
  5265. type: string
  5266. enum:
  5267. - customer
  5268. - supplier
  5269. - service
  5270. description:
  5271. type:
  5272. - string
  5273. - 'null'
  5274. street:
  5275. type:
  5276. - string
  5277. - 'null'
  5278. streetNo:
  5279. type:
  5280. - string
  5281. - 'null'
  5282. zip:
  5283. type:
  5284. - string
  5285. - 'null'
  5286. city:
  5287. type:
  5288. - string
  5289. - 'null'
  5290. country:
  5291. type:
  5292. - string
  5293. - 'null'
  5294. website:
  5295. type:
  5296. - string
  5297. - 'null'
  5298. logo:
  5299. type:
  5300. - string
  5301. - 'null'
  5302. format: iri-reference
  5303. example: 'https://example.com/'
  5304. logoUrl:
  5305. readOnly: true
  5306. type:
  5307. - string
  5308. - 'null'
  5309. createdByIri:
  5310. readOnly: true
  5311. type:
  5312. - string
  5313. - 'null'
  5314. format: iri-reference
  5315. example: 'https://example.com/'
  5316. createdAt:
  5317. readOnly: true
  5318. type:
  5319. - string
  5320. - 'null'
  5321. format: date-time
  5322. PartnerFollow:
  5323. type: object
  5324. description: ''
  5325. deprecated: false
  5326. properties:
  5327. userIri:
  5328. type:
  5329. - string
  5330. - 'null'
  5331. format: iri-reference
  5332. example: 'https://example.com/'
  5333. partner:
  5334. readOnly: true
  5335. description: '?PartnerApi'
  5336. $ref: '#/components/schemas/Partner'
  5337. partnerIri:
  5338. type:
  5339. - string
  5340. - 'null'
  5341. format: iri-reference
  5342. example: 'https://example.com/'
  5343. createdAt:
  5344. readOnly: true
  5345. type:
  5346. - string
  5347. - 'null'
  5348. format: date-time
  5349. owner:
  5350. readOnly: true
  5351. type:
  5352. - string
  5353. - 'null'
  5354. format: iri-reference
  5355. example: 'https://example.com/'
  5356. required:
  5357. - partnerIri
  5358. PartnerFollow.jsonhal:
  5359. type: object
  5360. description: ''
  5361. deprecated: false
  5362. properties:
  5363. _links:
  5364. type: object
  5365. properties:
  5366. self:
  5367. type: object
  5368. properties:
  5369. href:
  5370. type: string
  5371. format: iri-reference
  5372. userIri:
  5373. type:
  5374. - string
  5375. - 'null'
  5376. format: iri-reference
  5377. example: 'https://example.com/'
  5378. partner:
  5379. readOnly: true
  5380. description: '?PartnerApi'
  5381. $ref: '#/components/schemas/Partner.jsonhal'
  5382. partnerIri:
  5383. type:
  5384. - string
  5385. - 'null'
  5386. format: iri-reference
  5387. example: 'https://example.com/'
  5388. createdAt:
  5389. readOnly: true
  5390. type:
  5391. - string
  5392. - 'null'
  5393. format: date-time
  5394. owner:
  5395. readOnly: true
  5396. type:
  5397. - string
  5398. - 'null'
  5399. format: iri-reference
  5400. example: 'https://example.com/'
  5401. required:
  5402. - partnerIri
  5403. PartnerFollow.jsonld:
  5404. type: object
  5405. description: ''
  5406. deprecated: false
  5407. properties:
  5408. '@context':
  5409. readOnly: true
  5410. oneOf:
  5411. -
  5412. type: string
  5413. -
  5414. type: object
  5415. properties:
  5416. '@vocab':
  5417. type: string
  5418. hydra:
  5419. type: string
  5420. enum: ['http://www.w3.org/ns/hydra/core#']
  5421. required:
  5422. - '@vocab'
  5423. - hydra
  5424. additionalProperties: true
  5425. '@id':
  5426. readOnly: true
  5427. type: string
  5428. '@type':
  5429. readOnly: true
  5430. type: string
  5431. userIri:
  5432. type:
  5433. - string
  5434. - 'null'
  5435. format: iri-reference
  5436. example: 'https://example.com/'
  5437. partner:
  5438. readOnly: true
  5439. description: '?PartnerApi'
  5440. $ref: '#/components/schemas/Partner.jsonld'
  5441. partnerIri:
  5442. type:
  5443. - string
  5444. - 'null'
  5445. format: iri-reference
  5446. example: 'https://example.com/'
  5447. createdAt:
  5448. readOnly: true
  5449. type:
  5450. - string
  5451. - 'null'
  5452. format: date-time
  5453. owner:
  5454. readOnly: true
  5455. type:
  5456. - string
  5457. - 'null'
  5458. format: iri-reference
  5459. example: 'https://example.com/'
  5460. required:
  5461. - partnerIri
  5462. PartnerProduct:
  5463. type: object
  5464. description: ''
  5465. deprecated: false
  5466. properties:
  5467. partner:
  5468. readOnly: true
  5469. description: '?PartnerApi'
  5470. $ref: '#/components/schemas/Partner'
  5471. partnerIri:
  5472. type:
  5473. - string
  5474. - 'null'
  5475. format: iri-reference
  5476. example: 'https://example.com/'
  5477. product:
  5478. readOnly: true
  5479. description: '?ProductApi'
  5480. $ref: '#/components/schemas/Product'
  5481. productIri:
  5482. type:
  5483. - string
  5484. - 'null'
  5485. format: iri-reference
  5486. example: 'https://example.com/'
  5487. createdAt:
  5488. readOnly: true
  5489. type:
  5490. - string
  5491. - 'null'
  5492. format: date-time
  5493. required:
  5494. - partnerIri
  5495. - productIri
  5496. PartnerProduct.jsonhal:
  5497. type: object
  5498. description: ''
  5499. deprecated: false
  5500. properties:
  5501. _links:
  5502. type: object
  5503. properties:
  5504. self:
  5505. type: object
  5506. properties:
  5507. href:
  5508. type: string
  5509. format: iri-reference
  5510. partner:
  5511. readOnly: true
  5512. description: '?PartnerApi'
  5513. $ref: '#/components/schemas/Partner.jsonhal'
  5514. partnerIri:
  5515. type:
  5516. - string
  5517. - 'null'
  5518. format: iri-reference
  5519. example: 'https://example.com/'
  5520. product:
  5521. readOnly: true
  5522. description: '?ProductApi'
  5523. $ref: '#/components/schemas/Product.jsonhal'
  5524. productIri:
  5525. type:
  5526. - string
  5527. - 'null'
  5528. format: iri-reference
  5529. example: 'https://example.com/'
  5530. createdAt:
  5531. readOnly: true
  5532. type:
  5533. - string
  5534. - 'null'
  5535. format: date-time
  5536. required:
  5537. - partnerIri
  5538. - productIri
  5539. PartnerProduct.jsonld:
  5540. type: object
  5541. description: ''
  5542. deprecated: false
  5543. properties:
  5544. '@context':
  5545. readOnly: true
  5546. oneOf:
  5547. -
  5548. type: string
  5549. -
  5550. type: object
  5551. properties:
  5552. '@vocab':
  5553. type: string
  5554. hydra:
  5555. type: string
  5556. enum: ['http://www.w3.org/ns/hydra/core#']
  5557. required:
  5558. - '@vocab'
  5559. - hydra
  5560. additionalProperties: true
  5561. '@id':
  5562. readOnly: true
  5563. type: string
  5564. '@type':
  5565. readOnly: true
  5566. type: string
  5567. partner:
  5568. readOnly: true
  5569. description: '?PartnerApi'
  5570. $ref: '#/components/schemas/Partner.jsonld'
  5571. partnerIri:
  5572. type:
  5573. - string
  5574. - 'null'
  5575. format: iri-reference
  5576. example: 'https://example.com/'
  5577. product:
  5578. readOnly: true
  5579. description: '?ProductApi'
  5580. $ref: '#/components/schemas/Product.jsonld'
  5581. productIri:
  5582. type:
  5583. - string
  5584. - 'null'
  5585. format: iri-reference
  5586. example: 'https://example.com/'
  5587. createdAt:
  5588. readOnly: true
  5589. type:
  5590. - string
  5591. - 'null'
  5592. format: date-time
  5593. required:
  5594. - partnerIri
  5595. - productIri
  5596. Post:
  5597. type: object
  5598. description: ''
  5599. deprecated: false
  5600. required:
  5601. - headline
  5602. - message
  5603. properties:
  5604. headline:
  5605. type:
  5606. - string
  5607. - 'null'
  5608. message:
  5609. type:
  5610. - string
  5611. - 'null'
  5612. owner:
  5613. readOnly: true
  5614. description: '?UserApi'
  5615. $ref: '#/components/schemas/User'
  5616. partner:
  5617. readOnly: true
  5618. description: '?PartnerApi'
  5619. $ref: '#/components/schemas/Partner'
  5620. partnerIri:
  5621. type:
  5622. - string
  5623. - 'null'
  5624. format: iri-reference
  5625. example: 'https://example.com/'
  5626. product:
  5627. readOnly: true
  5628. description: '?ProductApi'
  5629. $ref: '#/components/schemas/Product'
  5630. productIri:
  5631. type:
  5632. - string
  5633. - 'null'
  5634. format: iri-reference
  5635. example: 'https://example.com/'
  5636. contact:
  5637. readOnly: true
  5638. description: '?ContactApi'
  5639. $ref: '#/components/schemas/Contact'
  5640. contactIri:
  5641. type:
  5642. - string
  5643. - 'null'
  5644. format: iri-reference
  5645. example: 'https://example.com/'
  5646. sale:
  5647. readOnly: true
  5648. description: '?SaleApi'
  5649. $ref: '#/components/schemas/Contact'
  5650. saleIri:
  5651. type:
  5652. - string
  5653. - 'null'
  5654. format: iri-reference
  5655. example: 'https://example.com/'
  5656. numComments:
  5657. readOnly: true
  5658. type:
  5659. - integer
  5660. - 'null'
  5661. createdAt:
  5662. readOnly: true
  5663. type:
  5664. - string
  5665. - 'null'
  5666. format: date-time
  5667. Post-posting.create:
  5668. type: object
  5669. description: ''
  5670. deprecated: false
  5671. required:
  5672. - headline
  5673. - message
  5674. properties:
  5675. headline:
  5676. type:
  5677. - string
  5678. - 'null'
  5679. message:
  5680. type:
  5681. - string
  5682. - 'null'
  5683. partnerIri:
  5684. type:
  5685. - string
  5686. - 'null'
  5687. format: iri-reference
  5688. example: 'https://example.com/'
  5689. productIri:
  5690. type:
  5691. - string
  5692. - 'null'
  5693. format: iri-reference
  5694. example: 'https://example.com/'
  5695. contactIri:
  5696. type:
  5697. - string
  5698. - 'null'
  5699. format: iri-reference
  5700. example: 'https://example.com/'
  5701. saleIri:
  5702. type:
  5703. - string
  5704. - 'null'
  5705. format: iri-reference
  5706. example: 'https://example.com/'
  5707. Post-posting.patch:
  5708. type: object
  5709. description: ''
  5710. deprecated: false
  5711. required:
  5712. - headline
  5713. - message
  5714. properties:
  5715. headline:
  5716. type:
  5717. - string
  5718. - 'null'
  5719. message:
  5720. type:
  5721. - string
  5722. - 'null'
  5723. Post.jsonhal:
  5724. type: object
  5725. description: ''
  5726. deprecated: false
  5727. required:
  5728. - headline
  5729. - message
  5730. properties:
  5731. _links:
  5732. type: object
  5733. properties:
  5734. self:
  5735. type: object
  5736. properties:
  5737. href:
  5738. type: string
  5739. format: iri-reference
  5740. headline:
  5741. type:
  5742. - string
  5743. - 'null'
  5744. message:
  5745. type:
  5746. - string
  5747. - 'null'
  5748. owner:
  5749. readOnly: true
  5750. description: '?UserApi'
  5751. $ref: '#/components/schemas/User.jsonhal'
  5752. partner:
  5753. readOnly: true
  5754. description: '?PartnerApi'
  5755. $ref: '#/components/schemas/Partner.jsonhal'
  5756. partnerIri:
  5757. type:
  5758. - string
  5759. - 'null'
  5760. format: iri-reference
  5761. example: 'https://example.com/'
  5762. product:
  5763. readOnly: true
  5764. description: '?ProductApi'
  5765. $ref: '#/components/schemas/Product.jsonhal'
  5766. productIri:
  5767. type:
  5768. - string
  5769. - 'null'
  5770. format: iri-reference
  5771. example: 'https://example.com/'
  5772. contact:
  5773. readOnly: true
  5774. description: '?ContactApi'
  5775. $ref: '#/components/schemas/Contact.jsonhal'
  5776. contactIri:
  5777. type:
  5778. - string
  5779. - 'null'
  5780. format: iri-reference
  5781. example: 'https://example.com/'
  5782. sale:
  5783. readOnly: true
  5784. description: '?SaleApi'
  5785. $ref: '#/components/schemas/Contact.jsonhal'
  5786. saleIri:
  5787. type:
  5788. - string
  5789. - 'null'
  5790. format: iri-reference
  5791. example: 'https://example.com/'
  5792. numComments:
  5793. readOnly: true
  5794. type:
  5795. - integer
  5796. - 'null'
  5797. createdAt:
  5798. readOnly: true
  5799. type:
  5800. - string
  5801. - 'null'
  5802. format: date-time
  5803. Post.jsonhal-posting.create:
  5804. type: object
  5805. description: ''
  5806. deprecated: false
  5807. required:
  5808. - headline
  5809. - message
  5810. properties:
  5811. _links:
  5812. type: object
  5813. properties:
  5814. self:
  5815. type: object
  5816. properties:
  5817. href:
  5818. type: string
  5819. format: iri-reference
  5820. headline:
  5821. type:
  5822. - string
  5823. - 'null'
  5824. message:
  5825. type:
  5826. - string
  5827. - 'null'
  5828. partnerIri:
  5829. type:
  5830. - string
  5831. - 'null'
  5832. format: iri-reference
  5833. example: 'https://example.com/'
  5834. productIri:
  5835. type:
  5836. - string
  5837. - 'null'
  5838. format: iri-reference
  5839. example: 'https://example.com/'
  5840. contactIri:
  5841. type:
  5842. - string
  5843. - 'null'
  5844. format: iri-reference
  5845. example: 'https://example.com/'
  5846. saleIri:
  5847. type:
  5848. - string
  5849. - 'null'
  5850. format: iri-reference
  5851. example: 'https://example.com/'
  5852. Post.jsonld:
  5853. type: object
  5854. description: ''
  5855. deprecated: false
  5856. required:
  5857. - headline
  5858. - message
  5859. properties:
  5860. '@context':
  5861. readOnly: true
  5862. oneOf:
  5863. -
  5864. type: string
  5865. -
  5866. type: object
  5867. properties:
  5868. '@vocab':
  5869. type: string
  5870. hydra:
  5871. type: string
  5872. enum: ['http://www.w3.org/ns/hydra/core#']
  5873. required:
  5874. - '@vocab'
  5875. - hydra
  5876. additionalProperties: true
  5877. '@id':
  5878. readOnly: true
  5879. type: string
  5880. '@type':
  5881. readOnly: true
  5882. type: string
  5883. headline:
  5884. type:
  5885. - string
  5886. - 'null'
  5887. message:
  5888. type:
  5889. - string
  5890. - 'null'
  5891. owner:
  5892. readOnly: true
  5893. description: '?UserApi'
  5894. $ref: '#/components/schemas/User.jsonld'
  5895. partner:
  5896. readOnly: true
  5897. description: '?PartnerApi'
  5898. $ref: '#/components/schemas/Partner.jsonld'
  5899. partnerIri:
  5900. type:
  5901. - string
  5902. - 'null'
  5903. format: iri-reference
  5904. example: 'https://example.com/'
  5905. product:
  5906. readOnly: true
  5907. description: '?ProductApi'
  5908. $ref: '#/components/schemas/Product.jsonld'
  5909. productIri:
  5910. type:
  5911. - string
  5912. - 'null'
  5913. format: iri-reference
  5914. example: 'https://example.com/'
  5915. contact:
  5916. readOnly: true
  5917. description: '?ContactApi'
  5918. $ref: '#/components/schemas/Contact.jsonld'
  5919. contactIri:
  5920. type:
  5921. - string
  5922. - 'null'
  5923. format: iri-reference
  5924. example: 'https://example.com/'
  5925. sale:
  5926. readOnly: true
  5927. description: '?SaleApi'
  5928. $ref: '#/components/schemas/Contact.jsonld'
  5929. saleIri:
  5930. type:
  5931. - string
  5932. - 'null'
  5933. format: iri-reference
  5934. example: 'https://example.com/'
  5935. numComments:
  5936. readOnly: true
  5937. type:
  5938. - integer
  5939. - 'null'
  5940. createdAt:
  5941. readOnly: true
  5942. type:
  5943. - string
  5944. - 'null'
  5945. format: date-time
  5946. Post.jsonld-posting.create:
  5947. type: object
  5948. description: ''
  5949. deprecated: false
  5950. required:
  5951. - headline
  5952. - message
  5953. properties:
  5954. headline:
  5955. type:
  5956. - string
  5957. - 'null'
  5958. message:
  5959. type:
  5960. - string
  5961. - 'null'
  5962. partnerIri:
  5963. type:
  5964. - string
  5965. - 'null'
  5966. format: iri-reference
  5967. example: 'https://example.com/'
  5968. productIri:
  5969. type:
  5970. - string
  5971. - 'null'
  5972. format: iri-reference
  5973. example: 'https://example.com/'
  5974. contactIri:
  5975. type:
  5976. - string
  5977. - 'null'
  5978. format: iri-reference
  5979. example: 'https://example.com/'
  5980. saleIri:
  5981. type:
  5982. - string
  5983. - 'null'
  5984. format: iri-reference
  5985. example: 'https://example.com/'
  5986. Product:
  5987. type: object
  5988. description: ''
  5989. deprecated: false
  5990. required:
  5991. - name
  5992. properties:
  5993. name:
  5994. type: string
  5995. description:
  5996. type:
  5997. - string
  5998. - 'null'
  5999. image:
  6000. type:
  6001. - string
  6002. - 'null'
  6003. format: iri-reference
  6004. example: 'https://example.com/'
  6005. imageUrl:
  6006. readOnly: true
  6007. type:
  6008. - string
  6009. - 'null'
  6010. createdBy:
  6011. readOnly: true
  6012. description: '?UserApi'
  6013. $ref: '#/components/schemas/User'
  6014. createdAt:
  6015. type:
  6016. - string
  6017. - 'null'
  6018. format: date-time
  6019. Product.jsonhal:
  6020. type: object
  6021. description: ''
  6022. deprecated: false
  6023. required:
  6024. - name
  6025. properties:
  6026. _links:
  6027. type: object
  6028. properties:
  6029. self:
  6030. type: object
  6031. properties:
  6032. href:
  6033. type: string
  6034. format: iri-reference
  6035. name:
  6036. type: string
  6037. description:
  6038. type:
  6039. - string
  6040. - 'null'
  6041. image:
  6042. type:
  6043. - string
  6044. - 'null'
  6045. format: iri-reference
  6046. example: 'https://example.com/'
  6047. imageUrl:
  6048. readOnly: true
  6049. type:
  6050. - string
  6051. - 'null'
  6052. createdBy:
  6053. readOnly: true
  6054. description: '?UserApi'
  6055. $ref: '#/components/schemas/User.jsonhal'
  6056. createdAt:
  6057. type:
  6058. - string
  6059. - 'null'
  6060. format: date-time
  6061. Product.jsonld:
  6062. type: object
  6063. description: ''
  6064. deprecated: false
  6065. required:
  6066. - name
  6067. properties:
  6068. '@context':
  6069. readOnly: true
  6070. oneOf:
  6071. -
  6072. type: string
  6073. -
  6074. type: object
  6075. properties:
  6076. '@vocab':
  6077. type: string
  6078. hydra:
  6079. type: string
  6080. enum: ['http://www.w3.org/ns/hydra/core#']
  6081. required:
  6082. - '@vocab'
  6083. - hydra
  6084. additionalProperties: true
  6085. '@id':
  6086. readOnly: true
  6087. type: string
  6088. '@type':
  6089. readOnly: true
  6090. type: string
  6091. name:
  6092. type: string
  6093. description:
  6094. type:
  6095. - string
  6096. - 'null'
  6097. image:
  6098. type:
  6099. - string
  6100. - 'null'
  6101. format: iri-reference
  6102. example: 'https://example.com/'
  6103. imageUrl:
  6104. readOnly: true
  6105. type:
  6106. - string
  6107. - 'null'
  6108. createdBy:
  6109. readOnly: true
  6110. description: '?UserApi'
  6111. $ref: '#/components/schemas/User.jsonld'
  6112. createdAt:
  6113. type:
  6114. - string
  6115. - 'null'
  6116. format: date-time
  6117. Sale:
  6118. type: object
  6119. description: ''
  6120. deprecated: false
  6121. properties:
  6122. owner:
  6123. readOnly: true
  6124. description: '?UserApi'
  6125. $ref: '#/components/schemas/User'
  6126. partner:
  6127. readOnly: true
  6128. description: '?PartnerApi'
  6129. $ref: '#/components/schemas/Partner'
  6130. partnerIri:
  6131. type:
  6132. - string
  6133. - 'null'
  6134. format: iri-reference
  6135. example: 'https://example.com/'
  6136. product:
  6137. readOnly: true
  6138. description: '?ProductApi'
  6139. $ref: '#/components/schemas/Product'
  6140. productIri:
  6141. type:
  6142. - string
  6143. - 'null'
  6144. format: iri-reference
  6145. example: 'https://example.com/'
  6146. turnover:
  6147. type:
  6148. - integer
  6149. - 'null'
  6150. profit:
  6151. type:
  6152. - integer
  6153. - 'null'
  6154. quantity:
  6155. type:
  6156. - integer
  6157. - 'null'
  6158. comment:
  6159. type:
  6160. - string
  6161. - 'null'
  6162. createdAt:
  6163. readOnly: true
  6164. type:
  6165. - string
  6166. - 'null'
  6167. format: date-time
  6168. required:
  6169. - partnerIri
  6170. - productIri
  6171. - turnover
  6172. - profit
  6173. - quantity
  6174. Sale.jsonhal:
  6175. type: object
  6176. description: ''
  6177. deprecated: false
  6178. properties:
  6179. _links:
  6180. type: object
  6181. properties:
  6182. self:
  6183. type: object
  6184. properties:
  6185. href:
  6186. type: string
  6187. format: iri-reference
  6188. owner:
  6189. readOnly: true
  6190. description: '?UserApi'
  6191. $ref: '#/components/schemas/User.jsonhal'
  6192. partner:
  6193. readOnly: true
  6194. description: '?PartnerApi'
  6195. $ref: '#/components/schemas/Partner.jsonhal'
  6196. partnerIri:
  6197. type:
  6198. - string
  6199. - 'null'
  6200. format: iri-reference
  6201. example: 'https://example.com/'
  6202. product:
  6203. readOnly: true
  6204. description: '?ProductApi'
  6205. $ref: '#/components/schemas/Product.jsonhal'
  6206. productIri:
  6207. type:
  6208. - string
  6209. - 'null'
  6210. format: iri-reference
  6211. example: 'https://example.com/'
  6212. turnover:
  6213. type:
  6214. - integer
  6215. - 'null'
  6216. profit:
  6217. type:
  6218. - integer
  6219. - 'null'
  6220. quantity:
  6221. type:
  6222. - integer
  6223. - 'null'
  6224. comment:
  6225. type:
  6226. - string
  6227. - 'null'
  6228. createdAt:
  6229. readOnly: true
  6230. type:
  6231. - string
  6232. - 'null'
  6233. format: date-time
  6234. required:
  6235. - partnerIri
  6236. - productIri
  6237. - turnover
  6238. - profit
  6239. - quantity
  6240. Sale.jsonld:
  6241. type: object
  6242. description: ''
  6243. deprecated: false
  6244. properties:
  6245. '@context':
  6246. readOnly: true
  6247. oneOf:
  6248. -
  6249. type: string
  6250. -
  6251. type: object
  6252. properties:
  6253. '@vocab':
  6254. type: string
  6255. hydra:
  6256. type: string
  6257. enum: ['http://www.w3.org/ns/hydra/core#']
  6258. required:
  6259. - '@vocab'
  6260. - hydra
  6261. additionalProperties: true
  6262. '@id':
  6263. readOnly: true
  6264. type: string
  6265. '@type':
  6266. readOnly: true
  6267. type: string
  6268. owner:
  6269. readOnly: true
  6270. description: '?UserApi'
  6271. $ref: '#/components/schemas/User.jsonld'
  6272. partner:
  6273. readOnly: true
  6274. description: '?PartnerApi'
  6275. $ref: '#/components/schemas/Partner.jsonld'
  6276. partnerIri:
  6277. type:
  6278. - string
  6279. - 'null'
  6280. format: iri-reference
  6281. example: 'https://example.com/'
  6282. product:
  6283. readOnly: true
  6284. description: '?ProductApi'
  6285. $ref: '#/components/schemas/Product.jsonld'
  6286. productIri:
  6287. type:
  6288. - string
  6289. - 'null'
  6290. format: iri-reference
  6291. example: 'https://example.com/'
  6292. turnover:
  6293. type:
  6294. - integer
  6295. - 'null'
  6296. profit:
  6297. type:
  6298. - integer
  6299. - 'null'
  6300. quantity:
  6301. type:
  6302. - integer
  6303. - 'null'
  6304. comment:
  6305. type:
  6306. - string
  6307. - 'null'
  6308. createdAt:
  6309. readOnly: true
  6310. type:
  6311. - string
  6312. - 'null'
  6313. format: date-time
  6314. required:
  6315. - partnerIri
  6316. - productIri
  6317. - turnover
  6318. - profit
  6319. - quantity
  6320. SaleSummary:
  6321. type: object
  6322. description: ''
  6323. deprecated: false
  6324. properties:
  6325. userId:
  6326. type: integer
  6327. owner:
  6328. readOnly: true
  6329. description: '?UserApi'
  6330. $ref: '#/components/schemas/User'
  6331. turnover:
  6332. type:
  6333. - integer
  6334. - 'null'
  6335. profit:
  6336. type:
  6337. - integer
  6338. - 'null'
  6339. SaleSummary.jsonhal:
  6340. type: object
  6341. description: ''
  6342. deprecated: false
  6343. properties:
  6344. _links:
  6345. type: object
  6346. properties:
  6347. self:
  6348. type: object
  6349. properties:
  6350. href:
  6351. type: string
  6352. format: iri-reference
  6353. userId:
  6354. type: integer
  6355. owner:
  6356. readOnly: true
  6357. description: '?UserApi'
  6358. $ref: '#/components/schemas/User.jsonhal'
  6359. turnover:
  6360. type:
  6361. - integer
  6362. - 'null'
  6363. profit:
  6364. type:
  6365. - integer
  6366. - 'null'
  6367. SaleSummary.jsonld:
  6368. type: object
  6369. description: ''
  6370. deprecated: false
  6371. properties:
  6372. '@id':
  6373. readOnly: true
  6374. type: string
  6375. '@type':
  6376. readOnly: true
  6377. type: string
  6378. '@context':
  6379. readOnly: true
  6380. oneOf:
  6381. -
  6382. type: string
  6383. -
  6384. type: object
  6385. properties:
  6386. '@vocab':
  6387. type: string
  6388. hydra:
  6389. type: string
  6390. enum: ['http://www.w3.org/ns/hydra/core#']
  6391. required:
  6392. - '@vocab'
  6393. - hydra
  6394. additionalProperties: true
  6395. userId:
  6396. type: integer
  6397. owner:
  6398. readOnly: true
  6399. description: '?UserApi'
  6400. $ref: '#/components/schemas/User.jsonld'
  6401. turnover:
  6402. type:
  6403. - integer
  6404. - 'null'
  6405. profit:
  6406. type:
  6407. - integer
  6408. - 'null'
  6409. Task:
  6410. type: object
  6411. description: ''
  6412. deprecated: false
  6413. required:
  6414. - headline
  6415. - assignedToIri
  6416. - dueAt
  6417. - productIri
  6418. - prio
  6419. - completed
  6420. properties:
  6421. headline:
  6422. type:
  6423. - string
  6424. - 'null'
  6425. description:
  6426. type:
  6427. - string
  6428. - 'null'
  6429. createdBy:
  6430. readOnly: true
  6431. description: '?UserApi'
  6432. $ref: '#/components/schemas/User'
  6433. assignedTo:
  6434. readOnly: true
  6435. description: '?UserApi'
  6436. $ref: '#/components/schemas/User'
  6437. assignedToIri:
  6438. type:
  6439. - string
  6440. - 'null'
  6441. format: iri-reference
  6442. example: 'https://example.com/'
  6443. dueAt:
  6444. type:
  6445. - string
  6446. - 'null'
  6447. format: date-time
  6448. partner:
  6449. readOnly: true
  6450. description: '?PartnerApi'
  6451. $ref: '#/components/schemas/Partner'
  6452. partnerIri:
  6453. type:
  6454. - string
  6455. - 'null'
  6456. format: iri-reference
  6457. example: 'https://example.com/'
  6458. product:
  6459. readOnly: true
  6460. description: '?ProductApi'
  6461. $ref: '#/components/schemas/Product'
  6462. productIri:
  6463. type:
  6464. - string
  6465. - 'null'
  6466. format: iri-reference
  6467. example: 'https://example.com/'
  6468. contact:
  6469. readOnly: true
  6470. description: '?ContactApi'
  6471. $ref: '#/components/schemas/Contact'
  6472. contactIri:
  6473. type:
  6474. - string
  6475. - 'null'
  6476. format: iri-reference
  6477. example: 'https://example.com/'
  6478. prio:
  6479. type: string
  6480. enum:
  6481. - low
  6482. - medium
  6483. - high
  6484. completed:
  6485. type:
  6486. - boolean
  6487. - 'null'
  6488. numTaskNotes:
  6489. readOnly: true
  6490. type:
  6491. - integer
  6492. - 'null'
  6493. createdAt:
  6494. readOnly: true
  6495. type:
  6496. - string
  6497. - 'null'
  6498. format: date-time
  6499. Task.jsonhal:
  6500. type: object
  6501. description: ''
  6502. deprecated: false
  6503. required:
  6504. - headline
  6505. - assignedToIri
  6506. - dueAt
  6507. - productIri
  6508. - prio
  6509. - completed
  6510. properties:
  6511. _links:
  6512. type: object
  6513. properties:
  6514. self:
  6515. type: object
  6516. properties:
  6517. href:
  6518. type: string
  6519. format: iri-reference
  6520. headline:
  6521. type:
  6522. - string
  6523. - 'null'
  6524. description:
  6525. type:
  6526. - string
  6527. - 'null'
  6528. createdBy:
  6529. readOnly: true
  6530. description: '?UserApi'
  6531. $ref: '#/components/schemas/User.jsonhal'
  6532. assignedTo:
  6533. readOnly: true
  6534. description: '?UserApi'
  6535. $ref: '#/components/schemas/User.jsonhal'
  6536. assignedToIri:
  6537. type:
  6538. - string
  6539. - 'null'
  6540. format: iri-reference
  6541. example: 'https://example.com/'
  6542. dueAt:
  6543. type:
  6544. - string
  6545. - 'null'
  6546. format: date-time
  6547. partner:
  6548. readOnly: true
  6549. description: '?PartnerApi'
  6550. $ref: '#/components/schemas/Partner.jsonhal'
  6551. partnerIri:
  6552. type:
  6553. - string
  6554. - 'null'
  6555. format: iri-reference
  6556. example: 'https://example.com/'
  6557. product:
  6558. readOnly: true
  6559. description: '?ProductApi'
  6560. $ref: '#/components/schemas/Product.jsonhal'
  6561. productIri:
  6562. type:
  6563. - string
  6564. - 'null'
  6565. format: iri-reference
  6566. example: 'https://example.com/'
  6567. contact:
  6568. readOnly: true
  6569. description: '?ContactApi'
  6570. $ref: '#/components/schemas/Contact.jsonhal'
  6571. contactIri:
  6572. type:
  6573. - string
  6574. - 'null'
  6575. format: iri-reference
  6576. example: 'https://example.com/'
  6577. prio:
  6578. type: string
  6579. enum:
  6580. - low
  6581. - medium
  6582. - high
  6583. completed:
  6584. type:
  6585. - boolean
  6586. - 'null'
  6587. numTaskNotes:
  6588. readOnly: true
  6589. type:
  6590. - integer
  6591. - 'null'
  6592. createdAt:
  6593. readOnly: true
  6594. type:
  6595. - string
  6596. - 'null'
  6597. format: date-time
  6598. Task.jsonld:
  6599. type: object
  6600. description: ''
  6601. deprecated: false
  6602. required:
  6603. - headline
  6604. - assignedToIri
  6605. - dueAt
  6606. - productIri
  6607. - prio
  6608. - completed
  6609. properties:
  6610. '@context':
  6611. readOnly: true
  6612. oneOf:
  6613. -
  6614. type: string
  6615. -
  6616. type: object
  6617. properties:
  6618. '@vocab':
  6619. type: string
  6620. hydra:
  6621. type: string
  6622. enum: ['http://www.w3.org/ns/hydra/core#']
  6623. required:
  6624. - '@vocab'
  6625. - hydra
  6626. additionalProperties: true
  6627. '@id':
  6628. readOnly: true
  6629. type: string
  6630. '@type':
  6631. readOnly: true
  6632. type: string
  6633. headline:
  6634. type:
  6635. - string
  6636. - 'null'
  6637. description:
  6638. type:
  6639. - string
  6640. - 'null'
  6641. createdBy:
  6642. readOnly: true
  6643. description: '?UserApi'
  6644. $ref: '#/components/schemas/User.jsonld'
  6645. assignedTo:
  6646. readOnly: true
  6647. description: '?UserApi'
  6648. $ref: '#/components/schemas/User.jsonld'
  6649. assignedToIri:
  6650. type:
  6651. - string
  6652. - 'null'
  6653. format: iri-reference
  6654. example: 'https://example.com/'
  6655. dueAt:
  6656. type:
  6657. - string
  6658. - 'null'
  6659. format: date-time
  6660. partner:
  6661. readOnly: true
  6662. description: '?PartnerApi'
  6663. $ref: '#/components/schemas/Partner.jsonld'
  6664. partnerIri:
  6665. type:
  6666. - string
  6667. - 'null'
  6668. format: iri-reference
  6669. example: 'https://example.com/'
  6670. product:
  6671. readOnly: true
  6672. description: '?ProductApi'
  6673. $ref: '#/components/schemas/Product.jsonld'
  6674. productIri:
  6675. type:
  6676. - string
  6677. - 'null'
  6678. format: iri-reference
  6679. example: 'https://example.com/'
  6680. contact:
  6681. readOnly: true
  6682. description: '?ContactApi'
  6683. $ref: '#/components/schemas/Contact.jsonld'
  6684. contactIri:
  6685. type:
  6686. - string
  6687. - 'null'
  6688. format: iri-reference
  6689. example: 'https://example.com/'
  6690. prio:
  6691. type: string
  6692. enum:
  6693. - low
  6694. - medium
  6695. - high
  6696. completed:
  6697. type:
  6698. - boolean
  6699. - 'null'
  6700. numTaskNotes:
  6701. readOnly: true
  6702. type:
  6703. - integer
  6704. - 'null'
  6705. createdAt:
  6706. readOnly: true
  6707. type:
  6708. - string
  6709. - 'null'
  6710. format: date-time
  6711. TaskNote:
  6712. type: object
  6713. description: ''
  6714. deprecated: false
  6715. required:
  6716. - message
  6717. - taskIri
  6718. - contactType
  6719. properties:
  6720. message:
  6721. type:
  6722. - string
  6723. - 'null'
  6724. owner:
  6725. readOnly: true
  6726. description: '?UserApi'
  6727. $ref: '#/components/schemas/User'
  6728. taskIri:
  6729. type:
  6730. - string
  6731. - 'null'
  6732. format: iri-reference
  6733. example: 'https://example.com/'
  6734. contact:
  6735. readOnly: true
  6736. description: '?ContactApi'
  6737. $ref: '#/components/schemas/Contact'
  6738. contactIri:
  6739. type:
  6740. - string
  6741. - 'null'
  6742. format: iri-reference
  6743. example: 'https://example.com/'
  6744. contactType:
  6745. type: string
  6746. enum:
  6747. - personal
  6748. - phone
  6749. - email
  6750. createdAt:
  6751. readOnly: true
  6752. type:
  6753. - string
  6754. - 'null'
  6755. format: date-time
  6756. TaskNote.jsonhal:
  6757. type: object
  6758. description: ''
  6759. deprecated: false
  6760. required:
  6761. - message
  6762. - taskIri
  6763. - contactType
  6764. properties:
  6765. _links:
  6766. type: object
  6767. properties:
  6768. self:
  6769. type: object
  6770. properties:
  6771. href:
  6772. type: string
  6773. format: iri-reference
  6774. message:
  6775. type:
  6776. - string
  6777. - 'null'
  6778. owner:
  6779. readOnly: true
  6780. description: '?UserApi'
  6781. $ref: '#/components/schemas/User.jsonhal'
  6782. taskIri:
  6783. type:
  6784. - string
  6785. - 'null'
  6786. format: iri-reference
  6787. example: 'https://example.com/'
  6788. contact:
  6789. readOnly: true
  6790. description: '?ContactApi'
  6791. $ref: '#/components/schemas/Contact.jsonhal'
  6792. contactIri:
  6793. type:
  6794. - string
  6795. - 'null'
  6796. format: iri-reference
  6797. example: 'https://example.com/'
  6798. contactType:
  6799. type: string
  6800. enum:
  6801. - personal
  6802. - phone
  6803. - email
  6804. createdAt:
  6805. readOnly: true
  6806. type:
  6807. - string
  6808. - 'null'
  6809. format: date-time
  6810. TaskNote.jsonld:
  6811. type: object
  6812. description: ''
  6813. deprecated: false
  6814. required:
  6815. - message
  6816. - taskIri
  6817. - contactType
  6818. properties:
  6819. '@context':
  6820. readOnly: true
  6821. oneOf:
  6822. -
  6823. type: string
  6824. -
  6825. type: object
  6826. properties:
  6827. '@vocab':
  6828. type: string
  6829. hydra:
  6830. type: string
  6831. enum: ['http://www.w3.org/ns/hydra/core#']
  6832. required:
  6833. - '@vocab'
  6834. - hydra
  6835. additionalProperties: true
  6836. '@id':
  6837. readOnly: true
  6838. type: string
  6839. '@type':
  6840. readOnly: true
  6841. type: string
  6842. message:
  6843. type:
  6844. - string
  6845. - 'null'
  6846. owner:
  6847. readOnly: true
  6848. description: '?UserApi'
  6849. $ref: '#/components/schemas/User.jsonld'
  6850. taskIri:
  6851. type:
  6852. - string
  6853. - 'null'
  6854. format: iri-reference
  6855. example: 'https://example.com/'
  6856. contact:
  6857. readOnly: true
  6858. description: '?ContactApi'
  6859. $ref: '#/components/schemas/Contact.jsonld'
  6860. contactIri:
  6861. type:
  6862. - string
  6863. - 'null'
  6864. format: iri-reference
  6865. example: 'https://example.com/'
  6866. contactType:
  6867. type: string
  6868. enum:
  6869. - personal
  6870. - phone
  6871. - email
  6872. createdAt:
  6873. readOnly: true
  6874. type:
  6875. - string
  6876. - 'null'
  6877. format: date-time
  6878. User:
  6879. type: object
  6880. description: ''
  6881. deprecated: false
  6882. required:
  6883. - email
  6884. - firstName
  6885. - lastName
  6886. properties:
  6887. email:
  6888. format: email
  6889. externalDocs:
  6890. url: 'https://schema.org/email'
  6891. type:
  6892. - string
  6893. - 'null'
  6894. firstName:
  6895. type:
  6896. - string
  6897. - 'null'
  6898. lastName:
  6899. type:
  6900. - string
  6901. - 'null'
  6902. goals:
  6903. type:
  6904. - string
  6905. - 'null'
  6906. image:
  6907. type:
  6908. - string
  6909. - 'null'
  6910. format: iri-reference
  6911. example: 'https://example.com/'
  6912. imageUrl:
  6913. readOnly: true
  6914. type:
  6915. - string
  6916. - 'null'
  6917. fullName:
  6918. readOnly: true
  6919. type:
  6920. - string
  6921. - 'null'
  6922. password:
  6923. writeOnly: true
  6924. description: 'The plaintext password when being set or changed.'
  6925. type:
  6926. - string
  6927. - 'null'
  6928. active:
  6929. type: boolean
  6930. createdAt:
  6931. readOnly: true
  6932. type:
  6933. - string
  6934. - 'null'
  6935. format: date-time
  6936. User.jsonhal:
  6937. type: object
  6938. description: ''
  6939. deprecated: false
  6940. required:
  6941. - email
  6942. - firstName
  6943. - lastName
  6944. properties:
  6945. _links:
  6946. type: object
  6947. properties:
  6948. self:
  6949. type: object
  6950. properties:
  6951. href:
  6952. type: string
  6953. format: iri-reference
  6954. email:
  6955. format: email
  6956. externalDocs:
  6957. url: 'https://schema.org/email'
  6958. type:
  6959. - string
  6960. - 'null'
  6961. firstName:
  6962. type:
  6963. - string
  6964. - 'null'
  6965. lastName:
  6966. type:
  6967. - string
  6968. - 'null'
  6969. goals:
  6970. type:
  6971. - string
  6972. - 'null'
  6973. image:
  6974. type:
  6975. - string
  6976. - 'null'
  6977. format: iri-reference
  6978. example: 'https://example.com/'
  6979. imageUrl:
  6980. readOnly: true
  6981. type:
  6982. - string
  6983. - 'null'
  6984. fullName:
  6985. readOnly: true
  6986. type:
  6987. - string
  6988. - 'null'
  6989. password:
  6990. writeOnly: true
  6991. description: 'The plaintext password when being set or changed.'
  6992. type:
  6993. - string
  6994. - 'null'
  6995. active:
  6996. type: boolean
  6997. createdAt:
  6998. readOnly: true
  6999. type:
  7000. - string
  7001. - 'null'
  7002. format: date-time
  7003. User.jsonld:
  7004. type: object
  7005. description: ''
  7006. deprecated: false
  7007. required:
  7008. - email
  7009. - firstName
  7010. - lastName
  7011. properties:
  7012. '@context':
  7013. readOnly: true
  7014. oneOf:
  7015. -
  7016. type: string
  7017. -
  7018. type: object
  7019. properties:
  7020. '@vocab':
  7021. type: string
  7022. hydra:
  7023. type: string
  7024. enum: ['http://www.w3.org/ns/hydra/core#']
  7025. required:
  7026. - '@vocab'
  7027. - hydra
  7028. additionalProperties: true
  7029. '@id':
  7030. readOnly: true
  7031. type: string
  7032. '@type':
  7033. readOnly: true
  7034. type: string
  7035. email:
  7036. format: email
  7037. externalDocs:
  7038. url: 'https://schema.org/email'
  7039. type:
  7040. - string
  7041. - 'null'
  7042. firstName:
  7043. type:
  7044. - string
  7045. - 'null'
  7046. lastName:
  7047. type:
  7048. - string
  7049. - 'null'
  7050. goals:
  7051. type:
  7052. - string
  7053. - 'null'
  7054. image:
  7055. type:
  7056. - string
  7057. - 'null'
  7058. format: iri-reference
  7059. example: 'https://example.com/'
  7060. imageUrl:
  7061. readOnly: true
  7062. type:
  7063. - string
  7064. - 'null'
  7065. fullName:
  7066. readOnly: true
  7067. type:
  7068. - string
  7069. - 'null'
  7070. password:
  7071. writeOnly: true
  7072. description: 'The plaintext password when being set or changed.'
  7073. type:
  7074. - string
  7075. - 'null'
  7076. active:
  7077. type: boolean
  7078. createdAt:
  7079. readOnly: true
  7080. type:
  7081. - string
  7082. - 'null'
  7083. format: date-time
  7084. UserProduct:
  7085. type: object
  7086. description: ''
  7087. deprecated: false
  7088. properties:
  7089. user:
  7090. readOnly: true
  7091. description: '?UserApi'
  7092. $ref: '#/components/schemas/User'
  7093. product:
  7094. readOnly: true
  7095. description: '?ProductApi'
  7096. $ref: '#/components/schemas/Product'
  7097. productIri:
  7098. type:
  7099. - string
  7100. - 'null'
  7101. format: iri-reference
  7102. example: 'https://example.com/'
  7103. createdAt:
  7104. readOnly: true
  7105. type:
  7106. - string
  7107. - 'null'
  7108. format: date-time
  7109. owner:
  7110. readOnly: true
  7111. type:
  7112. - string
  7113. - 'null'
  7114. format: iri-reference
  7115. example: 'https://example.com/'
  7116. required:
  7117. - productIri
  7118. UserProduct.jsonhal:
  7119. type: object
  7120. description: ''
  7121. deprecated: false
  7122. properties:
  7123. _links:
  7124. type: object
  7125. properties:
  7126. self:
  7127. type: object
  7128. properties:
  7129. href:
  7130. type: string
  7131. format: iri-reference
  7132. user:
  7133. readOnly: true
  7134. description: '?UserApi'
  7135. $ref: '#/components/schemas/User.jsonhal'
  7136. product:
  7137. readOnly: true
  7138. description: '?ProductApi'
  7139. $ref: '#/components/schemas/Product.jsonhal'
  7140. productIri:
  7141. type:
  7142. - string
  7143. - 'null'
  7144. format: iri-reference
  7145. example: 'https://example.com/'
  7146. createdAt:
  7147. readOnly: true
  7148. type:
  7149. - string
  7150. - 'null'
  7151. format: date-time
  7152. owner:
  7153. readOnly: true
  7154. type:
  7155. - string
  7156. - 'null'
  7157. format: iri-reference
  7158. example: 'https://example.com/'
  7159. required:
  7160. - productIri
  7161. UserProduct.jsonld:
  7162. type: object
  7163. description: ''
  7164. deprecated: false
  7165. properties:
  7166. '@context':
  7167. readOnly: true
  7168. oneOf:
  7169. -
  7170. type: string
  7171. -
  7172. type: object
  7173. properties:
  7174. '@vocab':
  7175. type: string
  7176. hydra:
  7177. type: string
  7178. enum: ['http://www.w3.org/ns/hydra/core#']
  7179. required:
  7180. - '@vocab'
  7181. - hydra
  7182. additionalProperties: true
  7183. '@id':
  7184. readOnly: true
  7185. type: string
  7186. '@type':
  7187. readOnly: true
  7188. type: string
  7189. user:
  7190. readOnly: true
  7191. description: '?UserApi'
  7192. $ref: '#/components/schemas/User.jsonld'
  7193. product:
  7194. readOnly: true
  7195. description: '?ProductApi'
  7196. $ref: '#/components/schemas/Product.jsonld'
  7197. productIri:
  7198. type:
  7199. - string
  7200. - 'null'
  7201. format: iri-reference
  7202. example: 'https://example.com/'
  7203. createdAt:
  7204. readOnly: true
  7205. type:
  7206. - string
  7207. - 'null'
  7208. format: date-time
  7209. owner:
  7210. readOnly: true
  7211. type:
  7212. - string
  7213. - 'null'
  7214. format: iri-reference
  7215. example: 'https://example.com/'
  7216. required:
  7217. - productIri
  7218. responses: { }
  7219. parameters: { }
  7220. examples: { }
  7221. requestBodies: { }
  7222. headers: { }
  7223. securitySchemes:
  7224. JWT:
  7225. type: http
  7226. scheme: bearer
  7227. bearerFormat: JWT
  7228. security:
  7229. -
  7230. JWT: []
  7231. tags: []