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.
 
 
 

7263 linhas
212 KiB

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