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

2487 regels
72 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/media_objects:
  504. get:
  505. operationId: api_media_objects_get_collection
  506. tags:
  507. - MediaObject
  508. responses:
  509. 200:
  510. description: 'MediaObject collection'
  511. content:
  512. application/ld+json:
  513. schema:
  514. type: object
  515. properties:
  516. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/MediaObject.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/MediaObject-media_object.read'
  527. text/html:
  528. schema:
  529. type: array
  530. items:
  531. $ref: '#/components/schemas/MediaObject-media_object.read'
  532. application/hal+json:
  533. schema:
  534. type: object
  535. properties:
  536. _embedded: { type: array, items: { $ref: '#/components/schemas/MediaObject.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 MediaObject resources.'
  544. description: 'Retrieves the collection of MediaObject 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_media_objects_post
  577. tags:
  578. - MediaObject
  579. responses:
  580. 201:
  581. description: 'MediaObject resource created'
  582. content:
  583. application/ld+json:
  584. schema:
  585. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  586. application/json:
  587. schema:
  588. $ref: '#/components/schemas/MediaObject-media_object.read'
  589. text/html:
  590. schema:
  591. $ref: '#/components/schemas/MediaObject-media_object.read'
  592. application/hal+json:
  593. schema:
  594. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  595. links: { }
  596. 400:
  597. description: 'Invalid input'
  598. 422:
  599. description: 'Unprocessable entity'
  600. summary: 'Creates a MediaObject resource.'
  601. description: 'Creates a MediaObject 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/media_objects/{id}':
  617. get:
  618. operationId: api_media_objects_id_get
  619. tags:
  620. - MediaObject
  621. responses:
  622. 200:
  623. description: 'MediaObject resource'
  624. content:
  625. application/ld+json:
  626. schema:
  627. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  628. application/json:
  629. schema:
  630. $ref: '#/components/schemas/MediaObject-media_object.read'
  631. text/html:
  632. schema:
  633. $ref: '#/components/schemas/MediaObject-media_object.read'
  634. application/hal+json:
  635. schema:
  636. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  637. 404:
  638. description: 'Resource not found'
  639. summary: 'Retrieves a MediaObject resource.'
  640. description: 'Retrieves a MediaObject 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. parameters: []
  656. /api/partners:
  657. get:
  658. operationId: api_partners_get_collection
  659. tags:
  660. - Partner
  661. responses:
  662. 200:
  663. description: 'Partner collection'
  664. content:
  665. application/ld+json:
  666. schema:
  667. type: object
  668. properties:
  669. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  670. 'hydra:totalItems': { type: integer, minimum: 0 }
  671. '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 } }
  672. '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 } } } } } }
  673. required:
  674. - 'hydra:member'
  675. application/json:
  676. schema:
  677. type: array
  678. items:
  679. $ref: '#/components/schemas/Partner'
  680. text/html:
  681. schema:
  682. type: array
  683. items:
  684. $ref: '#/components/schemas/Partner'
  685. application/hal+json:
  686. schema:
  687. type: object
  688. properties:
  689. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  690. totalItems: { type: integer, minimum: 0 }
  691. itemsPerPage: { type: integer, minimum: 0 }
  692. _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 } } } } }
  693. required:
  694. - _links
  695. - _embedded
  696. summary: 'Retrieves the collection of Partner resources.'
  697. description: 'Retrieves the collection of Partner resources.'
  698. parameters:
  699. -
  700. name: page
  701. in: query
  702. description: 'The collection page number'
  703. required: false
  704. deprecated: false
  705. allowEmptyValue: true
  706. schema:
  707. type: integer
  708. default: 1
  709. style: form
  710. explode: false
  711. allowReserved: false
  712. -
  713. name: itemsPerPage
  714. in: query
  715. description: 'The number of items per page'
  716. required: false
  717. deprecated: false
  718. allowEmptyValue: true
  719. schema:
  720. type: integer
  721. default: 10
  722. minimum: 0
  723. maximum: 50
  724. style: form
  725. explode: false
  726. allowReserved: false
  727. -
  728. name: type
  729. in: query
  730. description: ''
  731. required: false
  732. deprecated: false
  733. allowEmptyValue: true
  734. schema:
  735. type: string
  736. style: form
  737. explode: false
  738. allowReserved: false
  739. -
  740. name: 'type[]'
  741. in: query
  742. description: ''
  743. required: false
  744. deprecated: false
  745. allowEmptyValue: true
  746. schema:
  747. type: array
  748. items:
  749. type: string
  750. style: form
  751. explode: true
  752. allowReserved: false
  753. -
  754. name: 'order[name]'
  755. in: query
  756. description: ''
  757. required: false
  758. deprecated: false
  759. allowEmptyValue: true
  760. schema:
  761. type: string
  762. enum:
  763. - asc
  764. - desc
  765. style: form
  766. explode: false
  767. allowReserved: false
  768. -
  769. name: 'order[city]'
  770. in: query
  771. description: ''
  772. required: false
  773. deprecated: false
  774. allowEmptyValue: true
  775. schema:
  776. type: string
  777. enum:
  778. - asc
  779. - desc
  780. style: form
  781. explode: false
  782. allowReserved: false
  783. -
  784. name: 'order[website]'
  785. in: query
  786. description: ''
  787. required: false
  788. deprecated: false
  789. allowEmptyValue: true
  790. schema:
  791. type: string
  792. enum:
  793. - asc
  794. - desc
  795. style: form
  796. explode: false
  797. allowReserved: false
  798. deprecated: false
  799. post:
  800. operationId: api_partners_post
  801. tags:
  802. - Partner
  803. responses:
  804. 201:
  805. description: 'Partner resource created'
  806. content:
  807. application/ld+json:
  808. schema:
  809. $ref: '#/components/schemas/Partner.jsonld'
  810. application/json:
  811. schema:
  812. $ref: '#/components/schemas/Partner'
  813. text/html:
  814. schema:
  815. $ref: '#/components/schemas/Partner'
  816. application/hal+json:
  817. schema:
  818. $ref: '#/components/schemas/Partner.jsonhal'
  819. links: { }
  820. 400:
  821. description: 'Invalid input'
  822. 422:
  823. description: 'Unprocessable entity'
  824. summary: 'Creates a Partner resource.'
  825. description: 'Creates a Partner resource.'
  826. parameters: []
  827. requestBody:
  828. description: 'The new Partner resource'
  829. content:
  830. application/ld+json:
  831. schema:
  832. $ref: '#/components/schemas/Partner.jsonld'
  833. application/json:
  834. schema:
  835. $ref: '#/components/schemas/Partner'
  836. text/html:
  837. schema:
  838. $ref: '#/components/schemas/Partner'
  839. application/hal+json:
  840. schema:
  841. $ref: '#/components/schemas/Partner.jsonhal'
  842. required: true
  843. deprecated: false
  844. parameters: []
  845. '/api/partners/{id}':
  846. get:
  847. operationId: api_partners_id_get
  848. tags:
  849. - Partner
  850. responses:
  851. 200:
  852. description: 'Partner resource'
  853. content:
  854. application/ld+json:
  855. schema:
  856. $ref: '#/components/schemas/Partner.jsonld'
  857. application/json:
  858. schema:
  859. $ref: '#/components/schemas/Partner'
  860. text/html:
  861. schema:
  862. $ref: '#/components/schemas/Partner'
  863. application/hal+json:
  864. schema:
  865. $ref: '#/components/schemas/Partner.jsonhal'
  866. 404:
  867. description: 'Resource not found'
  868. summary: 'Retrieves a Partner resource.'
  869. description: 'Retrieves a Partner resource.'
  870. parameters:
  871. -
  872. name: id
  873. in: path
  874. description: 'PartnerApi identifier'
  875. required: true
  876. deprecated: false
  877. allowEmptyValue: false
  878. schema:
  879. type: string
  880. style: simple
  881. explode: false
  882. allowReserved: false
  883. deprecated: false
  884. delete:
  885. operationId: api_partners_id_delete
  886. tags:
  887. - Partner
  888. responses:
  889. 204:
  890. description: 'Partner resource deleted'
  891. 404:
  892. description: 'Resource not found'
  893. summary: 'Removes the Partner resource.'
  894. description: 'Removes the 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. patch:
  910. operationId: api_partners_id_patch
  911. tags:
  912. - Partner
  913. responses:
  914. 200:
  915. description: 'Partner resource updated'
  916. content:
  917. application/ld+json:
  918. schema:
  919. $ref: '#/components/schemas/Partner.jsonld'
  920. application/json:
  921. schema:
  922. $ref: '#/components/schemas/Partner'
  923. text/html:
  924. schema:
  925. $ref: '#/components/schemas/Partner'
  926. application/hal+json:
  927. schema:
  928. $ref: '#/components/schemas/Partner.jsonhal'
  929. links: { }
  930. 400:
  931. description: 'Invalid input'
  932. 422:
  933. description: 'Unprocessable entity'
  934. 404:
  935. description: 'Resource not found'
  936. summary: 'Updates the Partner resource.'
  937. description: 'Updates the Partner resource.'
  938. parameters:
  939. -
  940. name: id
  941. in: path
  942. description: 'PartnerApi identifier'
  943. required: true
  944. deprecated: false
  945. allowEmptyValue: false
  946. schema:
  947. type: string
  948. style: simple
  949. explode: false
  950. allowReserved: false
  951. requestBody:
  952. description: 'The updated Partner resource'
  953. content:
  954. application/merge-patch+json:
  955. schema:
  956. $ref: '#/components/schemas/Partner'
  957. required: true
  958. deprecated: false
  959. parameters: []
  960. /api/posts:
  961. get:
  962. operationId: api_posts_get_collection
  963. tags:
  964. - Post
  965. responses:
  966. 200:
  967. description: 'Post collection'
  968. content:
  969. application/ld+json:
  970. schema:
  971. type: object
  972. properties:
  973. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  974. 'hydra:totalItems': { type: integer, minimum: 0 }
  975. '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 } }
  976. '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 } } } } } }
  977. required:
  978. - 'hydra:member'
  979. application/json:
  980. schema:
  981. type: array
  982. items:
  983. $ref: '#/components/schemas/Post'
  984. text/html:
  985. schema:
  986. type: array
  987. items:
  988. $ref: '#/components/schemas/Post'
  989. application/hal+json:
  990. schema:
  991. type: object
  992. properties:
  993. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  994. totalItems: { type: integer, minimum: 0 }
  995. itemsPerPage: { type: integer, minimum: 0 }
  996. _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 } } } } }
  997. required:
  998. - _links
  999. - _embedded
  1000. summary: 'Retrieves the collection of Post resources.'
  1001. description: 'Retrieves the collection of Post resources.'
  1002. parameters:
  1003. -
  1004. name: page
  1005. in: query
  1006. description: 'The collection page number'
  1007. required: false
  1008. deprecated: false
  1009. allowEmptyValue: true
  1010. schema:
  1011. type: integer
  1012. default: 1
  1013. style: form
  1014. explode: false
  1015. allowReserved: false
  1016. -
  1017. name: itemsPerPage
  1018. in: query
  1019. description: 'The number of items per page'
  1020. required: false
  1021. deprecated: false
  1022. allowEmptyValue: true
  1023. schema:
  1024. type: integer
  1025. default: 10
  1026. minimum: 0
  1027. maximum: 50
  1028. style: form
  1029. explode: false
  1030. allowReserved: false
  1031. -
  1032. name: partner
  1033. in: query
  1034. description: ''
  1035. required: false
  1036. deprecated: false
  1037. allowEmptyValue: true
  1038. schema:
  1039. type: string
  1040. style: form
  1041. explode: false
  1042. allowReserved: false
  1043. -
  1044. name: 'partner[]'
  1045. in: query
  1046. description: ''
  1047. required: false
  1048. deprecated: false
  1049. allowEmptyValue: true
  1050. schema:
  1051. type: array
  1052. items:
  1053. type: string
  1054. style: form
  1055. explode: true
  1056. allowReserved: false
  1057. -
  1058. name: contact
  1059. in: query
  1060. description: ''
  1061. required: false
  1062. deprecated: false
  1063. allowEmptyValue: true
  1064. schema:
  1065. type: string
  1066. style: form
  1067. explode: false
  1068. allowReserved: false
  1069. -
  1070. name: 'contact[]'
  1071. in: query
  1072. description: ''
  1073. required: false
  1074. deprecated: false
  1075. allowEmptyValue: true
  1076. schema:
  1077. type: array
  1078. items:
  1079. type: string
  1080. style: form
  1081. explode: true
  1082. allowReserved: false
  1083. deprecated: false
  1084. post:
  1085. operationId: api_posts_post
  1086. tags:
  1087. - Post
  1088. responses:
  1089. 201:
  1090. description: 'Post resource created'
  1091. content:
  1092. application/ld+json:
  1093. schema:
  1094. $ref: '#/components/schemas/Post.jsonld'
  1095. application/json:
  1096. schema:
  1097. $ref: '#/components/schemas/Post'
  1098. text/html:
  1099. schema:
  1100. $ref: '#/components/schemas/Post'
  1101. application/hal+json:
  1102. schema:
  1103. $ref: '#/components/schemas/Post.jsonhal'
  1104. links: { }
  1105. 400:
  1106. description: 'Invalid input'
  1107. 422:
  1108. description: 'Unprocessable entity'
  1109. summary: 'Creates a Post resource.'
  1110. description: 'Creates a Post resource.'
  1111. parameters: []
  1112. requestBody:
  1113. description: 'The new Post resource'
  1114. content:
  1115. application/ld+json:
  1116. schema:
  1117. $ref: '#/components/schemas/Post.jsonld'
  1118. application/json:
  1119. schema:
  1120. $ref: '#/components/schemas/Post'
  1121. text/html:
  1122. schema:
  1123. $ref: '#/components/schemas/Post'
  1124. application/hal+json:
  1125. schema:
  1126. $ref: '#/components/schemas/Post.jsonhal'
  1127. required: true
  1128. deprecated: false
  1129. parameters: []
  1130. '/api/posts/{id}':
  1131. get:
  1132. operationId: api_posts_id_get
  1133. tags:
  1134. - Post
  1135. responses:
  1136. 200:
  1137. description: 'Post resource'
  1138. content:
  1139. application/ld+json:
  1140. schema:
  1141. $ref: '#/components/schemas/Post.jsonld'
  1142. application/json:
  1143. schema:
  1144. $ref: '#/components/schemas/Post'
  1145. text/html:
  1146. schema:
  1147. $ref: '#/components/schemas/Post'
  1148. application/hal+json:
  1149. schema:
  1150. $ref: '#/components/schemas/Post.jsonhal'
  1151. 404:
  1152. description: 'Resource not found'
  1153. summary: 'Retrieves a Post resource.'
  1154. description: 'Retrieves a Post resource.'
  1155. parameters:
  1156. -
  1157. name: id
  1158. in: path
  1159. description: 'PostingApi identifier'
  1160. required: true
  1161. deprecated: false
  1162. allowEmptyValue: false
  1163. schema:
  1164. type: string
  1165. style: simple
  1166. explode: false
  1167. allowReserved: false
  1168. deprecated: false
  1169. delete:
  1170. operationId: api_posts_id_delete
  1171. tags:
  1172. - Post
  1173. responses:
  1174. 204:
  1175. description: 'Post resource deleted'
  1176. 404:
  1177. description: 'Resource not found'
  1178. summary: 'Removes the Post resource.'
  1179. description: 'Removes the 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. patch:
  1195. operationId: api_posts_id_patch
  1196. tags:
  1197. - Post
  1198. responses:
  1199. 200:
  1200. description: 'Post resource updated'
  1201. content:
  1202. application/ld+json:
  1203. schema:
  1204. $ref: '#/components/schemas/Post.jsonld'
  1205. application/json:
  1206. schema:
  1207. $ref: '#/components/schemas/Post'
  1208. text/html:
  1209. schema:
  1210. $ref: '#/components/schemas/Post'
  1211. application/hal+json:
  1212. schema:
  1213. $ref: '#/components/schemas/Post.jsonhal'
  1214. links: { }
  1215. 400:
  1216. description: 'Invalid input'
  1217. 422:
  1218. description: 'Unprocessable entity'
  1219. 404:
  1220. description: 'Resource not found'
  1221. summary: 'Updates the Post resource.'
  1222. description: 'Updates the Post resource.'
  1223. parameters:
  1224. -
  1225. name: id
  1226. in: path
  1227. description: 'PostingApi identifier'
  1228. required: true
  1229. deprecated: false
  1230. allowEmptyValue: false
  1231. schema:
  1232. type: string
  1233. style: simple
  1234. explode: false
  1235. allowReserved: false
  1236. requestBody:
  1237. description: 'The updated Post resource'
  1238. content:
  1239. application/merge-patch+json:
  1240. schema:
  1241. $ref: '#/components/schemas/Post'
  1242. required: true
  1243. deprecated: false
  1244. parameters: []
  1245. /api/users:
  1246. get:
  1247. operationId: api_users_get_collection
  1248. tags:
  1249. - User
  1250. responses:
  1251. 200:
  1252. description: 'User collection'
  1253. content:
  1254. application/ld+json:
  1255. schema:
  1256. type: object
  1257. properties:
  1258. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1259. 'hydra:totalItems': { type: integer, minimum: 0 }
  1260. '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 } }
  1261. '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 } } } } } }
  1262. required:
  1263. - 'hydra:member'
  1264. application/json:
  1265. schema:
  1266. type: array
  1267. items:
  1268. $ref: '#/components/schemas/User'
  1269. text/html:
  1270. schema:
  1271. type: array
  1272. items:
  1273. $ref: '#/components/schemas/User'
  1274. application/hal+json:
  1275. schema:
  1276. type: object
  1277. properties:
  1278. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  1279. totalItems: { type: integer, minimum: 0 }
  1280. itemsPerPage: { type: integer, minimum: 0 }
  1281. _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 } } } } }
  1282. required:
  1283. - _links
  1284. - _embedded
  1285. summary: 'Retrieves the collection of User resources.'
  1286. description: 'Retrieves the collection of User resources.'
  1287. parameters:
  1288. -
  1289. name: page
  1290. in: query
  1291. description: 'The collection page number'
  1292. required: false
  1293. deprecated: false
  1294. allowEmptyValue: true
  1295. schema:
  1296. type: integer
  1297. default: 1
  1298. style: form
  1299. explode: false
  1300. allowReserved: false
  1301. -
  1302. name: itemsPerPage
  1303. in: query
  1304. description: 'The number of items per page'
  1305. required: false
  1306. deprecated: false
  1307. allowEmptyValue: true
  1308. schema:
  1309. type: integer
  1310. default: 10
  1311. minimum: 0
  1312. maximum: 50
  1313. style: form
  1314. explode: false
  1315. allowReserved: false
  1316. deprecated: false
  1317. post:
  1318. operationId: api_users_post
  1319. tags:
  1320. - User
  1321. responses:
  1322. 201:
  1323. description: 'User resource created'
  1324. content:
  1325. application/ld+json:
  1326. schema:
  1327. $ref: '#/components/schemas/User.jsonld'
  1328. application/json:
  1329. schema:
  1330. $ref: '#/components/schemas/User'
  1331. text/html:
  1332. schema:
  1333. $ref: '#/components/schemas/User'
  1334. application/hal+json:
  1335. schema:
  1336. $ref: '#/components/schemas/User.jsonhal'
  1337. links: { }
  1338. 400:
  1339. description: 'Invalid input'
  1340. 422:
  1341. description: 'Unprocessable entity'
  1342. summary: 'Creates a User resource.'
  1343. description: 'Creates a User resource.'
  1344. parameters: []
  1345. requestBody:
  1346. description: 'The new User resource'
  1347. content:
  1348. application/ld+json:
  1349. schema:
  1350. $ref: '#/components/schemas/User.jsonld'
  1351. application/json:
  1352. schema:
  1353. $ref: '#/components/schemas/User'
  1354. text/html:
  1355. schema:
  1356. $ref: '#/components/schemas/User'
  1357. application/hal+json:
  1358. schema:
  1359. $ref: '#/components/schemas/User.jsonhal'
  1360. required: true
  1361. deprecated: false
  1362. parameters: []
  1363. '/api/users/{id}':
  1364. get:
  1365. operationId: api_users_id_get
  1366. tags:
  1367. - User
  1368. responses:
  1369. 200:
  1370. description: 'User resource'
  1371. content:
  1372. application/ld+json:
  1373. schema:
  1374. $ref: '#/components/schemas/User.jsonld'
  1375. application/json:
  1376. schema:
  1377. $ref: '#/components/schemas/User'
  1378. text/html:
  1379. schema:
  1380. $ref: '#/components/schemas/User'
  1381. application/hal+json:
  1382. schema:
  1383. $ref: '#/components/schemas/User.jsonhal'
  1384. 404:
  1385. description: 'Resource not found'
  1386. summary: 'Retrieves a User resource.'
  1387. description: 'Retrieves a User resource.'
  1388. parameters:
  1389. -
  1390. name: id
  1391. in: path
  1392. description: 'UserApi identifier'
  1393. required: true
  1394. deprecated: false
  1395. allowEmptyValue: false
  1396. schema:
  1397. type: string
  1398. style: simple
  1399. explode: false
  1400. allowReserved: false
  1401. deprecated: false
  1402. patch:
  1403. operationId: api_users_id_patch
  1404. tags:
  1405. - User
  1406. responses:
  1407. 200:
  1408. description: 'User resource updated'
  1409. content:
  1410. application/ld+json:
  1411. schema:
  1412. $ref: '#/components/schemas/User.jsonld'
  1413. application/json:
  1414. schema:
  1415. $ref: '#/components/schemas/User'
  1416. text/html:
  1417. schema:
  1418. $ref: '#/components/schemas/User'
  1419. application/hal+json:
  1420. schema:
  1421. $ref: '#/components/schemas/User.jsonhal'
  1422. links: { }
  1423. 400:
  1424. description: 'Invalid input'
  1425. 422:
  1426. description: 'Unprocessable entity'
  1427. 404:
  1428. description: 'Resource not found'
  1429. summary: 'Updates the User resource.'
  1430. description: 'Updates the User resource.'
  1431. parameters:
  1432. -
  1433. name: id
  1434. in: path
  1435. description: 'UserApi identifier'
  1436. required: true
  1437. deprecated: false
  1438. allowEmptyValue: false
  1439. schema:
  1440. type: string
  1441. style: simple
  1442. explode: false
  1443. allowReserved: false
  1444. requestBody:
  1445. description: 'The updated User resource'
  1446. content:
  1447. application/merge-patch+json:
  1448. schema:
  1449. $ref: '#/components/schemas/User'
  1450. required: true
  1451. deprecated: false
  1452. parameters: []
  1453. /auth:
  1454. post:
  1455. operationId: login_check_post
  1456. tags:
  1457. - 'Login Check'
  1458. responses:
  1459. 200:
  1460. description: 'User token created'
  1461. content:
  1462. application/json:
  1463. schema:
  1464. type: object
  1465. properties:
  1466. token: { readOnly: true, type: string, nullable: false }
  1467. required:
  1468. - token
  1469. summary: 'Creates a user token.'
  1470. description: 'Creates a user token.'
  1471. requestBody:
  1472. description: 'The login data'
  1473. content:
  1474. application/json:
  1475. schema:
  1476. type: object
  1477. properties:
  1478. email:
  1479. type: string
  1480. nullable: false
  1481. password:
  1482. type: string
  1483. nullable: false
  1484. required:
  1485. - email
  1486. - password
  1487. required: true
  1488. parameters: []
  1489. components:
  1490. schemas:
  1491. Comment:
  1492. type: object
  1493. description: ''
  1494. deprecated: false
  1495. required:
  1496. - message
  1497. properties:
  1498. message:
  1499. type:
  1500. - string
  1501. - 'null'
  1502. owner:
  1503. type:
  1504. - string
  1505. - 'null'
  1506. format: iri-reference
  1507. example: 'https://example.com/'
  1508. ownerName:
  1509. readOnly: true
  1510. type:
  1511. - string
  1512. - 'null'
  1513. posting:
  1514. type:
  1515. - string
  1516. - 'null'
  1517. format: iri-reference
  1518. example: 'https://example.com/'
  1519. createdAt:
  1520. readOnly: true
  1521. type:
  1522. - string
  1523. - 'null'
  1524. format: date-time
  1525. Comment.jsonhal:
  1526. type: object
  1527. description: ''
  1528. deprecated: false
  1529. required:
  1530. - message
  1531. properties:
  1532. _links:
  1533. type: object
  1534. properties:
  1535. self:
  1536. type: object
  1537. properties:
  1538. href:
  1539. type: string
  1540. format: iri-reference
  1541. message:
  1542. type:
  1543. - string
  1544. - 'null'
  1545. owner:
  1546. type:
  1547. - string
  1548. - 'null'
  1549. format: iri-reference
  1550. example: 'https://example.com/'
  1551. ownerName:
  1552. readOnly: true
  1553. type:
  1554. - string
  1555. - 'null'
  1556. posting:
  1557. type:
  1558. - string
  1559. - 'null'
  1560. format: iri-reference
  1561. example: 'https://example.com/'
  1562. createdAt:
  1563. readOnly: true
  1564. type:
  1565. - string
  1566. - 'null'
  1567. format: date-time
  1568. Comment.jsonld:
  1569. type: object
  1570. description: ''
  1571. deprecated: false
  1572. required:
  1573. - message
  1574. properties:
  1575. '@context':
  1576. readOnly: true
  1577. oneOf:
  1578. -
  1579. type: string
  1580. -
  1581. type: object
  1582. properties:
  1583. '@vocab':
  1584. type: string
  1585. hydra:
  1586. type: string
  1587. enum: ['http://www.w3.org/ns/hydra/core#']
  1588. required:
  1589. - '@vocab'
  1590. - hydra
  1591. additionalProperties: true
  1592. '@id':
  1593. readOnly: true
  1594. type: string
  1595. '@type':
  1596. readOnly: true
  1597. type: string
  1598. message:
  1599. type:
  1600. - string
  1601. - 'null'
  1602. owner:
  1603. type:
  1604. - string
  1605. - 'null'
  1606. format: iri-reference
  1607. example: 'https://example.com/'
  1608. ownerName:
  1609. readOnly: true
  1610. type:
  1611. - string
  1612. - 'null'
  1613. posting:
  1614. type:
  1615. - string
  1616. - 'null'
  1617. format: iri-reference
  1618. example: 'https://example.com/'
  1619. createdAt:
  1620. readOnly: true
  1621. type:
  1622. - string
  1623. - 'null'
  1624. format: date-time
  1625. Contact:
  1626. type: object
  1627. description: ''
  1628. deprecated: false
  1629. required:
  1630. - firstName
  1631. - lastName
  1632. properties:
  1633. firstName:
  1634. type:
  1635. - string
  1636. - 'null'
  1637. lastName:
  1638. type:
  1639. - string
  1640. - 'null'
  1641. partner:
  1642. type:
  1643. - string
  1644. - 'null'
  1645. format: iri-reference
  1646. example: 'https://example.com/'
  1647. birthday:
  1648. type:
  1649. - string
  1650. - 'null'
  1651. format: date-time
  1652. image:
  1653. type:
  1654. - string
  1655. - 'null'
  1656. format: iri-reference
  1657. example: 'https://example.com/'
  1658. imageUrl:
  1659. readOnly: true
  1660. type:
  1661. - string
  1662. - 'null'
  1663. position:
  1664. type:
  1665. - string
  1666. - 'null'
  1667. phone:
  1668. type:
  1669. - string
  1670. - 'null'
  1671. email:
  1672. type:
  1673. - string
  1674. - 'null'
  1675. postings:
  1676. type: array
  1677. items:
  1678. type: string
  1679. format: iri-reference
  1680. example: 'https://example.com/'
  1681. createdAt:
  1682. type:
  1683. - string
  1684. - 'null'
  1685. format: date-time
  1686. Contact.jsonhal:
  1687. type: object
  1688. description: ''
  1689. deprecated: false
  1690. required:
  1691. - firstName
  1692. - lastName
  1693. properties:
  1694. _links:
  1695. type: object
  1696. properties:
  1697. self:
  1698. type: object
  1699. properties:
  1700. href:
  1701. type: string
  1702. format: iri-reference
  1703. firstName:
  1704. type:
  1705. - string
  1706. - 'null'
  1707. lastName:
  1708. type:
  1709. - string
  1710. - 'null'
  1711. partner:
  1712. type:
  1713. - string
  1714. - 'null'
  1715. format: iri-reference
  1716. example: 'https://example.com/'
  1717. birthday:
  1718. type:
  1719. - string
  1720. - 'null'
  1721. format: date-time
  1722. image:
  1723. type:
  1724. - string
  1725. - 'null'
  1726. format: iri-reference
  1727. example: 'https://example.com/'
  1728. imageUrl:
  1729. readOnly: true
  1730. type:
  1731. - string
  1732. - 'null'
  1733. position:
  1734. type:
  1735. - string
  1736. - 'null'
  1737. phone:
  1738. type:
  1739. - string
  1740. - 'null'
  1741. email:
  1742. type:
  1743. - string
  1744. - 'null'
  1745. postings:
  1746. type: array
  1747. items:
  1748. type: string
  1749. format: iri-reference
  1750. example: 'https://example.com/'
  1751. createdAt:
  1752. type:
  1753. - string
  1754. - 'null'
  1755. format: date-time
  1756. Contact.jsonld:
  1757. type: object
  1758. description: ''
  1759. deprecated: false
  1760. required:
  1761. - firstName
  1762. - lastName
  1763. properties:
  1764. '@context':
  1765. readOnly: true
  1766. oneOf:
  1767. -
  1768. type: string
  1769. -
  1770. type: object
  1771. properties:
  1772. '@vocab':
  1773. type: string
  1774. hydra:
  1775. type: string
  1776. enum: ['http://www.w3.org/ns/hydra/core#']
  1777. required:
  1778. - '@vocab'
  1779. - hydra
  1780. additionalProperties: true
  1781. '@id':
  1782. readOnly: true
  1783. type: string
  1784. '@type':
  1785. readOnly: true
  1786. type: string
  1787. firstName:
  1788. type:
  1789. - string
  1790. - 'null'
  1791. lastName:
  1792. type:
  1793. - string
  1794. - 'null'
  1795. partner:
  1796. type:
  1797. - string
  1798. - 'null'
  1799. format: iri-reference
  1800. example: 'https://example.com/'
  1801. birthday:
  1802. type:
  1803. - string
  1804. - 'null'
  1805. format: date-time
  1806. image:
  1807. type:
  1808. - string
  1809. - 'null'
  1810. format: iri-reference
  1811. example: 'https://example.com/'
  1812. imageUrl:
  1813. readOnly: true
  1814. type:
  1815. - string
  1816. - 'null'
  1817. position:
  1818. type:
  1819. - string
  1820. - 'null'
  1821. phone:
  1822. type:
  1823. - string
  1824. - 'null'
  1825. email:
  1826. type:
  1827. - string
  1828. - 'null'
  1829. postings:
  1830. type: array
  1831. items:
  1832. type: string
  1833. format: iri-reference
  1834. example: 'https://example.com/'
  1835. createdAt:
  1836. type:
  1837. - string
  1838. - 'null'
  1839. format: date-time
  1840. MediaObject-media_object.read:
  1841. type: object
  1842. description: ''
  1843. deprecated: false
  1844. externalDocs:
  1845. url: 'https://schema.org/MediaObject'
  1846. properties:
  1847. contentUrl:
  1848. externalDocs:
  1849. url: 'https://schema.org/contentUrl'
  1850. type:
  1851. - string
  1852. - 'null'
  1853. MediaObject.jsonhal-media_object.read:
  1854. type: object
  1855. description: ''
  1856. deprecated: false
  1857. externalDocs:
  1858. url: 'https://schema.org/MediaObject'
  1859. properties:
  1860. _links:
  1861. type: object
  1862. properties:
  1863. self:
  1864. type: object
  1865. properties:
  1866. href:
  1867. type: string
  1868. format: iri-reference
  1869. contentUrl:
  1870. externalDocs:
  1871. url: 'https://schema.org/contentUrl'
  1872. type:
  1873. - string
  1874. - 'null'
  1875. MediaObject.jsonld-media_object.read:
  1876. type: object
  1877. description: ''
  1878. deprecated: false
  1879. externalDocs:
  1880. url: 'https://schema.org/MediaObject'
  1881. properties:
  1882. '@context':
  1883. readOnly: true
  1884. oneOf:
  1885. -
  1886. type: string
  1887. -
  1888. type: object
  1889. properties:
  1890. '@vocab':
  1891. type: string
  1892. hydra:
  1893. type: string
  1894. enum: ['http://www.w3.org/ns/hydra/core#']
  1895. required:
  1896. - '@vocab'
  1897. - hydra
  1898. additionalProperties: true
  1899. '@id':
  1900. readOnly: true
  1901. type: string
  1902. '@type':
  1903. readOnly: true
  1904. type: string
  1905. contentUrl:
  1906. externalDocs:
  1907. url: 'https://schema.org/contentUrl'
  1908. type:
  1909. - string
  1910. - 'null'
  1911. Partner:
  1912. type: object
  1913. description: ''
  1914. deprecated: false
  1915. required:
  1916. - name
  1917. - type
  1918. properties:
  1919. name:
  1920. type: string
  1921. type:
  1922. type: string
  1923. enum:
  1924. - customer
  1925. - supplier
  1926. - service
  1927. street:
  1928. type:
  1929. - string
  1930. - 'null'
  1931. streetNo:
  1932. type:
  1933. - string
  1934. - 'null'
  1935. zip:
  1936. type:
  1937. - string
  1938. - 'null'
  1939. city:
  1940. type:
  1941. - string
  1942. - 'null'
  1943. country:
  1944. type:
  1945. - string
  1946. - 'null'
  1947. website:
  1948. type:
  1949. - string
  1950. - 'null'
  1951. logo:
  1952. type:
  1953. - string
  1954. - 'null'
  1955. format: iri-reference
  1956. example: 'https://example.com/'
  1957. logoUrl:
  1958. readOnly: true
  1959. type:
  1960. - string
  1961. - 'null'
  1962. createdAt:
  1963. type:
  1964. - string
  1965. - 'null'
  1966. format: date-time
  1967. contacts:
  1968. type: array
  1969. items:
  1970. type: string
  1971. format: iri-reference
  1972. example: 'https://example.com/'
  1973. Partner.jsonhal:
  1974. type: object
  1975. description: ''
  1976. deprecated: false
  1977. required:
  1978. - name
  1979. - type
  1980. properties:
  1981. _links:
  1982. type: object
  1983. properties:
  1984. self:
  1985. type: object
  1986. properties:
  1987. href:
  1988. type: string
  1989. format: iri-reference
  1990. name:
  1991. type: string
  1992. type:
  1993. type: string
  1994. enum:
  1995. - customer
  1996. - supplier
  1997. - service
  1998. street:
  1999. type:
  2000. - string
  2001. - 'null'
  2002. streetNo:
  2003. type:
  2004. - string
  2005. - 'null'
  2006. zip:
  2007. type:
  2008. - string
  2009. - 'null'
  2010. city:
  2011. type:
  2012. - string
  2013. - 'null'
  2014. country:
  2015. type:
  2016. - string
  2017. - 'null'
  2018. website:
  2019. type:
  2020. - string
  2021. - 'null'
  2022. logo:
  2023. type:
  2024. - string
  2025. - 'null'
  2026. format: iri-reference
  2027. example: 'https://example.com/'
  2028. logoUrl:
  2029. readOnly: true
  2030. type:
  2031. - string
  2032. - 'null'
  2033. createdAt:
  2034. type:
  2035. - string
  2036. - 'null'
  2037. format: date-time
  2038. contacts:
  2039. type: array
  2040. items:
  2041. type: string
  2042. format: iri-reference
  2043. example: 'https://example.com/'
  2044. Partner.jsonld:
  2045. type: object
  2046. description: ''
  2047. deprecated: false
  2048. required:
  2049. - name
  2050. - type
  2051. properties:
  2052. '@context':
  2053. readOnly: true
  2054. oneOf:
  2055. -
  2056. type: string
  2057. -
  2058. type: object
  2059. properties:
  2060. '@vocab':
  2061. type: string
  2062. hydra:
  2063. type: string
  2064. enum: ['http://www.w3.org/ns/hydra/core#']
  2065. required:
  2066. - '@vocab'
  2067. - hydra
  2068. additionalProperties: true
  2069. '@id':
  2070. readOnly: true
  2071. type: string
  2072. '@type':
  2073. readOnly: true
  2074. type: string
  2075. name:
  2076. type: string
  2077. type:
  2078. type: string
  2079. enum:
  2080. - customer
  2081. - supplier
  2082. - service
  2083. street:
  2084. type:
  2085. - string
  2086. - 'null'
  2087. streetNo:
  2088. type:
  2089. - string
  2090. - 'null'
  2091. zip:
  2092. type:
  2093. - string
  2094. - 'null'
  2095. city:
  2096. type:
  2097. - string
  2098. - 'null'
  2099. country:
  2100. type:
  2101. - string
  2102. - 'null'
  2103. website:
  2104. type:
  2105. - string
  2106. - 'null'
  2107. logo:
  2108. type:
  2109. - string
  2110. - 'null'
  2111. format: iri-reference
  2112. example: 'https://example.com/'
  2113. logoUrl:
  2114. readOnly: true
  2115. type:
  2116. - string
  2117. - 'null'
  2118. createdAt:
  2119. type:
  2120. - string
  2121. - 'null'
  2122. format: date-time
  2123. contacts:
  2124. type: array
  2125. items:
  2126. type: string
  2127. format: iri-reference
  2128. example: 'https://example.com/'
  2129. Post:
  2130. type: object
  2131. description: ''
  2132. deprecated: false
  2133. required:
  2134. - headline
  2135. - message
  2136. properties:
  2137. headline:
  2138. type:
  2139. - string
  2140. - 'null'
  2141. message:
  2142. type:
  2143. - string
  2144. - 'null'
  2145. owner:
  2146. type:
  2147. - string
  2148. - 'null'
  2149. format: iri-reference
  2150. example: 'https://example.com/'
  2151. ownerName:
  2152. readOnly: true
  2153. type:
  2154. - string
  2155. - 'null'
  2156. partner:
  2157. type:
  2158. - string
  2159. - 'null'
  2160. format: iri-reference
  2161. example: 'https://example.com/'
  2162. contact:
  2163. type:
  2164. - string
  2165. - 'null'
  2166. format: iri-reference
  2167. example: 'https://example.com/'
  2168. comments:
  2169. type: array
  2170. items:
  2171. $ref: '#/components/schemas/Comment'
  2172. createdAt:
  2173. readOnly: true
  2174. type:
  2175. - string
  2176. - 'null'
  2177. format: date-time
  2178. Post.jsonhal:
  2179. type: object
  2180. description: ''
  2181. deprecated: false
  2182. required:
  2183. - headline
  2184. - message
  2185. properties:
  2186. _links:
  2187. type: object
  2188. properties:
  2189. self:
  2190. type: object
  2191. properties:
  2192. href:
  2193. type: string
  2194. format: iri-reference
  2195. headline:
  2196. type:
  2197. - string
  2198. - 'null'
  2199. message:
  2200. type:
  2201. - string
  2202. - 'null'
  2203. owner:
  2204. type:
  2205. - string
  2206. - 'null'
  2207. format: iri-reference
  2208. example: 'https://example.com/'
  2209. ownerName:
  2210. readOnly: true
  2211. type:
  2212. - string
  2213. - 'null'
  2214. partner:
  2215. type:
  2216. - string
  2217. - 'null'
  2218. format: iri-reference
  2219. example: 'https://example.com/'
  2220. contact:
  2221. type:
  2222. - string
  2223. - 'null'
  2224. format: iri-reference
  2225. example: 'https://example.com/'
  2226. comments:
  2227. type: array
  2228. items:
  2229. $ref: '#/components/schemas/Comment.jsonhal'
  2230. createdAt:
  2231. readOnly: true
  2232. type:
  2233. - string
  2234. - 'null'
  2235. format: date-time
  2236. Post.jsonld:
  2237. type: object
  2238. description: ''
  2239. deprecated: false
  2240. required:
  2241. - headline
  2242. - message
  2243. properties:
  2244. '@context':
  2245. readOnly: true
  2246. oneOf:
  2247. -
  2248. type: string
  2249. -
  2250. type: object
  2251. properties:
  2252. '@vocab':
  2253. type: string
  2254. hydra:
  2255. type: string
  2256. enum: ['http://www.w3.org/ns/hydra/core#']
  2257. required:
  2258. - '@vocab'
  2259. - hydra
  2260. additionalProperties: true
  2261. '@id':
  2262. readOnly: true
  2263. type: string
  2264. '@type':
  2265. readOnly: true
  2266. type: string
  2267. headline:
  2268. type:
  2269. - string
  2270. - 'null'
  2271. message:
  2272. type:
  2273. - string
  2274. - 'null'
  2275. owner:
  2276. type:
  2277. - string
  2278. - 'null'
  2279. format: iri-reference
  2280. example: 'https://example.com/'
  2281. ownerName:
  2282. readOnly: true
  2283. type:
  2284. - string
  2285. - 'null'
  2286. partner:
  2287. type:
  2288. - string
  2289. - 'null'
  2290. format: iri-reference
  2291. example: 'https://example.com/'
  2292. contact:
  2293. type:
  2294. - string
  2295. - 'null'
  2296. format: iri-reference
  2297. example: 'https://example.com/'
  2298. comments:
  2299. type: array
  2300. items:
  2301. $ref: '#/components/schemas/Comment.jsonld'
  2302. createdAt:
  2303. readOnly: true
  2304. type:
  2305. - string
  2306. - 'null'
  2307. format: date-time
  2308. User:
  2309. type: object
  2310. description: ''
  2311. deprecated: false
  2312. required:
  2313. - email
  2314. - firstName
  2315. - lastName
  2316. properties:
  2317. email:
  2318. format: email
  2319. externalDocs:
  2320. url: 'https://schema.org/email'
  2321. type:
  2322. - string
  2323. - 'null'
  2324. firstName:
  2325. type:
  2326. - string
  2327. - 'null'
  2328. lastName:
  2329. type:
  2330. - string
  2331. - 'null'
  2332. password:
  2333. writeOnly: true
  2334. description: 'The plaintext password when being set or changed.'
  2335. type:
  2336. - string
  2337. - 'null'
  2338. active:
  2339. type: boolean
  2340. postings:
  2341. type: array
  2342. items:
  2343. type: string
  2344. format: iri-reference
  2345. example: 'https://example.com/'
  2346. createdAt:
  2347. readOnly: true
  2348. type:
  2349. - string
  2350. - 'null'
  2351. format: date-time
  2352. User.jsonhal:
  2353. type: object
  2354. description: ''
  2355. deprecated: false
  2356. required:
  2357. - email
  2358. - firstName
  2359. - lastName
  2360. properties:
  2361. _links:
  2362. type: object
  2363. properties:
  2364. self:
  2365. type: object
  2366. properties:
  2367. href:
  2368. type: string
  2369. format: iri-reference
  2370. email:
  2371. format: email
  2372. externalDocs:
  2373. url: 'https://schema.org/email'
  2374. type:
  2375. - string
  2376. - 'null'
  2377. firstName:
  2378. type:
  2379. - string
  2380. - 'null'
  2381. lastName:
  2382. type:
  2383. - string
  2384. - 'null'
  2385. password:
  2386. writeOnly: true
  2387. description: 'The plaintext password when being set or changed.'
  2388. type:
  2389. - string
  2390. - 'null'
  2391. active:
  2392. type: boolean
  2393. postings:
  2394. type: array
  2395. items:
  2396. type: string
  2397. format: iri-reference
  2398. example: 'https://example.com/'
  2399. createdAt:
  2400. readOnly: true
  2401. type:
  2402. - string
  2403. - 'null'
  2404. format: date-time
  2405. User.jsonld:
  2406. type: object
  2407. description: ''
  2408. deprecated: false
  2409. required:
  2410. - email
  2411. - firstName
  2412. - lastName
  2413. properties:
  2414. '@context':
  2415. readOnly: true
  2416. oneOf:
  2417. -
  2418. type: string
  2419. -
  2420. type: object
  2421. properties:
  2422. '@vocab':
  2423. type: string
  2424. hydra:
  2425. type: string
  2426. enum: ['http://www.w3.org/ns/hydra/core#']
  2427. required:
  2428. - '@vocab'
  2429. - hydra
  2430. additionalProperties: true
  2431. '@id':
  2432. readOnly: true
  2433. type: string
  2434. '@type':
  2435. readOnly: true
  2436. type: string
  2437. email:
  2438. format: email
  2439. externalDocs:
  2440. url: 'https://schema.org/email'
  2441. type:
  2442. - string
  2443. - 'null'
  2444. firstName:
  2445. type:
  2446. - string
  2447. - 'null'
  2448. lastName:
  2449. type:
  2450. - string
  2451. - 'null'
  2452. password:
  2453. writeOnly: true
  2454. description: 'The plaintext password when being set or changed.'
  2455. type:
  2456. - string
  2457. - 'null'
  2458. active:
  2459. type: boolean
  2460. postings:
  2461. type: array
  2462. items:
  2463. type: string
  2464. format: iri-reference
  2465. example: 'https://example.com/'
  2466. createdAt:
  2467. readOnly: true
  2468. type:
  2469. - string
  2470. - 'null'
  2471. format: date-time
  2472. responses: { }
  2473. parameters: { }
  2474. examples: { }
  2475. requestBodies: { }
  2476. headers: { }
  2477. securitySchemes:
  2478. JWT:
  2479. type: http
  2480. scheme: bearer
  2481. bearerFormat: JWT
  2482. security:
  2483. -
  2484. JWT: []
  2485. tags: []