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

3659 Zeilen
104 KiB

  1. openapi: 3.1.0
  2. info:
  3. title: 'Matsen API Platform'
  4. description: ''
  5. version: 1.0.0
  6. servers:
  7. -
  8. url: /
  9. description: ''
  10. paths:
  11. /api/comments:
  12. get:
  13. operationId: api_comments_get_collection
  14. tags:
  15. - Comment
  16. responses:
  17. 200:
  18. description: 'Comment collection'
  19. content:
  20. application/ld+json:
  21. schema:
  22. type: object
  23. properties:
  24. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Comment.jsonld' } }
  25. 'hydra:totalItems': { type: integer, minimum: 0 }
  26. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  27. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  28. required:
  29. - 'hydra:member'
  30. application/json:
  31. schema:
  32. type: array
  33. items:
  34. $ref: '#/components/schemas/Comment'
  35. text/html:
  36. schema:
  37. type: array
  38. items:
  39. $ref: '#/components/schemas/Comment'
  40. application/hal+json:
  41. schema:
  42. type: object
  43. properties:
  44. _embedded: { type: array, items: { $ref: '#/components/schemas/Comment.jsonhal' } }
  45. totalItems: { type: integer, minimum: 0 }
  46. itemsPerPage: { type: integer, minimum: 0 }
  47. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  48. required:
  49. - _links
  50. - _embedded
  51. summary: 'Retrieves the collection of Comment resources.'
  52. description: 'Retrieves the collection of Comment resources.'
  53. parameters:
  54. -
  55. name: page
  56. in: query
  57. description: 'The collection page number'
  58. required: false
  59. deprecated: false
  60. allowEmptyValue: true
  61. schema:
  62. type: integer
  63. default: 1
  64. style: form
  65. explode: false
  66. allowReserved: false
  67. -
  68. name: itemsPerPage
  69. in: query
  70. description: 'The number of items per page'
  71. required: false
  72. deprecated: false
  73. allowEmptyValue: true
  74. schema:
  75. type: integer
  76. default: 10
  77. minimum: 0
  78. maximum: 50
  79. style: form
  80. explode: false
  81. allowReserved: false
  82. deprecated: false
  83. post:
  84. operationId: api_comments_post
  85. tags:
  86. - Comment
  87. responses:
  88. 201:
  89. description: 'Comment resource created'
  90. content:
  91. application/ld+json:
  92. schema:
  93. $ref: '#/components/schemas/Comment.jsonld'
  94. application/json:
  95. schema:
  96. $ref: '#/components/schemas/Comment'
  97. text/html:
  98. schema:
  99. $ref: '#/components/schemas/Comment'
  100. application/hal+json:
  101. schema:
  102. $ref: '#/components/schemas/Comment.jsonhal'
  103. links: { }
  104. 400:
  105. description: 'Invalid input'
  106. 422:
  107. description: 'Unprocessable entity'
  108. summary: 'Creates a Comment resource.'
  109. description: 'Creates a Comment resource.'
  110. parameters: []
  111. requestBody:
  112. description: 'The new Comment resource'
  113. content:
  114. application/ld+json:
  115. schema:
  116. $ref: '#/components/schemas/Comment.jsonld'
  117. application/json:
  118. schema:
  119. $ref: '#/components/schemas/Comment'
  120. text/html:
  121. schema:
  122. $ref: '#/components/schemas/Comment'
  123. application/hal+json:
  124. schema:
  125. $ref: '#/components/schemas/Comment.jsonhal'
  126. required: true
  127. deprecated: false
  128. parameters: []
  129. '/api/comments/{id}':
  130. get:
  131. operationId: api_comments_id_get
  132. tags:
  133. - Comment
  134. responses:
  135. 200:
  136. description: 'Comment resource'
  137. content:
  138. application/ld+json:
  139. schema:
  140. $ref: '#/components/schemas/Comment.jsonld'
  141. application/json:
  142. schema:
  143. $ref: '#/components/schemas/Comment'
  144. text/html:
  145. schema:
  146. $ref: '#/components/schemas/Comment'
  147. application/hal+json:
  148. schema:
  149. $ref: '#/components/schemas/Comment.jsonhal'
  150. 404:
  151. description: 'Resource not found'
  152. summary: 'Retrieves a Comment resource.'
  153. description: 'Retrieves a Comment resource.'
  154. parameters:
  155. -
  156. name: id
  157. in: path
  158. description: 'CommentApi identifier'
  159. required: true
  160. deprecated: false
  161. allowEmptyValue: false
  162. schema:
  163. type: string
  164. style: simple
  165. explode: false
  166. allowReserved: false
  167. deprecated: false
  168. delete:
  169. operationId: api_comments_id_delete
  170. tags:
  171. - Comment
  172. responses:
  173. 204:
  174. description: 'Comment resource deleted'
  175. 404:
  176. description: 'Resource not found'
  177. summary: 'Removes the Comment resource.'
  178. description: 'Removes the Comment resource.'
  179. parameters:
  180. -
  181. name: id
  182. in: path
  183. description: 'CommentApi identifier'
  184. required: true
  185. deprecated: false
  186. allowEmptyValue: false
  187. schema:
  188. type: string
  189. style: simple
  190. explode: false
  191. allowReserved: false
  192. deprecated: false
  193. patch:
  194. operationId: api_comments_id_patch
  195. tags:
  196. - Comment
  197. responses:
  198. 200:
  199. description: 'Comment resource updated'
  200. content:
  201. application/ld+json:
  202. schema:
  203. $ref: '#/components/schemas/Comment.jsonld'
  204. application/json:
  205. schema:
  206. $ref: '#/components/schemas/Comment'
  207. text/html:
  208. schema:
  209. $ref: '#/components/schemas/Comment'
  210. application/hal+json:
  211. schema:
  212. $ref: '#/components/schemas/Comment.jsonhal'
  213. links: { }
  214. 400:
  215. description: 'Invalid input'
  216. 422:
  217. description: 'Unprocessable entity'
  218. 404:
  219. description: 'Resource not found'
  220. summary: 'Updates the Comment resource.'
  221. description: 'Updates the Comment resource.'
  222. parameters:
  223. -
  224. name: id
  225. in: path
  226. description: 'CommentApi identifier'
  227. required: true
  228. deprecated: false
  229. allowEmptyValue: false
  230. schema:
  231. type: string
  232. style: simple
  233. explode: false
  234. allowReserved: false
  235. requestBody:
  236. description: 'The updated Comment resource'
  237. content:
  238. application/merge-patch+json:
  239. schema:
  240. $ref: '#/components/schemas/Comment'
  241. required: true
  242. deprecated: false
  243. parameters: []
  244. /api/contacts:
  245. get:
  246. operationId: api_contacts_get_collection
  247. tags:
  248. - Contact
  249. responses:
  250. 200:
  251. description: 'Contact collection'
  252. content:
  253. application/ld+json:
  254. schema:
  255. type: object
  256. properties:
  257. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.jsonld' } }
  258. 'hydra:totalItems': { type: integer, minimum: 0 }
  259. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  260. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  261. required:
  262. - 'hydra:member'
  263. application/json:
  264. schema:
  265. type: array
  266. items:
  267. $ref: '#/components/schemas/Contact'
  268. text/html:
  269. schema:
  270. type: array
  271. items:
  272. $ref: '#/components/schemas/Contact'
  273. application/hal+json:
  274. schema:
  275. type: object
  276. properties:
  277. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.jsonhal' } }
  278. totalItems: { type: integer, minimum: 0 }
  279. itemsPerPage: { type: integer, minimum: 0 }
  280. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  281. required:
  282. - _links
  283. - _embedded
  284. summary: 'Retrieves the collection of Contact resources.'
  285. description: 'Retrieves the collection of Contact resources.'
  286. parameters:
  287. -
  288. name: page
  289. in: query
  290. description: 'The collection page number'
  291. required: false
  292. deprecated: false
  293. allowEmptyValue: true
  294. schema:
  295. type: integer
  296. default: 1
  297. style: form
  298. explode: false
  299. allowReserved: false
  300. -
  301. name: itemsPerPage
  302. in: query
  303. description: 'The number of items per page'
  304. required: false
  305. deprecated: false
  306. allowEmptyValue: true
  307. schema:
  308. type: integer
  309. default: 10
  310. minimum: 0
  311. maximum: 50
  312. style: form
  313. explode: false
  314. allowReserved: false
  315. -
  316. name: partner
  317. in: query
  318. description: ''
  319. required: false
  320. deprecated: false
  321. allowEmptyValue: true
  322. schema:
  323. type: string
  324. style: form
  325. explode: false
  326. allowReserved: false
  327. -
  328. name: 'partner[]'
  329. in: query
  330. description: ''
  331. required: false
  332. deprecated: false
  333. allowEmptyValue: true
  334. schema:
  335. type: array
  336. items:
  337. type: string
  338. style: form
  339. explode: true
  340. allowReserved: false
  341. deprecated: false
  342. post:
  343. operationId: api_contacts_post
  344. tags:
  345. - Contact
  346. responses:
  347. 201:
  348. description: 'Contact resource created'
  349. content:
  350. application/ld+json:
  351. schema:
  352. $ref: '#/components/schemas/Contact.jsonld'
  353. application/json:
  354. schema:
  355. $ref: '#/components/schemas/Contact'
  356. text/html:
  357. schema:
  358. $ref: '#/components/schemas/Contact'
  359. application/hal+json:
  360. schema:
  361. $ref: '#/components/schemas/Contact.jsonhal'
  362. links: { }
  363. 400:
  364. description: 'Invalid input'
  365. 422:
  366. description: 'Unprocessable entity'
  367. summary: 'Creates a Contact resource.'
  368. description: 'Creates a Contact resource.'
  369. parameters: []
  370. requestBody:
  371. description: 'The new Contact resource'
  372. content:
  373. application/ld+json:
  374. schema:
  375. $ref: '#/components/schemas/Contact.jsonld'
  376. application/json:
  377. schema:
  378. $ref: '#/components/schemas/Contact'
  379. text/html:
  380. schema:
  381. $ref: '#/components/schemas/Contact'
  382. application/hal+json:
  383. schema:
  384. $ref: '#/components/schemas/Contact.jsonhal'
  385. required: true
  386. deprecated: false
  387. parameters: []
  388. '/api/contacts/{id}':
  389. get:
  390. operationId: api_contacts_id_get
  391. tags:
  392. - Contact
  393. responses:
  394. 200:
  395. description: 'Contact resource'
  396. content:
  397. application/ld+json:
  398. schema:
  399. $ref: '#/components/schemas/Contact.jsonld'
  400. application/json:
  401. schema:
  402. $ref: '#/components/schemas/Contact'
  403. text/html:
  404. schema:
  405. $ref: '#/components/schemas/Contact'
  406. application/hal+json:
  407. schema:
  408. $ref: '#/components/schemas/Contact.jsonhal'
  409. 404:
  410. description: 'Resource not found'
  411. summary: 'Retrieves a Contact resource.'
  412. description: 'Retrieves a Contact resource.'
  413. parameters:
  414. -
  415. name: id
  416. in: path
  417. description: 'ContactApi identifier'
  418. required: true
  419. deprecated: false
  420. allowEmptyValue: false
  421. schema:
  422. type: string
  423. style: simple
  424. explode: false
  425. allowReserved: false
  426. deprecated: false
  427. delete:
  428. operationId: api_contacts_id_delete
  429. tags:
  430. - Contact
  431. responses:
  432. 204:
  433. description: 'Contact resource deleted'
  434. 404:
  435. description: 'Resource not found'
  436. summary: 'Removes the Contact resource.'
  437. description: 'Removes the Contact resource.'
  438. parameters:
  439. -
  440. name: id
  441. in: path
  442. description: 'ContactApi identifier'
  443. required: true
  444. deprecated: false
  445. allowEmptyValue: false
  446. schema:
  447. type: string
  448. style: simple
  449. explode: false
  450. allowReserved: false
  451. deprecated: false
  452. patch:
  453. operationId: api_contacts_id_patch
  454. tags:
  455. - Contact
  456. responses:
  457. 200:
  458. description: 'Contact resource updated'
  459. content:
  460. application/ld+json:
  461. schema:
  462. $ref: '#/components/schemas/Contact.jsonld'
  463. application/json:
  464. schema:
  465. $ref: '#/components/schemas/Contact'
  466. text/html:
  467. schema:
  468. $ref: '#/components/schemas/Contact'
  469. application/hal+json:
  470. schema:
  471. $ref: '#/components/schemas/Contact.jsonhal'
  472. links: { }
  473. 400:
  474. description: 'Invalid input'
  475. 422:
  476. description: 'Unprocessable entity'
  477. 404:
  478. description: 'Resource not found'
  479. summary: 'Updates the Contact resource.'
  480. description: 'Updates the Contact resource.'
  481. parameters:
  482. -
  483. name: id
  484. in: path
  485. description: 'ContactApi identifier'
  486. required: true
  487. deprecated: false
  488. allowEmptyValue: false
  489. schema:
  490. type: string
  491. style: simple
  492. explode: false
  493. allowReserved: false
  494. requestBody:
  495. description: 'The updated Contact resource'
  496. content:
  497. application/merge-patch+json:
  498. schema:
  499. $ref: '#/components/schemas/Contact'
  500. required: true
  501. deprecated: false
  502. parameters: []
  503. /api/medias:
  504. get:
  505. operationId: api_medias_get_collection
  506. tags:
  507. - Media
  508. responses:
  509. 200:
  510. description: 'Media collection'
  511. content:
  512. application/ld+json:
  513. schema:
  514. type: object
  515. properties:
  516. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Media.jsonld-media_object.read' } }
  517. 'hydra:totalItems': { type: integer, minimum: 0 }
  518. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  519. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  520. required:
  521. - 'hydra:member'
  522. application/json:
  523. schema:
  524. type: array
  525. items:
  526. $ref: '#/components/schemas/Media-media_object.read'
  527. text/html:
  528. schema:
  529. type: array
  530. items:
  531. $ref: '#/components/schemas/Media-media_object.read'
  532. application/hal+json:
  533. schema:
  534. type: object
  535. properties:
  536. _embedded: { type: array, items: { $ref: '#/components/schemas/Media.jsonhal-media_object.read' } }
  537. totalItems: { type: integer, minimum: 0 }
  538. itemsPerPage: { type: integer, minimum: 0 }
  539. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  540. required:
  541. - _links
  542. - _embedded
  543. summary: 'Retrieves the collection of Media resources.'
  544. description: 'Retrieves the collection of Media resources.'
  545. parameters:
  546. -
  547. name: page
  548. in: query
  549. description: 'The collection page number'
  550. required: false
  551. deprecated: false
  552. allowEmptyValue: true
  553. schema:
  554. type: integer
  555. default: 1
  556. style: form
  557. explode: false
  558. allowReserved: false
  559. -
  560. name: itemsPerPage
  561. in: query
  562. description: 'The number of items per page'
  563. required: false
  564. deprecated: false
  565. allowEmptyValue: true
  566. schema:
  567. type: integer
  568. default: 10
  569. minimum: 0
  570. maximum: 50
  571. style: form
  572. explode: false
  573. allowReserved: false
  574. deprecated: false
  575. post:
  576. operationId: api_medias_post
  577. tags:
  578. - Media
  579. responses:
  580. 201:
  581. description: 'Media resource created'
  582. content:
  583. application/ld+json:
  584. schema:
  585. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  586. application/json:
  587. schema:
  588. $ref: '#/components/schemas/Media-media_object.read'
  589. text/html:
  590. schema:
  591. $ref: '#/components/schemas/Media-media_object.read'
  592. application/hal+json:
  593. schema:
  594. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  595. links: { }
  596. 400:
  597. description: 'Invalid input'
  598. 422:
  599. description: 'Unprocessable entity'
  600. summary: 'Creates a Media resource.'
  601. description: 'Creates a Media resource.'
  602. parameters: []
  603. requestBody:
  604. description: ''
  605. content:
  606. multipart/form-data:
  607. schema:
  608. type: object
  609. properties:
  610. file:
  611. type: string
  612. format: binary
  613. required: false
  614. deprecated: false
  615. parameters: []
  616. '/api/medias/{id}':
  617. get:
  618. operationId: api_medias_id_get
  619. tags:
  620. - Media
  621. responses:
  622. 200:
  623. description: 'Media resource'
  624. content:
  625. application/ld+json:
  626. schema:
  627. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  628. application/json:
  629. schema:
  630. $ref: '#/components/schemas/Media-media_object.read'
  631. text/html:
  632. schema:
  633. $ref: '#/components/schemas/Media-media_object.read'
  634. application/hal+json:
  635. schema:
  636. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  637. 404:
  638. description: 'Resource not found'
  639. summary: 'Retrieves a Media resource.'
  640. description: 'Retrieves a Media resource.'
  641. parameters:
  642. -
  643. name: id
  644. in: path
  645. description: 'MediaObject identifier'
  646. required: true
  647. deprecated: false
  648. allowEmptyValue: false
  649. schema:
  650. type: string
  651. style: simple
  652. explode: false
  653. allowReserved: false
  654. deprecated: false
  655. delete:
  656. operationId: api_medias_id_delete
  657. tags:
  658. - Media
  659. responses:
  660. 204:
  661. description: 'Media resource deleted'
  662. 404:
  663. description: 'Resource not found'
  664. summary: 'Removes the Media resource.'
  665. description: 'Removes the Media resource.'
  666. parameters:
  667. -
  668. name: id
  669. in: path
  670. description: 'MediaObject identifier'
  671. required: true
  672. deprecated: false
  673. allowEmptyValue: false
  674. schema:
  675. type: string
  676. style: simple
  677. explode: false
  678. allowReserved: false
  679. deprecated: false
  680. parameters: []
  681. /api/partners:
  682. get:
  683. operationId: api_partners_get_collection
  684. tags:
  685. - Partner
  686. responses:
  687. 200:
  688. description: 'Partner collection'
  689. content:
  690. application/ld+json:
  691. schema:
  692. type: object
  693. properties:
  694. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  695. 'hydra:totalItems': { type: integer, minimum: 0 }
  696. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  697. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  698. required:
  699. - 'hydra:member'
  700. application/json:
  701. schema:
  702. type: array
  703. items:
  704. $ref: '#/components/schemas/Partner'
  705. text/html:
  706. schema:
  707. type: array
  708. items:
  709. $ref: '#/components/schemas/Partner'
  710. application/hal+json:
  711. schema:
  712. type: object
  713. properties:
  714. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  715. totalItems: { type: integer, minimum: 0 }
  716. itemsPerPage: { type: integer, minimum: 0 }
  717. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  718. required:
  719. - _links
  720. - _embedded
  721. summary: 'Retrieves the collection of Partner resources.'
  722. description: 'Retrieves the collection of Partner resources.'
  723. parameters:
  724. -
  725. name: page
  726. in: query
  727. description: 'The collection page number'
  728. required: false
  729. deprecated: false
  730. allowEmptyValue: true
  731. schema:
  732. type: integer
  733. default: 1
  734. style: form
  735. explode: false
  736. allowReserved: false
  737. -
  738. name: itemsPerPage
  739. in: query
  740. description: 'The number of items per page'
  741. required: false
  742. deprecated: false
  743. allowEmptyValue: true
  744. schema:
  745. type: integer
  746. default: 10
  747. minimum: 0
  748. maximum: 50
  749. style: form
  750. explode: false
  751. allowReserved: false
  752. -
  753. name: type
  754. in: query
  755. description: ''
  756. required: false
  757. deprecated: false
  758. allowEmptyValue: true
  759. schema:
  760. type: string
  761. style: form
  762. explode: false
  763. allowReserved: false
  764. -
  765. name: 'type[]'
  766. in: query
  767. description: ''
  768. required: false
  769. deprecated: false
  770. allowEmptyValue: true
  771. schema:
  772. type: array
  773. items:
  774. type: string
  775. style: form
  776. explode: true
  777. allowReserved: false
  778. -
  779. name: 'order[name]'
  780. in: query
  781. description: ''
  782. required: false
  783. deprecated: false
  784. allowEmptyValue: true
  785. schema:
  786. type: string
  787. enum:
  788. - asc
  789. - desc
  790. style: form
  791. explode: false
  792. allowReserved: false
  793. -
  794. name: 'order[city]'
  795. in: query
  796. description: ''
  797. required: false
  798. deprecated: false
  799. allowEmptyValue: true
  800. schema:
  801. type: string
  802. enum:
  803. - asc
  804. - desc
  805. style: form
  806. explode: false
  807. allowReserved: false
  808. -
  809. name: 'order[website]'
  810. in: query
  811. description: ''
  812. required: false
  813. deprecated: false
  814. allowEmptyValue: true
  815. schema:
  816. type: string
  817. enum:
  818. - asc
  819. - desc
  820. style: form
  821. explode: false
  822. allowReserved: false
  823. deprecated: false
  824. post:
  825. operationId: api_partners_post
  826. tags:
  827. - Partner
  828. responses:
  829. 201:
  830. description: 'Partner resource created'
  831. content:
  832. application/ld+json:
  833. schema:
  834. $ref: '#/components/schemas/Partner.jsonld'
  835. application/json:
  836. schema:
  837. $ref: '#/components/schemas/Partner'
  838. text/html:
  839. schema:
  840. $ref: '#/components/schemas/Partner'
  841. application/hal+json:
  842. schema:
  843. $ref: '#/components/schemas/Partner.jsonhal'
  844. links: { }
  845. 400:
  846. description: 'Invalid input'
  847. 422:
  848. description: 'Unprocessable entity'
  849. summary: 'Creates a Partner resource.'
  850. description: 'Creates a Partner resource.'
  851. parameters: []
  852. requestBody:
  853. description: 'The new Partner resource'
  854. content:
  855. application/ld+json:
  856. schema:
  857. $ref: '#/components/schemas/Partner.jsonld'
  858. application/json:
  859. schema:
  860. $ref: '#/components/schemas/Partner'
  861. text/html:
  862. schema:
  863. $ref: '#/components/schemas/Partner'
  864. application/hal+json:
  865. schema:
  866. $ref: '#/components/schemas/Partner.jsonhal'
  867. required: true
  868. deprecated: false
  869. parameters: []
  870. '/api/partners/{id}':
  871. get:
  872. operationId: api_partners_id_get
  873. tags:
  874. - Partner
  875. responses:
  876. 200:
  877. description: 'Partner resource'
  878. content:
  879. application/ld+json:
  880. schema:
  881. $ref: '#/components/schemas/Partner.jsonld'
  882. application/json:
  883. schema:
  884. $ref: '#/components/schemas/Partner'
  885. text/html:
  886. schema:
  887. $ref: '#/components/schemas/Partner'
  888. application/hal+json:
  889. schema:
  890. $ref: '#/components/schemas/Partner.jsonhal'
  891. 404:
  892. description: 'Resource not found'
  893. summary: 'Retrieves a Partner resource.'
  894. description: 'Retrieves a Partner resource.'
  895. parameters:
  896. -
  897. name: id
  898. in: path
  899. description: 'PartnerApi identifier'
  900. required: true
  901. deprecated: false
  902. allowEmptyValue: false
  903. schema:
  904. type: string
  905. style: simple
  906. explode: false
  907. allowReserved: false
  908. deprecated: false
  909. delete:
  910. operationId: api_partners_id_delete
  911. tags:
  912. - Partner
  913. responses:
  914. 204:
  915. description: 'Partner resource deleted'
  916. 404:
  917. description: 'Resource not found'
  918. summary: 'Removes the Partner resource.'
  919. description: 'Removes the Partner resource.'
  920. parameters:
  921. -
  922. name: id
  923. in: path
  924. description: 'PartnerApi identifier'
  925. required: true
  926. deprecated: false
  927. allowEmptyValue: false
  928. schema:
  929. type: string
  930. style: simple
  931. explode: false
  932. allowReserved: false
  933. deprecated: false
  934. patch:
  935. operationId: api_partners_id_patch
  936. tags:
  937. - Partner
  938. responses:
  939. 200:
  940. description: 'Partner resource updated'
  941. content:
  942. application/ld+json:
  943. schema:
  944. $ref: '#/components/schemas/Partner.jsonld'
  945. application/json:
  946. schema:
  947. $ref: '#/components/schemas/Partner'
  948. text/html:
  949. schema:
  950. $ref: '#/components/schemas/Partner'
  951. application/hal+json:
  952. schema:
  953. $ref: '#/components/schemas/Partner.jsonhal'
  954. links: { }
  955. 400:
  956. description: 'Invalid input'
  957. 422:
  958. description: 'Unprocessable entity'
  959. 404:
  960. description: 'Resource not found'
  961. summary: 'Updates the Partner resource.'
  962. description: 'Updates the Partner resource.'
  963. parameters:
  964. -
  965. name: id
  966. in: path
  967. description: 'PartnerApi identifier'
  968. required: true
  969. deprecated: false
  970. allowEmptyValue: false
  971. schema:
  972. type: string
  973. style: simple
  974. explode: false
  975. allowReserved: false
  976. requestBody:
  977. description: 'The updated Partner resource'
  978. content:
  979. application/merge-patch+json:
  980. schema:
  981. $ref: '#/components/schemas/Partner'
  982. required: true
  983. deprecated: false
  984. parameters: []
  985. /api/posts:
  986. get:
  987. operationId: api_posts_get_collection
  988. tags:
  989. - Post
  990. responses:
  991. 200:
  992. description: 'Post collection'
  993. content:
  994. application/ld+json:
  995. schema:
  996. type: object
  997. properties:
  998. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  999. 'hydra:totalItems': { type: integer, minimum: 0 }
  1000. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  1001. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1002. required:
  1003. - 'hydra:member'
  1004. application/json:
  1005. schema:
  1006. type: array
  1007. items:
  1008. $ref: '#/components/schemas/Post'
  1009. text/html:
  1010. schema:
  1011. type: array
  1012. items:
  1013. $ref: '#/components/schemas/Post'
  1014. application/hal+json:
  1015. schema:
  1016. type: object
  1017. properties:
  1018. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  1019. totalItems: { type: integer, minimum: 0 }
  1020. itemsPerPage: { type: integer, minimum: 0 }
  1021. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  1022. required:
  1023. - _links
  1024. - _embedded
  1025. summary: 'Retrieves the collection of Post resources.'
  1026. description: 'Retrieves the collection of Post resources.'
  1027. parameters:
  1028. -
  1029. name: page
  1030. in: query
  1031. description: 'The collection page number'
  1032. required: false
  1033. deprecated: false
  1034. allowEmptyValue: true
  1035. schema:
  1036. type: integer
  1037. default: 1
  1038. style: form
  1039. explode: false
  1040. allowReserved: false
  1041. -
  1042. name: itemsPerPage
  1043. in: query
  1044. description: 'The number of items per page'
  1045. required: false
  1046. deprecated: false
  1047. allowEmptyValue: true
  1048. schema:
  1049. type: integer
  1050. default: 10
  1051. minimum: 0
  1052. maximum: 50
  1053. style: form
  1054. explode: false
  1055. allowReserved: false
  1056. -
  1057. name: partner
  1058. in: query
  1059. description: ''
  1060. required: false
  1061. deprecated: false
  1062. allowEmptyValue: true
  1063. schema:
  1064. type: string
  1065. style: form
  1066. explode: false
  1067. allowReserved: false
  1068. -
  1069. name: 'partner[]'
  1070. in: query
  1071. description: ''
  1072. required: false
  1073. deprecated: false
  1074. allowEmptyValue: true
  1075. schema:
  1076. type: array
  1077. items:
  1078. type: string
  1079. style: form
  1080. explode: true
  1081. allowReserved: false
  1082. -
  1083. name: contact
  1084. in: query
  1085. description: ''
  1086. required: false
  1087. deprecated: false
  1088. allowEmptyValue: true
  1089. schema:
  1090. type: string
  1091. style: form
  1092. explode: false
  1093. allowReserved: false
  1094. -
  1095. name: 'contact[]'
  1096. in: query
  1097. description: ''
  1098. required: false
  1099. deprecated: false
  1100. allowEmptyValue: true
  1101. schema:
  1102. type: array
  1103. items:
  1104. type: string
  1105. style: form
  1106. explode: true
  1107. allowReserved: false
  1108. deprecated: false
  1109. post:
  1110. operationId: api_posts_post
  1111. tags:
  1112. - Post
  1113. responses:
  1114. 201:
  1115. description: 'Post resource created'
  1116. content:
  1117. application/ld+json:
  1118. schema:
  1119. $ref: '#/components/schemas/Post.jsonld'
  1120. application/json:
  1121. schema:
  1122. $ref: '#/components/schemas/Post'
  1123. text/html:
  1124. schema:
  1125. $ref: '#/components/schemas/Post'
  1126. application/hal+json:
  1127. schema:
  1128. $ref: '#/components/schemas/Post.jsonhal'
  1129. links: { }
  1130. 400:
  1131. description: 'Invalid input'
  1132. 422:
  1133. description: 'Unprocessable entity'
  1134. summary: 'Creates a Post resource.'
  1135. description: 'Creates a Post resource.'
  1136. parameters: []
  1137. requestBody:
  1138. description: 'The new Post resource'
  1139. content:
  1140. application/ld+json:
  1141. schema:
  1142. $ref: '#/components/schemas/Post.jsonld-posting.create'
  1143. application/json:
  1144. schema:
  1145. $ref: '#/components/schemas/Post-posting.create'
  1146. text/html:
  1147. schema:
  1148. $ref: '#/components/schemas/Post-posting.create'
  1149. application/hal+json:
  1150. schema:
  1151. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  1152. required: true
  1153. deprecated: false
  1154. parameters: []
  1155. '/api/posts/{id}':
  1156. get:
  1157. operationId: api_posts_id_get
  1158. tags:
  1159. - Post
  1160. responses:
  1161. 200:
  1162. description: 'Post resource'
  1163. content:
  1164. application/ld+json:
  1165. schema:
  1166. $ref: '#/components/schemas/Post.jsonld'
  1167. application/json:
  1168. schema:
  1169. $ref: '#/components/schemas/Post'
  1170. text/html:
  1171. schema:
  1172. $ref: '#/components/schemas/Post'
  1173. application/hal+json:
  1174. schema:
  1175. $ref: '#/components/schemas/Post.jsonhal'
  1176. 404:
  1177. description: 'Resource not found'
  1178. summary: 'Retrieves a Post resource.'
  1179. description: 'Retrieves a Post resource.'
  1180. parameters:
  1181. -
  1182. name: id
  1183. in: path
  1184. description: 'PostingApi identifier'
  1185. required: true
  1186. deprecated: false
  1187. allowEmptyValue: false
  1188. schema:
  1189. type: string
  1190. style: simple
  1191. explode: false
  1192. allowReserved: false
  1193. deprecated: false
  1194. delete:
  1195. operationId: api_posts_id_delete
  1196. tags:
  1197. - Post
  1198. responses:
  1199. 204:
  1200. description: 'Post resource deleted'
  1201. 404:
  1202. description: 'Resource not found'
  1203. summary: 'Removes the Post resource.'
  1204. description: 'Removes the Post resource.'
  1205. parameters:
  1206. -
  1207. name: id
  1208. in: path
  1209. description: 'PostingApi identifier'
  1210. required: true
  1211. deprecated: false
  1212. allowEmptyValue: false
  1213. schema:
  1214. type: string
  1215. style: simple
  1216. explode: false
  1217. allowReserved: false
  1218. deprecated: false
  1219. patch:
  1220. operationId: api_posts_id_patch
  1221. tags:
  1222. - Post
  1223. responses:
  1224. 200:
  1225. description: 'Post resource updated'
  1226. content:
  1227. application/ld+json:
  1228. schema:
  1229. $ref: '#/components/schemas/Post.jsonld'
  1230. application/json:
  1231. schema:
  1232. $ref: '#/components/schemas/Post'
  1233. text/html:
  1234. schema:
  1235. $ref: '#/components/schemas/Post'
  1236. application/hal+json:
  1237. schema:
  1238. $ref: '#/components/schemas/Post.jsonhal'
  1239. links: { }
  1240. 400:
  1241. description: 'Invalid input'
  1242. 422:
  1243. description: 'Unprocessable entity'
  1244. 404:
  1245. description: 'Resource not found'
  1246. summary: 'Updates the Post resource.'
  1247. description: 'Updates the Post resource.'
  1248. parameters:
  1249. -
  1250. name: id
  1251. in: path
  1252. description: 'PostingApi identifier'
  1253. required: true
  1254. deprecated: false
  1255. allowEmptyValue: false
  1256. schema:
  1257. type: string
  1258. style: simple
  1259. explode: false
  1260. allowReserved: false
  1261. requestBody:
  1262. description: 'The updated Post resource'
  1263. content:
  1264. application/merge-patch+json:
  1265. schema:
  1266. $ref: '#/components/schemas/Post-posting.patch'
  1267. required: true
  1268. deprecated: false
  1269. parameters: []
  1270. /api/products:
  1271. get:
  1272. operationId: api_products_get_collection
  1273. tags:
  1274. - Product
  1275. responses:
  1276. 200:
  1277. description: 'Product collection'
  1278. content:
  1279. application/ld+json:
  1280. schema:
  1281. type: object
  1282. properties:
  1283. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  1284. 'hydra:totalItems': { type: integer, minimum: 0 }
  1285. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  1286. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1287. required:
  1288. - 'hydra:member'
  1289. application/json:
  1290. schema:
  1291. type: array
  1292. items:
  1293. $ref: '#/components/schemas/Product'
  1294. text/html:
  1295. schema:
  1296. type: array
  1297. items:
  1298. $ref: '#/components/schemas/Product'
  1299. application/hal+json:
  1300. schema:
  1301. type: object
  1302. properties:
  1303. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  1304. totalItems: { type: integer, minimum: 0 }
  1305. itemsPerPage: { type: integer, minimum: 0 }
  1306. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  1307. required:
  1308. - _links
  1309. - _embedded
  1310. summary: 'Retrieves the collection of Product resources.'
  1311. description: 'Retrieves the collection of Product resources.'
  1312. parameters:
  1313. -
  1314. name: page
  1315. in: query
  1316. description: 'The collection page number'
  1317. required: false
  1318. deprecated: false
  1319. allowEmptyValue: true
  1320. schema:
  1321. type: integer
  1322. default: 1
  1323. style: form
  1324. explode: false
  1325. allowReserved: false
  1326. -
  1327. name: itemsPerPage
  1328. in: query
  1329. description: 'The number of items per page'
  1330. required: false
  1331. deprecated: false
  1332. allowEmptyValue: true
  1333. schema:
  1334. type: integer
  1335. default: 10
  1336. minimum: 0
  1337. maximum: 50
  1338. style: form
  1339. explode: false
  1340. allowReserved: false
  1341. -
  1342. name: 'order[name]'
  1343. in: query
  1344. description: ''
  1345. required: false
  1346. deprecated: false
  1347. allowEmptyValue: true
  1348. schema:
  1349. type: string
  1350. enum:
  1351. - asc
  1352. - desc
  1353. style: form
  1354. explode: false
  1355. allowReserved: false
  1356. deprecated: false
  1357. post:
  1358. operationId: api_products_post
  1359. tags:
  1360. - Product
  1361. responses:
  1362. 201:
  1363. description: 'Product resource created'
  1364. content:
  1365. application/ld+json:
  1366. schema:
  1367. $ref: '#/components/schemas/Product.jsonld'
  1368. application/json:
  1369. schema:
  1370. $ref: '#/components/schemas/Product'
  1371. text/html:
  1372. schema:
  1373. $ref: '#/components/schemas/Product'
  1374. application/hal+json:
  1375. schema:
  1376. $ref: '#/components/schemas/Product.jsonhal'
  1377. links: { }
  1378. 400:
  1379. description: 'Invalid input'
  1380. 422:
  1381. description: 'Unprocessable entity'
  1382. summary: 'Creates a Product resource.'
  1383. description: 'Creates a Product resource.'
  1384. parameters: []
  1385. requestBody:
  1386. description: 'The new Product resource'
  1387. content:
  1388. application/ld+json:
  1389. schema:
  1390. $ref: '#/components/schemas/Product.jsonld'
  1391. application/json:
  1392. schema:
  1393. $ref: '#/components/schemas/Product'
  1394. text/html:
  1395. schema:
  1396. $ref: '#/components/schemas/Product'
  1397. application/hal+json:
  1398. schema:
  1399. $ref: '#/components/schemas/Product.jsonhal'
  1400. required: true
  1401. deprecated: false
  1402. parameters: []
  1403. '/api/products/{id}':
  1404. get:
  1405. operationId: api_products_id_get
  1406. tags:
  1407. - Product
  1408. responses:
  1409. 200:
  1410. description: 'Product resource'
  1411. content:
  1412. application/ld+json:
  1413. schema:
  1414. $ref: '#/components/schemas/Product.jsonld'
  1415. application/json:
  1416. schema:
  1417. $ref: '#/components/schemas/Product'
  1418. text/html:
  1419. schema:
  1420. $ref: '#/components/schemas/Product'
  1421. application/hal+json:
  1422. schema:
  1423. $ref: '#/components/schemas/Product.jsonhal'
  1424. 404:
  1425. description: 'Resource not found'
  1426. summary: 'Retrieves a Product resource.'
  1427. description: 'Retrieves a Product resource.'
  1428. parameters:
  1429. -
  1430. name: id
  1431. in: path
  1432. description: 'ProductApi identifier'
  1433. required: true
  1434. deprecated: false
  1435. allowEmptyValue: false
  1436. schema:
  1437. type: string
  1438. style: simple
  1439. explode: false
  1440. allowReserved: false
  1441. deprecated: false
  1442. delete:
  1443. operationId: api_products_id_delete
  1444. tags:
  1445. - Product
  1446. responses:
  1447. 204:
  1448. description: 'Product resource deleted'
  1449. 404:
  1450. description: 'Resource not found'
  1451. summary: 'Removes the Product resource.'
  1452. description: 'Removes the Product resource.'
  1453. parameters:
  1454. -
  1455. name: id
  1456. in: path
  1457. description: 'ProductApi identifier'
  1458. required: true
  1459. deprecated: false
  1460. allowEmptyValue: false
  1461. schema:
  1462. type: string
  1463. style: simple
  1464. explode: false
  1465. allowReserved: false
  1466. deprecated: false
  1467. patch:
  1468. operationId: api_products_id_patch
  1469. tags:
  1470. - Product
  1471. responses:
  1472. 200:
  1473. description: 'Product resource updated'
  1474. content:
  1475. application/ld+json:
  1476. schema:
  1477. $ref: '#/components/schemas/Product.jsonld'
  1478. application/json:
  1479. schema:
  1480. $ref: '#/components/schemas/Product'
  1481. text/html:
  1482. schema:
  1483. $ref: '#/components/schemas/Product'
  1484. application/hal+json:
  1485. schema:
  1486. $ref: '#/components/schemas/Product.jsonhal'
  1487. links: { }
  1488. 400:
  1489. description: 'Invalid input'
  1490. 422:
  1491. description: 'Unprocessable entity'
  1492. 404:
  1493. description: 'Resource not found'
  1494. summary: 'Updates the Product resource.'
  1495. description: 'Updates the Product resource.'
  1496. parameters:
  1497. -
  1498. name: id
  1499. in: path
  1500. description: 'ProductApi identifier'
  1501. required: true
  1502. deprecated: false
  1503. allowEmptyValue: false
  1504. schema:
  1505. type: string
  1506. style: simple
  1507. explode: false
  1508. allowReserved: false
  1509. requestBody:
  1510. description: 'The updated Product resource'
  1511. content:
  1512. application/merge-patch+json:
  1513. schema:
  1514. $ref: '#/components/schemas/Product'
  1515. required: true
  1516. deprecated: false
  1517. parameters: []
  1518. /api/tasks:
  1519. get:
  1520. operationId: api_tasks_get_collection
  1521. tags:
  1522. - Task
  1523. responses:
  1524. 200:
  1525. description: 'Task collection'
  1526. content:
  1527. application/ld+json:
  1528. schema:
  1529. type: object
  1530. properties:
  1531. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  1532. 'hydra:totalItems': { type: integer, minimum: 0 }
  1533. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  1534. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1535. required:
  1536. - 'hydra:member'
  1537. application/json:
  1538. schema:
  1539. type: array
  1540. items:
  1541. $ref: '#/components/schemas/Task'
  1542. text/html:
  1543. schema:
  1544. type: array
  1545. items:
  1546. $ref: '#/components/schemas/Task'
  1547. application/hal+json:
  1548. schema:
  1549. type: object
  1550. properties:
  1551. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  1552. totalItems: { type: integer, minimum: 0 }
  1553. itemsPerPage: { type: integer, minimum: 0 }
  1554. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  1555. required:
  1556. - _links
  1557. - _embedded
  1558. summary: 'Retrieves the collection of Task resources.'
  1559. description: 'Retrieves the collection of Task resources.'
  1560. parameters:
  1561. -
  1562. name: page
  1563. in: query
  1564. description: 'The collection page number'
  1565. required: false
  1566. deprecated: false
  1567. allowEmptyValue: true
  1568. schema:
  1569. type: integer
  1570. default: 1
  1571. style: form
  1572. explode: false
  1573. allowReserved: false
  1574. -
  1575. name: itemsPerPage
  1576. in: query
  1577. description: 'The number of items per page'
  1578. required: false
  1579. deprecated: false
  1580. allowEmptyValue: true
  1581. schema:
  1582. type: integer
  1583. default: 10
  1584. minimum: 0
  1585. maximum: 50
  1586. style: form
  1587. explode: false
  1588. allowReserved: false
  1589. -
  1590. name: partner
  1591. in: query
  1592. description: ''
  1593. required: false
  1594. deprecated: false
  1595. allowEmptyValue: true
  1596. schema:
  1597. type: string
  1598. style: form
  1599. explode: false
  1600. allowReserved: false
  1601. -
  1602. name: 'partner[]'
  1603. in: query
  1604. description: ''
  1605. required: false
  1606. deprecated: false
  1607. allowEmptyValue: true
  1608. schema:
  1609. type: array
  1610. items:
  1611. type: string
  1612. style: form
  1613. explode: true
  1614. allowReserved: false
  1615. -
  1616. name: contact
  1617. in: query
  1618. description: ''
  1619. required: false
  1620. deprecated: false
  1621. allowEmptyValue: true
  1622. schema:
  1623. type: string
  1624. style: form
  1625. explode: false
  1626. allowReserved: false
  1627. -
  1628. name: 'contact[]'
  1629. in: query
  1630. description: ''
  1631. required: false
  1632. deprecated: false
  1633. allowEmptyValue: true
  1634. schema:
  1635. type: array
  1636. items:
  1637. type: string
  1638. style: form
  1639. explode: true
  1640. allowReserved: false
  1641. deprecated: false
  1642. post:
  1643. operationId: api_tasks_post
  1644. tags:
  1645. - Task
  1646. responses:
  1647. 201:
  1648. description: 'Task resource created'
  1649. content:
  1650. application/ld+json:
  1651. schema:
  1652. $ref: '#/components/schemas/Task.jsonld'
  1653. application/json:
  1654. schema:
  1655. $ref: '#/components/schemas/Task'
  1656. text/html:
  1657. schema:
  1658. $ref: '#/components/schemas/Task'
  1659. application/hal+json:
  1660. schema:
  1661. $ref: '#/components/schemas/Task.jsonhal'
  1662. links: { }
  1663. 400:
  1664. description: 'Invalid input'
  1665. 422:
  1666. description: 'Unprocessable entity'
  1667. summary: 'Creates a Task resource.'
  1668. description: 'Creates a Task resource.'
  1669. parameters: []
  1670. requestBody:
  1671. description: 'The new Task resource'
  1672. content:
  1673. application/ld+json:
  1674. schema:
  1675. $ref: '#/components/schemas/Task.jsonld'
  1676. application/json:
  1677. schema:
  1678. $ref: '#/components/schemas/Task'
  1679. text/html:
  1680. schema:
  1681. $ref: '#/components/schemas/Task'
  1682. application/hal+json:
  1683. schema:
  1684. $ref: '#/components/schemas/Task.jsonhal'
  1685. required: true
  1686. deprecated: false
  1687. parameters: []
  1688. '/api/tasks/{id}':
  1689. get:
  1690. operationId: api_tasks_id_get
  1691. tags:
  1692. - Task
  1693. responses:
  1694. 200:
  1695. description: 'Task resource'
  1696. content:
  1697. application/ld+json:
  1698. schema:
  1699. $ref: '#/components/schemas/Task.jsonld'
  1700. application/json:
  1701. schema:
  1702. $ref: '#/components/schemas/Task'
  1703. text/html:
  1704. schema:
  1705. $ref: '#/components/schemas/Task'
  1706. application/hal+json:
  1707. schema:
  1708. $ref: '#/components/schemas/Task.jsonhal'
  1709. 404:
  1710. description: 'Resource not found'
  1711. summary: 'Retrieves a Task resource.'
  1712. description: 'Retrieves a Task resource.'
  1713. parameters:
  1714. -
  1715. name: id
  1716. in: path
  1717. description: 'TaskApi identifier'
  1718. required: true
  1719. deprecated: false
  1720. allowEmptyValue: false
  1721. schema:
  1722. type: string
  1723. style: simple
  1724. explode: false
  1725. allowReserved: false
  1726. deprecated: false
  1727. delete:
  1728. operationId: api_tasks_id_delete
  1729. tags:
  1730. - Task
  1731. responses:
  1732. 204:
  1733. description: 'Task resource deleted'
  1734. 404:
  1735. description: 'Resource not found'
  1736. summary: 'Removes the Task resource.'
  1737. description: 'Removes the Task resource.'
  1738. parameters:
  1739. -
  1740. name: id
  1741. in: path
  1742. description: 'TaskApi identifier'
  1743. required: true
  1744. deprecated: false
  1745. allowEmptyValue: false
  1746. schema:
  1747. type: string
  1748. style: simple
  1749. explode: false
  1750. allowReserved: false
  1751. deprecated: false
  1752. patch:
  1753. operationId: api_tasks_id_patch
  1754. tags:
  1755. - Task
  1756. responses:
  1757. 200:
  1758. description: 'Task resource updated'
  1759. content:
  1760. application/ld+json:
  1761. schema:
  1762. $ref: '#/components/schemas/Task.jsonld'
  1763. application/json:
  1764. schema:
  1765. $ref: '#/components/schemas/Task'
  1766. text/html:
  1767. schema:
  1768. $ref: '#/components/schemas/Task'
  1769. application/hal+json:
  1770. schema:
  1771. $ref: '#/components/schemas/Task.jsonhal'
  1772. links: { }
  1773. 400:
  1774. description: 'Invalid input'
  1775. 422:
  1776. description: 'Unprocessable entity'
  1777. 404:
  1778. description: 'Resource not found'
  1779. summary: 'Updates the Task resource.'
  1780. description: 'Updates the Task resource.'
  1781. parameters:
  1782. -
  1783. name: id
  1784. in: path
  1785. description: 'TaskApi identifier'
  1786. required: true
  1787. deprecated: false
  1788. allowEmptyValue: false
  1789. schema:
  1790. type: string
  1791. style: simple
  1792. explode: false
  1793. allowReserved: false
  1794. requestBody:
  1795. description: 'The updated Task resource'
  1796. content:
  1797. application/merge-patch+json:
  1798. schema:
  1799. $ref: '#/components/schemas/Task'
  1800. required: true
  1801. deprecated: false
  1802. parameters: []
  1803. /api/users:
  1804. get:
  1805. operationId: api_users_get_collection
  1806. tags:
  1807. - User
  1808. responses:
  1809. 200:
  1810. description: 'User collection'
  1811. content:
  1812. application/ld+json:
  1813. schema:
  1814. type: object
  1815. properties:
  1816. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1817. 'hydra:totalItems': { type: integer, minimum: 0 }
  1818. '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 } }
  1819. '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 } } } } } }
  1820. required:
  1821. - 'hydra:member'
  1822. application/json:
  1823. schema:
  1824. type: array
  1825. items:
  1826. $ref: '#/components/schemas/User'
  1827. text/html:
  1828. schema:
  1829. type: array
  1830. items:
  1831. $ref: '#/components/schemas/User'
  1832. application/hal+json:
  1833. schema:
  1834. type: object
  1835. properties:
  1836. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  1837. totalItems: { type: integer, minimum: 0 }
  1838. itemsPerPage: { type: integer, minimum: 0 }
  1839. _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 } } } } }
  1840. required:
  1841. - _links
  1842. - _embedded
  1843. summary: 'Retrieves the collection of User resources.'
  1844. description: 'Retrieves the collection of User resources.'
  1845. parameters:
  1846. -
  1847. name: page
  1848. in: query
  1849. description: 'The collection page number'
  1850. required: false
  1851. deprecated: false
  1852. allowEmptyValue: true
  1853. schema:
  1854. type: integer
  1855. default: 1
  1856. style: form
  1857. explode: false
  1858. allowReserved: false
  1859. -
  1860. name: itemsPerPage
  1861. in: query
  1862. description: 'The number of items per page'
  1863. required: false
  1864. deprecated: false
  1865. allowEmptyValue: true
  1866. schema:
  1867. type: integer
  1868. default: 10
  1869. minimum: 0
  1870. maximum: 50
  1871. style: form
  1872. explode: false
  1873. allowReserved: false
  1874. deprecated: false
  1875. post:
  1876. operationId: api_users_post
  1877. tags:
  1878. - User
  1879. responses:
  1880. 201:
  1881. description: 'User resource created'
  1882. content:
  1883. application/ld+json:
  1884. schema:
  1885. $ref: '#/components/schemas/User.jsonld'
  1886. application/json:
  1887. schema:
  1888. $ref: '#/components/schemas/User'
  1889. text/html:
  1890. schema:
  1891. $ref: '#/components/schemas/User'
  1892. application/hal+json:
  1893. schema:
  1894. $ref: '#/components/schemas/User.jsonhal'
  1895. links: { }
  1896. 400:
  1897. description: 'Invalid input'
  1898. 422:
  1899. description: 'Unprocessable entity'
  1900. summary: 'Creates a User resource.'
  1901. description: 'Creates a User resource.'
  1902. parameters: []
  1903. requestBody:
  1904. description: 'The new User resource'
  1905. content:
  1906. application/ld+json:
  1907. schema:
  1908. $ref: '#/components/schemas/User.jsonld'
  1909. application/json:
  1910. schema:
  1911. $ref: '#/components/schemas/User'
  1912. text/html:
  1913. schema:
  1914. $ref: '#/components/schemas/User'
  1915. application/hal+json:
  1916. schema:
  1917. $ref: '#/components/schemas/User.jsonhal'
  1918. required: true
  1919. deprecated: false
  1920. parameters: []
  1921. '/api/users/{id}':
  1922. get:
  1923. operationId: api_users_id_get
  1924. tags:
  1925. - User
  1926. responses:
  1927. 200:
  1928. description: 'User resource'
  1929. content:
  1930. application/ld+json:
  1931. schema:
  1932. $ref: '#/components/schemas/User.jsonld'
  1933. application/json:
  1934. schema:
  1935. $ref: '#/components/schemas/User'
  1936. text/html:
  1937. schema:
  1938. $ref: '#/components/schemas/User'
  1939. application/hal+json:
  1940. schema:
  1941. $ref: '#/components/schemas/User.jsonhal'
  1942. 404:
  1943. description: 'Resource not found'
  1944. summary: 'Retrieves a User resource.'
  1945. description: 'Retrieves a User resource.'
  1946. parameters:
  1947. -
  1948. name: id
  1949. in: path
  1950. description: 'UserApi identifier'
  1951. required: true
  1952. deprecated: false
  1953. allowEmptyValue: false
  1954. schema:
  1955. type: string
  1956. style: simple
  1957. explode: false
  1958. allowReserved: false
  1959. deprecated: false
  1960. patch:
  1961. operationId: api_users_id_patch
  1962. tags:
  1963. - User
  1964. responses:
  1965. 200:
  1966. description: 'User resource updated'
  1967. content:
  1968. application/ld+json:
  1969. schema:
  1970. $ref: '#/components/schemas/User.jsonld'
  1971. application/json:
  1972. schema:
  1973. $ref: '#/components/schemas/User'
  1974. text/html:
  1975. schema:
  1976. $ref: '#/components/schemas/User'
  1977. application/hal+json:
  1978. schema:
  1979. $ref: '#/components/schemas/User.jsonhal'
  1980. links: { }
  1981. 400:
  1982. description: 'Invalid input'
  1983. 422:
  1984. description: 'Unprocessable entity'
  1985. 404:
  1986. description: 'Resource not found'
  1987. summary: 'Updates the User resource.'
  1988. description: 'Updates the User resource.'
  1989. parameters:
  1990. -
  1991. name: id
  1992. in: path
  1993. description: 'UserApi identifier'
  1994. required: true
  1995. deprecated: false
  1996. allowEmptyValue: false
  1997. schema:
  1998. type: string
  1999. style: simple
  2000. explode: false
  2001. allowReserved: false
  2002. requestBody:
  2003. description: 'The updated User resource'
  2004. content:
  2005. application/merge-patch+json:
  2006. schema:
  2007. $ref: '#/components/schemas/User'
  2008. required: true
  2009. deprecated: false
  2010. parameters: []
  2011. /auth:
  2012. post:
  2013. operationId: login_check_post
  2014. tags:
  2015. - 'Login Check'
  2016. responses:
  2017. 200:
  2018. description: 'User token created'
  2019. content:
  2020. application/json:
  2021. schema:
  2022. type: object
  2023. properties:
  2024. token: { readOnly: true, type: string, nullable: false }
  2025. required:
  2026. - token
  2027. summary: 'Creates a user token.'
  2028. description: 'Creates a user token.'
  2029. requestBody:
  2030. description: 'The login data'
  2031. content:
  2032. application/json:
  2033. schema:
  2034. type: object
  2035. properties:
  2036. email:
  2037. type: string
  2038. nullable: false
  2039. password:
  2040. type: string
  2041. nullable: false
  2042. required:
  2043. - email
  2044. - password
  2045. required: true
  2046. parameters: []
  2047. components:
  2048. schemas:
  2049. Comment:
  2050. type: object
  2051. description: ''
  2052. deprecated: false
  2053. required:
  2054. - message
  2055. properties:
  2056. message:
  2057. type:
  2058. - string
  2059. - 'null'
  2060. owner:
  2061. readOnly: true
  2062. 'owl:maxCardinality': 1
  2063. type:
  2064. - string
  2065. - 'null'
  2066. format: iri-reference
  2067. example: 'https://example.com/'
  2068. ownerName:
  2069. readOnly: true
  2070. type:
  2071. - string
  2072. - 'null'
  2073. post:
  2074. 'owl:maxCardinality': 1
  2075. type:
  2076. - string
  2077. - 'null'
  2078. format: iri-reference
  2079. example: 'https://example.com/'
  2080. createdAt:
  2081. readOnly: true
  2082. type:
  2083. - string
  2084. - 'null'
  2085. format: date-time
  2086. Comment.jsonhal:
  2087. type: object
  2088. description: ''
  2089. deprecated: false
  2090. required:
  2091. - message
  2092. properties:
  2093. _links:
  2094. type: object
  2095. properties:
  2096. self:
  2097. type: object
  2098. properties:
  2099. href:
  2100. type: string
  2101. format: iri-reference
  2102. message:
  2103. type:
  2104. - string
  2105. - 'null'
  2106. owner:
  2107. readOnly: true
  2108. 'owl:maxCardinality': 1
  2109. type:
  2110. - string
  2111. - 'null'
  2112. format: iri-reference
  2113. example: 'https://example.com/'
  2114. ownerName:
  2115. readOnly: true
  2116. type:
  2117. - string
  2118. - 'null'
  2119. post:
  2120. 'owl:maxCardinality': 1
  2121. type:
  2122. - string
  2123. - 'null'
  2124. format: iri-reference
  2125. example: 'https://example.com/'
  2126. createdAt:
  2127. readOnly: true
  2128. type:
  2129. - string
  2130. - 'null'
  2131. format: date-time
  2132. Comment.jsonld:
  2133. type: object
  2134. description: ''
  2135. deprecated: false
  2136. required:
  2137. - message
  2138. properties:
  2139. '@context':
  2140. readOnly: true
  2141. oneOf:
  2142. -
  2143. type: string
  2144. -
  2145. type: object
  2146. properties:
  2147. '@vocab':
  2148. type: string
  2149. hydra:
  2150. type: string
  2151. enum: ['http://www.w3.org/ns/hydra/core#']
  2152. required:
  2153. - '@vocab'
  2154. - hydra
  2155. additionalProperties: true
  2156. '@id':
  2157. readOnly: true
  2158. type: string
  2159. '@type':
  2160. readOnly: true
  2161. type: string
  2162. message:
  2163. type:
  2164. - string
  2165. - 'null'
  2166. owner:
  2167. readOnly: true
  2168. 'owl:maxCardinality': 1
  2169. type:
  2170. - string
  2171. - 'null'
  2172. format: iri-reference
  2173. example: 'https://example.com/'
  2174. ownerName:
  2175. readOnly: true
  2176. type:
  2177. - string
  2178. - 'null'
  2179. post:
  2180. 'owl:maxCardinality': 1
  2181. type:
  2182. - string
  2183. - 'null'
  2184. format: iri-reference
  2185. example: 'https://example.com/'
  2186. createdAt:
  2187. readOnly: true
  2188. type:
  2189. - string
  2190. - 'null'
  2191. format: date-time
  2192. Contact:
  2193. type: object
  2194. description: ''
  2195. deprecated: false
  2196. required:
  2197. - firstName
  2198. - lastName
  2199. - partner
  2200. properties:
  2201. firstName:
  2202. type:
  2203. - string
  2204. - 'null'
  2205. lastName:
  2206. type:
  2207. - string
  2208. - 'null'
  2209. partner:
  2210. 'owl:maxCardinality': 1
  2211. type:
  2212. - string
  2213. - 'null'
  2214. format: iri-reference
  2215. example: 'https://example.com/'
  2216. birthday:
  2217. type:
  2218. - string
  2219. - 'null'
  2220. image:
  2221. 'owl:maxCardinality': 1
  2222. type:
  2223. - string
  2224. - 'null'
  2225. format: iri-reference
  2226. example: 'https://example.com/'
  2227. imageUrl:
  2228. readOnly: true
  2229. type:
  2230. - string
  2231. - 'null'
  2232. position:
  2233. type:
  2234. - string
  2235. - 'null'
  2236. phone:
  2237. type:
  2238. - string
  2239. - 'null'
  2240. email:
  2241. format: email
  2242. externalDocs:
  2243. url: 'https://schema.org/email'
  2244. type:
  2245. - string
  2246. - 'null'
  2247. posts:
  2248. readOnly: true
  2249. type: array
  2250. items:
  2251. type: string
  2252. format: iri-reference
  2253. example: 'https://example.com/'
  2254. createdAt:
  2255. readOnly: true
  2256. type:
  2257. - string
  2258. - 'null'
  2259. format: date-time
  2260. Contact.jsonhal:
  2261. type: object
  2262. description: ''
  2263. deprecated: false
  2264. required:
  2265. - firstName
  2266. - lastName
  2267. - partner
  2268. properties:
  2269. _links:
  2270. type: object
  2271. properties:
  2272. self:
  2273. type: object
  2274. properties:
  2275. href:
  2276. type: string
  2277. format: iri-reference
  2278. firstName:
  2279. type:
  2280. - string
  2281. - 'null'
  2282. lastName:
  2283. type:
  2284. - string
  2285. - 'null'
  2286. partner:
  2287. 'owl:maxCardinality': 1
  2288. type:
  2289. - string
  2290. - 'null'
  2291. format: iri-reference
  2292. example: 'https://example.com/'
  2293. birthday:
  2294. type:
  2295. - string
  2296. - 'null'
  2297. image:
  2298. 'owl:maxCardinality': 1
  2299. type:
  2300. - string
  2301. - 'null'
  2302. format: iri-reference
  2303. example: 'https://example.com/'
  2304. imageUrl:
  2305. readOnly: true
  2306. type:
  2307. - string
  2308. - 'null'
  2309. position:
  2310. type:
  2311. - string
  2312. - 'null'
  2313. phone:
  2314. type:
  2315. - string
  2316. - 'null'
  2317. email:
  2318. format: email
  2319. externalDocs:
  2320. url: 'https://schema.org/email'
  2321. type:
  2322. - string
  2323. - 'null'
  2324. posts:
  2325. readOnly: true
  2326. type: array
  2327. items:
  2328. type: string
  2329. format: iri-reference
  2330. example: 'https://example.com/'
  2331. createdAt:
  2332. readOnly: true
  2333. type:
  2334. - string
  2335. - 'null'
  2336. format: date-time
  2337. Contact.jsonld:
  2338. type: object
  2339. description: ''
  2340. deprecated: false
  2341. required:
  2342. - firstName
  2343. - lastName
  2344. - partner
  2345. properties:
  2346. '@context':
  2347. readOnly: true
  2348. oneOf:
  2349. -
  2350. type: string
  2351. -
  2352. type: object
  2353. properties:
  2354. '@vocab':
  2355. type: string
  2356. hydra:
  2357. type: string
  2358. enum: ['http://www.w3.org/ns/hydra/core#']
  2359. required:
  2360. - '@vocab'
  2361. - hydra
  2362. additionalProperties: true
  2363. '@id':
  2364. readOnly: true
  2365. type: string
  2366. '@type':
  2367. readOnly: true
  2368. type: string
  2369. firstName:
  2370. type:
  2371. - string
  2372. - 'null'
  2373. lastName:
  2374. type:
  2375. - string
  2376. - 'null'
  2377. partner:
  2378. 'owl:maxCardinality': 1
  2379. type:
  2380. - string
  2381. - 'null'
  2382. format: iri-reference
  2383. example: 'https://example.com/'
  2384. birthday:
  2385. type:
  2386. - string
  2387. - 'null'
  2388. image:
  2389. 'owl:maxCardinality': 1
  2390. type:
  2391. - string
  2392. - 'null'
  2393. format: iri-reference
  2394. example: 'https://example.com/'
  2395. imageUrl:
  2396. readOnly: true
  2397. type:
  2398. - string
  2399. - 'null'
  2400. position:
  2401. type:
  2402. - string
  2403. - 'null'
  2404. phone:
  2405. type:
  2406. - string
  2407. - 'null'
  2408. email:
  2409. format: email
  2410. externalDocs:
  2411. url: 'https://schema.org/email'
  2412. type:
  2413. - string
  2414. - 'null'
  2415. posts:
  2416. readOnly: true
  2417. type: array
  2418. items:
  2419. type: string
  2420. format: iri-reference
  2421. example: 'https://example.com/'
  2422. createdAt:
  2423. readOnly: true
  2424. type:
  2425. - string
  2426. - 'null'
  2427. format: date-time
  2428. Media-media_object.read:
  2429. type: object
  2430. description: ''
  2431. deprecated: false
  2432. externalDocs:
  2433. url: 'https://schema.org/MediaObject'
  2434. properties:
  2435. contentUrl:
  2436. externalDocs:
  2437. url: 'https://schema.org/contentUrl'
  2438. type:
  2439. - string
  2440. - 'null'
  2441. Media.jsonhal-media_object.read:
  2442. type: object
  2443. description: ''
  2444. deprecated: false
  2445. externalDocs:
  2446. url: 'https://schema.org/MediaObject'
  2447. properties:
  2448. _links:
  2449. type: object
  2450. properties:
  2451. self:
  2452. type: object
  2453. properties:
  2454. href:
  2455. type: string
  2456. format: iri-reference
  2457. contentUrl:
  2458. externalDocs:
  2459. url: 'https://schema.org/contentUrl'
  2460. type:
  2461. - string
  2462. - 'null'
  2463. Media.jsonld-media_object.read:
  2464. type: object
  2465. description: ''
  2466. deprecated: false
  2467. externalDocs:
  2468. url: 'https://schema.org/MediaObject'
  2469. properties:
  2470. '@context':
  2471. readOnly: true
  2472. oneOf:
  2473. -
  2474. type: string
  2475. -
  2476. type: object
  2477. properties:
  2478. '@vocab':
  2479. type: string
  2480. hydra:
  2481. type: string
  2482. enum: ['http://www.w3.org/ns/hydra/core#']
  2483. required:
  2484. - '@vocab'
  2485. - hydra
  2486. additionalProperties: true
  2487. '@id':
  2488. readOnly: true
  2489. type: string
  2490. '@type':
  2491. readOnly: true
  2492. type: string
  2493. contentUrl:
  2494. externalDocs:
  2495. url: 'https://schema.org/contentUrl'
  2496. type:
  2497. - string
  2498. - 'null'
  2499. Partner:
  2500. type: object
  2501. description: ''
  2502. deprecated: false
  2503. required:
  2504. - name
  2505. - partnerType
  2506. properties:
  2507. name:
  2508. type: string
  2509. partnerType:
  2510. type: string
  2511. enum:
  2512. - customer
  2513. - supplier
  2514. - service
  2515. street:
  2516. type:
  2517. - string
  2518. - 'null'
  2519. streetNo:
  2520. type:
  2521. - string
  2522. - 'null'
  2523. zip:
  2524. type:
  2525. - string
  2526. - 'null'
  2527. city:
  2528. type:
  2529. - string
  2530. - 'null'
  2531. country:
  2532. type:
  2533. - string
  2534. - 'null'
  2535. website:
  2536. type:
  2537. - string
  2538. - 'null'
  2539. logo:
  2540. 'owl:maxCardinality': 1
  2541. type:
  2542. - string
  2543. - 'null'
  2544. format: iri-reference
  2545. example: 'https://example.com/'
  2546. logoUrl:
  2547. readOnly: true
  2548. type:
  2549. - string
  2550. - 'null'
  2551. createdAt:
  2552. readOnly: true
  2553. type:
  2554. - string
  2555. - 'null'
  2556. format: date-time
  2557. posts:
  2558. readOnly: true
  2559. type: array
  2560. items:
  2561. type: string
  2562. format: iri-reference
  2563. example: 'https://example.com/'
  2564. contacts:
  2565. readOnly: true
  2566. type: array
  2567. items:
  2568. type: string
  2569. format: iri-reference
  2570. example: 'https://example.com/'
  2571. Partner.jsonhal:
  2572. type: object
  2573. description: ''
  2574. deprecated: false
  2575. required:
  2576. - name
  2577. - partnerType
  2578. properties:
  2579. _links:
  2580. type: object
  2581. properties:
  2582. self:
  2583. type: object
  2584. properties:
  2585. href:
  2586. type: string
  2587. format: iri-reference
  2588. name:
  2589. type: string
  2590. partnerType:
  2591. type: string
  2592. enum:
  2593. - customer
  2594. - supplier
  2595. - service
  2596. street:
  2597. type:
  2598. - string
  2599. - 'null'
  2600. streetNo:
  2601. type:
  2602. - string
  2603. - 'null'
  2604. zip:
  2605. type:
  2606. - string
  2607. - 'null'
  2608. city:
  2609. type:
  2610. - string
  2611. - 'null'
  2612. country:
  2613. type:
  2614. - string
  2615. - 'null'
  2616. website:
  2617. type:
  2618. - string
  2619. - 'null'
  2620. logo:
  2621. 'owl:maxCardinality': 1
  2622. type:
  2623. - string
  2624. - 'null'
  2625. format: iri-reference
  2626. example: 'https://example.com/'
  2627. logoUrl:
  2628. readOnly: true
  2629. type:
  2630. - string
  2631. - 'null'
  2632. createdAt:
  2633. readOnly: true
  2634. type:
  2635. - string
  2636. - 'null'
  2637. format: date-time
  2638. posts:
  2639. readOnly: true
  2640. type: array
  2641. items:
  2642. type: string
  2643. format: iri-reference
  2644. example: 'https://example.com/'
  2645. contacts:
  2646. readOnly: true
  2647. type: array
  2648. items:
  2649. type: string
  2650. format: iri-reference
  2651. example: 'https://example.com/'
  2652. Partner.jsonld:
  2653. type: object
  2654. description: ''
  2655. deprecated: false
  2656. required:
  2657. - name
  2658. - partnerType
  2659. properties:
  2660. '@context':
  2661. readOnly: true
  2662. oneOf:
  2663. -
  2664. type: string
  2665. -
  2666. type: object
  2667. properties:
  2668. '@vocab':
  2669. type: string
  2670. hydra:
  2671. type: string
  2672. enum: ['http://www.w3.org/ns/hydra/core#']
  2673. required:
  2674. - '@vocab'
  2675. - hydra
  2676. additionalProperties: true
  2677. '@id':
  2678. readOnly: true
  2679. type: string
  2680. '@type':
  2681. readOnly: true
  2682. type: string
  2683. name:
  2684. type: string
  2685. partnerType:
  2686. type: string
  2687. enum:
  2688. - customer
  2689. - supplier
  2690. - service
  2691. street:
  2692. type:
  2693. - string
  2694. - 'null'
  2695. streetNo:
  2696. type:
  2697. - string
  2698. - 'null'
  2699. zip:
  2700. type:
  2701. - string
  2702. - 'null'
  2703. city:
  2704. type:
  2705. - string
  2706. - 'null'
  2707. country:
  2708. type:
  2709. - string
  2710. - 'null'
  2711. website:
  2712. type:
  2713. - string
  2714. - 'null'
  2715. logo:
  2716. 'owl:maxCardinality': 1
  2717. type:
  2718. - string
  2719. - 'null'
  2720. format: iri-reference
  2721. example: 'https://example.com/'
  2722. logoUrl:
  2723. readOnly: true
  2724. type:
  2725. - string
  2726. - 'null'
  2727. createdAt:
  2728. readOnly: true
  2729. type:
  2730. - string
  2731. - 'null'
  2732. format: date-time
  2733. posts:
  2734. readOnly: true
  2735. type: array
  2736. items:
  2737. type: string
  2738. format: iri-reference
  2739. example: 'https://example.com/'
  2740. contacts:
  2741. readOnly: true
  2742. type: array
  2743. items:
  2744. type: string
  2745. format: iri-reference
  2746. example: 'https://example.com/'
  2747. Post:
  2748. type: object
  2749. description: ''
  2750. deprecated: false
  2751. required:
  2752. - headline
  2753. - message
  2754. properties:
  2755. headline:
  2756. type:
  2757. - string
  2758. - 'null'
  2759. message:
  2760. type:
  2761. - string
  2762. - 'null'
  2763. owner:
  2764. readOnly: true
  2765. 'owl:maxCardinality': 1
  2766. type:
  2767. - string
  2768. - 'null'
  2769. format: iri-reference
  2770. example: 'https://example.com/'
  2771. ownerName:
  2772. readOnly: true
  2773. type:
  2774. - string
  2775. - 'null'
  2776. partner:
  2777. 'owl:maxCardinality': 1
  2778. type:
  2779. - string
  2780. - 'null'
  2781. format: iri-reference
  2782. example: 'https://example.com/'
  2783. contact:
  2784. 'owl:maxCardinality': 1
  2785. type:
  2786. - string
  2787. - 'null'
  2788. format: iri-reference
  2789. example: 'https://example.com/'
  2790. comments:
  2791. description: 'array<int, CommentApi>'
  2792. type: array
  2793. items:
  2794. $ref: '#/components/schemas/Comment'
  2795. createdAt:
  2796. readOnly: true
  2797. type:
  2798. - string
  2799. - 'null'
  2800. format: date-time
  2801. Post-posting.create:
  2802. type: object
  2803. description: ''
  2804. deprecated: false
  2805. required:
  2806. - headline
  2807. - message
  2808. properties:
  2809. headline:
  2810. type:
  2811. - string
  2812. - 'null'
  2813. message:
  2814. type:
  2815. - string
  2816. - 'null'
  2817. partner:
  2818. 'owl:maxCardinality': 1
  2819. type:
  2820. - string
  2821. - 'null'
  2822. format: iri-reference
  2823. example: 'https://example.com/'
  2824. contact:
  2825. 'owl:maxCardinality': 1
  2826. type:
  2827. - string
  2828. - 'null'
  2829. format: iri-reference
  2830. example: 'https://example.com/'
  2831. Post-posting.patch:
  2832. type: object
  2833. description: ''
  2834. deprecated: false
  2835. required:
  2836. - headline
  2837. - message
  2838. properties:
  2839. headline:
  2840. type:
  2841. - string
  2842. - 'null'
  2843. message:
  2844. type:
  2845. - string
  2846. - 'null'
  2847. Post.jsonhal:
  2848. type: object
  2849. description: ''
  2850. deprecated: false
  2851. required:
  2852. - headline
  2853. - message
  2854. properties:
  2855. _links:
  2856. type: object
  2857. properties:
  2858. self:
  2859. type: object
  2860. properties:
  2861. href:
  2862. type: string
  2863. format: iri-reference
  2864. headline:
  2865. type:
  2866. - string
  2867. - 'null'
  2868. message:
  2869. type:
  2870. - string
  2871. - 'null'
  2872. owner:
  2873. readOnly: true
  2874. 'owl:maxCardinality': 1
  2875. type:
  2876. - string
  2877. - 'null'
  2878. format: iri-reference
  2879. example: 'https://example.com/'
  2880. ownerName:
  2881. readOnly: true
  2882. type:
  2883. - string
  2884. - 'null'
  2885. partner:
  2886. 'owl:maxCardinality': 1
  2887. type:
  2888. - string
  2889. - 'null'
  2890. format: iri-reference
  2891. example: 'https://example.com/'
  2892. contact:
  2893. 'owl:maxCardinality': 1
  2894. type:
  2895. - string
  2896. - 'null'
  2897. format: iri-reference
  2898. example: 'https://example.com/'
  2899. comments:
  2900. description: 'array<int, CommentApi>'
  2901. type: array
  2902. items:
  2903. $ref: '#/components/schemas/Comment.jsonhal'
  2904. createdAt:
  2905. readOnly: true
  2906. type:
  2907. - string
  2908. - 'null'
  2909. format: date-time
  2910. Post.jsonhal-posting.create:
  2911. type: object
  2912. description: ''
  2913. deprecated: false
  2914. required:
  2915. - headline
  2916. - message
  2917. properties:
  2918. _links:
  2919. type: object
  2920. properties:
  2921. self:
  2922. type: object
  2923. properties:
  2924. href:
  2925. type: string
  2926. format: iri-reference
  2927. headline:
  2928. type:
  2929. - string
  2930. - 'null'
  2931. message:
  2932. type:
  2933. - string
  2934. - 'null'
  2935. partner:
  2936. 'owl:maxCardinality': 1
  2937. type:
  2938. - string
  2939. - 'null'
  2940. format: iri-reference
  2941. example: 'https://example.com/'
  2942. contact:
  2943. 'owl:maxCardinality': 1
  2944. type:
  2945. - string
  2946. - 'null'
  2947. format: iri-reference
  2948. example: 'https://example.com/'
  2949. Post.jsonld:
  2950. type: object
  2951. description: ''
  2952. deprecated: false
  2953. required:
  2954. - headline
  2955. - message
  2956. properties:
  2957. '@context':
  2958. readOnly: true
  2959. oneOf:
  2960. -
  2961. type: string
  2962. -
  2963. type: object
  2964. properties:
  2965. '@vocab':
  2966. type: string
  2967. hydra:
  2968. type: string
  2969. enum: ['http://www.w3.org/ns/hydra/core#']
  2970. required:
  2971. - '@vocab'
  2972. - hydra
  2973. additionalProperties: true
  2974. '@id':
  2975. readOnly: true
  2976. type: string
  2977. '@type':
  2978. readOnly: true
  2979. type: string
  2980. headline:
  2981. type:
  2982. - string
  2983. - 'null'
  2984. message:
  2985. type:
  2986. - string
  2987. - 'null'
  2988. owner:
  2989. readOnly: true
  2990. 'owl:maxCardinality': 1
  2991. type:
  2992. - string
  2993. - 'null'
  2994. format: iri-reference
  2995. example: 'https://example.com/'
  2996. ownerName:
  2997. readOnly: true
  2998. type:
  2999. - string
  3000. - 'null'
  3001. partner:
  3002. 'owl:maxCardinality': 1
  3003. type:
  3004. - string
  3005. - 'null'
  3006. format: iri-reference
  3007. example: 'https://example.com/'
  3008. contact:
  3009. 'owl:maxCardinality': 1
  3010. type:
  3011. - string
  3012. - 'null'
  3013. format: iri-reference
  3014. example: 'https://example.com/'
  3015. comments:
  3016. description: 'array<int, CommentApi>'
  3017. type: array
  3018. items:
  3019. $ref: '#/components/schemas/Comment.jsonld'
  3020. createdAt:
  3021. readOnly: true
  3022. type:
  3023. - string
  3024. - 'null'
  3025. format: date-time
  3026. Post.jsonld-posting.create:
  3027. type: object
  3028. description: ''
  3029. deprecated: false
  3030. required:
  3031. - headline
  3032. - message
  3033. properties:
  3034. headline:
  3035. type:
  3036. - string
  3037. - 'null'
  3038. message:
  3039. type:
  3040. - string
  3041. - 'null'
  3042. partner:
  3043. 'owl:maxCardinality': 1
  3044. type:
  3045. - string
  3046. - 'null'
  3047. format: iri-reference
  3048. example: 'https://example.com/'
  3049. contact:
  3050. 'owl:maxCardinality': 1
  3051. type:
  3052. - string
  3053. - 'null'
  3054. format: iri-reference
  3055. example: 'https://example.com/'
  3056. Product:
  3057. type: object
  3058. description: ''
  3059. deprecated: false
  3060. required:
  3061. - name
  3062. properties:
  3063. name:
  3064. type: string
  3065. description:
  3066. type:
  3067. - string
  3068. - 'null'
  3069. image:
  3070. 'owl:maxCardinality': 1
  3071. type:
  3072. - string
  3073. - 'null'
  3074. format: iri-reference
  3075. example: 'https://example.com/'
  3076. imageUrl:
  3077. readOnly: true
  3078. type:
  3079. - string
  3080. - 'null'
  3081. createdAt:
  3082. type:
  3083. - string
  3084. - 'null'
  3085. format: date-time
  3086. Product.jsonhal:
  3087. type: object
  3088. description: ''
  3089. deprecated: false
  3090. required:
  3091. - name
  3092. properties:
  3093. _links:
  3094. type: object
  3095. properties:
  3096. self:
  3097. type: object
  3098. properties:
  3099. href:
  3100. type: string
  3101. format: iri-reference
  3102. name:
  3103. type: string
  3104. description:
  3105. type:
  3106. - string
  3107. - 'null'
  3108. image:
  3109. 'owl:maxCardinality': 1
  3110. type:
  3111. - string
  3112. - 'null'
  3113. format: iri-reference
  3114. example: 'https://example.com/'
  3115. imageUrl:
  3116. readOnly: true
  3117. type:
  3118. - string
  3119. - 'null'
  3120. createdAt:
  3121. type:
  3122. - string
  3123. - 'null'
  3124. format: date-time
  3125. Product.jsonld:
  3126. type: object
  3127. description: ''
  3128. deprecated: false
  3129. required:
  3130. - name
  3131. properties:
  3132. '@context':
  3133. readOnly: true
  3134. oneOf:
  3135. -
  3136. type: string
  3137. -
  3138. type: object
  3139. properties:
  3140. '@vocab':
  3141. type: string
  3142. hydra:
  3143. type: string
  3144. enum: ['http://www.w3.org/ns/hydra/core#']
  3145. required:
  3146. - '@vocab'
  3147. - hydra
  3148. additionalProperties: true
  3149. '@id':
  3150. readOnly: true
  3151. type: string
  3152. '@type':
  3153. readOnly: true
  3154. type: string
  3155. name:
  3156. type: string
  3157. description:
  3158. type:
  3159. - string
  3160. - 'null'
  3161. image:
  3162. 'owl:maxCardinality': 1
  3163. type:
  3164. - string
  3165. - 'null'
  3166. format: iri-reference
  3167. example: 'https://example.com/'
  3168. imageUrl:
  3169. readOnly: true
  3170. type:
  3171. - string
  3172. - 'null'
  3173. createdAt:
  3174. type:
  3175. - string
  3176. - 'null'
  3177. format: date-time
  3178. Task:
  3179. type: object
  3180. description: ''
  3181. deprecated: false
  3182. required:
  3183. - headline
  3184. - description
  3185. - assignedTo
  3186. - dueAt
  3187. - prio
  3188. properties:
  3189. headline:
  3190. type:
  3191. - string
  3192. - 'null'
  3193. description:
  3194. type:
  3195. - string
  3196. - 'null'
  3197. createdBy:
  3198. readOnly: true
  3199. 'owl:maxCardinality': 1
  3200. type:
  3201. - string
  3202. - 'null'
  3203. format: iri-reference
  3204. example: 'https://example.com/'
  3205. createdByName:
  3206. readOnly: true
  3207. type:
  3208. - string
  3209. - 'null'
  3210. assignedTo:
  3211. 'owl:maxCardinality': 1
  3212. type:
  3213. - string
  3214. - 'null'
  3215. format: iri-reference
  3216. example: 'https://example.com/'
  3217. assignedToName:
  3218. readOnly: true
  3219. type:
  3220. - string
  3221. - 'null'
  3222. dueAt:
  3223. type:
  3224. - string
  3225. - 'null'
  3226. format: date-time
  3227. partner:
  3228. 'owl:maxCardinality': 1
  3229. type:
  3230. - string
  3231. - 'null'
  3232. format: iri-reference
  3233. example: 'https://example.com/'
  3234. partnerName:
  3235. readOnly: true
  3236. type:
  3237. - string
  3238. - 'null'
  3239. contact:
  3240. 'owl:maxCardinality': 1
  3241. type:
  3242. - string
  3243. - 'null'
  3244. format: iri-reference
  3245. example: 'https://example.com/'
  3246. contactName:
  3247. readOnly: true
  3248. type:
  3249. - string
  3250. - 'null'
  3251. prio:
  3252. type: string
  3253. enum:
  3254. - low
  3255. - medium
  3256. - high
  3257. completed:
  3258. type:
  3259. - boolean
  3260. - 'null'
  3261. createdAt:
  3262. readOnly: true
  3263. type:
  3264. - string
  3265. - 'null'
  3266. format: date-time
  3267. Task.jsonhal:
  3268. type: object
  3269. description: ''
  3270. deprecated: false
  3271. required:
  3272. - headline
  3273. - description
  3274. - assignedTo
  3275. - dueAt
  3276. - prio
  3277. properties:
  3278. _links:
  3279. type: object
  3280. properties:
  3281. self:
  3282. type: object
  3283. properties:
  3284. href:
  3285. type: string
  3286. format: iri-reference
  3287. headline:
  3288. type:
  3289. - string
  3290. - 'null'
  3291. description:
  3292. type:
  3293. - string
  3294. - 'null'
  3295. createdBy:
  3296. readOnly: true
  3297. 'owl:maxCardinality': 1
  3298. type:
  3299. - string
  3300. - 'null'
  3301. format: iri-reference
  3302. example: 'https://example.com/'
  3303. createdByName:
  3304. readOnly: true
  3305. type:
  3306. - string
  3307. - 'null'
  3308. assignedTo:
  3309. 'owl:maxCardinality': 1
  3310. type:
  3311. - string
  3312. - 'null'
  3313. format: iri-reference
  3314. example: 'https://example.com/'
  3315. assignedToName:
  3316. readOnly: true
  3317. type:
  3318. - string
  3319. - 'null'
  3320. dueAt:
  3321. type:
  3322. - string
  3323. - 'null'
  3324. format: date-time
  3325. partner:
  3326. 'owl:maxCardinality': 1
  3327. type:
  3328. - string
  3329. - 'null'
  3330. format: iri-reference
  3331. example: 'https://example.com/'
  3332. partnerName:
  3333. readOnly: true
  3334. type:
  3335. - string
  3336. - 'null'
  3337. contact:
  3338. 'owl:maxCardinality': 1
  3339. type:
  3340. - string
  3341. - 'null'
  3342. format: iri-reference
  3343. example: 'https://example.com/'
  3344. contactName:
  3345. readOnly: true
  3346. type:
  3347. - string
  3348. - 'null'
  3349. prio:
  3350. type: string
  3351. enum:
  3352. - low
  3353. - medium
  3354. - high
  3355. completed:
  3356. type:
  3357. - boolean
  3358. - 'null'
  3359. createdAt:
  3360. readOnly: true
  3361. type:
  3362. - string
  3363. - 'null'
  3364. format: date-time
  3365. Task.jsonld:
  3366. type: object
  3367. description: ''
  3368. deprecated: false
  3369. required:
  3370. - headline
  3371. - description
  3372. - assignedTo
  3373. - dueAt
  3374. - prio
  3375. properties:
  3376. '@context':
  3377. readOnly: true
  3378. oneOf:
  3379. -
  3380. type: string
  3381. -
  3382. type: object
  3383. properties:
  3384. '@vocab':
  3385. type: string
  3386. hydra:
  3387. type: string
  3388. enum: ['http://www.w3.org/ns/hydra/core#']
  3389. required:
  3390. - '@vocab'
  3391. - hydra
  3392. additionalProperties: true
  3393. '@id':
  3394. readOnly: true
  3395. type: string
  3396. '@type':
  3397. readOnly: true
  3398. type: string
  3399. headline:
  3400. type:
  3401. - string
  3402. - 'null'
  3403. description:
  3404. type:
  3405. - string
  3406. - 'null'
  3407. createdBy:
  3408. readOnly: true
  3409. 'owl:maxCardinality': 1
  3410. type:
  3411. - string
  3412. - 'null'
  3413. format: iri-reference
  3414. example: 'https://example.com/'
  3415. createdByName:
  3416. readOnly: true
  3417. type:
  3418. - string
  3419. - 'null'
  3420. assignedTo:
  3421. 'owl:maxCardinality': 1
  3422. type:
  3423. - string
  3424. - 'null'
  3425. format: iri-reference
  3426. example: 'https://example.com/'
  3427. assignedToName:
  3428. readOnly: true
  3429. type:
  3430. - string
  3431. - 'null'
  3432. dueAt:
  3433. type:
  3434. - string
  3435. - 'null'
  3436. format: date-time
  3437. partner:
  3438. 'owl:maxCardinality': 1
  3439. type:
  3440. - string
  3441. - 'null'
  3442. format: iri-reference
  3443. example: 'https://example.com/'
  3444. partnerName:
  3445. readOnly: true
  3446. type:
  3447. - string
  3448. - 'null'
  3449. contact:
  3450. 'owl:maxCardinality': 1
  3451. type:
  3452. - string
  3453. - 'null'
  3454. format: iri-reference
  3455. example: 'https://example.com/'
  3456. contactName:
  3457. readOnly: true
  3458. type:
  3459. - string
  3460. - 'null'
  3461. prio:
  3462. type: string
  3463. enum:
  3464. - low
  3465. - medium
  3466. - high
  3467. completed:
  3468. type:
  3469. - boolean
  3470. - 'null'
  3471. createdAt:
  3472. readOnly: true
  3473. type:
  3474. - string
  3475. - 'null'
  3476. format: date-time
  3477. User:
  3478. type: object
  3479. description: ''
  3480. deprecated: false
  3481. required:
  3482. - email
  3483. - firstName
  3484. - lastName
  3485. properties:
  3486. email:
  3487. format: email
  3488. externalDocs:
  3489. url: 'https://schema.org/email'
  3490. type:
  3491. - string
  3492. - 'null'
  3493. firstName:
  3494. type:
  3495. - string
  3496. - 'null'
  3497. lastName:
  3498. type:
  3499. - string
  3500. - 'null'
  3501. image:
  3502. 'owl:maxCardinality': 1
  3503. type:
  3504. - string
  3505. - 'null'
  3506. format: iri-reference
  3507. example: 'https://example.com/'
  3508. password:
  3509. writeOnly: true
  3510. description: 'The plaintext password when being set or changed.'
  3511. type:
  3512. - string
  3513. - 'null'
  3514. active:
  3515. type: boolean
  3516. createdAt:
  3517. readOnly: true
  3518. type:
  3519. - string
  3520. - 'null'
  3521. format: date-time
  3522. User.jsonhal:
  3523. type: object
  3524. description: ''
  3525. deprecated: false
  3526. required:
  3527. - email
  3528. - firstName
  3529. - lastName
  3530. properties:
  3531. _links:
  3532. type: object
  3533. properties:
  3534. self:
  3535. type: object
  3536. properties:
  3537. href:
  3538. type: string
  3539. format: iri-reference
  3540. email:
  3541. format: email
  3542. externalDocs:
  3543. url: 'https://schema.org/email'
  3544. type:
  3545. - string
  3546. - 'null'
  3547. firstName:
  3548. type:
  3549. - string
  3550. - 'null'
  3551. lastName:
  3552. type:
  3553. - string
  3554. - 'null'
  3555. image:
  3556. 'owl:maxCardinality': 1
  3557. type:
  3558. - string
  3559. - 'null'
  3560. format: iri-reference
  3561. example: 'https://example.com/'
  3562. password:
  3563. writeOnly: true
  3564. description: 'The plaintext password when being set or changed.'
  3565. type:
  3566. - string
  3567. - 'null'
  3568. active:
  3569. type: boolean
  3570. createdAt:
  3571. readOnly: true
  3572. type:
  3573. - string
  3574. - 'null'
  3575. format: date-time
  3576. User.jsonld:
  3577. type: object
  3578. description: ''
  3579. deprecated: false
  3580. required:
  3581. - email
  3582. - firstName
  3583. - lastName
  3584. properties:
  3585. '@context':
  3586. readOnly: true
  3587. oneOf:
  3588. -
  3589. type: string
  3590. -
  3591. type: object
  3592. properties:
  3593. '@vocab':
  3594. type: string
  3595. hydra:
  3596. type: string
  3597. enum: ['http://www.w3.org/ns/hydra/core#']
  3598. required:
  3599. - '@vocab'
  3600. - hydra
  3601. additionalProperties: true
  3602. '@id':
  3603. readOnly: true
  3604. type: string
  3605. '@type':
  3606. readOnly: true
  3607. type: string
  3608. email:
  3609. format: email
  3610. externalDocs:
  3611. url: 'https://schema.org/email'
  3612. type:
  3613. - string
  3614. - 'null'
  3615. firstName:
  3616. type:
  3617. - string
  3618. - 'null'
  3619. lastName:
  3620. type:
  3621. - string
  3622. - 'null'
  3623. image:
  3624. 'owl:maxCardinality': 1
  3625. type:
  3626. - string
  3627. - 'null'
  3628. format: iri-reference
  3629. example: 'https://example.com/'
  3630. password:
  3631. writeOnly: true
  3632. description: 'The plaintext password when being set or changed.'
  3633. type:
  3634. - string
  3635. - 'null'
  3636. active:
  3637. type: boolean
  3638. createdAt:
  3639. readOnly: true
  3640. type:
  3641. - string
  3642. - 'null'
  3643. format: date-time
  3644. responses: { }
  3645. parameters: { }
  3646. examples: { }
  3647. requestBodies: { }
  3648. headers: { }
  3649. securitySchemes:
  3650. JWT:
  3651. type: http
  3652. scheme: bearer
  3653. bearerFormat: JWT
  3654. security:
  3655. -
  3656. JWT: []
  3657. tags: []