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

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