Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 

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