You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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