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.
 
 
 

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