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.
 
 
 
 

7099 linhas
208 KiB

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