25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.
 
 
 
 

7375 satır
211 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. type:
  4051. - string
  4052. - 'null'
  4053. format: iri-reference
  4054. example: 'https://example.com/'
  4055. ownerName:
  4056. readOnly: true
  4057. type:
  4058. - string
  4059. - 'null'
  4060. post:
  4061. type:
  4062. - string
  4063. - 'null'
  4064. format: iri-reference
  4065. example: 'https://example.com/'
  4066. createdAt:
  4067. readOnly: true
  4068. type:
  4069. - string
  4070. - 'null'
  4071. format: date-time
  4072. Comment.jsonhal:
  4073. type: object
  4074. description: ''
  4075. deprecated: false
  4076. required:
  4077. - message
  4078. properties:
  4079. _links:
  4080. type: object
  4081. properties:
  4082. self:
  4083. type: object
  4084. properties:
  4085. href:
  4086. type: string
  4087. format: iri-reference
  4088. message:
  4089. type:
  4090. - string
  4091. - 'null'
  4092. owner:
  4093. readOnly: true
  4094. type:
  4095. - string
  4096. - 'null'
  4097. format: iri-reference
  4098. example: 'https://example.com/'
  4099. ownerName:
  4100. readOnly: true
  4101. type:
  4102. - string
  4103. - 'null'
  4104. post:
  4105. type:
  4106. - string
  4107. - 'null'
  4108. format: iri-reference
  4109. example: 'https://example.com/'
  4110. createdAt:
  4111. readOnly: true
  4112. type:
  4113. - string
  4114. - 'null'
  4115. format: date-time
  4116. Comment.jsonld:
  4117. type: object
  4118. description: ''
  4119. deprecated: false
  4120. required:
  4121. - message
  4122. properties:
  4123. '@context':
  4124. readOnly: true
  4125. oneOf:
  4126. -
  4127. type: string
  4128. -
  4129. type: object
  4130. properties:
  4131. '@vocab':
  4132. type: string
  4133. hydra:
  4134. type: string
  4135. enum: ['http://www.w3.org/ns/hydra/core#']
  4136. required:
  4137. - '@vocab'
  4138. - hydra
  4139. additionalProperties: true
  4140. '@id':
  4141. readOnly: true
  4142. type: string
  4143. '@type':
  4144. readOnly: true
  4145. type: string
  4146. message:
  4147. type:
  4148. - string
  4149. - 'null'
  4150. owner:
  4151. readOnly: true
  4152. type:
  4153. - string
  4154. - 'null'
  4155. format: iri-reference
  4156. example: 'https://example.com/'
  4157. ownerName:
  4158. readOnly: true
  4159. type:
  4160. - string
  4161. - 'null'
  4162. post:
  4163. type:
  4164. - string
  4165. - 'null'
  4166. format: iri-reference
  4167. example: 'https://example.com/'
  4168. createdAt:
  4169. readOnly: true
  4170. type:
  4171. - string
  4172. - 'null'
  4173. format: date-time
  4174. Contact:
  4175. type: object
  4176. description: ''
  4177. deprecated: false
  4178. required:
  4179. - firstName
  4180. - lastName
  4181. - partner
  4182. properties:
  4183. firstName:
  4184. type:
  4185. - string
  4186. - 'null'
  4187. lastName:
  4188. type:
  4189. - string
  4190. - 'null'
  4191. partner:
  4192. type:
  4193. - string
  4194. - 'null'
  4195. format: iri-reference
  4196. example: 'https://example.com/'
  4197. birthday:
  4198. type:
  4199. - string
  4200. - 'null'
  4201. format: date-time
  4202. image:
  4203. type:
  4204. - string
  4205. - 'null'
  4206. format: iri-reference
  4207. example: 'https://example.com/'
  4208. imageUrl:
  4209. readOnly: true
  4210. type:
  4211. - string
  4212. - 'null'
  4213. position:
  4214. type:
  4215. - string
  4216. - 'null'
  4217. phone:
  4218. type:
  4219. - string
  4220. - 'null'
  4221. email:
  4222. format: email
  4223. externalDocs:
  4224. url: 'https://schema.org/email'
  4225. type:
  4226. - string
  4227. - 'null'
  4228. posts:
  4229. readOnly: true
  4230. type: array
  4231. items:
  4232. type: string
  4233. format: iri-reference
  4234. example: 'https://example.com/'
  4235. createdBy:
  4236. readOnly: true
  4237. type:
  4238. - string
  4239. - 'null'
  4240. format: iri-reference
  4241. example: 'https://example.com/'
  4242. createdByName:
  4243. readOnly: true
  4244. type:
  4245. - string
  4246. - 'null'
  4247. createdAt:
  4248. readOnly: true
  4249. type:
  4250. - string
  4251. - 'null'
  4252. format: date-time
  4253. Contact.jsonhal:
  4254. type: object
  4255. description: ''
  4256. deprecated: false
  4257. required:
  4258. - firstName
  4259. - lastName
  4260. - partner
  4261. properties:
  4262. _links:
  4263. type: object
  4264. properties:
  4265. self:
  4266. type: object
  4267. properties:
  4268. href:
  4269. type: string
  4270. format: iri-reference
  4271. firstName:
  4272. type:
  4273. - string
  4274. - 'null'
  4275. lastName:
  4276. type:
  4277. - string
  4278. - 'null'
  4279. partner:
  4280. type:
  4281. - string
  4282. - 'null'
  4283. format: iri-reference
  4284. example: 'https://example.com/'
  4285. birthday:
  4286. type:
  4287. - string
  4288. - 'null'
  4289. format: date-time
  4290. image:
  4291. type:
  4292. - string
  4293. - 'null'
  4294. format: iri-reference
  4295. example: 'https://example.com/'
  4296. imageUrl:
  4297. readOnly: true
  4298. type:
  4299. - string
  4300. - 'null'
  4301. position:
  4302. type:
  4303. - string
  4304. - 'null'
  4305. phone:
  4306. type:
  4307. - string
  4308. - 'null'
  4309. email:
  4310. format: email
  4311. externalDocs:
  4312. url: 'https://schema.org/email'
  4313. type:
  4314. - string
  4315. - 'null'
  4316. posts:
  4317. readOnly: true
  4318. type: array
  4319. items:
  4320. type: string
  4321. format: iri-reference
  4322. example: 'https://example.com/'
  4323. createdBy:
  4324. readOnly: true
  4325. type:
  4326. - string
  4327. - 'null'
  4328. format: iri-reference
  4329. example: 'https://example.com/'
  4330. createdByName:
  4331. readOnly: true
  4332. type:
  4333. - string
  4334. - 'null'
  4335. createdAt:
  4336. readOnly: true
  4337. type:
  4338. - string
  4339. - 'null'
  4340. format: date-time
  4341. Contact.jsonld:
  4342. type: object
  4343. description: ''
  4344. deprecated: false
  4345. required:
  4346. - firstName
  4347. - lastName
  4348. - partner
  4349. properties:
  4350. '@context':
  4351. readOnly: true
  4352. oneOf:
  4353. -
  4354. type: string
  4355. -
  4356. type: object
  4357. properties:
  4358. '@vocab':
  4359. type: string
  4360. hydra:
  4361. type: string
  4362. enum: ['http://www.w3.org/ns/hydra/core#']
  4363. required:
  4364. - '@vocab'
  4365. - hydra
  4366. additionalProperties: true
  4367. '@id':
  4368. readOnly: true
  4369. type: string
  4370. '@type':
  4371. readOnly: true
  4372. type: string
  4373. firstName:
  4374. type:
  4375. - string
  4376. - 'null'
  4377. lastName:
  4378. type:
  4379. - string
  4380. - 'null'
  4381. partner:
  4382. type:
  4383. - string
  4384. - 'null'
  4385. format: iri-reference
  4386. example: 'https://example.com/'
  4387. birthday:
  4388. type:
  4389. - string
  4390. - 'null'
  4391. format: date-time
  4392. image:
  4393. type:
  4394. - string
  4395. - 'null'
  4396. format: iri-reference
  4397. example: 'https://example.com/'
  4398. imageUrl:
  4399. readOnly: true
  4400. type:
  4401. - string
  4402. - 'null'
  4403. position:
  4404. type:
  4405. - string
  4406. - 'null'
  4407. phone:
  4408. type:
  4409. - string
  4410. - 'null'
  4411. email:
  4412. format: email
  4413. externalDocs:
  4414. url: 'https://schema.org/email'
  4415. type:
  4416. - string
  4417. - 'null'
  4418. posts:
  4419. readOnly: true
  4420. type: array
  4421. items:
  4422. type: string
  4423. format: iri-reference
  4424. example: 'https://example.com/'
  4425. createdBy:
  4426. readOnly: true
  4427. type:
  4428. - string
  4429. - 'null'
  4430. format: iri-reference
  4431. example: 'https://example.com/'
  4432. createdByName:
  4433. readOnly: true
  4434. type:
  4435. - string
  4436. - 'null'
  4437. createdAt:
  4438. readOnly: true
  4439. type:
  4440. - string
  4441. - 'null'
  4442. format: date-time
  4443. ContactPartnerProduct:
  4444. type: object
  4445. description: ''
  4446. deprecated: false
  4447. required:
  4448. - contact
  4449. - partnerProduct
  4450. - product
  4451. properties:
  4452. contact:
  4453. type:
  4454. - string
  4455. - 'null'
  4456. format: iri-reference
  4457. example: 'https://example.com/'
  4458. partnerProduct:
  4459. type:
  4460. - string
  4461. - 'null'
  4462. format: iri-reference
  4463. example: 'https://example.com/'
  4464. product:
  4465. description: '?ProductApi'
  4466. $ref: '#/components/schemas/Product'
  4467. productName:
  4468. readOnly: true
  4469. type:
  4470. - string
  4471. - 'null'
  4472. createdAt:
  4473. readOnly: true
  4474. type:
  4475. - string
  4476. - 'null'
  4477. format: date-time
  4478. ContactPartnerProduct.jsonhal:
  4479. type: object
  4480. description: ''
  4481. deprecated: false
  4482. required:
  4483. - contact
  4484. - partnerProduct
  4485. - product
  4486. properties:
  4487. _links:
  4488. type: object
  4489. properties:
  4490. self:
  4491. type: object
  4492. properties:
  4493. href:
  4494. type: string
  4495. format: iri-reference
  4496. contact:
  4497. type:
  4498. - string
  4499. - 'null'
  4500. format: iri-reference
  4501. example: 'https://example.com/'
  4502. partnerProduct:
  4503. type:
  4504. - string
  4505. - 'null'
  4506. format: iri-reference
  4507. example: 'https://example.com/'
  4508. product:
  4509. description: '?ProductApi'
  4510. $ref: '#/components/schemas/Product.jsonhal'
  4511. productName:
  4512. readOnly: true
  4513. type:
  4514. - string
  4515. - 'null'
  4516. createdAt:
  4517. readOnly: true
  4518. type:
  4519. - string
  4520. - 'null'
  4521. format: date-time
  4522. ContactPartnerProduct.jsonld:
  4523. type: object
  4524. description: ''
  4525. deprecated: false
  4526. required:
  4527. - contact
  4528. - partnerProduct
  4529. - product
  4530. properties:
  4531. '@context':
  4532. readOnly: true
  4533. oneOf:
  4534. -
  4535. type: string
  4536. -
  4537. type: object
  4538. properties:
  4539. '@vocab':
  4540. type: string
  4541. hydra:
  4542. type: string
  4543. enum: ['http://www.w3.org/ns/hydra/core#']
  4544. required:
  4545. - '@vocab'
  4546. - hydra
  4547. additionalProperties: true
  4548. '@id':
  4549. readOnly: true
  4550. type: string
  4551. '@type':
  4552. readOnly: true
  4553. type: string
  4554. contact:
  4555. type:
  4556. - string
  4557. - 'null'
  4558. format: iri-reference
  4559. example: 'https://example.com/'
  4560. partnerProduct:
  4561. type:
  4562. - string
  4563. - 'null'
  4564. format: iri-reference
  4565. example: 'https://example.com/'
  4566. product:
  4567. description: '?ProductApi'
  4568. $ref: '#/components/schemas/Product.jsonld'
  4569. productName:
  4570. readOnly: true
  4571. type:
  4572. - string
  4573. - 'null'
  4574. createdAt:
  4575. readOnly: true
  4576. type:
  4577. - string
  4578. - 'null'
  4579. format: date-time
  4580. Document:
  4581. type: object
  4582. description: ''
  4583. deprecated: false
  4584. required:
  4585. - name
  4586. - documentObject
  4587. properties:
  4588. name:
  4589. type:
  4590. - string
  4591. - 'null'
  4592. description:
  4593. type:
  4594. - string
  4595. - 'null'
  4596. partner:
  4597. type:
  4598. - string
  4599. - 'null'
  4600. format: iri-reference
  4601. example: 'https://example.com/'
  4602. partnerName:
  4603. readOnly: true
  4604. type:
  4605. - string
  4606. - 'null'
  4607. product:
  4608. type:
  4609. - string
  4610. - 'null'
  4611. format: iri-reference
  4612. example: 'https://example.com/'
  4613. productName:
  4614. readOnly: true
  4615. type:
  4616. - string
  4617. - 'null'
  4618. documentObject:
  4619. type:
  4620. - string
  4621. - 'null'
  4622. format: iri-reference
  4623. example: 'https://example.com/'
  4624. documentUrl:
  4625. readOnly: true
  4626. type:
  4627. - string
  4628. - 'null'
  4629. createdBy:
  4630. readOnly: true
  4631. type:
  4632. - string
  4633. - 'null'
  4634. format: iri-reference
  4635. example: 'https://example.com/'
  4636. createdByName:
  4637. readOnly: true
  4638. type:
  4639. - string
  4640. - 'null'
  4641. createdAt:
  4642. readOnly: true
  4643. type:
  4644. - string
  4645. - 'null'
  4646. format: date-time
  4647. Document.jsonhal:
  4648. type: object
  4649. description: ''
  4650. deprecated: false
  4651. required:
  4652. - name
  4653. - documentObject
  4654. properties:
  4655. _links:
  4656. type: object
  4657. properties:
  4658. self:
  4659. type: object
  4660. properties:
  4661. href:
  4662. type: string
  4663. format: iri-reference
  4664. name:
  4665. type:
  4666. - string
  4667. - 'null'
  4668. description:
  4669. type:
  4670. - string
  4671. - 'null'
  4672. partner:
  4673. type:
  4674. - string
  4675. - 'null'
  4676. format: iri-reference
  4677. example: 'https://example.com/'
  4678. partnerName:
  4679. readOnly: true
  4680. type:
  4681. - string
  4682. - 'null'
  4683. product:
  4684. type:
  4685. - string
  4686. - 'null'
  4687. format: iri-reference
  4688. example: 'https://example.com/'
  4689. productName:
  4690. readOnly: true
  4691. type:
  4692. - string
  4693. - 'null'
  4694. documentObject:
  4695. type:
  4696. - string
  4697. - 'null'
  4698. format: iri-reference
  4699. example: 'https://example.com/'
  4700. documentUrl:
  4701. readOnly: true
  4702. type:
  4703. - string
  4704. - 'null'
  4705. createdBy:
  4706. readOnly: true
  4707. type:
  4708. - string
  4709. - 'null'
  4710. format: iri-reference
  4711. example: 'https://example.com/'
  4712. createdByName:
  4713. readOnly: true
  4714. type:
  4715. - string
  4716. - 'null'
  4717. createdAt:
  4718. readOnly: true
  4719. type:
  4720. - string
  4721. - 'null'
  4722. format: date-time
  4723. Document.jsonld:
  4724. type: object
  4725. description: ''
  4726. deprecated: false
  4727. required:
  4728. - name
  4729. - documentObject
  4730. properties:
  4731. '@context':
  4732. readOnly: true
  4733. oneOf:
  4734. -
  4735. type: string
  4736. -
  4737. type: object
  4738. properties:
  4739. '@vocab':
  4740. type: string
  4741. hydra:
  4742. type: string
  4743. enum: ['http://www.w3.org/ns/hydra/core#']
  4744. required:
  4745. - '@vocab'
  4746. - hydra
  4747. additionalProperties: true
  4748. '@id':
  4749. readOnly: true
  4750. type: string
  4751. '@type':
  4752. readOnly: true
  4753. type: string
  4754. name:
  4755. type:
  4756. - string
  4757. - 'null'
  4758. description:
  4759. type:
  4760. - string
  4761. - 'null'
  4762. partner:
  4763. type:
  4764. - string
  4765. - 'null'
  4766. format: iri-reference
  4767. example: 'https://example.com/'
  4768. partnerName:
  4769. readOnly: true
  4770. type:
  4771. - string
  4772. - 'null'
  4773. product:
  4774. type:
  4775. - string
  4776. - 'null'
  4777. format: iri-reference
  4778. example: 'https://example.com/'
  4779. productName:
  4780. readOnly: true
  4781. type:
  4782. - string
  4783. - 'null'
  4784. documentObject:
  4785. type:
  4786. - string
  4787. - 'null'
  4788. format: iri-reference
  4789. example: 'https://example.com/'
  4790. documentUrl:
  4791. readOnly: true
  4792. type:
  4793. - string
  4794. - 'null'
  4795. createdBy:
  4796. readOnly: true
  4797. type:
  4798. - string
  4799. - 'null'
  4800. format: iri-reference
  4801. example: 'https://example.com/'
  4802. createdByName:
  4803. readOnly: true
  4804. type:
  4805. - string
  4806. - 'null'
  4807. createdAt:
  4808. readOnly: true
  4809. type:
  4810. - string
  4811. - 'null'
  4812. format: date-time
  4813. DocumentObject-document_object.read:
  4814. type: object
  4815. description: ''
  4816. deprecated: false
  4817. externalDocs:
  4818. url: 'https://schema.org/MediaObject'
  4819. properties:
  4820. contentUrl:
  4821. externalDocs:
  4822. url: 'https://schema.org/contentUrl'
  4823. type:
  4824. - string
  4825. - 'null'
  4826. DocumentObject.jsonhal-document_object.read:
  4827. type: object
  4828. description: ''
  4829. deprecated: false
  4830. externalDocs:
  4831. url: 'https://schema.org/MediaObject'
  4832. properties:
  4833. _links:
  4834. type: object
  4835. properties:
  4836. self:
  4837. type: object
  4838. properties:
  4839. href:
  4840. type: string
  4841. format: iri-reference
  4842. contentUrl:
  4843. externalDocs:
  4844. url: 'https://schema.org/contentUrl'
  4845. type:
  4846. - string
  4847. - 'null'
  4848. DocumentObject.jsonld-document_object.read:
  4849. type: object
  4850. description: ''
  4851. deprecated: false
  4852. externalDocs:
  4853. url: 'https://schema.org/MediaObject'
  4854. properties:
  4855. '@context':
  4856. readOnly: true
  4857. oneOf:
  4858. -
  4859. type: string
  4860. -
  4861. type: object
  4862. properties:
  4863. '@vocab':
  4864. type: string
  4865. hydra:
  4866. type: string
  4867. enum: ['http://www.w3.org/ns/hydra/core#']
  4868. required:
  4869. - '@vocab'
  4870. - hydra
  4871. additionalProperties: true
  4872. '@id':
  4873. readOnly: true
  4874. type: string
  4875. '@type':
  4876. readOnly: true
  4877. type: string
  4878. contentUrl:
  4879. externalDocs:
  4880. url: 'https://schema.org/contentUrl'
  4881. type:
  4882. - string
  4883. - 'null'
  4884. MediaObject-media_object.read:
  4885. type: object
  4886. description: ''
  4887. deprecated: false
  4888. externalDocs:
  4889. url: 'https://schema.org/MediaObject'
  4890. properties:
  4891. contentUrl:
  4892. externalDocs:
  4893. url: 'https://schema.org/contentUrl'
  4894. type:
  4895. - string
  4896. - 'null'
  4897. MediaObject.jsonhal-media_object.read:
  4898. type: object
  4899. description: ''
  4900. deprecated: false
  4901. externalDocs:
  4902. url: 'https://schema.org/MediaObject'
  4903. properties:
  4904. _links:
  4905. type: object
  4906. properties:
  4907. self:
  4908. type: object
  4909. properties:
  4910. href:
  4911. type: string
  4912. format: iri-reference
  4913. contentUrl:
  4914. externalDocs:
  4915. url: 'https://schema.org/contentUrl'
  4916. type:
  4917. - string
  4918. - 'null'
  4919. MediaObject.jsonld-media_object.read:
  4920. type: object
  4921. description: ''
  4922. deprecated: false
  4923. externalDocs:
  4924. url: 'https://schema.org/MediaObject'
  4925. properties:
  4926. '@context':
  4927. readOnly: true
  4928. oneOf:
  4929. -
  4930. type: string
  4931. -
  4932. type: object
  4933. properties:
  4934. '@vocab':
  4935. type: string
  4936. hydra:
  4937. type: string
  4938. enum: ['http://www.w3.org/ns/hydra/core#']
  4939. required:
  4940. - '@vocab'
  4941. - hydra
  4942. additionalProperties: true
  4943. '@id':
  4944. readOnly: true
  4945. type: string
  4946. '@type':
  4947. readOnly: true
  4948. type: string
  4949. contentUrl:
  4950. externalDocs:
  4951. url: 'https://schema.org/contentUrl'
  4952. type:
  4953. - string
  4954. - 'null'
  4955. Partner:
  4956. type: object
  4957. description: ''
  4958. deprecated: false
  4959. required:
  4960. - name
  4961. - partnerType
  4962. properties:
  4963. name:
  4964. type: string
  4965. partnerType:
  4966. type: string
  4967. enum:
  4968. - customer
  4969. - supplier
  4970. - service
  4971. description:
  4972. type:
  4973. - string
  4974. - 'null'
  4975. street:
  4976. type:
  4977. - string
  4978. - 'null'
  4979. streetNo:
  4980. type:
  4981. - string
  4982. - 'null'
  4983. zip:
  4984. type:
  4985. - string
  4986. - 'null'
  4987. city:
  4988. type:
  4989. - string
  4990. - 'null'
  4991. country:
  4992. type:
  4993. - string
  4994. - 'null'
  4995. website:
  4996. type:
  4997. - string
  4998. - 'null'
  4999. logo:
  5000. type:
  5001. - string
  5002. - 'null'
  5003. format: iri-reference
  5004. example: 'https://example.com/'
  5005. logoUrl:
  5006. readOnly: true
  5007. type:
  5008. - string
  5009. - 'null'
  5010. createdBy:
  5011. readOnly: true
  5012. type:
  5013. - string
  5014. - 'null'
  5015. format: iri-reference
  5016. example: 'https://example.com/'
  5017. createdByName:
  5018. readOnly: true
  5019. type:
  5020. - string
  5021. - 'null'
  5022. createdAt:
  5023. readOnly: true
  5024. type:
  5025. - string
  5026. - 'null'
  5027. format: date-time
  5028. posts:
  5029. readOnly: true
  5030. description: 'array<int, PostingApi>'
  5031. type: array
  5032. items:
  5033. type: string
  5034. contacts:
  5035. readOnly: true
  5036. type: array
  5037. items:
  5038. type: string
  5039. format: iri-reference
  5040. example: 'https://example.com/'
  5041. partnerProducts:
  5042. readOnly: true
  5043. type: array
  5044. items:
  5045. type: string
  5046. format: iri-reference
  5047. example: 'https://example.com/'
  5048. Partner.jsonhal:
  5049. type: object
  5050. description: ''
  5051. deprecated: false
  5052. required:
  5053. - name
  5054. - partnerType
  5055. properties:
  5056. _links:
  5057. type: object
  5058. properties:
  5059. self:
  5060. type: object
  5061. properties:
  5062. href:
  5063. type: string
  5064. format: iri-reference
  5065. name:
  5066. type: string
  5067. partnerType:
  5068. type: string
  5069. enum:
  5070. - customer
  5071. - supplier
  5072. - service
  5073. description:
  5074. type:
  5075. - string
  5076. - 'null'
  5077. street:
  5078. type:
  5079. - string
  5080. - 'null'
  5081. streetNo:
  5082. type:
  5083. - string
  5084. - 'null'
  5085. zip:
  5086. type:
  5087. - string
  5088. - 'null'
  5089. city:
  5090. type:
  5091. - string
  5092. - 'null'
  5093. country:
  5094. type:
  5095. - string
  5096. - 'null'
  5097. website:
  5098. type:
  5099. - string
  5100. - 'null'
  5101. logo:
  5102. type:
  5103. - string
  5104. - 'null'
  5105. format: iri-reference
  5106. example: 'https://example.com/'
  5107. logoUrl:
  5108. readOnly: true
  5109. type:
  5110. - string
  5111. - 'null'
  5112. createdBy:
  5113. readOnly: true
  5114. type:
  5115. - string
  5116. - 'null'
  5117. format: iri-reference
  5118. example: 'https://example.com/'
  5119. createdByName:
  5120. readOnly: true
  5121. type:
  5122. - string
  5123. - 'null'
  5124. createdAt:
  5125. readOnly: true
  5126. type:
  5127. - string
  5128. - 'null'
  5129. format: date-time
  5130. posts:
  5131. readOnly: true
  5132. description: 'array<int, PostingApi>'
  5133. type: array
  5134. items:
  5135. type: string
  5136. contacts:
  5137. readOnly: true
  5138. type: array
  5139. items:
  5140. type: string
  5141. format: iri-reference
  5142. example: 'https://example.com/'
  5143. partnerProducts:
  5144. readOnly: true
  5145. type: array
  5146. items:
  5147. type: string
  5148. format: iri-reference
  5149. example: 'https://example.com/'
  5150. Partner.jsonld:
  5151. type: object
  5152. description: ''
  5153. deprecated: false
  5154. required:
  5155. - name
  5156. - partnerType
  5157. properties:
  5158. '@context':
  5159. readOnly: true
  5160. oneOf:
  5161. -
  5162. type: string
  5163. -
  5164. type: object
  5165. properties:
  5166. '@vocab':
  5167. type: string
  5168. hydra:
  5169. type: string
  5170. enum: ['http://www.w3.org/ns/hydra/core#']
  5171. required:
  5172. - '@vocab'
  5173. - hydra
  5174. additionalProperties: true
  5175. '@id':
  5176. readOnly: true
  5177. type: string
  5178. '@type':
  5179. readOnly: true
  5180. type: string
  5181. name:
  5182. type: string
  5183. partnerType:
  5184. type: string
  5185. enum:
  5186. - customer
  5187. - supplier
  5188. - service
  5189. description:
  5190. type:
  5191. - string
  5192. - 'null'
  5193. street:
  5194. type:
  5195. - string
  5196. - 'null'
  5197. streetNo:
  5198. type:
  5199. - string
  5200. - 'null'
  5201. zip:
  5202. type:
  5203. - string
  5204. - 'null'
  5205. city:
  5206. type:
  5207. - string
  5208. - 'null'
  5209. country:
  5210. type:
  5211. - string
  5212. - 'null'
  5213. website:
  5214. type:
  5215. - string
  5216. - 'null'
  5217. logo:
  5218. type:
  5219. - string
  5220. - 'null'
  5221. format: iri-reference
  5222. example: 'https://example.com/'
  5223. logoUrl:
  5224. readOnly: true
  5225. type:
  5226. - string
  5227. - 'null'
  5228. createdBy:
  5229. readOnly: true
  5230. type:
  5231. - string
  5232. - 'null'
  5233. format: iri-reference
  5234. example: 'https://example.com/'
  5235. createdByName:
  5236. readOnly: true
  5237. type:
  5238. - string
  5239. - 'null'
  5240. createdAt:
  5241. readOnly: true
  5242. type:
  5243. - string
  5244. - 'null'
  5245. format: date-time
  5246. posts:
  5247. readOnly: true
  5248. description: 'array<int, PostingApi>'
  5249. type: array
  5250. items:
  5251. type: string
  5252. contacts:
  5253. readOnly: true
  5254. type: array
  5255. items:
  5256. type: string
  5257. format: iri-reference
  5258. example: 'https://example.com/'
  5259. partnerProducts:
  5260. readOnly: true
  5261. type: array
  5262. items:
  5263. type: string
  5264. format: iri-reference
  5265. example: 'https://example.com/'
  5266. PartnerFollow:
  5267. type: object
  5268. description: ''
  5269. deprecated: false
  5270. properties:
  5271. user:
  5272. readOnly: true
  5273. type:
  5274. - string
  5275. - 'null'
  5276. format: iri-reference
  5277. example: 'https://example.com/'
  5278. userName:
  5279. readOnly: true
  5280. type:
  5281. - string
  5282. - 'null'
  5283. partner:
  5284. description: '?PartnerApi'
  5285. $ref: '#/components/schemas/Partner'
  5286. partnerName:
  5287. readOnly: true
  5288. type:
  5289. - string
  5290. - 'null'
  5291. createdAt:
  5292. readOnly: true
  5293. type:
  5294. - string
  5295. - 'null'
  5296. format: date-time
  5297. owner:
  5298. readOnly: true
  5299. type:
  5300. - string
  5301. - 'null'
  5302. format: iri-reference
  5303. example: 'https://example.com/'
  5304. required:
  5305. - partner
  5306. PartnerFollow.jsonhal:
  5307. type: object
  5308. description: ''
  5309. deprecated: false
  5310. properties:
  5311. _links:
  5312. type: object
  5313. properties:
  5314. self:
  5315. type: object
  5316. properties:
  5317. href:
  5318. type: string
  5319. format: iri-reference
  5320. user:
  5321. readOnly: true
  5322. type:
  5323. - string
  5324. - 'null'
  5325. format: iri-reference
  5326. example: 'https://example.com/'
  5327. userName:
  5328. readOnly: true
  5329. type:
  5330. - string
  5331. - 'null'
  5332. partner:
  5333. description: '?PartnerApi'
  5334. $ref: '#/components/schemas/Partner.jsonhal'
  5335. partnerName:
  5336. readOnly: true
  5337. type:
  5338. - string
  5339. - 'null'
  5340. createdAt:
  5341. readOnly: true
  5342. type:
  5343. - string
  5344. - 'null'
  5345. format: date-time
  5346. owner:
  5347. readOnly: true
  5348. type:
  5349. - string
  5350. - 'null'
  5351. format: iri-reference
  5352. example: 'https://example.com/'
  5353. required:
  5354. - partner
  5355. PartnerFollow.jsonld:
  5356. type: object
  5357. description: ''
  5358. deprecated: false
  5359. properties:
  5360. '@context':
  5361. readOnly: true
  5362. oneOf:
  5363. -
  5364. type: string
  5365. -
  5366. type: object
  5367. properties:
  5368. '@vocab':
  5369. type: string
  5370. hydra:
  5371. type: string
  5372. enum: ['http://www.w3.org/ns/hydra/core#']
  5373. required:
  5374. - '@vocab'
  5375. - hydra
  5376. additionalProperties: true
  5377. '@id':
  5378. readOnly: true
  5379. type: string
  5380. '@type':
  5381. readOnly: true
  5382. type: string
  5383. user:
  5384. readOnly: true
  5385. type:
  5386. - string
  5387. - 'null'
  5388. format: iri-reference
  5389. example: 'https://example.com/'
  5390. userName:
  5391. readOnly: true
  5392. type:
  5393. - string
  5394. - 'null'
  5395. partner:
  5396. description: '?PartnerApi'
  5397. $ref: '#/components/schemas/Partner.jsonld'
  5398. partnerName:
  5399. readOnly: true
  5400. type:
  5401. - string
  5402. - 'null'
  5403. createdAt:
  5404. readOnly: true
  5405. type:
  5406. - string
  5407. - 'null'
  5408. format: date-time
  5409. owner:
  5410. readOnly: true
  5411. type:
  5412. - string
  5413. - 'null'
  5414. format: iri-reference
  5415. example: 'https://example.com/'
  5416. required:
  5417. - partner
  5418. PartnerProduct:
  5419. type: object
  5420. description: ''
  5421. deprecated: false
  5422. required:
  5423. - partner
  5424. - product
  5425. properties:
  5426. partner:
  5427. description: '?PartnerApi'
  5428. $ref: '#/components/schemas/Partner'
  5429. partnerName:
  5430. readOnly: true
  5431. type:
  5432. - string
  5433. - 'null'
  5434. product:
  5435. description: '?ProductApi'
  5436. $ref: '#/components/schemas/Product'
  5437. productName:
  5438. readOnly: true
  5439. type:
  5440. - string
  5441. - 'null'
  5442. createdAt:
  5443. readOnly: true
  5444. type:
  5445. - string
  5446. - 'null'
  5447. format: date-time
  5448. PartnerProduct.jsonhal:
  5449. type: object
  5450. description: ''
  5451. deprecated: false
  5452. required:
  5453. - partner
  5454. - product
  5455. properties:
  5456. _links:
  5457. type: object
  5458. properties:
  5459. self:
  5460. type: object
  5461. properties:
  5462. href:
  5463. type: string
  5464. format: iri-reference
  5465. partner:
  5466. description: '?PartnerApi'
  5467. $ref: '#/components/schemas/Partner.jsonhal'
  5468. partnerName:
  5469. readOnly: true
  5470. type:
  5471. - string
  5472. - 'null'
  5473. product:
  5474. description: '?ProductApi'
  5475. $ref: '#/components/schemas/Product.jsonhal'
  5476. productName:
  5477. readOnly: true
  5478. type:
  5479. - string
  5480. - 'null'
  5481. createdAt:
  5482. readOnly: true
  5483. type:
  5484. - string
  5485. - 'null'
  5486. format: date-time
  5487. PartnerProduct.jsonld:
  5488. type: object
  5489. description: ''
  5490. deprecated: false
  5491. required:
  5492. - partner
  5493. - product
  5494. properties:
  5495. '@context':
  5496. readOnly: true
  5497. oneOf:
  5498. -
  5499. type: string
  5500. -
  5501. type: object
  5502. properties:
  5503. '@vocab':
  5504. type: string
  5505. hydra:
  5506. type: string
  5507. enum: ['http://www.w3.org/ns/hydra/core#']
  5508. required:
  5509. - '@vocab'
  5510. - hydra
  5511. additionalProperties: true
  5512. '@id':
  5513. readOnly: true
  5514. type: string
  5515. '@type':
  5516. readOnly: true
  5517. type: string
  5518. partner:
  5519. description: '?PartnerApi'
  5520. $ref: '#/components/schemas/Partner.jsonld'
  5521. partnerName:
  5522. readOnly: true
  5523. type:
  5524. - string
  5525. - 'null'
  5526. product:
  5527. description: '?ProductApi'
  5528. $ref: '#/components/schemas/Product.jsonld'
  5529. productName:
  5530. readOnly: true
  5531. type:
  5532. - string
  5533. - 'null'
  5534. createdAt:
  5535. readOnly: true
  5536. type:
  5537. - string
  5538. - 'null'
  5539. format: date-time
  5540. Post:
  5541. type: object
  5542. description: ''
  5543. deprecated: false
  5544. required:
  5545. - headline
  5546. - message
  5547. properties:
  5548. headline:
  5549. type:
  5550. - string
  5551. - 'null'
  5552. message:
  5553. type:
  5554. - string
  5555. - 'null'
  5556. owner:
  5557. readOnly: true
  5558. type:
  5559. - string
  5560. - 'null'
  5561. format: iri-reference
  5562. example: 'https://example.com/'
  5563. ownerName:
  5564. readOnly: true
  5565. type:
  5566. - string
  5567. - 'null'
  5568. partner:
  5569. type:
  5570. - string
  5571. - 'null'
  5572. format: iri-reference
  5573. example: 'https://example.com/'
  5574. partnerName:
  5575. readOnly: true
  5576. type:
  5577. - string
  5578. - 'null'
  5579. partnerType:
  5580. readOnly: true
  5581. type:
  5582. - string
  5583. - 'null'
  5584. enum:
  5585. - customer
  5586. - supplier
  5587. - service
  5588. - null
  5589. product:
  5590. type:
  5591. - string
  5592. - 'null'
  5593. format: iri-reference
  5594. example: 'https://example.com/'
  5595. productName:
  5596. readOnly: true
  5597. type:
  5598. - string
  5599. - 'null'
  5600. contact:
  5601. type:
  5602. - string
  5603. - 'null'
  5604. format: iri-reference
  5605. example: 'https://example.com/'
  5606. contactName:
  5607. readOnly: true
  5608. type:
  5609. - string
  5610. - 'null'
  5611. sale:
  5612. type:
  5613. - string
  5614. - 'null'
  5615. format: iri-reference
  5616. example: 'https://example.com/'
  5617. comments:
  5618. readOnly: true
  5619. description: 'array<int, CommentApi>'
  5620. type: array
  5621. items:
  5622. $ref: '#/components/schemas/Comment'
  5623. createdAt:
  5624. readOnly: true
  5625. type:
  5626. - string
  5627. - 'null'
  5628. format: date-time
  5629. Post-posting.create:
  5630. type: object
  5631. description: ''
  5632. deprecated: false
  5633. required:
  5634. - headline
  5635. - message
  5636. properties:
  5637. headline:
  5638. type:
  5639. - string
  5640. - 'null'
  5641. message:
  5642. type:
  5643. - string
  5644. - 'null'
  5645. partner:
  5646. type:
  5647. - string
  5648. - 'null'
  5649. format: iri-reference
  5650. example: 'https://example.com/'
  5651. product:
  5652. type:
  5653. - string
  5654. - 'null'
  5655. format: iri-reference
  5656. example: 'https://example.com/'
  5657. contact:
  5658. type:
  5659. - string
  5660. - 'null'
  5661. format: iri-reference
  5662. example: 'https://example.com/'
  5663. sale:
  5664. type:
  5665. - string
  5666. - 'null'
  5667. format: iri-reference
  5668. example: 'https://example.com/'
  5669. Post-posting.patch:
  5670. type: object
  5671. description: ''
  5672. deprecated: false
  5673. required:
  5674. - headline
  5675. - message
  5676. properties:
  5677. headline:
  5678. type:
  5679. - string
  5680. - 'null'
  5681. message:
  5682. type:
  5683. - string
  5684. - 'null'
  5685. Post.jsonhal:
  5686. type: object
  5687. description: ''
  5688. deprecated: false
  5689. required:
  5690. - headline
  5691. - message
  5692. properties:
  5693. _links:
  5694. type: object
  5695. properties:
  5696. self:
  5697. type: object
  5698. properties:
  5699. href:
  5700. type: string
  5701. format: iri-reference
  5702. headline:
  5703. type:
  5704. - string
  5705. - 'null'
  5706. message:
  5707. type:
  5708. - string
  5709. - 'null'
  5710. owner:
  5711. readOnly: true
  5712. type:
  5713. - string
  5714. - 'null'
  5715. format: iri-reference
  5716. example: 'https://example.com/'
  5717. ownerName:
  5718. readOnly: true
  5719. type:
  5720. - string
  5721. - 'null'
  5722. partner:
  5723. type:
  5724. - string
  5725. - 'null'
  5726. format: iri-reference
  5727. example: 'https://example.com/'
  5728. partnerName:
  5729. readOnly: true
  5730. type:
  5731. - string
  5732. - 'null'
  5733. partnerType:
  5734. readOnly: true
  5735. type:
  5736. - string
  5737. - 'null'
  5738. enum:
  5739. - customer
  5740. - supplier
  5741. - service
  5742. - null
  5743. product:
  5744. type:
  5745. - string
  5746. - 'null'
  5747. format: iri-reference
  5748. example: 'https://example.com/'
  5749. productName:
  5750. readOnly: true
  5751. type:
  5752. - string
  5753. - 'null'
  5754. contact:
  5755. type:
  5756. - string
  5757. - 'null'
  5758. format: iri-reference
  5759. example: 'https://example.com/'
  5760. contactName:
  5761. readOnly: true
  5762. type:
  5763. - string
  5764. - 'null'
  5765. sale:
  5766. type:
  5767. - string
  5768. - 'null'
  5769. format: iri-reference
  5770. example: 'https://example.com/'
  5771. comments:
  5772. readOnly: true
  5773. description: 'array<int, CommentApi>'
  5774. type: array
  5775. items:
  5776. $ref: '#/components/schemas/Comment.jsonhal'
  5777. createdAt:
  5778. readOnly: true
  5779. type:
  5780. - string
  5781. - 'null'
  5782. format: date-time
  5783. Post.jsonhal-posting.create:
  5784. type: object
  5785. description: ''
  5786. deprecated: false
  5787. required:
  5788. - headline
  5789. - message
  5790. properties:
  5791. _links:
  5792. type: object
  5793. properties:
  5794. self:
  5795. type: object
  5796. properties:
  5797. href:
  5798. type: string
  5799. format: iri-reference
  5800. headline:
  5801. type:
  5802. - string
  5803. - 'null'
  5804. message:
  5805. type:
  5806. - string
  5807. - 'null'
  5808. partner:
  5809. type:
  5810. - string
  5811. - 'null'
  5812. format: iri-reference
  5813. example: 'https://example.com/'
  5814. product:
  5815. type:
  5816. - string
  5817. - 'null'
  5818. format: iri-reference
  5819. example: 'https://example.com/'
  5820. contact:
  5821. type:
  5822. - string
  5823. - 'null'
  5824. format: iri-reference
  5825. example: 'https://example.com/'
  5826. sale:
  5827. type:
  5828. - string
  5829. - 'null'
  5830. format: iri-reference
  5831. example: 'https://example.com/'
  5832. Post.jsonld:
  5833. type: object
  5834. description: ''
  5835. deprecated: false
  5836. required:
  5837. - headline
  5838. - message
  5839. properties:
  5840. '@context':
  5841. readOnly: true
  5842. oneOf:
  5843. -
  5844. type: string
  5845. -
  5846. type: object
  5847. properties:
  5848. '@vocab':
  5849. type: string
  5850. hydra:
  5851. type: string
  5852. enum: ['http://www.w3.org/ns/hydra/core#']
  5853. required:
  5854. - '@vocab'
  5855. - hydra
  5856. additionalProperties: true
  5857. '@id':
  5858. readOnly: true
  5859. type: string
  5860. '@type':
  5861. readOnly: true
  5862. type: string
  5863. headline:
  5864. type:
  5865. - string
  5866. - 'null'
  5867. message:
  5868. type:
  5869. - string
  5870. - 'null'
  5871. owner:
  5872. readOnly: true
  5873. type:
  5874. - string
  5875. - 'null'
  5876. format: iri-reference
  5877. example: 'https://example.com/'
  5878. ownerName:
  5879. readOnly: true
  5880. type:
  5881. - string
  5882. - 'null'
  5883. partner:
  5884. type:
  5885. - string
  5886. - 'null'
  5887. format: iri-reference
  5888. example: 'https://example.com/'
  5889. partnerName:
  5890. readOnly: true
  5891. type:
  5892. - string
  5893. - 'null'
  5894. partnerType:
  5895. readOnly: true
  5896. type:
  5897. - string
  5898. - 'null'
  5899. enum:
  5900. - customer
  5901. - supplier
  5902. - service
  5903. - null
  5904. product:
  5905. type:
  5906. - string
  5907. - 'null'
  5908. format: iri-reference
  5909. example: 'https://example.com/'
  5910. productName:
  5911. readOnly: true
  5912. type:
  5913. - string
  5914. - 'null'
  5915. contact:
  5916. type:
  5917. - string
  5918. - 'null'
  5919. format: iri-reference
  5920. example: 'https://example.com/'
  5921. contactName:
  5922. readOnly: true
  5923. type:
  5924. - string
  5925. - 'null'
  5926. sale:
  5927. type:
  5928. - string
  5929. - 'null'
  5930. format: iri-reference
  5931. example: 'https://example.com/'
  5932. comments:
  5933. readOnly: true
  5934. description: 'array<int, CommentApi>'
  5935. type: array
  5936. items:
  5937. $ref: '#/components/schemas/Comment.jsonld'
  5938. createdAt:
  5939. readOnly: true
  5940. type:
  5941. - string
  5942. - 'null'
  5943. format: date-time
  5944. Post.jsonld-posting.create:
  5945. type: object
  5946. description: ''
  5947. deprecated: false
  5948. required:
  5949. - headline
  5950. - message
  5951. properties:
  5952. headline:
  5953. type:
  5954. - string
  5955. - 'null'
  5956. message:
  5957. type:
  5958. - string
  5959. - 'null'
  5960. partner:
  5961. type:
  5962. - string
  5963. - 'null'
  5964. format: iri-reference
  5965. example: 'https://example.com/'
  5966. product:
  5967. type:
  5968. - string
  5969. - 'null'
  5970. format: iri-reference
  5971. example: 'https://example.com/'
  5972. contact:
  5973. type:
  5974. - string
  5975. - 'null'
  5976. format: iri-reference
  5977. example: 'https://example.com/'
  5978. sale:
  5979. type:
  5980. - string
  5981. - 'null'
  5982. format: iri-reference
  5983. example: 'https://example.com/'
  5984. Product:
  5985. type: object
  5986. description: ''
  5987. deprecated: false
  5988. required:
  5989. - name
  5990. properties:
  5991. name:
  5992. type: string
  5993. description:
  5994. type:
  5995. - string
  5996. - 'null'
  5997. image:
  5998. type:
  5999. - string
  6000. - 'null'
  6001. format: iri-reference
  6002. example: 'https://example.com/'
  6003. imageUrl:
  6004. readOnly: true
  6005. type:
  6006. - string
  6007. - 'null'
  6008. createdBy:
  6009. readOnly: true
  6010. type:
  6011. - string
  6012. - 'null'
  6013. format: iri-reference
  6014. example: 'https://example.com/'
  6015. createdByName:
  6016. readOnly: true
  6017. type:
  6018. - string
  6019. - 'null'
  6020. createdAt:
  6021. type:
  6022. - string
  6023. - 'null'
  6024. format: date-time
  6025. Product.jsonhal:
  6026. type: object
  6027. description: ''
  6028. deprecated: false
  6029. required:
  6030. - name
  6031. properties:
  6032. _links:
  6033. type: object
  6034. properties:
  6035. self:
  6036. type: object
  6037. properties:
  6038. href:
  6039. type: string
  6040. format: iri-reference
  6041. name:
  6042. type: string
  6043. description:
  6044. type:
  6045. - string
  6046. - 'null'
  6047. image:
  6048. type:
  6049. - string
  6050. - 'null'
  6051. format: iri-reference
  6052. example: 'https://example.com/'
  6053. imageUrl:
  6054. readOnly: true
  6055. type:
  6056. - string
  6057. - 'null'
  6058. createdBy:
  6059. readOnly: true
  6060. type:
  6061. - string
  6062. - 'null'
  6063. format: iri-reference
  6064. example: 'https://example.com/'
  6065. createdByName:
  6066. readOnly: true
  6067. type:
  6068. - string
  6069. - 'null'
  6070. createdAt:
  6071. type:
  6072. - string
  6073. - 'null'
  6074. format: date-time
  6075. Product.jsonld:
  6076. type: object
  6077. description: ''
  6078. deprecated: false
  6079. required:
  6080. - name
  6081. properties:
  6082. '@context':
  6083. readOnly: true
  6084. oneOf:
  6085. -
  6086. type: string
  6087. -
  6088. type: object
  6089. properties:
  6090. '@vocab':
  6091. type: string
  6092. hydra:
  6093. type: string
  6094. enum: ['http://www.w3.org/ns/hydra/core#']
  6095. required:
  6096. - '@vocab'
  6097. - hydra
  6098. additionalProperties: true
  6099. '@id':
  6100. readOnly: true
  6101. type: string
  6102. '@type':
  6103. readOnly: true
  6104. type: string
  6105. name:
  6106. type: string
  6107. description:
  6108. type:
  6109. - string
  6110. - 'null'
  6111. image:
  6112. type:
  6113. - string
  6114. - 'null'
  6115. format: iri-reference
  6116. example: 'https://example.com/'
  6117. imageUrl:
  6118. readOnly: true
  6119. type:
  6120. - string
  6121. - 'null'
  6122. createdBy:
  6123. readOnly: true
  6124. type:
  6125. - string
  6126. - 'null'
  6127. format: iri-reference
  6128. example: 'https://example.com/'
  6129. createdByName:
  6130. readOnly: true
  6131. type:
  6132. - string
  6133. - 'null'
  6134. createdAt:
  6135. type:
  6136. - string
  6137. - 'null'
  6138. format: date-time
  6139. Sale:
  6140. type: object
  6141. description: ''
  6142. deprecated: false
  6143. properties:
  6144. owner:
  6145. readOnly: true
  6146. type:
  6147. - string
  6148. - 'null'
  6149. format: iri-reference
  6150. example: 'https://example.com/'
  6151. ownerName:
  6152. readOnly: true
  6153. type:
  6154. - string
  6155. - 'null'
  6156. partner:
  6157. type:
  6158. - string
  6159. - 'null'
  6160. format: iri-reference
  6161. example: 'https://example.com/'
  6162. partnerType:
  6163. readOnly: true
  6164. type: string
  6165. enum:
  6166. - customer
  6167. - supplier
  6168. - service
  6169. partnerName:
  6170. readOnly: true
  6171. type:
  6172. - string
  6173. - 'null'
  6174. product:
  6175. type:
  6176. - string
  6177. - 'null'
  6178. format: iri-reference
  6179. example: 'https://example.com/'
  6180. productName:
  6181. readOnly: true
  6182. type:
  6183. - string
  6184. - 'null'
  6185. turnover:
  6186. type:
  6187. - integer
  6188. - 'null'
  6189. profit:
  6190. type:
  6191. - integer
  6192. - 'null'
  6193. quantity:
  6194. type:
  6195. - integer
  6196. - 'null'
  6197. comment:
  6198. type:
  6199. - string
  6200. - 'null'
  6201. createdAt:
  6202. readOnly: true
  6203. type:
  6204. - string
  6205. - 'null'
  6206. format: date-time
  6207. posts:
  6208. readOnly: true
  6209. description: 'array<int, PostingApi>'
  6210. type: array
  6211. items:
  6212. type: string
  6213. required:
  6214. - partner
  6215. - product
  6216. - turnover
  6217. - profit
  6218. - quantity
  6219. Sale.jsonhal:
  6220. type: object
  6221. description: ''
  6222. deprecated: false
  6223. properties:
  6224. _links:
  6225. type: object
  6226. properties:
  6227. self:
  6228. type: object
  6229. properties:
  6230. href:
  6231. type: string
  6232. format: iri-reference
  6233. owner:
  6234. readOnly: true
  6235. type:
  6236. - string
  6237. - 'null'
  6238. format: iri-reference
  6239. example: 'https://example.com/'
  6240. ownerName:
  6241. readOnly: true
  6242. type:
  6243. - string
  6244. - 'null'
  6245. partner:
  6246. type:
  6247. - string
  6248. - 'null'
  6249. format: iri-reference
  6250. example: 'https://example.com/'
  6251. partnerType:
  6252. readOnly: true
  6253. type: string
  6254. enum:
  6255. - customer
  6256. - supplier
  6257. - service
  6258. partnerName:
  6259. readOnly: true
  6260. type:
  6261. - string
  6262. - 'null'
  6263. product:
  6264. type:
  6265. - string
  6266. - 'null'
  6267. format: iri-reference
  6268. example: 'https://example.com/'
  6269. productName:
  6270. readOnly: true
  6271. type:
  6272. - string
  6273. - 'null'
  6274. turnover:
  6275. type:
  6276. - integer
  6277. - 'null'
  6278. profit:
  6279. type:
  6280. - integer
  6281. - 'null'
  6282. quantity:
  6283. type:
  6284. - integer
  6285. - 'null'
  6286. comment:
  6287. type:
  6288. - string
  6289. - 'null'
  6290. createdAt:
  6291. readOnly: true
  6292. type:
  6293. - string
  6294. - 'null'
  6295. format: date-time
  6296. posts:
  6297. readOnly: true
  6298. description: 'array<int, PostingApi>'
  6299. type: array
  6300. items:
  6301. type: string
  6302. required:
  6303. - partner
  6304. - product
  6305. - turnover
  6306. - profit
  6307. - quantity
  6308. Sale.jsonld:
  6309. type: object
  6310. description: ''
  6311. deprecated: false
  6312. properties:
  6313. '@context':
  6314. readOnly: true
  6315. oneOf:
  6316. -
  6317. type: string
  6318. -
  6319. type: object
  6320. properties:
  6321. '@vocab':
  6322. type: string
  6323. hydra:
  6324. type: string
  6325. enum: ['http://www.w3.org/ns/hydra/core#']
  6326. required:
  6327. - '@vocab'
  6328. - hydra
  6329. additionalProperties: true
  6330. '@id':
  6331. readOnly: true
  6332. type: string
  6333. '@type':
  6334. readOnly: true
  6335. type: string
  6336. owner:
  6337. readOnly: true
  6338. type:
  6339. - string
  6340. - 'null'
  6341. format: iri-reference
  6342. example: 'https://example.com/'
  6343. ownerName:
  6344. readOnly: true
  6345. type:
  6346. - string
  6347. - 'null'
  6348. partner:
  6349. type:
  6350. - string
  6351. - 'null'
  6352. format: iri-reference
  6353. example: 'https://example.com/'
  6354. partnerType:
  6355. readOnly: true
  6356. type: string
  6357. enum:
  6358. - customer
  6359. - supplier
  6360. - service
  6361. partnerName:
  6362. readOnly: true
  6363. type:
  6364. - string
  6365. - 'null'
  6366. product:
  6367. type:
  6368. - string
  6369. - 'null'
  6370. format: iri-reference
  6371. example: 'https://example.com/'
  6372. productName:
  6373. readOnly: true
  6374. type:
  6375. - string
  6376. - 'null'
  6377. turnover:
  6378. type:
  6379. - integer
  6380. - 'null'
  6381. profit:
  6382. type:
  6383. - integer
  6384. - 'null'
  6385. quantity:
  6386. type:
  6387. - integer
  6388. - 'null'
  6389. comment:
  6390. type:
  6391. - string
  6392. - 'null'
  6393. createdAt:
  6394. readOnly: true
  6395. type:
  6396. - string
  6397. - 'null'
  6398. format: date-time
  6399. posts:
  6400. readOnly: true
  6401. description: 'array<int, PostingApi>'
  6402. type: array
  6403. items:
  6404. type: string
  6405. required:
  6406. - partner
  6407. - product
  6408. - turnover
  6409. - profit
  6410. - quantity
  6411. SaleSummary:
  6412. type: object
  6413. description: ''
  6414. deprecated: false
  6415. properties:
  6416. userId:
  6417. type: integer
  6418. owner:
  6419. type:
  6420. - string
  6421. - 'null'
  6422. format: iri-reference
  6423. example: 'https://example.com/'
  6424. ownerName:
  6425. type:
  6426. - string
  6427. - 'null'
  6428. turnover:
  6429. type:
  6430. - integer
  6431. - 'null'
  6432. profit:
  6433. type:
  6434. - integer
  6435. - 'null'
  6436. SaleSummary.jsonhal:
  6437. type: object
  6438. description: ''
  6439. deprecated: false
  6440. properties:
  6441. _links:
  6442. type: object
  6443. properties:
  6444. self:
  6445. type: object
  6446. properties:
  6447. href:
  6448. type: string
  6449. format: iri-reference
  6450. userId:
  6451. type: integer
  6452. owner:
  6453. type:
  6454. - string
  6455. - 'null'
  6456. format: iri-reference
  6457. example: 'https://example.com/'
  6458. ownerName:
  6459. type:
  6460. - string
  6461. - 'null'
  6462. turnover:
  6463. type:
  6464. - integer
  6465. - 'null'
  6466. profit:
  6467. type:
  6468. - integer
  6469. - 'null'
  6470. SaleSummary.jsonld:
  6471. type: object
  6472. description: ''
  6473. deprecated: false
  6474. properties:
  6475. '@id':
  6476. readOnly: true
  6477. type: string
  6478. '@type':
  6479. readOnly: true
  6480. type: string
  6481. '@context':
  6482. readOnly: true
  6483. oneOf:
  6484. -
  6485. type: string
  6486. -
  6487. type: object
  6488. properties:
  6489. '@vocab':
  6490. type: string
  6491. hydra:
  6492. type: string
  6493. enum: ['http://www.w3.org/ns/hydra/core#']
  6494. required:
  6495. - '@vocab'
  6496. - hydra
  6497. additionalProperties: true
  6498. userId:
  6499. type: integer
  6500. owner:
  6501. type:
  6502. - string
  6503. - 'null'
  6504. format: iri-reference
  6505. example: 'https://example.com/'
  6506. ownerName:
  6507. type:
  6508. - string
  6509. - 'null'
  6510. turnover:
  6511. type:
  6512. - integer
  6513. - 'null'
  6514. profit:
  6515. type:
  6516. - integer
  6517. - 'null'
  6518. Task:
  6519. type: object
  6520. description: ''
  6521. deprecated: false
  6522. required:
  6523. - headline
  6524. - description
  6525. - assignedTo
  6526. - dueAt
  6527. - product
  6528. - prio
  6529. - completed
  6530. properties:
  6531. headline:
  6532. type:
  6533. - string
  6534. - 'null'
  6535. description:
  6536. type:
  6537. - string
  6538. - 'null'
  6539. createdBy:
  6540. readOnly: true
  6541. type:
  6542. - string
  6543. - 'null'
  6544. format: iri-reference
  6545. example: 'https://example.com/'
  6546. createdByName:
  6547. readOnly: true
  6548. type:
  6549. - string
  6550. - 'null'
  6551. assignedTo:
  6552. type:
  6553. - string
  6554. - 'null'
  6555. format: iri-reference
  6556. example: 'https://example.com/'
  6557. assignedToName:
  6558. readOnly: true
  6559. type:
  6560. - string
  6561. - 'null'
  6562. dueAt:
  6563. type:
  6564. - string
  6565. - 'null'
  6566. format: date-time
  6567. partner:
  6568. type:
  6569. - string
  6570. - 'null'
  6571. format: iri-reference
  6572. example: 'https://example.com/'
  6573. partnerName:
  6574. readOnly: true
  6575. type:
  6576. - string
  6577. - 'null'
  6578. partnerType:
  6579. readOnly: true
  6580. type:
  6581. - string
  6582. - 'null'
  6583. enum:
  6584. - customer
  6585. - supplier
  6586. - service
  6587. - null
  6588. product:
  6589. type:
  6590. - string
  6591. - 'null'
  6592. format: iri-reference
  6593. example: 'https://example.com/'
  6594. productName:
  6595. readOnly: true
  6596. type:
  6597. - string
  6598. - 'null'
  6599. contact:
  6600. type:
  6601. - string
  6602. - 'null'
  6603. format: iri-reference
  6604. example: 'https://example.com/'
  6605. contactName:
  6606. readOnly: true
  6607. type:
  6608. - string
  6609. - 'null'
  6610. prio:
  6611. type: string
  6612. enum:
  6613. - low
  6614. - medium
  6615. - high
  6616. completed:
  6617. type:
  6618. - boolean
  6619. - 'null'
  6620. taskNotes:
  6621. readOnly: true
  6622. description: 'array<int, TaskNoteApi>'
  6623. type: array
  6624. items:
  6625. $ref: '#/components/schemas/TaskNote'
  6626. createdAt:
  6627. readOnly: true
  6628. type:
  6629. - string
  6630. - 'null'
  6631. format: date-time
  6632. Task.jsonhal:
  6633. type: object
  6634. description: ''
  6635. deprecated: false
  6636. required:
  6637. - headline
  6638. - description
  6639. - assignedTo
  6640. - dueAt
  6641. - product
  6642. - prio
  6643. - completed
  6644. properties:
  6645. _links:
  6646. type: object
  6647. properties:
  6648. self:
  6649. type: object
  6650. properties:
  6651. href:
  6652. type: string
  6653. format: iri-reference
  6654. headline:
  6655. type:
  6656. - string
  6657. - 'null'
  6658. description:
  6659. type:
  6660. - string
  6661. - 'null'
  6662. createdBy:
  6663. readOnly: true
  6664. type:
  6665. - string
  6666. - 'null'
  6667. format: iri-reference
  6668. example: 'https://example.com/'
  6669. createdByName:
  6670. readOnly: true
  6671. type:
  6672. - string
  6673. - 'null'
  6674. assignedTo:
  6675. type:
  6676. - string
  6677. - 'null'
  6678. format: iri-reference
  6679. example: 'https://example.com/'
  6680. assignedToName:
  6681. readOnly: true
  6682. type:
  6683. - string
  6684. - 'null'
  6685. dueAt:
  6686. type:
  6687. - string
  6688. - 'null'
  6689. format: date-time
  6690. partner:
  6691. type:
  6692. - string
  6693. - 'null'
  6694. format: iri-reference
  6695. example: 'https://example.com/'
  6696. partnerName:
  6697. readOnly: true
  6698. type:
  6699. - string
  6700. - 'null'
  6701. partnerType:
  6702. readOnly: true
  6703. type:
  6704. - string
  6705. - 'null'
  6706. enum:
  6707. - customer
  6708. - supplier
  6709. - service
  6710. - null
  6711. product:
  6712. type:
  6713. - string
  6714. - 'null'
  6715. format: iri-reference
  6716. example: 'https://example.com/'
  6717. productName:
  6718. readOnly: true
  6719. type:
  6720. - string
  6721. - 'null'
  6722. contact:
  6723. type:
  6724. - string
  6725. - 'null'
  6726. format: iri-reference
  6727. example: 'https://example.com/'
  6728. contactName:
  6729. readOnly: true
  6730. type:
  6731. - string
  6732. - 'null'
  6733. prio:
  6734. type: string
  6735. enum:
  6736. - low
  6737. - medium
  6738. - high
  6739. completed:
  6740. type:
  6741. - boolean
  6742. - 'null'
  6743. taskNotes:
  6744. readOnly: true
  6745. description: 'array<int, TaskNoteApi>'
  6746. type: array
  6747. items:
  6748. $ref: '#/components/schemas/TaskNote.jsonhal'
  6749. createdAt:
  6750. readOnly: true
  6751. type:
  6752. - string
  6753. - 'null'
  6754. format: date-time
  6755. Task.jsonld:
  6756. type: object
  6757. description: ''
  6758. deprecated: false
  6759. required:
  6760. - headline
  6761. - description
  6762. - assignedTo
  6763. - dueAt
  6764. - product
  6765. - prio
  6766. - completed
  6767. properties:
  6768. '@context':
  6769. readOnly: true
  6770. oneOf:
  6771. -
  6772. type: string
  6773. -
  6774. type: object
  6775. properties:
  6776. '@vocab':
  6777. type: string
  6778. hydra:
  6779. type: string
  6780. enum: ['http://www.w3.org/ns/hydra/core#']
  6781. required:
  6782. - '@vocab'
  6783. - hydra
  6784. additionalProperties: true
  6785. '@id':
  6786. readOnly: true
  6787. type: string
  6788. '@type':
  6789. readOnly: true
  6790. type: string
  6791. headline:
  6792. type:
  6793. - string
  6794. - 'null'
  6795. description:
  6796. type:
  6797. - string
  6798. - 'null'
  6799. createdBy:
  6800. readOnly: true
  6801. type:
  6802. - string
  6803. - 'null'
  6804. format: iri-reference
  6805. example: 'https://example.com/'
  6806. createdByName:
  6807. readOnly: true
  6808. type:
  6809. - string
  6810. - 'null'
  6811. assignedTo:
  6812. type:
  6813. - string
  6814. - 'null'
  6815. format: iri-reference
  6816. example: 'https://example.com/'
  6817. assignedToName:
  6818. readOnly: true
  6819. type:
  6820. - string
  6821. - 'null'
  6822. dueAt:
  6823. type:
  6824. - string
  6825. - 'null'
  6826. format: date-time
  6827. partner:
  6828. type:
  6829. - string
  6830. - 'null'
  6831. format: iri-reference
  6832. example: 'https://example.com/'
  6833. partnerName:
  6834. readOnly: true
  6835. type:
  6836. - string
  6837. - 'null'
  6838. partnerType:
  6839. readOnly: true
  6840. type:
  6841. - string
  6842. - 'null'
  6843. enum:
  6844. - customer
  6845. - supplier
  6846. - service
  6847. - null
  6848. product:
  6849. type:
  6850. - string
  6851. - 'null'
  6852. format: iri-reference
  6853. example: 'https://example.com/'
  6854. productName:
  6855. readOnly: true
  6856. type:
  6857. - string
  6858. - 'null'
  6859. contact:
  6860. type:
  6861. - string
  6862. - 'null'
  6863. format: iri-reference
  6864. example: 'https://example.com/'
  6865. contactName:
  6866. readOnly: true
  6867. type:
  6868. - string
  6869. - 'null'
  6870. prio:
  6871. type: string
  6872. enum:
  6873. - low
  6874. - medium
  6875. - high
  6876. completed:
  6877. type:
  6878. - boolean
  6879. - 'null'
  6880. taskNotes:
  6881. readOnly: true
  6882. description: 'array<int, TaskNoteApi>'
  6883. type: array
  6884. items:
  6885. $ref: '#/components/schemas/TaskNote.jsonld'
  6886. createdAt:
  6887. readOnly: true
  6888. type:
  6889. - string
  6890. - 'null'
  6891. format: date-time
  6892. TaskNote:
  6893. type: object
  6894. description: ''
  6895. deprecated: false
  6896. required:
  6897. - message
  6898. properties:
  6899. message:
  6900. type:
  6901. - string
  6902. - 'null'
  6903. owner:
  6904. readOnly: true
  6905. type:
  6906. - string
  6907. - 'null'
  6908. format: iri-reference
  6909. example: 'https://example.com/'
  6910. ownerName:
  6911. readOnly: true
  6912. type:
  6913. - string
  6914. - 'null'
  6915. task:
  6916. type:
  6917. - string
  6918. - 'null'
  6919. format: iri-reference
  6920. example: 'https://example.com/'
  6921. createdAt:
  6922. readOnly: true
  6923. type:
  6924. - string
  6925. - 'null'
  6926. format: date-time
  6927. TaskNote.jsonhal:
  6928. type: object
  6929. description: ''
  6930. deprecated: false
  6931. required:
  6932. - message
  6933. properties:
  6934. _links:
  6935. type: object
  6936. properties:
  6937. self:
  6938. type: object
  6939. properties:
  6940. href:
  6941. type: string
  6942. format: iri-reference
  6943. message:
  6944. type:
  6945. - string
  6946. - 'null'
  6947. owner:
  6948. readOnly: true
  6949. type:
  6950. - string
  6951. - 'null'
  6952. format: iri-reference
  6953. example: 'https://example.com/'
  6954. ownerName:
  6955. readOnly: true
  6956. type:
  6957. - string
  6958. - 'null'
  6959. task:
  6960. type:
  6961. - string
  6962. - 'null'
  6963. format: iri-reference
  6964. example: 'https://example.com/'
  6965. createdAt:
  6966. readOnly: true
  6967. type:
  6968. - string
  6969. - 'null'
  6970. format: date-time
  6971. TaskNote.jsonld:
  6972. type: object
  6973. description: ''
  6974. deprecated: false
  6975. required:
  6976. - message
  6977. properties:
  6978. '@context':
  6979. readOnly: true
  6980. oneOf:
  6981. -
  6982. type: string
  6983. -
  6984. type: object
  6985. properties:
  6986. '@vocab':
  6987. type: string
  6988. hydra:
  6989. type: string
  6990. enum: ['http://www.w3.org/ns/hydra/core#']
  6991. required:
  6992. - '@vocab'
  6993. - hydra
  6994. additionalProperties: true
  6995. '@id':
  6996. readOnly: true
  6997. type: string
  6998. '@type':
  6999. readOnly: true
  7000. type: string
  7001. message:
  7002. type:
  7003. - string
  7004. - 'null'
  7005. owner:
  7006. readOnly: true
  7007. type:
  7008. - string
  7009. - 'null'
  7010. format: iri-reference
  7011. example: 'https://example.com/'
  7012. ownerName:
  7013. readOnly: true
  7014. type:
  7015. - string
  7016. - 'null'
  7017. task:
  7018. type:
  7019. - string
  7020. - 'null'
  7021. format: iri-reference
  7022. example: 'https://example.com/'
  7023. createdAt:
  7024. readOnly: true
  7025. type:
  7026. - string
  7027. - 'null'
  7028. format: date-time
  7029. User:
  7030. type: object
  7031. description: ''
  7032. deprecated: false
  7033. required:
  7034. - email
  7035. - firstName
  7036. - lastName
  7037. properties:
  7038. email:
  7039. format: email
  7040. externalDocs:
  7041. url: 'https://schema.org/email'
  7042. type:
  7043. - string
  7044. - 'null'
  7045. firstName:
  7046. type:
  7047. - string
  7048. - 'null'
  7049. lastName:
  7050. type:
  7051. - string
  7052. - 'null'
  7053. image:
  7054. type:
  7055. - string
  7056. - 'null'
  7057. format: iri-reference
  7058. example: 'https://example.com/'
  7059. imageUrl:
  7060. readOnly: true
  7061. type:
  7062. - string
  7063. - 'null'
  7064. password:
  7065. writeOnly: true
  7066. description: 'The plaintext password when being set or changed.'
  7067. type:
  7068. - string
  7069. - 'null'
  7070. active:
  7071. type: boolean
  7072. createdAt:
  7073. readOnly: true
  7074. type:
  7075. - string
  7076. - 'null'
  7077. format: date-time
  7078. User.jsonhal:
  7079. type: object
  7080. description: ''
  7081. deprecated: false
  7082. required:
  7083. - email
  7084. - firstName
  7085. - lastName
  7086. properties:
  7087. _links:
  7088. type: object
  7089. properties:
  7090. self:
  7091. type: object
  7092. properties:
  7093. href:
  7094. type: string
  7095. format: iri-reference
  7096. email:
  7097. format: email
  7098. externalDocs:
  7099. url: 'https://schema.org/email'
  7100. type:
  7101. - string
  7102. - 'null'
  7103. firstName:
  7104. type:
  7105. - string
  7106. - 'null'
  7107. lastName:
  7108. type:
  7109. - string
  7110. - 'null'
  7111. image:
  7112. type:
  7113. - string
  7114. - 'null'
  7115. format: iri-reference
  7116. example: 'https://example.com/'
  7117. imageUrl:
  7118. readOnly: true
  7119. type:
  7120. - string
  7121. - 'null'
  7122. password:
  7123. writeOnly: true
  7124. description: 'The plaintext password when being set or changed.'
  7125. type:
  7126. - string
  7127. - 'null'
  7128. active:
  7129. type: boolean
  7130. createdAt:
  7131. readOnly: true
  7132. type:
  7133. - string
  7134. - 'null'
  7135. format: date-time
  7136. User.jsonld:
  7137. type: object
  7138. description: ''
  7139. deprecated: false
  7140. required:
  7141. - email
  7142. - firstName
  7143. - lastName
  7144. properties:
  7145. '@context':
  7146. readOnly: true
  7147. oneOf:
  7148. -
  7149. type: string
  7150. -
  7151. type: object
  7152. properties:
  7153. '@vocab':
  7154. type: string
  7155. hydra:
  7156. type: string
  7157. enum: ['http://www.w3.org/ns/hydra/core#']
  7158. required:
  7159. - '@vocab'
  7160. - hydra
  7161. additionalProperties: true
  7162. '@id':
  7163. readOnly: true
  7164. type: string
  7165. '@type':
  7166. readOnly: true
  7167. type: string
  7168. email:
  7169. format: email
  7170. externalDocs:
  7171. url: 'https://schema.org/email'
  7172. type:
  7173. - string
  7174. - 'null'
  7175. firstName:
  7176. type:
  7177. - string
  7178. - 'null'
  7179. lastName:
  7180. type:
  7181. - string
  7182. - 'null'
  7183. image:
  7184. type:
  7185. - string
  7186. - 'null'
  7187. format: iri-reference
  7188. example: 'https://example.com/'
  7189. imageUrl:
  7190. readOnly: true
  7191. type:
  7192. - string
  7193. - 'null'
  7194. password:
  7195. writeOnly: true
  7196. description: 'The plaintext password when being set or changed.'
  7197. type:
  7198. - string
  7199. - 'null'
  7200. active:
  7201. type: boolean
  7202. createdAt:
  7203. readOnly: true
  7204. type:
  7205. - string
  7206. - 'null'
  7207. format: date-time
  7208. UserProduct:
  7209. type: object
  7210. description: ''
  7211. deprecated: false
  7212. properties:
  7213. user:
  7214. readOnly: true
  7215. type:
  7216. - string
  7217. - 'null'
  7218. format: iri-reference
  7219. example: 'https://example.com/'
  7220. userName:
  7221. readOnly: true
  7222. type:
  7223. - string
  7224. - 'null'
  7225. product:
  7226. description: '?ProductApi'
  7227. $ref: '#/components/schemas/Product'
  7228. productName:
  7229. readOnly: true
  7230. type:
  7231. - string
  7232. - 'null'
  7233. createdAt:
  7234. readOnly: true
  7235. type:
  7236. - string
  7237. - 'null'
  7238. format: date-time
  7239. owner:
  7240. readOnly: true
  7241. type:
  7242. - string
  7243. - 'null'
  7244. format: iri-reference
  7245. example: 'https://example.com/'
  7246. required:
  7247. - product
  7248. UserProduct.jsonhal:
  7249. type: object
  7250. description: ''
  7251. deprecated: false
  7252. properties:
  7253. _links:
  7254. type: object
  7255. properties:
  7256. self:
  7257. type: object
  7258. properties:
  7259. href:
  7260. type: string
  7261. format: iri-reference
  7262. user:
  7263. readOnly: true
  7264. type:
  7265. - string
  7266. - 'null'
  7267. format: iri-reference
  7268. example: 'https://example.com/'
  7269. userName:
  7270. readOnly: true
  7271. type:
  7272. - string
  7273. - 'null'
  7274. product:
  7275. description: '?ProductApi'
  7276. $ref: '#/components/schemas/Product.jsonhal'
  7277. productName:
  7278. readOnly: true
  7279. type:
  7280. - string
  7281. - 'null'
  7282. createdAt:
  7283. readOnly: true
  7284. type:
  7285. - string
  7286. - 'null'
  7287. format: date-time
  7288. owner:
  7289. readOnly: true
  7290. type:
  7291. - string
  7292. - 'null'
  7293. format: iri-reference
  7294. example: 'https://example.com/'
  7295. required:
  7296. - product
  7297. UserProduct.jsonld:
  7298. type: object
  7299. description: ''
  7300. deprecated: false
  7301. properties:
  7302. '@context':
  7303. readOnly: true
  7304. oneOf:
  7305. -
  7306. type: string
  7307. -
  7308. type: object
  7309. properties:
  7310. '@vocab':
  7311. type: string
  7312. hydra:
  7313. type: string
  7314. enum: ['http://www.w3.org/ns/hydra/core#']
  7315. required:
  7316. - '@vocab'
  7317. - hydra
  7318. additionalProperties: true
  7319. '@id':
  7320. readOnly: true
  7321. type: string
  7322. '@type':
  7323. readOnly: true
  7324. type: string
  7325. user:
  7326. readOnly: true
  7327. type:
  7328. - string
  7329. - 'null'
  7330. format: iri-reference
  7331. example: 'https://example.com/'
  7332. userName:
  7333. readOnly: true
  7334. type:
  7335. - string
  7336. - 'null'
  7337. product:
  7338. description: '?ProductApi'
  7339. $ref: '#/components/schemas/Product.jsonld'
  7340. productName:
  7341. readOnly: true
  7342. type:
  7343. - string
  7344. - 'null'
  7345. createdAt:
  7346. readOnly: true
  7347. type:
  7348. - string
  7349. - 'null'
  7350. format: date-time
  7351. owner:
  7352. readOnly: true
  7353. type:
  7354. - string
  7355. - 'null'
  7356. format: iri-reference
  7357. example: 'https://example.com/'
  7358. required:
  7359. - product
  7360. responses: { }
  7361. parameters: { }
  7362. examples: { }
  7363. requestBodies: { }
  7364. headers: { }
  7365. securitySchemes:
  7366. JWT:
  7367. type: http
  7368. scheme: bearer
  7369. bearerFormat: JWT
  7370. security:
  7371. -
  7372. JWT: []
  7373. tags: []