Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
 
 
 
 

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