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

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