Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
 
 
 

4802 lignes
137 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. delete:
  169. operationId: api_comments_id_delete
  170. tags:
  171. - Comment
  172. responses:
  173. 204:
  174. description: 'Comment resource deleted'
  175. 404:
  176. description: 'Resource not found'
  177. summary: 'Removes the Comment resource.'
  178. description: 'Removes the Comment resource.'
  179. parameters:
  180. -
  181. name: id
  182. in: path
  183. description: 'CommentApi identifier'
  184. required: true
  185. deprecated: false
  186. allowEmptyValue: false
  187. schema:
  188. type: string
  189. style: simple
  190. explode: false
  191. allowReserved: false
  192. deprecated: false
  193. patch:
  194. operationId: api_comments_id_patch
  195. tags:
  196. - Comment
  197. responses:
  198. 200:
  199. description: 'Comment resource updated'
  200. content:
  201. application/ld+json:
  202. schema:
  203. $ref: '#/components/schemas/Comment.jsonld'
  204. application/json:
  205. schema:
  206. $ref: '#/components/schemas/Comment'
  207. text/html:
  208. schema:
  209. $ref: '#/components/schemas/Comment'
  210. application/hal+json:
  211. schema:
  212. $ref: '#/components/schemas/Comment.jsonhal'
  213. links: { }
  214. 400:
  215. description: 'Invalid input'
  216. 422:
  217. description: 'Unprocessable entity'
  218. 404:
  219. description: 'Resource not found'
  220. summary: 'Updates the Comment resource.'
  221. description: 'Updates the Comment resource.'
  222. parameters:
  223. -
  224. name: id
  225. in: path
  226. description: 'CommentApi identifier'
  227. required: true
  228. deprecated: false
  229. allowEmptyValue: false
  230. schema:
  231. type: string
  232. style: simple
  233. explode: false
  234. allowReserved: false
  235. requestBody:
  236. description: 'The updated Comment resource'
  237. content:
  238. application/merge-patch+json:
  239. schema:
  240. $ref: '#/components/schemas/Comment'
  241. required: true
  242. deprecated: false
  243. parameters: []
  244. /api/contacts:
  245. get:
  246. operationId: api_contacts_get_collection
  247. tags:
  248. - Contact
  249. responses:
  250. 200:
  251. description: 'Contact collection'
  252. content:
  253. application/ld+json:
  254. schema:
  255. type: object
  256. properties:
  257. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.jsonld' } }
  258. 'hydra:totalItems': { type: integer, minimum: 0 }
  259. '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 } }
  260. '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 } } } } } }
  261. required:
  262. - 'hydra:member'
  263. application/json:
  264. schema:
  265. type: array
  266. items:
  267. $ref: '#/components/schemas/Contact'
  268. text/html:
  269. schema:
  270. type: array
  271. items:
  272. $ref: '#/components/schemas/Contact'
  273. application/hal+json:
  274. schema:
  275. type: object
  276. properties:
  277. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.jsonhal' } }
  278. totalItems: { type: integer, minimum: 0 }
  279. itemsPerPage: { type: integer, minimum: 0 }
  280. _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 } } } } }
  281. required:
  282. - _links
  283. - _embedded
  284. summary: 'Retrieves the collection of Contact resources.'
  285. description: 'Retrieves the collection of Contact resources.'
  286. parameters:
  287. -
  288. name: page
  289. in: query
  290. description: 'The collection page number'
  291. required: false
  292. deprecated: false
  293. allowEmptyValue: true
  294. schema:
  295. type: integer
  296. default: 1
  297. style: form
  298. explode: false
  299. allowReserved: false
  300. -
  301. name: itemsPerPage
  302. in: query
  303. description: 'The number of items per page'
  304. required: false
  305. deprecated: false
  306. allowEmptyValue: true
  307. schema:
  308. type: integer
  309. default: 10
  310. minimum: 0
  311. maximum: 50
  312. style: form
  313. explode: false
  314. allowReserved: false
  315. -
  316. name: partner
  317. in: query
  318. description: ''
  319. required: false
  320. deprecated: false
  321. allowEmptyValue: true
  322. schema:
  323. type: string
  324. style: form
  325. explode: false
  326. allowReserved: false
  327. -
  328. name: 'partner[]'
  329. in: query
  330. description: ''
  331. required: false
  332. deprecated: false
  333. allowEmptyValue: true
  334. schema:
  335. type: array
  336. items:
  337. type: string
  338. style: form
  339. explode: true
  340. allowReserved: false
  341. deprecated: false
  342. post:
  343. operationId: api_contacts_post
  344. tags:
  345. - Contact
  346. responses:
  347. 201:
  348. description: 'Contact resource created'
  349. content:
  350. application/ld+json:
  351. schema:
  352. $ref: '#/components/schemas/Contact.jsonld'
  353. application/json:
  354. schema:
  355. $ref: '#/components/schemas/Contact'
  356. text/html:
  357. schema:
  358. $ref: '#/components/schemas/Contact'
  359. application/hal+json:
  360. schema:
  361. $ref: '#/components/schemas/Contact.jsonhal'
  362. links: { }
  363. 400:
  364. description: 'Invalid input'
  365. 422:
  366. description: 'Unprocessable entity'
  367. summary: 'Creates a Contact resource.'
  368. description: 'Creates a Contact resource.'
  369. parameters: []
  370. requestBody:
  371. description: 'The new Contact resource'
  372. content:
  373. application/ld+json:
  374. schema:
  375. $ref: '#/components/schemas/Contact.jsonld'
  376. application/json:
  377. schema:
  378. $ref: '#/components/schemas/Contact'
  379. text/html:
  380. schema:
  381. $ref: '#/components/schemas/Contact'
  382. application/hal+json:
  383. schema:
  384. $ref: '#/components/schemas/Contact.jsonhal'
  385. required: true
  386. deprecated: false
  387. parameters: []
  388. '/api/contacts/{id}':
  389. get:
  390. operationId: api_contacts_id_get
  391. tags:
  392. - Contact
  393. responses:
  394. 200:
  395. description: 'Contact resource'
  396. content:
  397. application/ld+json:
  398. schema:
  399. $ref: '#/components/schemas/Contact.jsonld'
  400. application/json:
  401. schema:
  402. $ref: '#/components/schemas/Contact'
  403. text/html:
  404. schema:
  405. $ref: '#/components/schemas/Contact'
  406. application/hal+json:
  407. schema:
  408. $ref: '#/components/schemas/Contact.jsonhal'
  409. 404:
  410. description: 'Resource not found'
  411. summary: 'Retrieves a Contact resource.'
  412. description: 'Retrieves a Contact resource.'
  413. parameters:
  414. -
  415. name: id
  416. in: path
  417. description: 'ContactApi 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. delete:
  428. operationId: api_contacts_id_delete
  429. tags:
  430. - Contact
  431. responses:
  432. 204:
  433. description: 'Contact resource deleted'
  434. 404:
  435. description: 'Resource not found'
  436. summary: 'Removes the Contact resource.'
  437. description: 'Removes the Contact resource.'
  438. parameters:
  439. -
  440. name: id
  441. in: path
  442. description: 'ContactApi identifier'
  443. required: true
  444. deprecated: false
  445. allowEmptyValue: false
  446. schema:
  447. type: string
  448. style: simple
  449. explode: false
  450. allowReserved: false
  451. deprecated: false
  452. patch:
  453. operationId: api_contacts_id_patch
  454. tags:
  455. - Contact
  456. responses:
  457. 200:
  458. description: 'Contact resource updated'
  459. content:
  460. application/ld+json:
  461. schema:
  462. $ref: '#/components/schemas/Contact.jsonld'
  463. application/json:
  464. schema:
  465. $ref: '#/components/schemas/Contact'
  466. text/html:
  467. schema:
  468. $ref: '#/components/schemas/Contact'
  469. application/hal+json:
  470. schema:
  471. $ref: '#/components/schemas/Contact.jsonhal'
  472. links: { }
  473. 400:
  474. description: 'Invalid input'
  475. 422:
  476. description: 'Unprocessable entity'
  477. 404:
  478. description: 'Resource not found'
  479. summary: 'Updates the Contact resource.'
  480. description: 'Updates the Contact resource.'
  481. parameters:
  482. -
  483. name: id
  484. in: path
  485. description: 'ContactApi identifier'
  486. required: true
  487. deprecated: false
  488. allowEmptyValue: false
  489. schema:
  490. type: string
  491. style: simple
  492. explode: false
  493. allowReserved: false
  494. requestBody:
  495. description: 'The updated Contact resource'
  496. content:
  497. application/merge-patch+json:
  498. schema:
  499. $ref: '#/components/schemas/Contact'
  500. required: true
  501. deprecated: false
  502. parameters: []
  503. /api/medias:
  504. get:
  505. operationId: api_medias_get_collection
  506. tags:
  507. - Media
  508. responses:
  509. 200:
  510. description: 'Media collection'
  511. content:
  512. application/ld+json:
  513. schema:
  514. type: object
  515. properties:
  516. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Media.jsonld-media_object.read' } }
  517. 'hydra:totalItems': { type: integer, minimum: 0 }
  518. '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 } }
  519. '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 } } } } } }
  520. required:
  521. - 'hydra:member'
  522. application/json:
  523. schema:
  524. type: array
  525. items:
  526. $ref: '#/components/schemas/Media-media_object.read'
  527. text/html:
  528. schema:
  529. type: array
  530. items:
  531. $ref: '#/components/schemas/Media-media_object.read'
  532. application/hal+json:
  533. schema:
  534. type: object
  535. properties:
  536. _embedded: { type: array, items: { $ref: '#/components/schemas/Media.jsonhal-media_object.read' } }
  537. totalItems: { type: integer, minimum: 0 }
  538. itemsPerPage: { type: integer, minimum: 0 }
  539. _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 } } } } }
  540. required:
  541. - _links
  542. - _embedded
  543. summary: 'Retrieves the collection of Media resources.'
  544. description: 'Retrieves the collection of Media resources.'
  545. parameters:
  546. -
  547. name: page
  548. in: query
  549. description: 'The collection page number'
  550. required: false
  551. deprecated: false
  552. allowEmptyValue: true
  553. schema:
  554. type: integer
  555. default: 1
  556. style: form
  557. explode: false
  558. allowReserved: false
  559. -
  560. name: itemsPerPage
  561. in: query
  562. description: 'The number of items per page'
  563. required: false
  564. deprecated: false
  565. allowEmptyValue: true
  566. schema:
  567. type: integer
  568. default: 10
  569. minimum: 0
  570. maximum: 50
  571. style: form
  572. explode: false
  573. allowReserved: false
  574. deprecated: false
  575. post:
  576. operationId: api_medias_post
  577. tags:
  578. - Media
  579. responses:
  580. 201:
  581. description: 'Media resource created'
  582. content:
  583. application/ld+json:
  584. schema:
  585. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  586. application/json:
  587. schema:
  588. $ref: '#/components/schemas/Media-media_object.read'
  589. text/html:
  590. schema:
  591. $ref: '#/components/schemas/Media-media_object.read'
  592. application/hal+json:
  593. schema:
  594. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  595. links: { }
  596. 400:
  597. description: 'Invalid input'
  598. 422:
  599. description: 'Unprocessable entity'
  600. summary: 'Creates a Media resource.'
  601. description: 'Creates a Media resource.'
  602. parameters: []
  603. requestBody:
  604. description: ''
  605. content:
  606. multipart/form-data:
  607. schema:
  608. type: object
  609. properties:
  610. file:
  611. type: string
  612. format: binary
  613. required: false
  614. deprecated: false
  615. parameters: []
  616. '/api/medias/{id}':
  617. get:
  618. operationId: api_medias_id_get
  619. tags:
  620. - Media
  621. responses:
  622. 200:
  623. description: 'Media resource'
  624. content:
  625. application/ld+json:
  626. schema:
  627. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  628. application/json:
  629. schema:
  630. $ref: '#/components/schemas/Media-media_object.read'
  631. text/html:
  632. schema:
  633. $ref: '#/components/schemas/Media-media_object.read'
  634. application/hal+json:
  635. schema:
  636. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  637. 404:
  638. description: 'Resource not found'
  639. summary: 'Retrieves a Media resource.'
  640. description: 'Retrieves a Media resource.'
  641. parameters:
  642. -
  643. name: id
  644. in: path
  645. description: 'MediaObject identifier'
  646. required: true
  647. deprecated: false
  648. allowEmptyValue: false
  649. schema:
  650. type: string
  651. style: simple
  652. explode: false
  653. allowReserved: false
  654. deprecated: false
  655. delete:
  656. operationId: api_medias_id_delete
  657. tags:
  658. - Media
  659. responses:
  660. 204:
  661. description: 'Media resource deleted'
  662. 404:
  663. description: 'Resource not found'
  664. summary: 'Removes the Media resource.'
  665. description: 'Removes the Media resource.'
  666. parameters:
  667. -
  668. name: id
  669. in: path
  670. description: 'MediaObject identifier'
  671. required: true
  672. deprecated: false
  673. allowEmptyValue: false
  674. schema:
  675. type: string
  676. style: simple
  677. explode: false
  678. allowReserved: false
  679. deprecated: false
  680. parameters: []
  681. /api/partners:
  682. get:
  683. operationId: api_partners_get_collection
  684. tags:
  685. - Partner
  686. responses:
  687. 200:
  688. description: 'Partner collection'
  689. content:
  690. application/ld+json:
  691. schema:
  692. type: object
  693. properties:
  694. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  695. 'hydra:totalItems': { type: integer, minimum: 0 }
  696. '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 } }
  697. '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 } } } } } }
  698. required:
  699. - 'hydra:member'
  700. application/json:
  701. schema:
  702. type: array
  703. items:
  704. $ref: '#/components/schemas/Partner'
  705. text/html:
  706. schema:
  707. type: array
  708. items:
  709. $ref: '#/components/schemas/Partner'
  710. application/hal+json:
  711. schema:
  712. type: object
  713. properties:
  714. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  715. totalItems: { type: integer, minimum: 0 }
  716. itemsPerPage: { type: integer, minimum: 0 }
  717. _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 } } } } }
  718. required:
  719. - _links
  720. - _embedded
  721. summary: 'Retrieves the collection of Partner resources.'
  722. description: 'Retrieves the collection of Partner resources.'
  723. parameters:
  724. -
  725. name: page
  726. in: query
  727. description: 'The collection page number'
  728. required: false
  729. deprecated: false
  730. allowEmptyValue: true
  731. schema:
  732. type: integer
  733. default: 1
  734. style: form
  735. explode: false
  736. allowReserved: false
  737. -
  738. name: itemsPerPage
  739. in: query
  740. description: 'The number of items per page'
  741. required: false
  742. deprecated: false
  743. allowEmptyValue: true
  744. schema:
  745. type: integer
  746. default: 10
  747. minimum: 0
  748. maximum: 50
  749. style: form
  750. explode: false
  751. allowReserved: false
  752. -
  753. name: type
  754. in: query
  755. description: ''
  756. required: false
  757. deprecated: false
  758. allowEmptyValue: true
  759. schema:
  760. type: string
  761. style: form
  762. explode: false
  763. allowReserved: false
  764. -
  765. name: 'type[]'
  766. in: query
  767. description: ''
  768. required: false
  769. deprecated: false
  770. allowEmptyValue: true
  771. schema:
  772. type: array
  773. items:
  774. type: string
  775. style: form
  776. explode: true
  777. allowReserved: false
  778. -
  779. name: 'order[name]'
  780. in: query
  781. description: ''
  782. required: false
  783. deprecated: false
  784. allowEmptyValue: true
  785. schema:
  786. type: string
  787. enum:
  788. - asc
  789. - desc
  790. style: form
  791. explode: false
  792. allowReserved: false
  793. -
  794. name: 'order[city]'
  795. in: query
  796. description: ''
  797. required: false
  798. deprecated: false
  799. allowEmptyValue: true
  800. schema:
  801. type: string
  802. enum:
  803. - asc
  804. - desc
  805. style: form
  806. explode: false
  807. allowReserved: false
  808. -
  809. name: 'order[website]'
  810. in: query
  811. description: ''
  812. required: false
  813. deprecated: false
  814. allowEmptyValue: true
  815. schema:
  816. type: string
  817. enum:
  818. - asc
  819. - desc
  820. style: form
  821. explode: false
  822. allowReserved: false
  823. deprecated: false
  824. post:
  825. operationId: api_partners_post
  826. tags:
  827. - Partner
  828. responses:
  829. 201:
  830. description: 'Partner resource created'
  831. content:
  832. application/ld+json:
  833. schema:
  834. $ref: '#/components/schemas/Partner.jsonld'
  835. application/json:
  836. schema:
  837. $ref: '#/components/schemas/Partner'
  838. text/html:
  839. schema:
  840. $ref: '#/components/schemas/Partner'
  841. application/hal+json:
  842. schema:
  843. $ref: '#/components/schemas/Partner.jsonhal'
  844. links: { }
  845. 400:
  846. description: 'Invalid input'
  847. 422:
  848. description: 'Unprocessable entity'
  849. summary: 'Creates a Partner resource.'
  850. description: 'Creates a Partner resource.'
  851. parameters: []
  852. requestBody:
  853. description: 'The new Partner resource'
  854. content:
  855. application/ld+json:
  856. schema:
  857. $ref: '#/components/schemas/Partner.jsonld'
  858. application/json:
  859. schema:
  860. $ref: '#/components/schemas/Partner'
  861. text/html:
  862. schema:
  863. $ref: '#/components/schemas/Partner'
  864. application/hal+json:
  865. schema:
  866. $ref: '#/components/schemas/Partner.jsonhal'
  867. required: true
  868. deprecated: false
  869. parameters: []
  870. '/api/partners/{id}':
  871. get:
  872. operationId: api_partners_id_get
  873. tags:
  874. - Partner
  875. responses:
  876. 200:
  877. description: 'Partner resource'
  878. content:
  879. application/ld+json:
  880. schema:
  881. $ref: '#/components/schemas/Partner.jsonld'
  882. application/json:
  883. schema:
  884. $ref: '#/components/schemas/Partner'
  885. text/html:
  886. schema:
  887. $ref: '#/components/schemas/Partner'
  888. application/hal+json:
  889. schema:
  890. $ref: '#/components/schemas/Partner.jsonhal'
  891. 404:
  892. description: 'Resource not found'
  893. summary: 'Retrieves a Partner resource.'
  894. description: 'Retrieves a Partner resource.'
  895. parameters:
  896. -
  897. name: id
  898. in: path
  899. description: 'PartnerApi identifier'
  900. required: true
  901. deprecated: false
  902. allowEmptyValue: false
  903. schema:
  904. type: string
  905. style: simple
  906. explode: false
  907. allowReserved: false
  908. deprecated: false
  909. delete:
  910. operationId: api_partners_id_delete
  911. tags:
  912. - Partner
  913. responses:
  914. 204:
  915. description: 'Partner resource deleted'
  916. 404:
  917. description: 'Resource not found'
  918. summary: 'Removes the Partner resource.'
  919. description: 'Removes the Partner resource.'
  920. parameters:
  921. -
  922. name: id
  923. in: path
  924. description: 'PartnerApi identifier'
  925. required: true
  926. deprecated: false
  927. allowEmptyValue: false
  928. schema:
  929. type: string
  930. style: simple
  931. explode: false
  932. allowReserved: false
  933. deprecated: false
  934. patch:
  935. operationId: api_partners_id_patch
  936. tags:
  937. - Partner
  938. responses:
  939. 200:
  940. description: 'Partner resource updated'
  941. content:
  942. application/ld+json:
  943. schema:
  944. $ref: '#/components/schemas/Partner.jsonld'
  945. application/json:
  946. schema:
  947. $ref: '#/components/schemas/Partner'
  948. text/html:
  949. schema:
  950. $ref: '#/components/schemas/Partner'
  951. application/hal+json:
  952. schema:
  953. $ref: '#/components/schemas/Partner.jsonhal'
  954. links: { }
  955. 400:
  956. description: 'Invalid input'
  957. 422:
  958. description: 'Unprocessable entity'
  959. 404:
  960. description: 'Resource not found'
  961. summary: 'Updates the Partner resource.'
  962. description: 'Updates the Partner resource.'
  963. parameters:
  964. -
  965. name: id
  966. in: path
  967. description: 'PartnerApi identifier'
  968. required: true
  969. deprecated: false
  970. allowEmptyValue: false
  971. schema:
  972. type: string
  973. style: simple
  974. explode: false
  975. allowReserved: false
  976. requestBody:
  977. description: 'The updated Partner resource'
  978. content:
  979. application/merge-patch+json:
  980. schema:
  981. $ref: '#/components/schemas/Partner'
  982. required: true
  983. deprecated: false
  984. parameters: []
  985. /api/posts:
  986. get:
  987. operationId: api_posts_get_collection
  988. tags:
  989. - Post
  990. responses:
  991. 200:
  992. description: 'Post collection'
  993. content:
  994. application/ld+json:
  995. schema:
  996. type: object
  997. properties:
  998. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  999. 'hydra:totalItems': { type: integer, minimum: 0 }
  1000. '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 } }
  1001. '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 } } } } } }
  1002. required:
  1003. - 'hydra:member'
  1004. application/json:
  1005. schema:
  1006. type: array
  1007. items:
  1008. $ref: '#/components/schemas/Post'
  1009. text/html:
  1010. schema:
  1011. type: array
  1012. items:
  1013. $ref: '#/components/schemas/Post'
  1014. application/hal+json:
  1015. schema:
  1016. type: object
  1017. properties:
  1018. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  1019. totalItems: { type: integer, minimum: 0 }
  1020. itemsPerPage: { type: integer, minimum: 0 }
  1021. _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 } } } } }
  1022. required:
  1023. - _links
  1024. - _embedded
  1025. summary: 'Retrieves the collection of Post resources.'
  1026. description: 'Retrieves the collection of Post resources.'
  1027. parameters:
  1028. -
  1029. name: page
  1030. in: query
  1031. description: 'The collection page number'
  1032. required: false
  1033. deprecated: false
  1034. allowEmptyValue: true
  1035. schema:
  1036. type: integer
  1037. default: 1
  1038. style: form
  1039. explode: false
  1040. allowReserved: false
  1041. -
  1042. name: itemsPerPage
  1043. in: query
  1044. description: 'The number of items per page'
  1045. required: false
  1046. deprecated: false
  1047. allowEmptyValue: true
  1048. schema:
  1049. type: integer
  1050. default: 10
  1051. minimum: 0
  1052. maximum: 50
  1053. style: form
  1054. explode: false
  1055. allowReserved: false
  1056. -
  1057. name: partner
  1058. in: query
  1059. description: ''
  1060. required: false
  1061. deprecated: false
  1062. allowEmptyValue: true
  1063. schema:
  1064. type: string
  1065. style: form
  1066. explode: false
  1067. allowReserved: false
  1068. -
  1069. name: 'partner[]'
  1070. in: query
  1071. description: ''
  1072. required: false
  1073. deprecated: false
  1074. allowEmptyValue: true
  1075. schema:
  1076. type: array
  1077. items:
  1078. type: string
  1079. style: form
  1080. explode: true
  1081. allowReserved: false
  1082. -
  1083. name: contact
  1084. in: query
  1085. description: ''
  1086. required: false
  1087. deprecated: false
  1088. allowEmptyValue: true
  1089. schema:
  1090. type: string
  1091. style: form
  1092. explode: false
  1093. allowReserved: false
  1094. -
  1095. name: 'contact[]'
  1096. in: query
  1097. description: ''
  1098. required: false
  1099. deprecated: false
  1100. allowEmptyValue: true
  1101. schema:
  1102. type: array
  1103. items:
  1104. type: string
  1105. style: form
  1106. explode: true
  1107. allowReserved: false
  1108. deprecated: false
  1109. post:
  1110. operationId: api_posts_post
  1111. tags:
  1112. - Post
  1113. responses:
  1114. 201:
  1115. description: 'Post resource created'
  1116. content:
  1117. application/ld+json:
  1118. schema:
  1119. $ref: '#/components/schemas/Post.jsonld'
  1120. application/json:
  1121. schema:
  1122. $ref: '#/components/schemas/Post'
  1123. text/html:
  1124. schema:
  1125. $ref: '#/components/schemas/Post'
  1126. application/hal+json:
  1127. schema:
  1128. $ref: '#/components/schemas/Post.jsonhal'
  1129. links: { }
  1130. 400:
  1131. description: 'Invalid input'
  1132. 422:
  1133. description: 'Unprocessable entity'
  1134. summary: 'Creates a Post resource.'
  1135. description: 'Creates a Post resource.'
  1136. parameters: []
  1137. requestBody:
  1138. description: 'The new Post resource'
  1139. content:
  1140. application/ld+json:
  1141. schema:
  1142. $ref: '#/components/schemas/Post.jsonld-posting.create'
  1143. application/json:
  1144. schema:
  1145. $ref: '#/components/schemas/Post-posting.create'
  1146. text/html:
  1147. schema:
  1148. $ref: '#/components/schemas/Post-posting.create'
  1149. application/hal+json:
  1150. schema:
  1151. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  1152. required: true
  1153. deprecated: false
  1154. parameters: []
  1155. '/api/posts/{id}':
  1156. get:
  1157. operationId: api_posts_id_get
  1158. tags:
  1159. - Post
  1160. responses:
  1161. 200:
  1162. description: 'Post resource'
  1163. content:
  1164. application/ld+json:
  1165. schema:
  1166. $ref: '#/components/schemas/Post.jsonld'
  1167. application/json:
  1168. schema:
  1169. $ref: '#/components/schemas/Post'
  1170. text/html:
  1171. schema:
  1172. $ref: '#/components/schemas/Post'
  1173. application/hal+json:
  1174. schema:
  1175. $ref: '#/components/schemas/Post.jsonhal'
  1176. 404:
  1177. description: 'Resource not found'
  1178. summary: 'Retrieves a Post resource.'
  1179. description: 'Retrieves a Post resource.'
  1180. parameters:
  1181. -
  1182. name: id
  1183. in: path
  1184. description: 'PostingApi identifier'
  1185. required: true
  1186. deprecated: false
  1187. allowEmptyValue: false
  1188. schema:
  1189. type: string
  1190. style: simple
  1191. explode: false
  1192. allowReserved: false
  1193. deprecated: false
  1194. delete:
  1195. operationId: api_posts_id_delete
  1196. tags:
  1197. - Post
  1198. responses:
  1199. 204:
  1200. description: 'Post resource deleted'
  1201. 404:
  1202. description: 'Resource not found'
  1203. summary: 'Removes the Post resource.'
  1204. description: 'Removes the Post resource.'
  1205. parameters:
  1206. -
  1207. name: id
  1208. in: path
  1209. description: 'PostingApi identifier'
  1210. required: true
  1211. deprecated: false
  1212. allowEmptyValue: false
  1213. schema:
  1214. type: string
  1215. style: simple
  1216. explode: false
  1217. allowReserved: false
  1218. deprecated: false
  1219. patch:
  1220. operationId: api_posts_id_patch
  1221. tags:
  1222. - Post
  1223. responses:
  1224. 200:
  1225. description: 'Post resource updated'
  1226. content:
  1227. application/ld+json:
  1228. schema:
  1229. $ref: '#/components/schemas/Post.jsonld'
  1230. application/json:
  1231. schema:
  1232. $ref: '#/components/schemas/Post'
  1233. text/html:
  1234. schema:
  1235. $ref: '#/components/schemas/Post'
  1236. application/hal+json:
  1237. schema:
  1238. $ref: '#/components/schemas/Post.jsonhal'
  1239. links: { }
  1240. 400:
  1241. description: 'Invalid input'
  1242. 422:
  1243. description: 'Unprocessable entity'
  1244. 404:
  1245. description: 'Resource not found'
  1246. summary: 'Updates the Post resource.'
  1247. description: 'Updates the Post resource.'
  1248. parameters:
  1249. -
  1250. name: id
  1251. in: path
  1252. description: 'PostingApi identifier'
  1253. required: true
  1254. deprecated: false
  1255. allowEmptyValue: false
  1256. schema:
  1257. type: string
  1258. style: simple
  1259. explode: false
  1260. allowReserved: false
  1261. requestBody:
  1262. description: 'The updated Post resource'
  1263. content:
  1264. application/merge-patch+json:
  1265. schema:
  1266. $ref: '#/components/schemas/Post-posting.patch'
  1267. required: true
  1268. deprecated: false
  1269. parameters: []
  1270. /api/products:
  1271. get:
  1272. operationId: api_products_get_collection
  1273. tags:
  1274. - Product
  1275. responses:
  1276. 200:
  1277. description: 'Product collection'
  1278. content:
  1279. application/ld+json:
  1280. schema:
  1281. type: object
  1282. properties:
  1283. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  1284. 'hydra:totalItems': { type: integer, minimum: 0 }
  1285. '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 } }
  1286. '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 } } } } } }
  1287. required:
  1288. - 'hydra:member'
  1289. application/json:
  1290. schema:
  1291. type: array
  1292. items:
  1293. $ref: '#/components/schemas/Product'
  1294. text/html:
  1295. schema:
  1296. type: array
  1297. items:
  1298. $ref: '#/components/schemas/Product'
  1299. application/hal+json:
  1300. schema:
  1301. type: object
  1302. properties:
  1303. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  1304. totalItems: { type: integer, minimum: 0 }
  1305. itemsPerPage: { type: integer, minimum: 0 }
  1306. _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 } } } } }
  1307. required:
  1308. - _links
  1309. - _embedded
  1310. summary: 'Retrieves the collection of Product resources.'
  1311. description: 'Retrieves the collection of Product resources.'
  1312. parameters:
  1313. -
  1314. name: page
  1315. in: query
  1316. description: 'The collection page number'
  1317. required: false
  1318. deprecated: false
  1319. allowEmptyValue: true
  1320. schema:
  1321. type: integer
  1322. default: 1
  1323. style: form
  1324. explode: false
  1325. allowReserved: false
  1326. -
  1327. name: itemsPerPage
  1328. in: query
  1329. description: 'The number of items per page'
  1330. required: false
  1331. deprecated: false
  1332. allowEmptyValue: true
  1333. schema:
  1334. type: integer
  1335. default: 10
  1336. minimum: 0
  1337. maximum: 50
  1338. style: form
  1339. explode: false
  1340. allowReserved: false
  1341. -
  1342. name: 'order[name]'
  1343. in: query
  1344. description: ''
  1345. required: false
  1346. deprecated: false
  1347. allowEmptyValue: true
  1348. schema:
  1349. type: string
  1350. enum:
  1351. - asc
  1352. - desc
  1353. style: form
  1354. explode: false
  1355. allowReserved: false
  1356. deprecated: false
  1357. post:
  1358. operationId: api_products_post
  1359. tags:
  1360. - Product
  1361. responses:
  1362. 201:
  1363. description: 'Product resource created'
  1364. content:
  1365. application/ld+json:
  1366. schema:
  1367. $ref: '#/components/schemas/Product.jsonld'
  1368. application/json:
  1369. schema:
  1370. $ref: '#/components/schemas/Product'
  1371. text/html:
  1372. schema:
  1373. $ref: '#/components/schemas/Product'
  1374. application/hal+json:
  1375. schema:
  1376. $ref: '#/components/schemas/Product.jsonhal'
  1377. links: { }
  1378. 400:
  1379. description: 'Invalid input'
  1380. 422:
  1381. description: 'Unprocessable entity'
  1382. summary: 'Creates a Product resource.'
  1383. description: 'Creates a Product resource.'
  1384. parameters: []
  1385. requestBody:
  1386. description: 'The new Product resource'
  1387. content:
  1388. application/ld+json:
  1389. schema:
  1390. $ref: '#/components/schemas/Product.jsonld'
  1391. application/json:
  1392. schema:
  1393. $ref: '#/components/schemas/Product'
  1394. text/html:
  1395. schema:
  1396. $ref: '#/components/schemas/Product'
  1397. application/hal+json:
  1398. schema:
  1399. $ref: '#/components/schemas/Product.jsonhal'
  1400. required: true
  1401. deprecated: false
  1402. parameters: []
  1403. '/api/products/{id}':
  1404. get:
  1405. operationId: api_products_id_get
  1406. tags:
  1407. - Product
  1408. responses:
  1409. 200:
  1410. description: 'Product resource'
  1411. content:
  1412. application/ld+json:
  1413. schema:
  1414. $ref: '#/components/schemas/Product.jsonld'
  1415. application/json:
  1416. schema:
  1417. $ref: '#/components/schemas/Product'
  1418. text/html:
  1419. schema:
  1420. $ref: '#/components/schemas/Product'
  1421. application/hal+json:
  1422. schema:
  1423. $ref: '#/components/schemas/Product.jsonhal'
  1424. 404:
  1425. description: 'Resource not found'
  1426. summary: 'Retrieves a Product resource.'
  1427. description: 'Retrieves a Product resource.'
  1428. parameters:
  1429. -
  1430. name: id
  1431. in: path
  1432. description: 'ProductApi identifier'
  1433. required: true
  1434. deprecated: false
  1435. allowEmptyValue: false
  1436. schema:
  1437. type: string
  1438. style: simple
  1439. explode: false
  1440. allowReserved: false
  1441. deprecated: false
  1442. delete:
  1443. operationId: api_products_id_delete
  1444. tags:
  1445. - Product
  1446. responses:
  1447. 204:
  1448. description: 'Product resource deleted'
  1449. 404:
  1450. description: 'Resource not found'
  1451. summary: 'Removes the Product resource.'
  1452. description: 'Removes the Product resource.'
  1453. parameters:
  1454. -
  1455. name: id
  1456. in: path
  1457. description: 'ProductApi identifier'
  1458. required: true
  1459. deprecated: false
  1460. allowEmptyValue: false
  1461. schema:
  1462. type: string
  1463. style: simple
  1464. explode: false
  1465. allowReserved: false
  1466. deprecated: false
  1467. patch:
  1468. operationId: api_products_id_patch
  1469. tags:
  1470. - Product
  1471. responses:
  1472. 200:
  1473. description: 'Product resource updated'
  1474. content:
  1475. application/ld+json:
  1476. schema:
  1477. $ref: '#/components/schemas/Product.jsonld'
  1478. application/json:
  1479. schema:
  1480. $ref: '#/components/schemas/Product'
  1481. text/html:
  1482. schema:
  1483. $ref: '#/components/schemas/Product'
  1484. application/hal+json:
  1485. schema:
  1486. $ref: '#/components/schemas/Product.jsonhal'
  1487. links: { }
  1488. 400:
  1489. description: 'Invalid input'
  1490. 422:
  1491. description: 'Unprocessable entity'
  1492. 404:
  1493. description: 'Resource not found'
  1494. summary: 'Updates the Product resource.'
  1495. description: 'Updates the Product resource.'
  1496. parameters:
  1497. -
  1498. name: id
  1499. in: path
  1500. description: 'ProductApi identifier'
  1501. required: true
  1502. deprecated: false
  1503. allowEmptyValue: false
  1504. schema:
  1505. type: string
  1506. style: simple
  1507. explode: false
  1508. allowReserved: false
  1509. requestBody:
  1510. description: 'The updated Product resource'
  1511. content:
  1512. application/merge-patch+json:
  1513. schema:
  1514. $ref: '#/components/schemas/Product'
  1515. required: true
  1516. deprecated: false
  1517. parameters: []
  1518. /api/sale_summaries:
  1519. get:
  1520. operationId: api_sale_summaries_get_collection
  1521. tags:
  1522. - SaleSummary
  1523. responses:
  1524. 200:
  1525. description: 'SaleSummary collection'
  1526. content:
  1527. application/ld+json:
  1528. schema:
  1529. type: object
  1530. properties:
  1531. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonld' } }
  1532. 'hydra:totalItems': { type: integer, minimum: 0 }
  1533. '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 } }
  1534. '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 } } } } } }
  1535. required:
  1536. - 'hydra:member'
  1537. application/json:
  1538. schema:
  1539. type: array
  1540. items:
  1541. $ref: '#/components/schemas/SaleSummary'
  1542. text/html:
  1543. schema:
  1544. type: array
  1545. items:
  1546. $ref: '#/components/schemas/SaleSummary'
  1547. application/hal+json:
  1548. schema:
  1549. type: object
  1550. properties:
  1551. _embedded: { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonhal' } }
  1552. totalItems: { type: integer, minimum: 0 }
  1553. itemsPerPage: { type: integer, minimum: 0 }
  1554. _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 } } } } }
  1555. required:
  1556. - _links
  1557. - _embedded
  1558. summary: 'Retrieves the collection of SaleSummary resources.'
  1559. description: 'Retrieves the collection of SaleSummary resources.'
  1560. parameters:
  1561. -
  1562. name: page
  1563. in: query
  1564. description: 'The collection page number'
  1565. required: false
  1566. deprecated: false
  1567. allowEmptyValue: true
  1568. schema:
  1569. type: integer
  1570. default: 1
  1571. style: form
  1572. explode: false
  1573. allowReserved: false
  1574. -
  1575. name: itemsPerPage
  1576. in: query
  1577. description: 'The number of items per page'
  1578. required: false
  1579. deprecated: false
  1580. allowEmptyValue: true
  1581. schema:
  1582. type: integer
  1583. default: 10
  1584. minimum: 0
  1585. maximum: 50
  1586. style: form
  1587. explode: false
  1588. allowReserved: false
  1589. deprecated: false
  1590. parameters: []
  1591. /api/sales:
  1592. get:
  1593. operationId: api_sales_get_collection
  1594. tags:
  1595. - Sale
  1596. responses:
  1597. 200:
  1598. description: 'Sale collection'
  1599. content:
  1600. application/ld+json:
  1601. schema:
  1602. type: object
  1603. properties:
  1604. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Sale.jsonld' } }
  1605. 'hydra:totalItems': { type: integer, minimum: 0 }
  1606. '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 } }
  1607. '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 } } } } } }
  1608. required:
  1609. - 'hydra:member'
  1610. application/json:
  1611. schema:
  1612. type: array
  1613. items:
  1614. $ref: '#/components/schemas/Sale'
  1615. text/html:
  1616. schema:
  1617. type: array
  1618. items:
  1619. $ref: '#/components/schemas/Sale'
  1620. application/hal+json:
  1621. schema:
  1622. type: object
  1623. properties:
  1624. _embedded: { type: array, items: { $ref: '#/components/schemas/Sale.jsonhal' } }
  1625. totalItems: { type: integer, minimum: 0 }
  1626. itemsPerPage: { type: integer, minimum: 0 }
  1627. _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 } } } } }
  1628. required:
  1629. - _links
  1630. - _embedded
  1631. summary: 'Retrieves the collection of Sale resources.'
  1632. description: 'Retrieves the collection of Sale resources.'
  1633. parameters:
  1634. -
  1635. name: page
  1636. in: query
  1637. description: 'The collection page number'
  1638. required: false
  1639. deprecated: false
  1640. allowEmptyValue: true
  1641. schema:
  1642. type: integer
  1643. default: 1
  1644. style: form
  1645. explode: false
  1646. allowReserved: false
  1647. -
  1648. name: itemsPerPage
  1649. in: query
  1650. description: 'The number of items per page'
  1651. required: false
  1652. deprecated: false
  1653. allowEmptyValue: true
  1654. schema:
  1655. type: integer
  1656. default: 10
  1657. minimum: 0
  1658. maximum: 50
  1659. style: form
  1660. explode: false
  1661. allowReserved: false
  1662. -
  1663. name: owner
  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: 'owner[]'
  1676. in: query
  1677. description: ''
  1678. required: false
  1679. deprecated: false
  1680. allowEmptyValue: true
  1681. schema:
  1682. type: array
  1683. items:
  1684. type: string
  1685. style: form
  1686. explode: true
  1687. allowReserved: false
  1688. -
  1689. name: partner
  1690. in: query
  1691. description: ''
  1692. required: false
  1693. deprecated: false
  1694. allowEmptyValue: true
  1695. schema:
  1696. type: string
  1697. style: form
  1698. explode: false
  1699. allowReserved: false
  1700. -
  1701. name: 'partner[]'
  1702. in: query
  1703. description: ''
  1704. required: false
  1705. deprecated: false
  1706. allowEmptyValue: true
  1707. schema:
  1708. type: array
  1709. items:
  1710. type: string
  1711. style: form
  1712. explode: true
  1713. allowReserved: false
  1714. deprecated: false
  1715. post:
  1716. operationId: api_sales_post
  1717. tags:
  1718. - Sale
  1719. responses:
  1720. 201:
  1721. description: 'Sale resource created'
  1722. content:
  1723. application/ld+json:
  1724. schema:
  1725. $ref: '#/components/schemas/Sale.jsonld'
  1726. application/json:
  1727. schema:
  1728. $ref: '#/components/schemas/Sale'
  1729. text/html:
  1730. schema:
  1731. $ref: '#/components/schemas/Sale'
  1732. application/hal+json:
  1733. schema:
  1734. $ref: '#/components/schemas/Sale.jsonhal'
  1735. links: { }
  1736. 400:
  1737. description: 'Invalid input'
  1738. 422:
  1739. description: 'Unprocessable entity'
  1740. summary: 'Creates a Sale resource.'
  1741. description: 'Creates a Sale resource.'
  1742. parameters: []
  1743. requestBody:
  1744. description: 'The new Sale resource'
  1745. content:
  1746. application/ld+json:
  1747. schema:
  1748. $ref: '#/components/schemas/Sale.jsonld'
  1749. application/json:
  1750. schema:
  1751. $ref: '#/components/schemas/Sale'
  1752. text/html:
  1753. schema:
  1754. $ref: '#/components/schemas/Sale'
  1755. application/hal+json:
  1756. schema:
  1757. $ref: '#/components/schemas/Sale.jsonhal'
  1758. required: true
  1759. deprecated: false
  1760. parameters: []
  1761. '/api/sales/{id}':
  1762. get:
  1763. operationId: api_sales_id_get
  1764. tags:
  1765. - Sale
  1766. responses:
  1767. 200:
  1768. description: 'Sale resource'
  1769. content:
  1770. application/ld+json:
  1771. schema:
  1772. $ref: '#/components/schemas/Sale.jsonld'
  1773. application/json:
  1774. schema:
  1775. $ref: '#/components/schemas/Sale'
  1776. text/html:
  1777. schema:
  1778. $ref: '#/components/schemas/Sale'
  1779. application/hal+json:
  1780. schema:
  1781. $ref: '#/components/schemas/Sale.jsonhal'
  1782. 404:
  1783. description: 'Resource not found'
  1784. summary: 'Retrieves a Sale resource.'
  1785. description: 'Retrieves a Sale resource.'
  1786. parameters:
  1787. -
  1788. name: id
  1789. in: path
  1790. description: 'SaleApi identifier'
  1791. required: true
  1792. deprecated: false
  1793. allowEmptyValue: false
  1794. schema:
  1795. type: string
  1796. style: simple
  1797. explode: false
  1798. allowReserved: false
  1799. deprecated: false
  1800. delete:
  1801. operationId: api_sales_id_delete
  1802. tags:
  1803. - Sale
  1804. responses:
  1805. 204:
  1806. description: 'Sale resource deleted'
  1807. 404:
  1808. description: 'Resource not found'
  1809. summary: 'Removes the Sale resource.'
  1810. description: 'Removes the Sale resource.'
  1811. parameters:
  1812. -
  1813. name: id
  1814. in: path
  1815. description: 'SaleApi identifier'
  1816. required: true
  1817. deprecated: false
  1818. allowEmptyValue: false
  1819. schema:
  1820. type: string
  1821. style: simple
  1822. explode: false
  1823. allowReserved: false
  1824. deprecated: false
  1825. patch:
  1826. operationId: api_sales_id_patch
  1827. tags:
  1828. - Sale
  1829. responses:
  1830. 200:
  1831. description: 'Sale resource updated'
  1832. content:
  1833. application/ld+json:
  1834. schema:
  1835. $ref: '#/components/schemas/Sale.jsonld'
  1836. application/json:
  1837. schema:
  1838. $ref: '#/components/schemas/Sale'
  1839. text/html:
  1840. schema:
  1841. $ref: '#/components/schemas/Sale'
  1842. application/hal+json:
  1843. schema:
  1844. $ref: '#/components/schemas/Sale.jsonhal'
  1845. links: { }
  1846. 400:
  1847. description: 'Invalid input'
  1848. 422:
  1849. description: 'Unprocessable entity'
  1850. 404:
  1851. description: 'Resource not found'
  1852. summary: 'Updates the Sale resource.'
  1853. description: 'Updates the Sale resource.'
  1854. parameters:
  1855. -
  1856. name: id
  1857. in: path
  1858. description: 'SaleApi identifier'
  1859. required: true
  1860. deprecated: false
  1861. allowEmptyValue: false
  1862. schema:
  1863. type: string
  1864. style: simple
  1865. explode: false
  1866. allowReserved: false
  1867. requestBody:
  1868. description: 'The updated Sale resource'
  1869. content:
  1870. application/merge-patch+json:
  1871. schema:
  1872. $ref: '#/components/schemas/Sale'
  1873. required: true
  1874. deprecated: false
  1875. parameters: []
  1876. /api/task_notes:
  1877. get:
  1878. operationId: api_task_notes_get_collection
  1879. tags:
  1880. - TaskNote
  1881. responses:
  1882. 200:
  1883. description: 'TaskNote collection'
  1884. content:
  1885. application/ld+json:
  1886. schema:
  1887. type: object
  1888. properties:
  1889. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonld' } }
  1890. 'hydra:totalItems': { type: integer, minimum: 0 }
  1891. '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 } }
  1892. '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 } } } } } }
  1893. required:
  1894. - 'hydra:member'
  1895. application/json:
  1896. schema:
  1897. type: array
  1898. items:
  1899. $ref: '#/components/schemas/TaskNote'
  1900. text/html:
  1901. schema:
  1902. type: array
  1903. items:
  1904. $ref: '#/components/schemas/TaskNote'
  1905. application/hal+json:
  1906. schema:
  1907. type: object
  1908. properties:
  1909. _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonhal' } }
  1910. totalItems: { type: integer, minimum: 0 }
  1911. itemsPerPage: { type: integer, minimum: 0 }
  1912. _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 } } } } }
  1913. required:
  1914. - _links
  1915. - _embedded
  1916. summary: 'Retrieves the collection of TaskNote resources.'
  1917. description: 'Retrieves the collection of TaskNote resources.'
  1918. parameters:
  1919. -
  1920. name: page
  1921. in: query
  1922. description: 'The collection page number'
  1923. required: false
  1924. deprecated: false
  1925. allowEmptyValue: true
  1926. schema:
  1927. type: integer
  1928. default: 1
  1929. style: form
  1930. explode: false
  1931. allowReserved: false
  1932. -
  1933. name: itemsPerPage
  1934. in: query
  1935. description: 'The number of items per page'
  1936. required: false
  1937. deprecated: false
  1938. allowEmptyValue: true
  1939. schema:
  1940. type: integer
  1941. default: 10
  1942. minimum: 0
  1943. maximum: 50
  1944. style: form
  1945. explode: false
  1946. allowReserved: false
  1947. -
  1948. name: task
  1949. in: query
  1950. description: ''
  1951. required: false
  1952. deprecated: false
  1953. allowEmptyValue: true
  1954. schema:
  1955. type: string
  1956. style: form
  1957. explode: false
  1958. allowReserved: false
  1959. -
  1960. name: 'task[]'
  1961. in: query
  1962. description: ''
  1963. required: false
  1964. deprecated: false
  1965. allowEmptyValue: true
  1966. schema:
  1967. type: array
  1968. items:
  1969. type: string
  1970. style: form
  1971. explode: true
  1972. allowReserved: false
  1973. deprecated: false
  1974. post:
  1975. operationId: api_task_notes_post
  1976. tags:
  1977. - TaskNote
  1978. responses:
  1979. 201:
  1980. description: 'TaskNote resource created'
  1981. content:
  1982. application/ld+json:
  1983. schema:
  1984. $ref: '#/components/schemas/TaskNote.jsonld'
  1985. application/json:
  1986. schema:
  1987. $ref: '#/components/schemas/TaskNote'
  1988. text/html:
  1989. schema:
  1990. $ref: '#/components/schemas/TaskNote'
  1991. application/hal+json:
  1992. schema:
  1993. $ref: '#/components/schemas/TaskNote.jsonhal'
  1994. links: { }
  1995. 400:
  1996. description: 'Invalid input'
  1997. 422:
  1998. description: 'Unprocessable entity'
  1999. summary: 'Creates a TaskNote resource.'
  2000. description: 'Creates a TaskNote resource.'
  2001. parameters: []
  2002. requestBody:
  2003. description: 'The new TaskNote resource'
  2004. content:
  2005. application/ld+json:
  2006. schema:
  2007. $ref: '#/components/schemas/TaskNote.jsonld'
  2008. application/json:
  2009. schema:
  2010. $ref: '#/components/schemas/TaskNote'
  2011. text/html:
  2012. schema:
  2013. $ref: '#/components/schemas/TaskNote'
  2014. application/hal+json:
  2015. schema:
  2016. $ref: '#/components/schemas/TaskNote.jsonhal'
  2017. required: true
  2018. deprecated: false
  2019. parameters: []
  2020. '/api/task_notes/{id}':
  2021. get:
  2022. operationId: api_task_notes_id_get
  2023. tags:
  2024. - TaskNote
  2025. responses:
  2026. 200:
  2027. description: 'TaskNote resource'
  2028. content:
  2029. application/ld+json:
  2030. schema:
  2031. $ref: '#/components/schemas/TaskNote.jsonld'
  2032. application/json:
  2033. schema:
  2034. $ref: '#/components/schemas/TaskNote'
  2035. text/html:
  2036. schema:
  2037. $ref: '#/components/schemas/TaskNote'
  2038. application/hal+json:
  2039. schema:
  2040. $ref: '#/components/schemas/TaskNote.jsonhal'
  2041. 404:
  2042. description: 'Resource not found'
  2043. summary: 'Retrieves a TaskNote resource.'
  2044. description: 'Retrieves a TaskNote resource.'
  2045. parameters:
  2046. -
  2047. name: id
  2048. in: path
  2049. description: 'TaskNoteApi identifier'
  2050. required: true
  2051. deprecated: false
  2052. allowEmptyValue: false
  2053. schema:
  2054. type: string
  2055. style: simple
  2056. explode: false
  2057. allowReserved: false
  2058. deprecated: false
  2059. delete:
  2060. operationId: api_task_notes_id_delete
  2061. tags:
  2062. - TaskNote
  2063. responses:
  2064. 204:
  2065. description: 'TaskNote resource deleted'
  2066. 404:
  2067. description: 'Resource not found'
  2068. summary: 'Removes the TaskNote resource.'
  2069. description: 'Removes the TaskNote resource.'
  2070. parameters:
  2071. -
  2072. name: id
  2073. in: path
  2074. description: 'TaskNoteApi identifier'
  2075. required: true
  2076. deprecated: false
  2077. allowEmptyValue: false
  2078. schema:
  2079. type: string
  2080. style: simple
  2081. explode: false
  2082. allowReserved: false
  2083. deprecated: false
  2084. patch:
  2085. operationId: api_task_notes_id_patch
  2086. tags:
  2087. - TaskNote
  2088. responses:
  2089. 200:
  2090. description: 'TaskNote resource updated'
  2091. content:
  2092. application/ld+json:
  2093. schema:
  2094. $ref: '#/components/schemas/TaskNote.jsonld'
  2095. application/json:
  2096. schema:
  2097. $ref: '#/components/schemas/TaskNote'
  2098. text/html:
  2099. schema:
  2100. $ref: '#/components/schemas/TaskNote'
  2101. application/hal+json:
  2102. schema:
  2103. $ref: '#/components/schemas/TaskNote.jsonhal'
  2104. links: { }
  2105. 400:
  2106. description: 'Invalid input'
  2107. 422:
  2108. description: 'Unprocessable entity'
  2109. 404:
  2110. description: 'Resource not found'
  2111. summary: 'Updates the TaskNote resource.'
  2112. description: 'Updates the TaskNote resource.'
  2113. parameters:
  2114. -
  2115. name: id
  2116. in: path
  2117. description: 'TaskNoteApi identifier'
  2118. required: true
  2119. deprecated: false
  2120. allowEmptyValue: false
  2121. schema:
  2122. type: string
  2123. style: simple
  2124. explode: false
  2125. allowReserved: false
  2126. requestBody:
  2127. description: 'The updated TaskNote resource'
  2128. content:
  2129. application/merge-patch+json:
  2130. schema:
  2131. $ref: '#/components/schemas/TaskNote'
  2132. required: true
  2133. deprecated: false
  2134. parameters: []
  2135. /api/tasks:
  2136. get:
  2137. operationId: api_tasks_get_collection
  2138. tags:
  2139. - Task
  2140. responses:
  2141. 200:
  2142. description: 'Task collection'
  2143. content:
  2144. application/ld+json:
  2145. schema:
  2146. type: object
  2147. properties:
  2148. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  2149. 'hydra:totalItems': { type: integer, minimum: 0 }
  2150. '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 } }
  2151. '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 } } } } } }
  2152. required:
  2153. - 'hydra:member'
  2154. application/json:
  2155. schema:
  2156. type: array
  2157. items:
  2158. $ref: '#/components/schemas/Task'
  2159. text/html:
  2160. schema:
  2161. type: array
  2162. items:
  2163. $ref: '#/components/schemas/Task'
  2164. application/hal+json:
  2165. schema:
  2166. type: object
  2167. properties:
  2168. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  2169. totalItems: { type: integer, minimum: 0 }
  2170. itemsPerPage: { type: integer, minimum: 0 }
  2171. _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 } } } } }
  2172. required:
  2173. - _links
  2174. - _embedded
  2175. summary: 'Retrieves the collection of Task resources.'
  2176. description: 'Retrieves the collection of Task resources.'
  2177. parameters:
  2178. -
  2179. name: page
  2180. in: query
  2181. description: 'The collection page number'
  2182. required: false
  2183. deprecated: false
  2184. allowEmptyValue: true
  2185. schema:
  2186. type: integer
  2187. default: 1
  2188. style: form
  2189. explode: false
  2190. allowReserved: false
  2191. -
  2192. name: itemsPerPage
  2193. in: query
  2194. description: 'The number of items per page'
  2195. required: false
  2196. deprecated: false
  2197. allowEmptyValue: true
  2198. schema:
  2199. type: integer
  2200. default: 10
  2201. minimum: 0
  2202. maximum: 50
  2203. style: form
  2204. explode: false
  2205. allowReserved: false
  2206. -
  2207. name: partner
  2208. in: query
  2209. description: ''
  2210. required: false
  2211. deprecated: false
  2212. allowEmptyValue: true
  2213. schema:
  2214. type: string
  2215. style: form
  2216. explode: false
  2217. allowReserved: false
  2218. -
  2219. name: 'partner[]'
  2220. in: query
  2221. description: ''
  2222. required: false
  2223. deprecated: false
  2224. allowEmptyValue: true
  2225. schema:
  2226. type: array
  2227. items:
  2228. type: string
  2229. style: form
  2230. explode: true
  2231. allowReserved: false
  2232. -
  2233. name: contact
  2234. in: query
  2235. description: ''
  2236. required: false
  2237. deprecated: false
  2238. allowEmptyValue: true
  2239. schema:
  2240. type: string
  2241. style: form
  2242. explode: false
  2243. allowReserved: false
  2244. -
  2245. name: 'contact[]'
  2246. in: query
  2247. description: ''
  2248. required: false
  2249. deprecated: false
  2250. allowEmptyValue: true
  2251. schema:
  2252. type: array
  2253. items:
  2254. type: string
  2255. style: form
  2256. explode: true
  2257. allowReserved: false
  2258. deprecated: false
  2259. post:
  2260. operationId: api_tasks_post
  2261. tags:
  2262. - Task
  2263. responses:
  2264. 201:
  2265. description: 'Task resource created'
  2266. content:
  2267. application/ld+json:
  2268. schema:
  2269. $ref: '#/components/schemas/Task.jsonld'
  2270. application/json:
  2271. schema:
  2272. $ref: '#/components/schemas/Task'
  2273. text/html:
  2274. schema:
  2275. $ref: '#/components/schemas/Task'
  2276. application/hal+json:
  2277. schema:
  2278. $ref: '#/components/schemas/Task.jsonhal'
  2279. links: { }
  2280. 400:
  2281. description: 'Invalid input'
  2282. 422:
  2283. description: 'Unprocessable entity'
  2284. summary: 'Creates a Task resource.'
  2285. description: 'Creates a Task resource.'
  2286. parameters: []
  2287. requestBody:
  2288. description: 'The new Task resource'
  2289. content:
  2290. application/ld+json:
  2291. schema:
  2292. $ref: '#/components/schemas/Task.jsonld'
  2293. application/json:
  2294. schema:
  2295. $ref: '#/components/schemas/Task'
  2296. text/html:
  2297. schema:
  2298. $ref: '#/components/schemas/Task'
  2299. application/hal+json:
  2300. schema:
  2301. $ref: '#/components/schemas/Task.jsonhal'
  2302. required: true
  2303. deprecated: false
  2304. parameters: []
  2305. '/api/tasks/{id}':
  2306. get:
  2307. operationId: api_tasks_id_get
  2308. tags:
  2309. - Task
  2310. responses:
  2311. 200:
  2312. description: 'Task resource'
  2313. content:
  2314. application/ld+json:
  2315. schema:
  2316. $ref: '#/components/schemas/Task.jsonld'
  2317. application/json:
  2318. schema:
  2319. $ref: '#/components/schemas/Task'
  2320. text/html:
  2321. schema:
  2322. $ref: '#/components/schemas/Task'
  2323. application/hal+json:
  2324. schema:
  2325. $ref: '#/components/schemas/Task.jsonhal'
  2326. 404:
  2327. description: 'Resource not found'
  2328. summary: 'Retrieves a Task resource.'
  2329. description: 'Retrieves a Task resource.'
  2330. parameters:
  2331. -
  2332. name: id
  2333. in: path
  2334. description: 'TaskApi identifier'
  2335. required: true
  2336. deprecated: false
  2337. allowEmptyValue: false
  2338. schema:
  2339. type: string
  2340. style: simple
  2341. explode: false
  2342. allowReserved: false
  2343. deprecated: false
  2344. delete:
  2345. operationId: api_tasks_id_delete
  2346. tags:
  2347. - Task
  2348. responses:
  2349. 204:
  2350. description: 'Task resource deleted'
  2351. 404:
  2352. description: 'Resource not found'
  2353. summary: 'Removes the Task resource.'
  2354. description: 'Removes the Task resource.'
  2355. parameters:
  2356. -
  2357. name: id
  2358. in: path
  2359. description: 'TaskApi identifier'
  2360. required: true
  2361. deprecated: false
  2362. allowEmptyValue: false
  2363. schema:
  2364. type: string
  2365. style: simple
  2366. explode: false
  2367. allowReserved: false
  2368. deprecated: false
  2369. patch:
  2370. operationId: api_tasks_id_patch
  2371. tags:
  2372. - Task
  2373. responses:
  2374. 200:
  2375. description: 'Task resource updated'
  2376. content:
  2377. application/ld+json:
  2378. schema:
  2379. $ref: '#/components/schemas/Task.jsonld'
  2380. application/json:
  2381. schema:
  2382. $ref: '#/components/schemas/Task'
  2383. text/html:
  2384. schema:
  2385. $ref: '#/components/schemas/Task'
  2386. application/hal+json:
  2387. schema:
  2388. $ref: '#/components/schemas/Task.jsonhal'
  2389. links: { }
  2390. 400:
  2391. description: 'Invalid input'
  2392. 422:
  2393. description: 'Unprocessable entity'
  2394. 404:
  2395. description: 'Resource not found'
  2396. summary: 'Updates the Task resource.'
  2397. description: 'Updates the Task resource.'
  2398. parameters:
  2399. -
  2400. name: id
  2401. in: path
  2402. description: 'TaskApi identifier'
  2403. required: true
  2404. deprecated: false
  2405. allowEmptyValue: false
  2406. schema:
  2407. type: string
  2408. style: simple
  2409. explode: false
  2410. allowReserved: false
  2411. requestBody:
  2412. description: 'The updated Task resource'
  2413. content:
  2414. application/merge-patch+json:
  2415. schema:
  2416. $ref: '#/components/schemas/Task'
  2417. required: true
  2418. deprecated: false
  2419. parameters: []
  2420. /api/users:
  2421. get:
  2422. operationId: api_users_get_collection
  2423. tags:
  2424. - User
  2425. responses:
  2426. 200:
  2427. description: 'User collection'
  2428. content:
  2429. application/ld+json:
  2430. schema:
  2431. type: object
  2432. properties:
  2433. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  2434. 'hydra:totalItems': { type: integer, minimum: 0 }
  2435. '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 } }
  2436. '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 } } } } } }
  2437. required:
  2438. - 'hydra:member'
  2439. application/json:
  2440. schema:
  2441. type: array
  2442. items:
  2443. $ref: '#/components/schemas/User'
  2444. text/html:
  2445. schema:
  2446. type: array
  2447. items:
  2448. $ref: '#/components/schemas/User'
  2449. application/hal+json:
  2450. schema:
  2451. type: object
  2452. properties:
  2453. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  2454. totalItems: { type: integer, minimum: 0 }
  2455. itemsPerPage: { type: integer, minimum: 0 }
  2456. _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 } } } } }
  2457. required:
  2458. - _links
  2459. - _embedded
  2460. summary: 'Retrieves the collection of User resources.'
  2461. description: 'Retrieves the collection of User resources.'
  2462. parameters:
  2463. -
  2464. name: page
  2465. in: query
  2466. description: 'The collection page number'
  2467. required: false
  2468. deprecated: false
  2469. allowEmptyValue: true
  2470. schema:
  2471. type: integer
  2472. default: 1
  2473. style: form
  2474. explode: false
  2475. allowReserved: false
  2476. -
  2477. name: itemsPerPage
  2478. in: query
  2479. description: 'The number of items per page'
  2480. required: false
  2481. deprecated: false
  2482. allowEmptyValue: true
  2483. schema:
  2484. type: integer
  2485. default: 10
  2486. minimum: 0
  2487. maximum: 50
  2488. style: form
  2489. explode: false
  2490. allowReserved: false
  2491. deprecated: false
  2492. post:
  2493. operationId: api_users_post
  2494. tags:
  2495. - User
  2496. responses:
  2497. 201:
  2498. description: 'User resource created'
  2499. content:
  2500. application/ld+json:
  2501. schema:
  2502. $ref: '#/components/schemas/User.jsonld'
  2503. application/json:
  2504. schema:
  2505. $ref: '#/components/schemas/User'
  2506. text/html:
  2507. schema:
  2508. $ref: '#/components/schemas/User'
  2509. application/hal+json:
  2510. schema:
  2511. $ref: '#/components/schemas/User.jsonhal'
  2512. links: { }
  2513. 400:
  2514. description: 'Invalid input'
  2515. 422:
  2516. description: 'Unprocessable entity'
  2517. summary: 'Creates a User resource.'
  2518. description: 'Creates a User resource.'
  2519. parameters: []
  2520. requestBody:
  2521. description: 'The new User resource'
  2522. content:
  2523. application/ld+json:
  2524. schema:
  2525. $ref: '#/components/schemas/User.jsonld'
  2526. application/json:
  2527. schema:
  2528. $ref: '#/components/schemas/User'
  2529. text/html:
  2530. schema:
  2531. $ref: '#/components/schemas/User'
  2532. application/hal+json:
  2533. schema:
  2534. $ref: '#/components/schemas/User.jsonhal'
  2535. required: true
  2536. deprecated: false
  2537. parameters: []
  2538. '/api/users/{id}':
  2539. get:
  2540. operationId: api_users_id_get
  2541. tags:
  2542. - User
  2543. responses:
  2544. 200:
  2545. description: 'User resource'
  2546. content:
  2547. application/ld+json:
  2548. schema:
  2549. $ref: '#/components/schemas/User.jsonld'
  2550. application/json:
  2551. schema:
  2552. $ref: '#/components/schemas/User'
  2553. text/html:
  2554. schema:
  2555. $ref: '#/components/schemas/User'
  2556. application/hal+json:
  2557. schema:
  2558. $ref: '#/components/schemas/User.jsonhal'
  2559. 404:
  2560. description: 'Resource not found'
  2561. summary: 'Retrieves a User resource.'
  2562. description: 'Retrieves a User resource.'
  2563. parameters:
  2564. -
  2565. name: id
  2566. in: path
  2567. description: 'UserApi identifier'
  2568. required: true
  2569. deprecated: false
  2570. allowEmptyValue: false
  2571. schema:
  2572. type: string
  2573. style: simple
  2574. explode: false
  2575. allowReserved: false
  2576. deprecated: false
  2577. patch:
  2578. operationId: api_users_id_patch
  2579. tags:
  2580. - User
  2581. responses:
  2582. 200:
  2583. description: 'User resource updated'
  2584. content:
  2585. application/ld+json:
  2586. schema:
  2587. $ref: '#/components/schemas/User.jsonld'
  2588. application/json:
  2589. schema:
  2590. $ref: '#/components/schemas/User'
  2591. text/html:
  2592. schema:
  2593. $ref: '#/components/schemas/User'
  2594. application/hal+json:
  2595. schema:
  2596. $ref: '#/components/schemas/User.jsonhal'
  2597. links: { }
  2598. 400:
  2599. description: 'Invalid input'
  2600. 422:
  2601. description: 'Unprocessable entity'
  2602. 404:
  2603. description: 'Resource not found'
  2604. summary: 'Updates the User resource.'
  2605. description: 'Updates the User resource.'
  2606. parameters:
  2607. -
  2608. name: id
  2609. in: path
  2610. description: 'UserApi identifier'
  2611. required: true
  2612. deprecated: false
  2613. allowEmptyValue: false
  2614. schema:
  2615. type: string
  2616. style: simple
  2617. explode: false
  2618. allowReserved: false
  2619. requestBody:
  2620. description: 'The updated User resource'
  2621. content:
  2622. application/merge-patch+json:
  2623. schema:
  2624. $ref: '#/components/schemas/User'
  2625. required: true
  2626. deprecated: false
  2627. parameters: []
  2628. /auth:
  2629. post:
  2630. operationId: login_check_post
  2631. tags:
  2632. - 'Login Check'
  2633. responses:
  2634. 200:
  2635. description: 'User token created'
  2636. content:
  2637. application/json:
  2638. schema:
  2639. type: object
  2640. properties:
  2641. token: { readOnly: true, type: string, nullable: false }
  2642. required:
  2643. - token
  2644. summary: 'Creates a user token.'
  2645. description: 'Creates a user token.'
  2646. requestBody:
  2647. description: 'The login data'
  2648. content:
  2649. application/json:
  2650. schema:
  2651. type: object
  2652. properties:
  2653. email:
  2654. type: string
  2655. nullable: false
  2656. password:
  2657. type: string
  2658. nullable: false
  2659. required:
  2660. - email
  2661. - password
  2662. required: true
  2663. parameters: []
  2664. components:
  2665. schemas:
  2666. Comment:
  2667. type: object
  2668. description: ''
  2669. deprecated: false
  2670. required:
  2671. - message
  2672. properties:
  2673. message:
  2674. type:
  2675. - string
  2676. - 'null'
  2677. owner:
  2678. readOnly: true
  2679. 'owl:maxCardinality': 1
  2680. type:
  2681. - string
  2682. - 'null'
  2683. format: iri-reference
  2684. example: 'https://example.com/'
  2685. ownerName:
  2686. readOnly: true
  2687. type:
  2688. - string
  2689. - 'null'
  2690. post:
  2691. 'owl:maxCardinality': 1
  2692. type:
  2693. - string
  2694. - 'null'
  2695. format: iri-reference
  2696. example: 'https://example.com/'
  2697. createdAt:
  2698. readOnly: true
  2699. type:
  2700. - string
  2701. - 'null'
  2702. format: date-time
  2703. Comment.jsonhal:
  2704. type: object
  2705. description: ''
  2706. deprecated: false
  2707. required:
  2708. - message
  2709. properties:
  2710. _links:
  2711. type: object
  2712. properties:
  2713. self:
  2714. type: object
  2715. properties:
  2716. href:
  2717. type: string
  2718. format: iri-reference
  2719. message:
  2720. type:
  2721. - string
  2722. - 'null'
  2723. owner:
  2724. readOnly: true
  2725. 'owl:maxCardinality': 1
  2726. type:
  2727. - string
  2728. - 'null'
  2729. format: iri-reference
  2730. example: 'https://example.com/'
  2731. ownerName:
  2732. readOnly: true
  2733. type:
  2734. - string
  2735. - 'null'
  2736. post:
  2737. 'owl:maxCardinality': 1
  2738. type:
  2739. - string
  2740. - 'null'
  2741. format: iri-reference
  2742. example: 'https://example.com/'
  2743. createdAt:
  2744. readOnly: true
  2745. type:
  2746. - string
  2747. - 'null'
  2748. format: date-time
  2749. Comment.jsonld:
  2750. type: object
  2751. description: ''
  2752. deprecated: false
  2753. required:
  2754. - message
  2755. properties:
  2756. '@context':
  2757. readOnly: true
  2758. oneOf:
  2759. -
  2760. type: string
  2761. -
  2762. type: object
  2763. properties:
  2764. '@vocab':
  2765. type: string
  2766. hydra:
  2767. type: string
  2768. enum: ['http://www.w3.org/ns/hydra/core#']
  2769. required:
  2770. - '@vocab'
  2771. - hydra
  2772. additionalProperties: true
  2773. '@id':
  2774. readOnly: true
  2775. type: string
  2776. '@type':
  2777. readOnly: true
  2778. type: string
  2779. message:
  2780. type:
  2781. - string
  2782. - 'null'
  2783. owner:
  2784. readOnly: true
  2785. 'owl:maxCardinality': 1
  2786. type:
  2787. - string
  2788. - 'null'
  2789. format: iri-reference
  2790. example: 'https://example.com/'
  2791. ownerName:
  2792. readOnly: true
  2793. type:
  2794. - string
  2795. - 'null'
  2796. post:
  2797. 'owl:maxCardinality': 1
  2798. type:
  2799. - string
  2800. - 'null'
  2801. format: iri-reference
  2802. example: 'https://example.com/'
  2803. createdAt:
  2804. readOnly: true
  2805. type:
  2806. - string
  2807. - 'null'
  2808. format: date-time
  2809. Contact:
  2810. type: object
  2811. description: ''
  2812. deprecated: false
  2813. required:
  2814. - firstName
  2815. - lastName
  2816. - partner
  2817. properties:
  2818. firstName:
  2819. type:
  2820. - string
  2821. - 'null'
  2822. lastName:
  2823. type:
  2824. - string
  2825. - 'null'
  2826. partner:
  2827. 'owl:maxCardinality': 1
  2828. type:
  2829. - string
  2830. - 'null'
  2831. format: iri-reference
  2832. example: 'https://example.com/'
  2833. birthday:
  2834. type:
  2835. - string
  2836. - 'null'
  2837. format: date-time
  2838. image:
  2839. 'owl:maxCardinality': 1
  2840. type:
  2841. - string
  2842. - 'null'
  2843. format: iri-reference
  2844. example: 'https://example.com/'
  2845. imageUrl:
  2846. readOnly: true
  2847. type:
  2848. - string
  2849. - 'null'
  2850. position:
  2851. type:
  2852. - string
  2853. - 'null'
  2854. phone:
  2855. type:
  2856. - string
  2857. - 'null'
  2858. email:
  2859. format: email
  2860. externalDocs:
  2861. url: 'https://schema.org/email'
  2862. type:
  2863. - string
  2864. - 'null'
  2865. posts:
  2866. readOnly: true
  2867. type: array
  2868. items:
  2869. type: string
  2870. format: iri-reference
  2871. example: 'https://example.com/'
  2872. createdAt:
  2873. readOnly: true
  2874. type:
  2875. - string
  2876. - 'null'
  2877. format: date-time
  2878. Contact.jsonhal:
  2879. type: object
  2880. description: ''
  2881. deprecated: false
  2882. required:
  2883. - firstName
  2884. - lastName
  2885. - partner
  2886. properties:
  2887. _links:
  2888. type: object
  2889. properties:
  2890. self:
  2891. type: object
  2892. properties:
  2893. href:
  2894. type: string
  2895. format: iri-reference
  2896. firstName:
  2897. type:
  2898. - string
  2899. - 'null'
  2900. lastName:
  2901. type:
  2902. - string
  2903. - 'null'
  2904. partner:
  2905. 'owl:maxCardinality': 1
  2906. type:
  2907. - string
  2908. - 'null'
  2909. format: iri-reference
  2910. example: 'https://example.com/'
  2911. birthday:
  2912. type:
  2913. - string
  2914. - 'null'
  2915. format: date-time
  2916. image:
  2917. 'owl:maxCardinality': 1
  2918. type:
  2919. - string
  2920. - 'null'
  2921. format: iri-reference
  2922. example: 'https://example.com/'
  2923. imageUrl:
  2924. readOnly: true
  2925. type:
  2926. - string
  2927. - 'null'
  2928. position:
  2929. type:
  2930. - string
  2931. - 'null'
  2932. phone:
  2933. type:
  2934. - string
  2935. - 'null'
  2936. email:
  2937. format: email
  2938. externalDocs:
  2939. url: 'https://schema.org/email'
  2940. type:
  2941. - string
  2942. - 'null'
  2943. posts:
  2944. readOnly: true
  2945. type: array
  2946. items:
  2947. type: string
  2948. format: iri-reference
  2949. example: 'https://example.com/'
  2950. createdAt:
  2951. readOnly: true
  2952. type:
  2953. - string
  2954. - 'null'
  2955. format: date-time
  2956. Contact.jsonld:
  2957. type: object
  2958. description: ''
  2959. deprecated: false
  2960. required:
  2961. - firstName
  2962. - lastName
  2963. - partner
  2964. properties:
  2965. '@context':
  2966. readOnly: true
  2967. oneOf:
  2968. -
  2969. type: string
  2970. -
  2971. type: object
  2972. properties:
  2973. '@vocab':
  2974. type: string
  2975. hydra:
  2976. type: string
  2977. enum: ['http://www.w3.org/ns/hydra/core#']
  2978. required:
  2979. - '@vocab'
  2980. - hydra
  2981. additionalProperties: true
  2982. '@id':
  2983. readOnly: true
  2984. type: string
  2985. '@type':
  2986. readOnly: true
  2987. type: string
  2988. firstName:
  2989. type:
  2990. - string
  2991. - 'null'
  2992. lastName:
  2993. type:
  2994. - string
  2995. - 'null'
  2996. partner:
  2997. 'owl:maxCardinality': 1
  2998. type:
  2999. - string
  3000. - 'null'
  3001. format: iri-reference
  3002. example: 'https://example.com/'
  3003. birthday:
  3004. type:
  3005. - string
  3006. - 'null'
  3007. format: date-time
  3008. image:
  3009. 'owl:maxCardinality': 1
  3010. type:
  3011. - string
  3012. - 'null'
  3013. format: iri-reference
  3014. example: 'https://example.com/'
  3015. imageUrl:
  3016. readOnly: true
  3017. type:
  3018. - string
  3019. - 'null'
  3020. position:
  3021. type:
  3022. - string
  3023. - 'null'
  3024. phone:
  3025. type:
  3026. - string
  3027. - 'null'
  3028. email:
  3029. format: email
  3030. externalDocs:
  3031. url: 'https://schema.org/email'
  3032. type:
  3033. - string
  3034. - 'null'
  3035. posts:
  3036. readOnly: true
  3037. type: array
  3038. items:
  3039. type: string
  3040. format: iri-reference
  3041. example: 'https://example.com/'
  3042. createdAt:
  3043. readOnly: true
  3044. type:
  3045. - string
  3046. - 'null'
  3047. format: date-time
  3048. Media-media_object.read:
  3049. type: object
  3050. description: ''
  3051. deprecated: false
  3052. externalDocs:
  3053. url: 'https://schema.org/MediaObject'
  3054. properties:
  3055. contentUrl:
  3056. externalDocs:
  3057. url: 'https://schema.org/contentUrl'
  3058. type:
  3059. - string
  3060. - 'null'
  3061. Media.jsonhal-media_object.read:
  3062. type: object
  3063. description: ''
  3064. deprecated: false
  3065. externalDocs:
  3066. url: 'https://schema.org/MediaObject'
  3067. properties:
  3068. _links:
  3069. type: object
  3070. properties:
  3071. self:
  3072. type: object
  3073. properties:
  3074. href:
  3075. type: string
  3076. format: iri-reference
  3077. contentUrl:
  3078. externalDocs:
  3079. url: 'https://schema.org/contentUrl'
  3080. type:
  3081. - string
  3082. - 'null'
  3083. Media.jsonld-media_object.read:
  3084. type: object
  3085. description: ''
  3086. deprecated: false
  3087. externalDocs:
  3088. url: 'https://schema.org/MediaObject'
  3089. properties:
  3090. '@context':
  3091. readOnly: true
  3092. oneOf:
  3093. -
  3094. type: string
  3095. -
  3096. type: object
  3097. properties:
  3098. '@vocab':
  3099. type: string
  3100. hydra:
  3101. type: string
  3102. enum: ['http://www.w3.org/ns/hydra/core#']
  3103. required:
  3104. - '@vocab'
  3105. - hydra
  3106. additionalProperties: true
  3107. '@id':
  3108. readOnly: true
  3109. type: string
  3110. '@type':
  3111. readOnly: true
  3112. type: string
  3113. contentUrl:
  3114. externalDocs:
  3115. url: 'https://schema.org/contentUrl'
  3116. type:
  3117. - string
  3118. - 'null'
  3119. Partner:
  3120. type: object
  3121. description: ''
  3122. deprecated: false
  3123. required:
  3124. - name
  3125. - partnerType
  3126. properties:
  3127. name:
  3128. type: string
  3129. partnerType:
  3130. type: string
  3131. enum:
  3132. - customer
  3133. - supplier
  3134. - service
  3135. street:
  3136. type:
  3137. - string
  3138. - 'null'
  3139. streetNo:
  3140. type:
  3141. - string
  3142. - 'null'
  3143. zip:
  3144. type:
  3145. - string
  3146. - 'null'
  3147. city:
  3148. type:
  3149. - string
  3150. - 'null'
  3151. country:
  3152. type:
  3153. - string
  3154. - 'null'
  3155. website:
  3156. type:
  3157. - string
  3158. - 'null'
  3159. logo:
  3160. 'owl:maxCardinality': 1
  3161. type:
  3162. - string
  3163. - 'null'
  3164. format: iri-reference
  3165. example: 'https://example.com/'
  3166. logoUrl:
  3167. readOnly: true
  3168. type:
  3169. - string
  3170. - 'null'
  3171. createdAt:
  3172. readOnly: true
  3173. type:
  3174. - string
  3175. - 'null'
  3176. format: date-time
  3177. posts:
  3178. readOnly: true
  3179. description: 'array<int, PostingApi>'
  3180. type: array
  3181. items:
  3182. type: string
  3183. contacts:
  3184. readOnly: true
  3185. type: array
  3186. items:
  3187. type: string
  3188. format: iri-reference
  3189. example: 'https://example.com/'
  3190. Partner.jsonhal:
  3191. type: object
  3192. description: ''
  3193. deprecated: false
  3194. required:
  3195. - name
  3196. - partnerType
  3197. properties:
  3198. _links:
  3199. type: object
  3200. properties:
  3201. self:
  3202. type: object
  3203. properties:
  3204. href:
  3205. type: string
  3206. format: iri-reference
  3207. name:
  3208. type: string
  3209. partnerType:
  3210. type: string
  3211. enum:
  3212. - customer
  3213. - supplier
  3214. - service
  3215. street:
  3216. type:
  3217. - string
  3218. - 'null'
  3219. streetNo:
  3220. type:
  3221. - string
  3222. - 'null'
  3223. zip:
  3224. type:
  3225. - string
  3226. - 'null'
  3227. city:
  3228. type:
  3229. - string
  3230. - 'null'
  3231. country:
  3232. type:
  3233. - string
  3234. - 'null'
  3235. website:
  3236. type:
  3237. - string
  3238. - 'null'
  3239. logo:
  3240. 'owl:maxCardinality': 1
  3241. type:
  3242. - string
  3243. - 'null'
  3244. format: iri-reference
  3245. example: 'https://example.com/'
  3246. logoUrl:
  3247. readOnly: true
  3248. type:
  3249. - string
  3250. - 'null'
  3251. createdAt:
  3252. readOnly: true
  3253. type:
  3254. - string
  3255. - 'null'
  3256. format: date-time
  3257. posts:
  3258. readOnly: true
  3259. description: 'array<int, PostingApi>'
  3260. type: array
  3261. items:
  3262. type: string
  3263. contacts:
  3264. readOnly: true
  3265. type: array
  3266. items:
  3267. type: string
  3268. format: iri-reference
  3269. example: 'https://example.com/'
  3270. Partner.jsonld:
  3271. type: object
  3272. description: ''
  3273. deprecated: false
  3274. required:
  3275. - name
  3276. - partnerType
  3277. properties:
  3278. '@context':
  3279. readOnly: true
  3280. oneOf:
  3281. -
  3282. type: string
  3283. -
  3284. type: object
  3285. properties:
  3286. '@vocab':
  3287. type: string
  3288. hydra:
  3289. type: string
  3290. enum: ['http://www.w3.org/ns/hydra/core#']
  3291. required:
  3292. - '@vocab'
  3293. - hydra
  3294. additionalProperties: true
  3295. '@id':
  3296. readOnly: true
  3297. type: string
  3298. '@type':
  3299. readOnly: true
  3300. type: string
  3301. name:
  3302. type: string
  3303. partnerType:
  3304. type: string
  3305. enum:
  3306. - customer
  3307. - supplier
  3308. - service
  3309. street:
  3310. type:
  3311. - string
  3312. - 'null'
  3313. streetNo:
  3314. type:
  3315. - string
  3316. - 'null'
  3317. zip:
  3318. type:
  3319. - string
  3320. - 'null'
  3321. city:
  3322. type:
  3323. - string
  3324. - 'null'
  3325. country:
  3326. type:
  3327. - string
  3328. - 'null'
  3329. website:
  3330. type:
  3331. - string
  3332. - 'null'
  3333. logo:
  3334. 'owl:maxCardinality': 1
  3335. type:
  3336. - string
  3337. - 'null'
  3338. format: iri-reference
  3339. example: 'https://example.com/'
  3340. logoUrl:
  3341. readOnly: true
  3342. type:
  3343. - string
  3344. - 'null'
  3345. createdAt:
  3346. readOnly: true
  3347. type:
  3348. - string
  3349. - 'null'
  3350. format: date-time
  3351. posts:
  3352. readOnly: true
  3353. description: 'array<int, PostingApi>'
  3354. type: array
  3355. items:
  3356. type: string
  3357. contacts:
  3358. readOnly: true
  3359. type: array
  3360. items:
  3361. type: string
  3362. format: iri-reference
  3363. example: 'https://example.com/'
  3364. Post:
  3365. type: object
  3366. description: ''
  3367. deprecated: false
  3368. required:
  3369. - headline
  3370. - message
  3371. properties:
  3372. headline:
  3373. type:
  3374. - string
  3375. - 'null'
  3376. message:
  3377. type:
  3378. - string
  3379. - 'null'
  3380. owner:
  3381. readOnly: true
  3382. 'owl:maxCardinality': 1
  3383. type:
  3384. - string
  3385. - 'null'
  3386. format: iri-reference
  3387. example: 'https://example.com/'
  3388. ownerName:
  3389. readOnly: true
  3390. type:
  3391. - string
  3392. - 'null'
  3393. partner:
  3394. 'owl:maxCardinality': 1
  3395. type:
  3396. - string
  3397. - 'null'
  3398. format: iri-reference
  3399. example: 'https://example.com/'
  3400. contact:
  3401. 'owl:maxCardinality': 1
  3402. type:
  3403. - string
  3404. - 'null'
  3405. format: iri-reference
  3406. example: 'https://example.com/'
  3407. sale:
  3408. 'owl:maxCardinality': 1
  3409. type:
  3410. - string
  3411. - 'null'
  3412. format: iri-reference
  3413. example: 'https://example.com/'
  3414. comments:
  3415. description: 'array<int, CommentApi>'
  3416. type: array
  3417. items:
  3418. $ref: '#/components/schemas/Comment'
  3419. createdAt:
  3420. readOnly: true
  3421. type:
  3422. - string
  3423. - 'null'
  3424. format: date-time
  3425. Post-posting.create:
  3426. type: object
  3427. description: ''
  3428. deprecated: false
  3429. required:
  3430. - headline
  3431. - message
  3432. properties:
  3433. headline:
  3434. type:
  3435. - string
  3436. - 'null'
  3437. message:
  3438. type:
  3439. - string
  3440. - 'null'
  3441. partner:
  3442. 'owl:maxCardinality': 1
  3443. type:
  3444. - string
  3445. - 'null'
  3446. format: iri-reference
  3447. example: 'https://example.com/'
  3448. contact:
  3449. 'owl:maxCardinality': 1
  3450. type:
  3451. - string
  3452. - 'null'
  3453. format: iri-reference
  3454. example: 'https://example.com/'
  3455. sale:
  3456. 'owl:maxCardinality': 1
  3457. type:
  3458. - string
  3459. - 'null'
  3460. format: iri-reference
  3461. example: 'https://example.com/'
  3462. Post-posting.patch:
  3463. type: object
  3464. description: ''
  3465. deprecated: false
  3466. required:
  3467. - headline
  3468. - message
  3469. properties:
  3470. headline:
  3471. type:
  3472. - string
  3473. - 'null'
  3474. message:
  3475. type:
  3476. - string
  3477. - 'null'
  3478. Post.jsonhal:
  3479. type: object
  3480. description: ''
  3481. deprecated: false
  3482. required:
  3483. - headline
  3484. - message
  3485. properties:
  3486. _links:
  3487. type: object
  3488. properties:
  3489. self:
  3490. type: object
  3491. properties:
  3492. href:
  3493. type: string
  3494. format: iri-reference
  3495. headline:
  3496. type:
  3497. - string
  3498. - 'null'
  3499. message:
  3500. type:
  3501. - string
  3502. - 'null'
  3503. owner:
  3504. readOnly: true
  3505. 'owl:maxCardinality': 1
  3506. type:
  3507. - string
  3508. - 'null'
  3509. format: iri-reference
  3510. example: 'https://example.com/'
  3511. ownerName:
  3512. readOnly: true
  3513. type:
  3514. - string
  3515. - 'null'
  3516. partner:
  3517. 'owl:maxCardinality': 1
  3518. type:
  3519. - string
  3520. - 'null'
  3521. format: iri-reference
  3522. example: 'https://example.com/'
  3523. contact:
  3524. 'owl:maxCardinality': 1
  3525. type:
  3526. - string
  3527. - 'null'
  3528. format: iri-reference
  3529. example: 'https://example.com/'
  3530. sale:
  3531. 'owl:maxCardinality': 1
  3532. type:
  3533. - string
  3534. - 'null'
  3535. format: iri-reference
  3536. example: 'https://example.com/'
  3537. comments:
  3538. description: 'array<int, CommentApi>'
  3539. type: array
  3540. items:
  3541. $ref: '#/components/schemas/Comment.jsonhal'
  3542. createdAt:
  3543. readOnly: true
  3544. type:
  3545. - string
  3546. - 'null'
  3547. format: date-time
  3548. Post.jsonhal-posting.create:
  3549. type: object
  3550. description: ''
  3551. deprecated: false
  3552. required:
  3553. - headline
  3554. - message
  3555. properties:
  3556. _links:
  3557. type: object
  3558. properties:
  3559. self:
  3560. type: object
  3561. properties:
  3562. href:
  3563. type: string
  3564. format: iri-reference
  3565. headline:
  3566. type:
  3567. - string
  3568. - 'null'
  3569. message:
  3570. type:
  3571. - string
  3572. - 'null'
  3573. partner:
  3574. 'owl:maxCardinality': 1
  3575. type:
  3576. - string
  3577. - 'null'
  3578. format: iri-reference
  3579. example: 'https://example.com/'
  3580. contact:
  3581. 'owl:maxCardinality': 1
  3582. type:
  3583. - string
  3584. - 'null'
  3585. format: iri-reference
  3586. example: 'https://example.com/'
  3587. sale:
  3588. 'owl:maxCardinality': 1
  3589. type:
  3590. - string
  3591. - 'null'
  3592. format: iri-reference
  3593. example: 'https://example.com/'
  3594. Post.jsonld:
  3595. type: object
  3596. description: ''
  3597. deprecated: false
  3598. required:
  3599. - headline
  3600. - message
  3601. properties:
  3602. '@context':
  3603. readOnly: true
  3604. oneOf:
  3605. -
  3606. type: string
  3607. -
  3608. type: object
  3609. properties:
  3610. '@vocab':
  3611. type: string
  3612. hydra:
  3613. type: string
  3614. enum: ['http://www.w3.org/ns/hydra/core#']
  3615. required:
  3616. - '@vocab'
  3617. - hydra
  3618. additionalProperties: true
  3619. '@id':
  3620. readOnly: true
  3621. type: string
  3622. '@type':
  3623. readOnly: true
  3624. type: string
  3625. headline:
  3626. type:
  3627. - string
  3628. - 'null'
  3629. message:
  3630. type:
  3631. - string
  3632. - 'null'
  3633. owner:
  3634. readOnly: true
  3635. 'owl:maxCardinality': 1
  3636. type:
  3637. - string
  3638. - 'null'
  3639. format: iri-reference
  3640. example: 'https://example.com/'
  3641. ownerName:
  3642. readOnly: true
  3643. type:
  3644. - string
  3645. - 'null'
  3646. partner:
  3647. 'owl:maxCardinality': 1
  3648. type:
  3649. - string
  3650. - 'null'
  3651. format: iri-reference
  3652. example: 'https://example.com/'
  3653. contact:
  3654. 'owl:maxCardinality': 1
  3655. type:
  3656. - string
  3657. - 'null'
  3658. format: iri-reference
  3659. example: 'https://example.com/'
  3660. sale:
  3661. 'owl:maxCardinality': 1
  3662. type:
  3663. - string
  3664. - 'null'
  3665. format: iri-reference
  3666. example: 'https://example.com/'
  3667. comments:
  3668. description: 'array<int, CommentApi>'
  3669. type: array
  3670. items:
  3671. $ref: '#/components/schemas/Comment.jsonld'
  3672. createdAt:
  3673. readOnly: true
  3674. type:
  3675. - string
  3676. - 'null'
  3677. format: date-time
  3678. Post.jsonld-posting.create:
  3679. type: object
  3680. description: ''
  3681. deprecated: false
  3682. required:
  3683. - headline
  3684. - message
  3685. properties:
  3686. headline:
  3687. type:
  3688. - string
  3689. - 'null'
  3690. message:
  3691. type:
  3692. - string
  3693. - 'null'
  3694. partner:
  3695. 'owl:maxCardinality': 1
  3696. type:
  3697. - string
  3698. - 'null'
  3699. format: iri-reference
  3700. example: 'https://example.com/'
  3701. contact:
  3702. 'owl:maxCardinality': 1
  3703. type:
  3704. - string
  3705. - 'null'
  3706. format: iri-reference
  3707. example: 'https://example.com/'
  3708. sale:
  3709. 'owl:maxCardinality': 1
  3710. type:
  3711. - string
  3712. - 'null'
  3713. format: iri-reference
  3714. example: 'https://example.com/'
  3715. Product:
  3716. type: object
  3717. description: ''
  3718. deprecated: false
  3719. required:
  3720. - name
  3721. properties:
  3722. name:
  3723. type: string
  3724. description:
  3725. type:
  3726. - string
  3727. - 'null'
  3728. image:
  3729. 'owl:maxCardinality': 1
  3730. type:
  3731. - string
  3732. - 'null'
  3733. format: iri-reference
  3734. example: 'https://example.com/'
  3735. imageUrl:
  3736. readOnly: true
  3737. type:
  3738. - string
  3739. - 'null'
  3740. createdAt:
  3741. type:
  3742. - string
  3743. - 'null'
  3744. format: date-time
  3745. Product.jsonhal:
  3746. type: object
  3747. description: ''
  3748. deprecated: false
  3749. required:
  3750. - name
  3751. properties:
  3752. _links:
  3753. type: object
  3754. properties:
  3755. self:
  3756. type: object
  3757. properties:
  3758. href:
  3759. type: string
  3760. format: iri-reference
  3761. name:
  3762. type: string
  3763. description:
  3764. type:
  3765. - string
  3766. - 'null'
  3767. image:
  3768. 'owl:maxCardinality': 1
  3769. type:
  3770. - string
  3771. - 'null'
  3772. format: iri-reference
  3773. example: 'https://example.com/'
  3774. imageUrl:
  3775. readOnly: true
  3776. type:
  3777. - string
  3778. - 'null'
  3779. createdAt:
  3780. type:
  3781. - string
  3782. - 'null'
  3783. format: date-time
  3784. Product.jsonld:
  3785. type: object
  3786. description: ''
  3787. deprecated: false
  3788. required:
  3789. - name
  3790. properties:
  3791. '@context':
  3792. readOnly: true
  3793. oneOf:
  3794. -
  3795. type: string
  3796. -
  3797. type: object
  3798. properties:
  3799. '@vocab':
  3800. type: string
  3801. hydra:
  3802. type: string
  3803. enum: ['http://www.w3.org/ns/hydra/core#']
  3804. required:
  3805. - '@vocab'
  3806. - hydra
  3807. additionalProperties: true
  3808. '@id':
  3809. readOnly: true
  3810. type: string
  3811. '@type':
  3812. readOnly: true
  3813. type: string
  3814. name:
  3815. type: string
  3816. description:
  3817. type:
  3818. - string
  3819. - 'null'
  3820. image:
  3821. 'owl:maxCardinality': 1
  3822. type:
  3823. - string
  3824. - 'null'
  3825. format: iri-reference
  3826. example: 'https://example.com/'
  3827. imageUrl:
  3828. readOnly: true
  3829. type:
  3830. - string
  3831. - 'null'
  3832. createdAt:
  3833. type:
  3834. - string
  3835. - 'null'
  3836. format: date-time
  3837. Sale:
  3838. type: object
  3839. description: ''
  3840. deprecated: false
  3841. properties:
  3842. owner:
  3843. readOnly: true
  3844. 'owl:maxCardinality': 1
  3845. type:
  3846. - string
  3847. - 'null'
  3848. format: iri-reference
  3849. example: 'https://example.com/'
  3850. ownerName:
  3851. readOnly: true
  3852. type:
  3853. - string
  3854. - 'null'
  3855. partner:
  3856. 'owl:maxCardinality': 1
  3857. type:
  3858. - string
  3859. - 'null'
  3860. format: iri-reference
  3861. example: 'https://example.com/'
  3862. partnerName:
  3863. readOnly: true
  3864. type:
  3865. - string
  3866. - 'null'
  3867. product:
  3868. 'owl:maxCardinality': 1
  3869. type:
  3870. - string
  3871. - 'null'
  3872. format: iri-reference
  3873. example: 'https://example.com/'
  3874. productName:
  3875. readOnly: true
  3876. type:
  3877. - string
  3878. - 'null'
  3879. turnover:
  3880. type:
  3881. - integer
  3882. - 'null'
  3883. profit:
  3884. type:
  3885. - integer
  3886. - 'null'
  3887. comment:
  3888. type:
  3889. - string
  3890. - 'null'
  3891. createdAt:
  3892. readOnly: true
  3893. type:
  3894. - string
  3895. - 'null'
  3896. format: date-time
  3897. posts:
  3898. readOnly: true
  3899. description: 'array<int, PostingApi>'
  3900. type: array
  3901. items:
  3902. type: string
  3903. required:
  3904. - turnover
  3905. Sale.jsonhal:
  3906. type: object
  3907. description: ''
  3908. deprecated: false
  3909. properties:
  3910. _links:
  3911. type: object
  3912. properties:
  3913. self:
  3914. type: object
  3915. properties:
  3916. href:
  3917. type: string
  3918. format: iri-reference
  3919. owner:
  3920. readOnly: true
  3921. 'owl:maxCardinality': 1
  3922. type:
  3923. - string
  3924. - 'null'
  3925. format: iri-reference
  3926. example: 'https://example.com/'
  3927. ownerName:
  3928. readOnly: true
  3929. type:
  3930. - string
  3931. - 'null'
  3932. partner:
  3933. 'owl:maxCardinality': 1
  3934. type:
  3935. - string
  3936. - 'null'
  3937. format: iri-reference
  3938. example: 'https://example.com/'
  3939. partnerName:
  3940. readOnly: true
  3941. type:
  3942. - string
  3943. - 'null'
  3944. product:
  3945. 'owl:maxCardinality': 1
  3946. type:
  3947. - string
  3948. - 'null'
  3949. format: iri-reference
  3950. example: 'https://example.com/'
  3951. productName:
  3952. readOnly: true
  3953. type:
  3954. - string
  3955. - 'null'
  3956. turnover:
  3957. type:
  3958. - integer
  3959. - 'null'
  3960. profit:
  3961. type:
  3962. - integer
  3963. - 'null'
  3964. comment:
  3965. type:
  3966. - string
  3967. - 'null'
  3968. createdAt:
  3969. readOnly: true
  3970. type:
  3971. - string
  3972. - 'null'
  3973. format: date-time
  3974. posts:
  3975. readOnly: true
  3976. description: 'array<int, PostingApi>'
  3977. type: array
  3978. items:
  3979. type: string
  3980. required:
  3981. - turnover
  3982. Sale.jsonld:
  3983. type: object
  3984. description: ''
  3985. deprecated: false
  3986. properties:
  3987. '@context':
  3988. readOnly: true
  3989. oneOf:
  3990. -
  3991. type: string
  3992. -
  3993. type: object
  3994. properties:
  3995. '@vocab':
  3996. type: string
  3997. hydra:
  3998. type: string
  3999. enum: ['http://www.w3.org/ns/hydra/core#']
  4000. required:
  4001. - '@vocab'
  4002. - hydra
  4003. additionalProperties: true
  4004. '@id':
  4005. readOnly: true
  4006. type: string
  4007. '@type':
  4008. readOnly: true
  4009. type: string
  4010. owner:
  4011. readOnly: true
  4012. 'owl:maxCardinality': 1
  4013. type:
  4014. - string
  4015. - 'null'
  4016. format: iri-reference
  4017. example: 'https://example.com/'
  4018. ownerName:
  4019. readOnly: true
  4020. type:
  4021. - string
  4022. - 'null'
  4023. partner:
  4024. 'owl:maxCardinality': 1
  4025. type:
  4026. - string
  4027. - 'null'
  4028. format: iri-reference
  4029. example: 'https://example.com/'
  4030. partnerName:
  4031. readOnly: true
  4032. type:
  4033. - string
  4034. - 'null'
  4035. product:
  4036. 'owl:maxCardinality': 1
  4037. type:
  4038. - string
  4039. - 'null'
  4040. format: iri-reference
  4041. example: 'https://example.com/'
  4042. productName:
  4043. readOnly: true
  4044. type:
  4045. - string
  4046. - 'null'
  4047. turnover:
  4048. type:
  4049. - integer
  4050. - 'null'
  4051. profit:
  4052. type:
  4053. - integer
  4054. - 'null'
  4055. comment:
  4056. type:
  4057. - string
  4058. - 'null'
  4059. createdAt:
  4060. readOnly: true
  4061. type:
  4062. - string
  4063. - 'null'
  4064. format: date-time
  4065. posts:
  4066. readOnly: true
  4067. description: 'array<int, PostingApi>'
  4068. type: array
  4069. items:
  4070. type: string
  4071. required:
  4072. - turnover
  4073. SaleSummary:
  4074. type: object
  4075. description: ''
  4076. deprecated: false
  4077. properties:
  4078. owner:
  4079. 'owl:maxCardinality': 1
  4080. type:
  4081. - string
  4082. - 'null'
  4083. format: iri-reference
  4084. example: 'https://example.com/'
  4085. ownerName:
  4086. type:
  4087. - string
  4088. - 'null'
  4089. turnover:
  4090. type:
  4091. - integer
  4092. - 'null'
  4093. profit:
  4094. type:
  4095. - integer
  4096. - 'null'
  4097. SaleSummary.jsonhal:
  4098. type: object
  4099. description: ''
  4100. deprecated: false
  4101. properties:
  4102. _links:
  4103. type: object
  4104. properties:
  4105. self:
  4106. type: object
  4107. properties:
  4108. href:
  4109. type: string
  4110. format: iri-reference
  4111. owner:
  4112. 'owl:maxCardinality': 1
  4113. type:
  4114. - string
  4115. - 'null'
  4116. format: iri-reference
  4117. example: 'https://example.com/'
  4118. ownerName:
  4119. type:
  4120. - string
  4121. - 'null'
  4122. turnover:
  4123. type:
  4124. - integer
  4125. - 'null'
  4126. profit:
  4127. type:
  4128. - integer
  4129. - 'null'
  4130. SaleSummary.jsonld:
  4131. type: object
  4132. description: ''
  4133. deprecated: false
  4134. properties:
  4135. '@id':
  4136. readOnly: true
  4137. type: string
  4138. '@type':
  4139. readOnly: true
  4140. type: string
  4141. owner:
  4142. 'owl:maxCardinality': 1
  4143. type:
  4144. - string
  4145. - 'null'
  4146. format: iri-reference
  4147. example: 'https://example.com/'
  4148. ownerName:
  4149. type:
  4150. - string
  4151. - 'null'
  4152. turnover:
  4153. type:
  4154. - integer
  4155. - 'null'
  4156. profit:
  4157. type:
  4158. - integer
  4159. - 'null'
  4160. Task:
  4161. type: object
  4162. description: ''
  4163. deprecated: false
  4164. required:
  4165. - headline
  4166. - description
  4167. - assignedTo
  4168. - dueAt
  4169. - prio
  4170. - completed
  4171. properties:
  4172. headline:
  4173. type:
  4174. - string
  4175. - 'null'
  4176. description:
  4177. type:
  4178. - string
  4179. - 'null'
  4180. createdBy:
  4181. readOnly: true
  4182. 'owl:maxCardinality': 1
  4183. type:
  4184. - string
  4185. - 'null'
  4186. format: iri-reference
  4187. example: 'https://example.com/'
  4188. createdByName:
  4189. readOnly: true
  4190. type:
  4191. - string
  4192. - 'null'
  4193. assignedTo:
  4194. 'owl:maxCardinality': 1
  4195. type:
  4196. - string
  4197. - 'null'
  4198. format: iri-reference
  4199. example: 'https://example.com/'
  4200. assignedToName:
  4201. readOnly: true
  4202. type:
  4203. - string
  4204. - 'null'
  4205. dueAt:
  4206. type:
  4207. - string
  4208. - 'null'
  4209. format: date-time
  4210. partner:
  4211. 'owl:maxCardinality': 1
  4212. type:
  4213. - string
  4214. - 'null'
  4215. format: iri-reference
  4216. example: 'https://example.com/'
  4217. partnerName:
  4218. readOnly: true
  4219. type:
  4220. - string
  4221. - 'null'
  4222. contact:
  4223. 'owl:maxCardinality': 1
  4224. type:
  4225. - string
  4226. - 'null'
  4227. format: iri-reference
  4228. example: 'https://example.com/'
  4229. contactName:
  4230. readOnly: true
  4231. type:
  4232. - string
  4233. - 'null'
  4234. prio:
  4235. type: string
  4236. enum:
  4237. - low
  4238. - medium
  4239. - high
  4240. completed:
  4241. type:
  4242. - boolean
  4243. - 'null'
  4244. taskNotes:
  4245. description: 'array<int, TaskNoteApi>'
  4246. type: array
  4247. items:
  4248. $ref: '#/components/schemas/TaskNote'
  4249. createdAt:
  4250. readOnly: true
  4251. type:
  4252. - string
  4253. - 'null'
  4254. format: date-time
  4255. Task.jsonhal:
  4256. type: object
  4257. description: ''
  4258. deprecated: false
  4259. required:
  4260. - headline
  4261. - description
  4262. - assignedTo
  4263. - dueAt
  4264. - prio
  4265. - completed
  4266. properties:
  4267. _links:
  4268. type: object
  4269. properties:
  4270. self:
  4271. type: object
  4272. properties:
  4273. href:
  4274. type: string
  4275. format: iri-reference
  4276. headline:
  4277. type:
  4278. - string
  4279. - 'null'
  4280. description:
  4281. type:
  4282. - string
  4283. - 'null'
  4284. createdBy:
  4285. readOnly: true
  4286. 'owl:maxCardinality': 1
  4287. type:
  4288. - string
  4289. - 'null'
  4290. format: iri-reference
  4291. example: 'https://example.com/'
  4292. createdByName:
  4293. readOnly: true
  4294. type:
  4295. - string
  4296. - 'null'
  4297. assignedTo:
  4298. 'owl:maxCardinality': 1
  4299. type:
  4300. - string
  4301. - 'null'
  4302. format: iri-reference
  4303. example: 'https://example.com/'
  4304. assignedToName:
  4305. readOnly: true
  4306. type:
  4307. - string
  4308. - 'null'
  4309. dueAt:
  4310. type:
  4311. - string
  4312. - 'null'
  4313. format: date-time
  4314. partner:
  4315. 'owl:maxCardinality': 1
  4316. type:
  4317. - string
  4318. - 'null'
  4319. format: iri-reference
  4320. example: 'https://example.com/'
  4321. partnerName:
  4322. readOnly: true
  4323. type:
  4324. - string
  4325. - 'null'
  4326. contact:
  4327. 'owl:maxCardinality': 1
  4328. type:
  4329. - string
  4330. - 'null'
  4331. format: iri-reference
  4332. example: 'https://example.com/'
  4333. contactName:
  4334. readOnly: true
  4335. type:
  4336. - string
  4337. - 'null'
  4338. prio:
  4339. type: string
  4340. enum:
  4341. - low
  4342. - medium
  4343. - high
  4344. completed:
  4345. type:
  4346. - boolean
  4347. - 'null'
  4348. taskNotes:
  4349. description: 'array<int, TaskNoteApi>'
  4350. type: array
  4351. items:
  4352. $ref: '#/components/schemas/TaskNote.jsonhal'
  4353. createdAt:
  4354. readOnly: true
  4355. type:
  4356. - string
  4357. - 'null'
  4358. format: date-time
  4359. Task.jsonld:
  4360. type: object
  4361. description: ''
  4362. deprecated: false
  4363. required:
  4364. - headline
  4365. - description
  4366. - assignedTo
  4367. - dueAt
  4368. - prio
  4369. - completed
  4370. properties:
  4371. '@context':
  4372. readOnly: true
  4373. oneOf:
  4374. -
  4375. type: string
  4376. -
  4377. type: object
  4378. properties:
  4379. '@vocab':
  4380. type: string
  4381. hydra:
  4382. type: string
  4383. enum: ['http://www.w3.org/ns/hydra/core#']
  4384. required:
  4385. - '@vocab'
  4386. - hydra
  4387. additionalProperties: true
  4388. '@id':
  4389. readOnly: true
  4390. type: string
  4391. '@type':
  4392. readOnly: true
  4393. type: string
  4394. headline:
  4395. type:
  4396. - string
  4397. - 'null'
  4398. description:
  4399. type:
  4400. - string
  4401. - 'null'
  4402. createdBy:
  4403. readOnly: true
  4404. 'owl:maxCardinality': 1
  4405. type:
  4406. - string
  4407. - 'null'
  4408. format: iri-reference
  4409. example: 'https://example.com/'
  4410. createdByName:
  4411. readOnly: true
  4412. type:
  4413. - string
  4414. - 'null'
  4415. assignedTo:
  4416. 'owl:maxCardinality': 1
  4417. type:
  4418. - string
  4419. - 'null'
  4420. format: iri-reference
  4421. example: 'https://example.com/'
  4422. assignedToName:
  4423. readOnly: true
  4424. type:
  4425. - string
  4426. - 'null'
  4427. dueAt:
  4428. type:
  4429. - string
  4430. - 'null'
  4431. format: date-time
  4432. partner:
  4433. 'owl:maxCardinality': 1
  4434. type:
  4435. - string
  4436. - 'null'
  4437. format: iri-reference
  4438. example: 'https://example.com/'
  4439. partnerName:
  4440. readOnly: true
  4441. type:
  4442. - string
  4443. - 'null'
  4444. contact:
  4445. 'owl:maxCardinality': 1
  4446. type:
  4447. - string
  4448. - 'null'
  4449. format: iri-reference
  4450. example: 'https://example.com/'
  4451. contactName:
  4452. readOnly: true
  4453. type:
  4454. - string
  4455. - 'null'
  4456. prio:
  4457. type: string
  4458. enum:
  4459. - low
  4460. - medium
  4461. - high
  4462. completed:
  4463. type:
  4464. - boolean
  4465. - 'null'
  4466. taskNotes:
  4467. description: 'array<int, TaskNoteApi>'
  4468. type: array
  4469. items:
  4470. $ref: '#/components/schemas/TaskNote.jsonld'
  4471. createdAt:
  4472. readOnly: true
  4473. type:
  4474. - string
  4475. - 'null'
  4476. format: date-time
  4477. TaskNote:
  4478. type: object
  4479. description: ''
  4480. deprecated: false
  4481. required:
  4482. - message
  4483. properties:
  4484. message:
  4485. type:
  4486. - string
  4487. - 'null'
  4488. owner:
  4489. readOnly: true
  4490. 'owl:maxCardinality': 1
  4491. type:
  4492. - string
  4493. - 'null'
  4494. format: iri-reference
  4495. example: 'https://example.com/'
  4496. ownerName:
  4497. readOnly: true
  4498. type:
  4499. - string
  4500. - 'null'
  4501. task:
  4502. 'owl:maxCardinality': 1
  4503. type:
  4504. - string
  4505. - 'null'
  4506. format: iri-reference
  4507. example: 'https://example.com/'
  4508. createdAt:
  4509. readOnly: true
  4510. type:
  4511. - string
  4512. - 'null'
  4513. format: date-time
  4514. TaskNote.jsonhal:
  4515. type: object
  4516. description: ''
  4517. deprecated: false
  4518. required:
  4519. - message
  4520. properties:
  4521. _links:
  4522. type: object
  4523. properties:
  4524. self:
  4525. type: object
  4526. properties:
  4527. href:
  4528. type: string
  4529. format: iri-reference
  4530. message:
  4531. type:
  4532. - string
  4533. - 'null'
  4534. owner:
  4535. readOnly: true
  4536. 'owl:maxCardinality': 1
  4537. type:
  4538. - string
  4539. - 'null'
  4540. format: iri-reference
  4541. example: 'https://example.com/'
  4542. ownerName:
  4543. readOnly: true
  4544. type:
  4545. - string
  4546. - 'null'
  4547. task:
  4548. 'owl:maxCardinality': 1
  4549. type:
  4550. - string
  4551. - 'null'
  4552. format: iri-reference
  4553. example: 'https://example.com/'
  4554. createdAt:
  4555. readOnly: true
  4556. type:
  4557. - string
  4558. - 'null'
  4559. format: date-time
  4560. TaskNote.jsonld:
  4561. type: object
  4562. description: ''
  4563. deprecated: false
  4564. required:
  4565. - message
  4566. properties:
  4567. '@context':
  4568. readOnly: true
  4569. oneOf:
  4570. -
  4571. type: string
  4572. -
  4573. type: object
  4574. properties:
  4575. '@vocab':
  4576. type: string
  4577. hydra:
  4578. type: string
  4579. enum: ['http://www.w3.org/ns/hydra/core#']
  4580. required:
  4581. - '@vocab'
  4582. - hydra
  4583. additionalProperties: true
  4584. '@id':
  4585. readOnly: true
  4586. type: string
  4587. '@type':
  4588. readOnly: true
  4589. type: string
  4590. message:
  4591. type:
  4592. - string
  4593. - 'null'
  4594. owner:
  4595. readOnly: true
  4596. 'owl:maxCardinality': 1
  4597. type:
  4598. - string
  4599. - 'null'
  4600. format: iri-reference
  4601. example: 'https://example.com/'
  4602. ownerName:
  4603. readOnly: true
  4604. type:
  4605. - string
  4606. - 'null'
  4607. task:
  4608. 'owl:maxCardinality': 1
  4609. type:
  4610. - string
  4611. - 'null'
  4612. format: iri-reference
  4613. example: 'https://example.com/'
  4614. createdAt:
  4615. readOnly: true
  4616. type:
  4617. - string
  4618. - 'null'
  4619. format: date-time
  4620. User:
  4621. type: object
  4622. description: ''
  4623. deprecated: false
  4624. required:
  4625. - email
  4626. - firstName
  4627. - lastName
  4628. properties:
  4629. email:
  4630. format: email
  4631. externalDocs:
  4632. url: 'https://schema.org/email'
  4633. type:
  4634. - string
  4635. - 'null'
  4636. firstName:
  4637. type:
  4638. - string
  4639. - 'null'
  4640. lastName:
  4641. type:
  4642. - string
  4643. - 'null'
  4644. image:
  4645. 'owl:maxCardinality': 1
  4646. type:
  4647. - string
  4648. - 'null'
  4649. format: iri-reference
  4650. example: 'https://example.com/'
  4651. password:
  4652. writeOnly: true
  4653. description: 'The plaintext password when being set or changed.'
  4654. type:
  4655. - string
  4656. - 'null'
  4657. active:
  4658. type: boolean
  4659. createdAt:
  4660. readOnly: true
  4661. type:
  4662. - string
  4663. - 'null'
  4664. format: date-time
  4665. User.jsonhal:
  4666. type: object
  4667. description: ''
  4668. deprecated: false
  4669. required:
  4670. - email
  4671. - firstName
  4672. - lastName
  4673. properties:
  4674. _links:
  4675. type: object
  4676. properties:
  4677. self:
  4678. type: object
  4679. properties:
  4680. href:
  4681. type: string
  4682. format: iri-reference
  4683. email:
  4684. format: email
  4685. externalDocs:
  4686. url: 'https://schema.org/email'
  4687. type:
  4688. - string
  4689. - 'null'
  4690. firstName:
  4691. type:
  4692. - string
  4693. - 'null'
  4694. lastName:
  4695. type:
  4696. - string
  4697. - 'null'
  4698. image:
  4699. 'owl:maxCardinality': 1
  4700. type:
  4701. - string
  4702. - 'null'
  4703. format: iri-reference
  4704. example: 'https://example.com/'
  4705. password:
  4706. writeOnly: true
  4707. description: 'The plaintext password when being set or changed.'
  4708. type:
  4709. - string
  4710. - 'null'
  4711. active:
  4712. type: boolean
  4713. createdAt:
  4714. readOnly: true
  4715. type:
  4716. - string
  4717. - 'null'
  4718. format: date-time
  4719. User.jsonld:
  4720. type: object
  4721. description: ''
  4722. deprecated: false
  4723. required:
  4724. - email
  4725. - firstName
  4726. - lastName
  4727. properties:
  4728. '@context':
  4729. readOnly: true
  4730. oneOf:
  4731. -
  4732. type: string
  4733. -
  4734. type: object
  4735. properties:
  4736. '@vocab':
  4737. type: string
  4738. hydra:
  4739. type: string
  4740. enum: ['http://www.w3.org/ns/hydra/core#']
  4741. required:
  4742. - '@vocab'
  4743. - hydra
  4744. additionalProperties: true
  4745. '@id':
  4746. readOnly: true
  4747. type: string
  4748. '@type':
  4749. readOnly: true
  4750. type: string
  4751. email:
  4752. format: email
  4753. externalDocs:
  4754. url: 'https://schema.org/email'
  4755. type:
  4756. - string
  4757. - 'null'
  4758. firstName:
  4759. type:
  4760. - string
  4761. - 'null'
  4762. lastName:
  4763. type:
  4764. - string
  4765. - 'null'
  4766. image:
  4767. 'owl:maxCardinality': 1
  4768. type:
  4769. - string
  4770. - 'null'
  4771. format: iri-reference
  4772. example: 'https://example.com/'
  4773. password:
  4774. writeOnly: true
  4775. description: 'The plaintext password when being set or changed.'
  4776. type:
  4777. - string
  4778. - 'null'
  4779. active:
  4780. type: boolean
  4781. createdAt:
  4782. readOnly: true
  4783. type:
  4784. - string
  4785. - 'null'
  4786. format: date-time
  4787. responses: { }
  4788. parameters: { }
  4789. examples: { }
  4790. requestBodies: { }
  4791. headers: { }
  4792. securitySchemes:
  4793. JWT:
  4794. type: http
  4795. scheme: bearer
  4796. bearerFormat: JWT
  4797. security:
  4798. -
  4799. JWT: []
  4800. tags: []