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.
 
 
 

2102 line
60 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/contacts:
  12. get:
  13. operationId: api_contacts_get_collection
  14. tags:
  15. - Contact
  16. responses:
  17. 200:
  18. description: 'Contact collection'
  19. content:
  20. application/ld+json:
  21. schema:
  22. type: object
  23. properties:
  24. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.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/Contact'
  35. text/html:
  36. schema:
  37. type: array
  38. items:
  39. $ref: '#/components/schemas/Contact'
  40. application/hal+json:
  41. schema:
  42. type: object
  43. properties:
  44. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.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 Contact resources.'
  52. description: 'Retrieves the collection of Contact 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. -
  83. name: partner
  84. in: query
  85. description: ''
  86. required: false
  87. deprecated: false
  88. allowEmptyValue: true
  89. schema:
  90. type: string
  91. style: form
  92. explode: false
  93. allowReserved: false
  94. -
  95. name: 'partner[]'
  96. in: query
  97. description: ''
  98. required: false
  99. deprecated: false
  100. allowEmptyValue: true
  101. schema:
  102. type: array
  103. items:
  104. type: string
  105. style: form
  106. explode: true
  107. allowReserved: false
  108. deprecated: false
  109. post:
  110. operationId: api_contacts_post
  111. tags:
  112. - Contact
  113. responses:
  114. 201:
  115. description: 'Contact resource created'
  116. content:
  117. application/ld+json:
  118. schema:
  119. $ref: '#/components/schemas/Contact.jsonld'
  120. application/json:
  121. schema:
  122. $ref: '#/components/schemas/Contact'
  123. text/html:
  124. schema:
  125. $ref: '#/components/schemas/Contact'
  126. application/hal+json:
  127. schema:
  128. $ref: '#/components/schemas/Contact.jsonhal'
  129. links: { }
  130. 400:
  131. description: 'Invalid input'
  132. 422:
  133. description: 'Unprocessable entity'
  134. summary: 'Creates a Contact resource.'
  135. description: 'Creates a Contact resource.'
  136. parameters: []
  137. requestBody:
  138. description: 'The new Contact resource'
  139. content:
  140. application/ld+json:
  141. schema:
  142. $ref: '#/components/schemas/Contact.jsonld'
  143. application/json:
  144. schema:
  145. $ref: '#/components/schemas/Contact'
  146. text/html:
  147. schema:
  148. $ref: '#/components/schemas/Contact'
  149. application/hal+json:
  150. schema:
  151. $ref: '#/components/schemas/Contact.jsonhal'
  152. required: true
  153. deprecated: false
  154. parameters: []
  155. '/api/contacts/{id}':
  156. get:
  157. operationId: api_contacts_id_get
  158. tags:
  159. - Contact
  160. responses:
  161. 200:
  162. description: 'Contact resource'
  163. content:
  164. application/ld+json:
  165. schema:
  166. $ref: '#/components/schemas/Contact.jsonld'
  167. application/json:
  168. schema:
  169. $ref: '#/components/schemas/Contact'
  170. text/html:
  171. schema:
  172. $ref: '#/components/schemas/Contact'
  173. application/hal+json:
  174. schema:
  175. $ref: '#/components/schemas/Contact.jsonhal'
  176. 404:
  177. description: 'Resource not found'
  178. summary: 'Retrieves a Contact resource.'
  179. description: 'Retrieves a Contact resource.'
  180. parameters:
  181. -
  182. name: id
  183. in: path
  184. description: 'ContactApi identifier'
  185. required: true
  186. deprecated: false
  187. allowEmptyValue: false
  188. schema:
  189. type: string
  190. style: simple
  191. explode: false
  192. allowReserved: false
  193. deprecated: false
  194. delete:
  195. operationId: api_contacts_id_delete
  196. tags:
  197. - Contact
  198. responses:
  199. 204:
  200. description: 'Contact resource deleted'
  201. 404:
  202. description: 'Resource not found'
  203. summary: 'Removes the Contact resource.'
  204. description: 'Removes the Contact resource.'
  205. parameters:
  206. -
  207. name: id
  208. in: path
  209. description: 'ContactApi identifier'
  210. required: true
  211. deprecated: false
  212. allowEmptyValue: false
  213. schema:
  214. type: string
  215. style: simple
  216. explode: false
  217. allowReserved: false
  218. deprecated: false
  219. patch:
  220. operationId: api_contacts_id_patch
  221. tags:
  222. - Contact
  223. responses:
  224. 200:
  225. description: 'Contact resource updated'
  226. content:
  227. application/ld+json:
  228. schema:
  229. $ref: '#/components/schemas/Contact.jsonld'
  230. application/json:
  231. schema:
  232. $ref: '#/components/schemas/Contact'
  233. text/html:
  234. schema:
  235. $ref: '#/components/schemas/Contact'
  236. application/hal+json:
  237. schema:
  238. $ref: '#/components/schemas/Contact.jsonhal'
  239. links: { }
  240. 400:
  241. description: 'Invalid input'
  242. 422:
  243. description: 'Unprocessable entity'
  244. 404:
  245. description: 'Resource not found'
  246. summary: 'Updates the Contact resource.'
  247. description: 'Updates the Contact resource.'
  248. parameters:
  249. -
  250. name: id
  251. in: path
  252. description: 'ContactApi identifier'
  253. required: true
  254. deprecated: false
  255. allowEmptyValue: false
  256. schema:
  257. type: string
  258. style: simple
  259. explode: false
  260. allowReserved: false
  261. requestBody:
  262. description: 'The updated Contact resource'
  263. content:
  264. application/merge-patch+json:
  265. schema:
  266. $ref: '#/components/schemas/Contact'
  267. required: true
  268. deprecated: false
  269. parameters: []
  270. /api/media_objects:
  271. get:
  272. operationId: api_media_objects_get_collection
  273. tags:
  274. - MediaObject
  275. responses:
  276. 200:
  277. description: 'MediaObject collection'
  278. content:
  279. application/ld+json:
  280. schema:
  281. type: object
  282. properties:
  283. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' } }
  284. 'hydra:totalItems': { type: integer, minimum: 0 }
  285. '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 } }
  286. '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 } } } } } }
  287. required:
  288. - 'hydra:member'
  289. application/json:
  290. schema:
  291. type: array
  292. items:
  293. $ref: '#/components/schemas/MediaObject-media_object.read'
  294. text/html:
  295. schema:
  296. type: array
  297. items:
  298. $ref: '#/components/schemas/MediaObject-media_object.read'
  299. application/hal+json:
  300. schema:
  301. type: object
  302. properties:
  303. _embedded: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read' } }
  304. totalItems: { type: integer, minimum: 0 }
  305. itemsPerPage: { type: integer, minimum: 0 }
  306. _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 } } } } }
  307. required:
  308. - _links
  309. - _embedded
  310. summary: 'Retrieves the collection of MediaObject resources.'
  311. description: 'Retrieves the collection of MediaObject resources.'
  312. parameters:
  313. -
  314. name: page
  315. in: query
  316. description: 'The collection page number'
  317. required: false
  318. deprecated: false
  319. allowEmptyValue: true
  320. schema:
  321. type: integer
  322. default: 1
  323. style: form
  324. explode: false
  325. allowReserved: false
  326. -
  327. name: itemsPerPage
  328. in: query
  329. description: 'The number of items per page'
  330. required: false
  331. deprecated: false
  332. allowEmptyValue: true
  333. schema:
  334. type: integer
  335. default: 10
  336. minimum: 0
  337. maximum: 50
  338. style: form
  339. explode: false
  340. allowReserved: false
  341. deprecated: false
  342. post:
  343. operationId: api_media_objects_post
  344. tags:
  345. - MediaObject
  346. responses:
  347. 201:
  348. description: 'MediaObject resource created'
  349. content:
  350. application/ld+json:
  351. schema:
  352. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  353. application/json:
  354. schema:
  355. $ref: '#/components/schemas/MediaObject-media_object.read'
  356. text/html:
  357. schema:
  358. $ref: '#/components/schemas/MediaObject-media_object.read'
  359. application/hal+json:
  360. schema:
  361. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  362. links: { }
  363. 400:
  364. description: 'Invalid input'
  365. 422:
  366. description: 'Unprocessable entity'
  367. summary: 'Creates a MediaObject resource.'
  368. description: 'Creates a MediaObject resource.'
  369. parameters: []
  370. requestBody:
  371. description: ''
  372. content:
  373. multipart/form-data:
  374. schema:
  375. type: object
  376. properties:
  377. file:
  378. type: string
  379. format: binary
  380. required: false
  381. deprecated: false
  382. parameters: []
  383. '/api/media_objects/{id}':
  384. get:
  385. operationId: api_media_objects_id_get
  386. tags:
  387. - MediaObject
  388. responses:
  389. 200:
  390. description: 'MediaObject resource'
  391. content:
  392. application/ld+json:
  393. schema:
  394. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  395. application/json:
  396. schema:
  397. $ref: '#/components/schemas/MediaObject-media_object.read'
  398. text/html:
  399. schema:
  400. $ref: '#/components/schemas/MediaObject-media_object.read'
  401. application/hal+json:
  402. schema:
  403. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  404. 404:
  405. description: 'Resource not found'
  406. summary: 'Retrieves a MediaObject resource.'
  407. description: 'Retrieves a MediaObject resource.'
  408. parameters:
  409. -
  410. name: id
  411. in: path
  412. description: 'MediaObject identifier'
  413. required: true
  414. deprecated: false
  415. allowEmptyValue: false
  416. schema:
  417. type: string
  418. style: simple
  419. explode: false
  420. allowReserved: false
  421. deprecated: false
  422. parameters: []
  423. /api/partners:
  424. get:
  425. operationId: api_partners_get_collection
  426. tags:
  427. - Partner
  428. responses:
  429. 200:
  430. description: 'Partner collection'
  431. content:
  432. application/ld+json:
  433. schema:
  434. type: object
  435. properties:
  436. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  437. 'hydra:totalItems': { type: integer, minimum: 0 }
  438. '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 } }
  439. '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 } } } } } }
  440. required:
  441. - 'hydra:member'
  442. application/json:
  443. schema:
  444. type: array
  445. items:
  446. $ref: '#/components/schemas/Partner'
  447. text/html:
  448. schema:
  449. type: array
  450. items:
  451. $ref: '#/components/schemas/Partner'
  452. application/hal+json:
  453. schema:
  454. type: object
  455. properties:
  456. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  457. totalItems: { type: integer, minimum: 0 }
  458. itemsPerPage: { type: integer, minimum: 0 }
  459. _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 } } } } }
  460. required:
  461. - _links
  462. - _embedded
  463. summary: 'Retrieves the collection of Partner resources.'
  464. description: 'Retrieves the collection of Partner resources.'
  465. parameters:
  466. -
  467. name: page
  468. in: query
  469. description: 'The collection page number'
  470. required: false
  471. deprecated: false
  472. allowEmptyValue: true
  473. schema:
  474. type: integer
  475. default: 1
  476. style: form
  477. explode: false
  478. allowReserved: false
  479. -
  480. name: itemsPerPage
  481. in: query
  482. description: 'The number of items per page'
  483. required: false
  484. deprecated: false
  485. allowEmptyValue: true
  486. schema:
  487. type: integer
  488. default: 10
  489. minimum: 0
  490. maximum: 50
  491. style: form
  492. explode: false
  493. allowReserved: false
  494. -
  495. name: type
  496. in: query
  497. description: ''
  498. required: false
  499. deprecated: false
  500. allowEmptyValue: true
  501. schema:
  502. type: string
  503. style: form
  504. explode: false
  505. allowReserved: false
  506. -
  507. name: 'type[]'
  508. in: query
  509. description: ''
  510. required: false
  511. deprecated: false
  512. allowEmptyValue: true
  513. schema:
  514. type: array
  515. items:
  516. type: string
  517. style: form
  518. explode: true
  519. allowReserved: false
  520. -
  521. name: 'order[name]'
  522. in: query
  523. description: ''
  524. required: false
  525. deprecated: false
  526. allowEmptyValue: true
  527. schema:
  528. type: string
  529. enum:
  530. - asc
  531. - desc
  532. style: form
  533. explode: false
  534. allowReserved: false
  535. -
  536. name: 'order[city]'
  537. in: query
  538. description: ''
  539. required: false
  540. deprecated: false
  541. allowEmptyValue: true
  542. schema:
  543. type: string
  544. enum:
  545. - asc
  546. - desc
  547. style: form
  548. explode: false
  549. allowReserved: false
  550. -
  551. name: 'order[website]'
  552. in: query
  553. description: ''
  554. required: false
  555. deprecated: false
  556. allowEmptyValue: true
  557. schema:
  558. type: string
  559. enum:
  560. - asc
  561. - desc
  562. style: form
  563. explode: false
  564. allowReserved: false
  565. deprecated: false
  566. post:
  567. operationId: api_partners_post
  568. tags:
  569. - Partner
  570. responses:
  571. 201:
  572. description: 'Partner resource created'
  573. content:
  574. application/ld+json:
  575. schema:
  576. $ref: '#/components/schemas/Partner.jsonld'
  577. application/json:
  578. schema:
  579. $ref: '#/components/schemas/Partner'
  580. text/html:
  581. schema:
  582. $ref: '#/components/schemas/Partner'
  583. application/hal+json:
  584. schema:
  585. $ref: '#/components/schemas/Partner.jsonhal'
  586. links: { }
  587. 400:
  588. description: 'Invalid input'
  589. 422:
  590. description: 'Unprocessable entity'
  591. summary: 'Creates a Partner resource.'
  592. description: 'Creates a Partner resource.'
  593. parameters: []
  594. requestBody:
  595. description: 'The new Partner resource'
  596. content:
  597. application/ld+json:
  598. schema:
  599. $ref: '#/components/schemas/Partner.jsonld'
  600. application/json:
  601. schema:
  602. $ref: '#/components/schemas/Partner'
  603. text/html:
  604. schema:
  605. $ref: '#/components/schemas/Partner'
  606. application/hal+json:
  607. schema:
  608. $ref: '#/components/schemas/Partner.jsonhal'
  609. required: true
  610. deprecated: false
  611. parameters: []
  612. '/api/partners/{id}':
  613. get:
  614. operationId: api_partners_id_get
  615. tags:
  616. - Partner
  617. responses:
  618. 200:
  619. description: 'Partner resource'
  620. content:
  621. application/ld+json:
  622. schema:
  623. $ref: '#/components/schemas/Partner.jsonld'
  624. application/json:
  625. schema:
  626. $ref: '#/components/schemas/Partner'
  627. text/html:
  628. schema:
  629. $ref: '#/components/schemas/Partner'
  630. application/hal+json:
  631. schema:
  632. $ref: '#/components/schemas/Partner.jsonhal'
  633. 404:
  634. description: 'Resource not found'
  635. summary: 'Retrieves a Partner resource.'
  636. description: 'Retrieves a Partner resource.'
  637. parameters:
  638. -
  639. name: id
  640. in: path
  641. description: 'PartnerApi identifier'
  642. required: true
  643. deprecated: false
  644. allowEmptyValue: false
  645. schema:
  646. type: string
  647. style: simple
  648. explode: false
  649. allowReserved: false
  650. deprecated: false
  651. delete:
  652. operationId: api_partners_id_delete
  653. tags:
  654. - Partner
  655. responses:
  656. 204:
  657. description: 'Partner resource deleted'
  658. 404:
  659. description: 'Resource not found'
  660. summary: 'Removes the Partner resource.'
  661. description: 'Removes the Partner resource.'
  662. parameters:
  663. -
  664. name: id
  665. in: path
  666. description: 'PartnerApi identifier'
  667. required: true
  668. deprecated: false
  669. allowEmptyValue: false
  670. schema:
  671. type: string
  672. style: simple
  673. explode: false
  674. allowReserved: false
  675. deprecated: false
  676. patch:
  677. operationId: api_partners_id_patch
  678. tags:
  679. - Partner
  680. responses:
  681. 200:
  682. description: 'Partner resource updated'
  683. content:
  684. application/ld+json:
  685. schema:
  686. $ref: '#/components/schemas/Partner.jsonld'
  687. application/json:
  688. schema:
  689. $ref: '#/components/schemas/Partner'
  690. text/html:
  691. schema:
  692. $ref: '#/components/schemas/Partner'
  693. application/hal+json:
  694. schema:
  695. $ref: '#/components/schemas/Partner.jsonhal'
  696. links: { }
  697. 400:
  698. description: 'Invalid input'
  699. 422:
  700. description: 'Unprocessable entity'
  701. 404:
  702. description: 'Resource not found'
  703. summary: 'Updates the Partner resource.'
  704. description: 'Updates the Partner resource.'
  705. parameters:
  706. -
  707. name: id
  708. in: path
  709. description: 'PartnerApi identifier'
  710. required: true
  711. deprecated: false
  712. allowEmptyValue: false
  713. schema:
  714. type: string
  715. style: simple
  716. explode: false
  717. allowReserved: false
  718. requestBody:
  719. description: 'The updated Partner resource'
  720. content:
  721. application/merge-patch+json:
  722. schema:
  723. $ref: '#/components/schemas/Partner'
  724. required: true
  725. deprecated: false
  726. parameters: []
  727. /api/posts:
  728. get:
  729. operationId: api_posts_get_collection
  730. tags:
  731. - Post
  732. responses:
  733. 200:
  734. description: 'Post collection'
  735. content:
  736. application/ld+json:
  737. schema:
  738. type: object
  739. properties:
  740. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  741. 'hydra:totalItems': { type: integer, minimum: 0 }
  742. '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 } }
  743. '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 } } } } } }
  744. required:
  745. - 'hydra:member'
  746. application/json:
  747. schema:
  748. type: array
  749. items:
  750. $ref: '#/components/schemas/Post'
  751. text/html:
  752. schema:
  753. type: array
  754. items:
  755. $ref: '#/components/schemas/Post'
  756. application/hal+json:
  757. schema:
  758. type: object
  759. properties:
  760. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  761. totalItems: { type: integer, minimum: 0 }
  762. itemsPerPage: { type: integer, minimum: 0 }
  763. _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 } } } } }
  764. required:
  765. - _links
  766. - _embedded
  767. summary: 'Retrieves the collection of Post resources.'
  768. description: 'Retrieves the collection of Post resources.'
  769. parameters:
  770. -
  771. name: page
  772. in: query
  773. description: 'The collection page number'
  774. required: false
  775. deprecated: false
  776. allowEmptyValue: true
  777. schema:
  778. type: integer
  779. default: 1
  780. style: form
  781. explode: false
  782. allowReserved: false
  783. -
  784. name: itemsPerPage
  785. in: query
  786. description: 'The number of items per page'
  787. required: false
  788. deprecated: false
  789. allowEmptyValue: true
  790. schema:
  791. type: integer
  792. default: 10
  793. minimum: 0
  794. maximum: 50
  795. style: form
  796. explode: false
  797. allowReserved: false
  798. -
  799. name: partner
  800. in: query
  801. description: ''
  802. required: false
  803. deprecated: false
  804. allowEmptyValue: true
  805. schema:
  806. type: string
  807. style: form
  808. explode: false
  809. allowReserved: false
  810. -
  811. name: 'partner[]'
  812. in: query
  813. description: ''
  814. required: false
  815. deprecated: false
  816. allowEmptyValue: true
  817. schema:
  818. type: array
  819. items:
  820. type: string
  821. style: form
  822. explode: true
  823. allowReserved: false
  824. -
  825. name: contact
  826. in: query
  827. description: ''
  828. required: false
  829. deprecated: false
  830. allowEmptyValue: true
  831. schema:
  832. type: string
  833. style: form
  834. explode: false
  835. allowReserved: false
  836. -
  837. name: 'contact[]'
  838. in: query
  839. description: ''
  840. required: false
  841. deprecated: false
  842. allowEmptyValue: true
  843. schema:
  844. type: array
  845. items:
  846. type: string
  847. style: form
  848. explode: true
  849. allowReserved: false
  850. deprecated: false
  851. post:
  852. operationId: api_posts_post
  853. tags:
  854. - Post
  855. responses:
  856. 201:
  857. description: 'Post resource created'
  858. content:
  859. application/ld+json:
  860. schema:
  861. $ref: '#/components/schemas/Post.jsonld'
  862. application/json:
  863. schema:
  864. $ref: '#/components/schemas/Post'
  865. text/html:
  866. schema:
  867. $ref: '#/components/schemas/Post'
  868. application/hal+json:
  869. schema:
  870. $ref: '#/components/schemas/Post.jsonhal'
  871. links: { }
  872. 400:
  873. description: 'Invalid input'
  874. 422:
  875. description: 'Unprocessable entity'
  876. summary: 'Creates a Post resource.'
  877. description: 'Creates a Post resource.'
  878. parameters: []
  879. requestBody:
  880. description: 'The new Post resource'
  881. content:
  882. application/ld+json:
  883. schema:
  884. $ref: '#/components/schemas/Post.jsonld'
  885. application/json:
  886. schema:
  887. $ref: '#/components/schemas/Post'
  888. text/html:
  889. schema:
  890. $ref: '#/components/schemas/Post'
  891. application/hal+json:
  892. schema:
  893. $ref: '#/components/schemas/Post.jsonhal'
  894. required: true
  895. deprecated: false
  896. parameters: []
  897. '/api/posts/{id}':
  898. get:
  899. operationId: api_posts_id_get
  900. tags:
  901. - Post
  902. responses:
  903. 200:
  904. description: 'Post resource'
  905. content:
  906. application/ld+json:
  907. schema:
  908. $ref: '#/components/schemas/Post.jsonld'
  909. application/json:
  910. schema:
  911. $ref: '#/components/schemas/Post'
  912. text/html:
  913. schema:
  914. $ref: '#/components/schemas/Post'
  915. application/hal+json:
  916. schema:
  917. $ref: '#/components/schemas/Post.jsonhal'
  918. 404:
  919. description: 'Resource not found'
  920. summary: 'Retrieves a Post resource.'
  921. description: 'Retrieves a Post resource.'
  922. parameters:
  923. -
  924. name: id
  925. in: path
  926. description: 'PostingApi identifier'
  927. required: true
  928. deprecated: false
  929. allowEmptyValue: false
  930. schema:
  931. type: string
  932. style: simple
  933. explode: false
  934. allowReserved: false
  935. deprecated: false
  936. delete:
  937. operationId: api_posts_id_delete
  938. tags:
  939. - Post
  940. responses:
  941. 204:
  942. description: 'Post resource deleted'
  943. 404:
  944. description: 'Resource not found'
  945. summary: 'Removes the Post resource.'
  946. description: 'Removes the Post resource.'
  947. parameters:
  948. -
  949. name: id
  950. in: path
  951. description: 'PostingApi identifier'
  952. required: true
  953. deprecated: false
  954. allowEmptyValue: false
  955. schema:
  956. type: string
  957. style: simple
  958. explode: false
  959. allowReserved: false
  960. deprecated: false
  961. patch:
  962. operationId: api_posts_id_patch
  963. tags:
  964. - Post
  965. responses:
  966. 200:
  967. description: 'Post resource updated'
  968. content:
  969. application/ld+json:
  970. schema:
  971. $ref: '#/components/schemas/Post.jsonld'
  972. application/json:
  973. schema:
  974. $ref: '#/components/schemas/Post'
  975. text/html:
  976. schema:
  977. $ref: '#/components/schemas/Post'
  978. application/hal+json:
  979. schema:
  980. $ref: '#/components/schemas/Post.jsonhal'
  981. links: { }
  982. 400:
  983. description: 'Invalid input'
  984. 422:
  985. description: 'Unprocessable entity'
  986. 404:
  987. description: 'Resource not found'
  988. summary: 'Updates the Post resource.'
  989. description: 'Updates the Post resource.'
  990. parameters:
  991. -
  992. name: id
  993. in: path
  994. description: 'PostingApi identifier'
  995. required: true
  996. deprecated: false
  997. allowEmptyValue: false
  998. schema:
  999. type: string
  1000. style: simple
  1001. explode: false
  1002. allowReserved: false
  1003. requestBody:
  1004. description: 'The updated Post resource'
  1005. content:
  1006. application/merge-patch+json:
  1007. schema:
  1008. $ref: '#/components/schemas/Post'
  1009. required: true
  1010. deprecated: false
  1011. parameters: []
  1012. /api/users:
  1013. get:
  1014. operationId: api_users_get_collection
  1015. tags:
  1016. - User
  1017. responses:
  1018. 200:
  1019. description: 'User collection'
  1020. content:
  1021. application/ld+json:
  1022. schema:
  1023. type: object
  1024. properties:
  1025. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1026. 'hydra:totalItems': { type: integer, minimum: 0 }
  1027. '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 } }
  1028. '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 } } } } } }
  1029. required:
  1030. - 'hydra:member'
  1031. application/json:
  1032. schema:
  1033. type: array
  1034. items:
  1035. $ref: '#/components/schemas/User'
  1036. text/html:
  1037. schema:
  1038. type: array
  1039. items:
  1040. $ref: '#/components/schemas/User'
  1041. application/hal+json:
  1042. schema:
  1043. type: object
  1044. properties:
  1045. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  1046. totalItems: { type: integer, minimum: 0 }
  1047. itemsPerPage: { type: integer, minimum: 0 }
  1048. _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 } } } } }
  1049. required:
  1050. - _links
  1051. - _embedded
  1052. summary: 'Retrieves the collection of User resources.'
  1053. description: 'Retrieves the collection of User resources.'
  1054. parameters:
  1055. -
  1056. name: page
  1057. in: query
  1058. description: 'The collection page number'
  1059. required: false
  1060. deprecated: false
  1061. allowEmptyValue: true
  1062. schema:
  1063. type: integer
  1064. default: 1
  1065. style: form
  1066. explode: false
  1067. allowReserved: false
  1068. -
  1069. name: itemsPerPage
  1070. in: query
  1071. description: 'The number of items per page'
  1072. required: false
  1073. deprecated: false
  1074. allowEmptyValue: true
  1075. schema:
  1076. type: integer
  1077. default: 10
  1078. minimum: 0
  1079. maximum: 50
  1080. style: form
  1081. explode: false
  1082. allowReserved: false
  1083. deprecated: false
  1084. post:
  1085. operationId: api_users_post
  1086. tags:
  1087. - User
  1088. responses:
  1089. 201:
  1090. description: 'User resource created'
  1091. content:
  1092. application/ld+json:
  1093. schema:
  1094. $ref: '#/components/schemas/User.jsonld'
  1095. application/json:
  1096. schema:
  1097. $ref: '#/components/schemas/User'
  1098. text/html:
  1099. schema:
  1100. $ref: '#/components/schemas/User'
  1101. application/hal+json:
  1102. schema:
  1103. $ref: '#/components/schemas/User.jsonhal'
  1104. links: { }
  1105. 400:
  1106. description: 'Invalid input'
  1107. 422:
  1108. description: 'Unprocessable entity'
  1109. summary: 'Creates a User resource.'
  1110. description: 'Creates a User resource.'
  1111. parameters: []
  1112. requestBody:
  1113. description: 'The new User resource'
  1114. content:
  1115. application/ld+json:
  1116. schema:
  1117. $ref: '#/components/schemas/User.jsonld'
  1118. application/json:
  1119. schema:
  1120. $ref: '#/components/schemas/User'
  1121. text/html:
  1122. schema:
  1123. $ref: '#/components/schemas/User'
  1124. application/hal+json:
  1125. schema:
  1126. $ref: '#/components/schemas/User.jsonhal'
  1127. required: true
  1128. deprecated: false
  1129. parameters: []
  1130. '/api/users/{id}':
  1131. get:
  1132. operationId: api_users_id_get
  1133. tags:
  1134. - User
  1135. responses:
  1136. 200:
  1137. description: 'User resource'
  1138. content:
  1139. application/ld+json:
  1140. schema:
  1141. $ref: '#/components/schemas/User.jsonld'
  1142. application/json:
  1143. schema:
  1144. $ref: '#/components/schemas/User'
  1145. text/html:
  1146. schema:
  1147. $ref: '#/components/schemas/User'
  1148. application/hal+json:
  1149. schema:
  1150. $ref: '#/components/schemas/User.jsonhal'
  1151. 404:
  1152. description: 'Resource not found'
  1153. summary: 'Retrieves a User resource.'
  1154. description: 'Retrieves a User resource.'
  1155. parameters:
  1156. -
  1157. name: id
  1158. in: path
  1159. description: 'UserApi 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. patch:
  1170. operationId: api_users_id_patch
  1171. tags:
  1172. - User
  1173. responses:
  1174. 200:
  1175. description: 'User resource updated'
  1176. content:
  1177. application/ld+json:
  1178. schema:
  1179. $ref: '#/components/schemas/User.jsonld'
  1180. application/json:
  1181. schema:
  1182. $ref: '#/components/schemas/User'
  1183. text/html:
  1184. schema:
  1185. $ref: '#/components/schemas/User'
  1186. application/hal+json:
  1187. schema:
  1188. $ref: '#/components/schemas/User.jsonhal'
  1189. links: { }
  1190. 400:
  1191. description: 'Invalid input'
  1192. 422:
  1193. description: 'Unprocessable entity'
  1194. 404:
  1195. description: 'Resource not found'
  1196. summary: 'Updates the User resource.'
  1197. description: 'Updates the User resource.'
  1198. parameters:
  1199. -
  1200. name: id
  1201. in: path
  1202. description: 'UserApi identifier'
  1203. required: true
  1204. deprecated: false
  1205. allowEmptyValue: false
  1206. schema:
  1207. type: string
  1208. style: simple
  1209. explode: false
  1210. allowReserved: false
  1211. requestBody:
  1212. description: 'The updated User resource'
  1213. content:
  1214. application/merge-patch+json:
  1215. schema:
  1216. $ref: '#/components/schemas/User'
  1217. required: true
  1218. deprecated: false
  1219. parameters: []
  1220. /auth:
  1221. post:
  1222. operationId: login_check_post
  1223. tags:
  1224. - 'Login Check'
  1225. responses:
  1226. 200:
  1227. description: 'User token created'
  1228. content:
  1229. application/json:
  1230. schema:
  1231. type: object
  1232. properties:
  1233. token: { readOnly: true, type: string, nullable: false }
  1234. required:
  1235. - token
  1236. summary: 'Creates a user token.'
  1237. description: 'Creates a user token.'
  1238. requestBody:
  1239. description: 'The login data'
  1240. content:
  1241. application/json:
  1242. schema:
  1243. type: object
  1244. properties:
  1245. email:
  1246. type: string
  1247. nullable: false
  1248. password:
  1249. type: string
  1250. nullable: false
  1251. required:
  1252. - email
  1253. - password
  1254. required: true
  1255. parameters: []
  1256. components:
  1257. schemas:
  1258. Contact:
  1259. type: object
  1260. description: ''
  1261. deprecated: false
  1262. required:
  1263. - firstName
  1264. - lastName
  1265. properties:
  1266. firstName:
  1267. type:
  1268. - string
  1269. - 'null'
  1270. lastName:
  1271. type:
  1272. - string
  1273. - 'null'
  1274. partner:
  1275. 'owl:maxCardinality': 1
  1276. type:
  1277. - string
  1278. - 'null'
  1279. format: iri-reference
  1280. example: 'https://example.com/'
  1281. birthday:
  1282. type:
  1283. - string
  1284. - 'null'
  1285. format: date-time
  1286. image:
  1287. 'owl:maxCardinality': 1
  1288. type:
  1289. - string
  1290. - 'null'
  1291. format: iri-reference
  1292. example: 'https://example.com/'
  1293. imageUrl:
  1294. readOnly: true
  1295. type:
  1296. - string
  1297. - 'null'
  1298. position:
  1299. type:
  1300. - string
  1301. - 'null'
  1302. phone:
  1303. type:
  1304. - string
  1305. - 'null'
  1306. email:
  1307. type:
  1308. - string
  1309. - 'null'
  1310. createdAt:
  1311. type:
  1312. - string
  1313. - 'null'
  1314. format: date-time
  1315. Contact.jsonhal:
  1316. type: object
  1317. description: ''
  1318. deprecated: false
  1319. required:
  1320. - firstName
  1321. - lastName
  1322. properties:
  1323. _links:
  1324. type: object
  1325. properties:
  1326. self:
  1327. type: object
  1328. properties:
  1329. href:
  1330. type: string
  1331. format: iri-reference
  1332. firstName:
  1333. type:
  1334. - string
  1335. - 'null'
  1336. lastName:
  1337. type:
  1338. - string
  1339. - 'null'
  1340. partner:
  1341. 'owl:maxCardinality': 1
  1342. type:
  1343. - string
  1344. - 'null'
  1345. format: iri-reference
  1346. example: 'https://example.com/'
  1347. birthday:
  1348. type:
  1349. - string
  1350. - 'null'
  1351. format: date-time
  1352. image:
  1353. 'owl:maxCardinality': 1
  1354. type:
  1355. - string
  1356. - 'null'
  1357. format: iri-reference
  1358. example: 'https://example.com/'
  1359. imageUrl:
  1360. readOnly: true
  1361. type:
  1362. - string
  1363. - 'null'
  1364. position:
  1365. type:
  1366. - string
  1367. - 'null'
  1368. phone:
  1369. type:
  1370. - string
  1371. - 'null'
  1372. email:
  1373. type:
  1374. - string
  1375. - 'null'
  1376. createdAt:
  1377. type:
  1378. - string
  1379. - 'null'
  1380. format: date-time
  1381. Contact.jsonld:
  1382. type: object
  1383. description: ''
  1384. deprecated: false
  1385. required:
  1386. - firstName
  1387. - lastName
  1388. properties:
  1389. '@context':
  1390. readOnly: true
  1391. oneOf:
  1392. -
  1393. type: string
  1394. -
  1395. type: object
  1396. properties:
  1397. '@vocab':
  1398. type: string
  1399. hydra:
  1400. type: string
  1401. enum: ['http://www.w3.org/ns/hydra/core#']
  1402. required:
  1403. - '@vocab'
  1404. - hydra
  1405. additionalProperties: true
  1406. '@id':
  1407. readOnly: true
  1408. type: string
  1409. '@type':
  1410. readOnly: true
  1411. type: string
  1412. firstName:
  1413. type:
  1414. - string
  1415. - 'null'
  1416. lastName:
  1417. type:
  1418. - string
  1419. - 'null'
  1420. partner:
  1421. 'owl:maxCardinality': 1
  1422. type:
  1423. - string
  1424. - 'null'
  1425. format: iri-reference
  1426. example: 'https://example.com/'
  1427. birthday:
  1428. type:
  1429. - string
  1430. - 'null'
  1431. format: date-time
  1432. image:
  1433. 'owl:maxCardinality': 1
  1434. type:
  1435. - string
  1436. - 'null'
  1437. format: iri-reference
  1438. example: 'https://example.com/'
  1439. imageUrl:
  1440. readOnly: true
  1441. type:
  1442. - string
  1443. - 'null'
  1444. position:
  1445. type:
  1446. - string
  1447. - 'null'
  1448. phone:
  1449. type:
  1450. - string
  1451. - 'null'
  1452. email:
  1453. type:
  1454. - string
  1455. - 'null'
  1456. createdAt:
  1457. type:
  1458. - string
  1459. - 'null'
  1460. format: date-time
  1461. MediaObject-media_object.read:
  1462. type: object
  1463. description: ''
  1464. deprecated: false
  1465. externalDocs:
  1466. url: 'https://schema.org/MediaObject'
  1467. properties:
  1468. contentUrl:
  1469. externalDocs:
  1470. url: 'https://schema.org/contentUrl'
  1471. type:
  1472. - string
  1473. - 'null'
  1474. MediaObject.jsonhal-media_object.read:
  1475. type: object
  1476. description: ''
  1477. deprecated: false
  1478. externalDocs:
  1479. url: 'https://schema.org/MediaObject'
  1480. properties:
  1481. _links:
  1482. type: object
  1483. properties:
  1484. self:
  1485. type: object
  1486. properties:
  1487. href:
  1488. type: string
  1489. format: iri-reference
  1490. contentUrl:
  1491. externalDocs:
  1492. url: 'https://schema.org/contentUrl'
  1493. type:
  1494. - string
  1495. - 'null'
  1496. MediaObject.jsonld-media_object.read:
  1497. type: object
  1498. description: ''
  1499. deprecated: false
  1500. externalDocs:
  1501. url: 'https://schema.org/MediaObject'
  1502. properties:
  1503. '@context':
  1504. readOnly: true
  1505. oneOf:
  1506. -
  1507. type: string
  1508. -
  1509. type: object
  1510. properties:
  1511. '@vocab':
  1512. type: string
  1513. hydra:
  1514. type: string
  1515. enum: ['http://www.w3.org/ns/hydra/core#']
  1516. required:
  1517. - '@vocab'
  1518. - hydra
  1519. additionalProperties: true
  1520. '@id':
  1521. readOnly: true
  1522. type: string
  1523. '@type':
  1524. readOnly: true
  1525. type: string
  1526. contentUrl:
  1527. externalDocs:
  1528. url: 'https://schema.org/contentUrl'
  1529. type:
  1530. - string
  1531. - 'null'
  1532. Partner:
  1533. type: object
  1534. description: ''
  1535. deprecated: false
  1536. required:
  1537. - name
  1538. - type
  1539. properties:
  1540. name:
  1541. type: string
  1542. type:
  1543. type: string
  1544. enum:
  1545. - customer
  1546. - supplier
  1547. - service
  1548. street:
  1549. type:
  1550. - string
  1551. - 'null'
  1552. streetNo:
  1553. type:
  1554. - string
  1555. - 'null'
  1556. zip:
  1557. type:
  1558. - string
  1559. - 'null'
  1560. city:
  1561. type:
  1562. - string
  1563. - 'null'
  1564. country:
  1565. type:
  1566. - string
  1567. - 'null'
  1568. website:
  1569. type:
  1570. - string
  1571. - 'null'
  1572. logo:
  1573. 'owl:maxCardinality': 1
  1574. type:
  1575. - string
  1576. - 'null'
  1577. format: iri-reference
  1578. example: 'https://example.com/'
  1579. logoUrl:
  1580. readOnly: true
  1581. type:
  1582. - string
  1583. - 'null'
  1584. createdAt:
  1585. type:
  1586. - string
  1587. - 'null'
  1588. format: date-time
  1589. contacts:
  1590. type: array
  1591. items:
  1592. type: string
  1593. format: iri-reference
  1594. example: 'https://example.com/'
  1595. Partner.jsonhal:
  1596. type: object
  1597. description: ''
  1598. deprecated: false
  1599. required:
  1600. - name
  1601. - type
  1602. properties:
  1603. _links:
  1604. type: object
  1605. properties:
  1606. self:
  1607. type: object
  1608. properties:
  1609. href:
  1610. type: string
  1611. format: iri-reference
  1612. name:
  1613. type: string
  1614. type:
  1615. type: string
  1616. enum:
  1617. - customer
  1618. - supplier
  1619. - service
  1620. street:
  1621. type:
  1622. - string
  1623. - 'null'
  1624. streetNo:
  1625. type:
  1626. - string
  1627. - 'null'
  1628. zip:
  1629. type:
  1630. - string
  1631. - 'null'
  1632. city:
  1633. type:
  1634. - string
  1635. - 'null'
  1636. country:
  1637. type:
  1638. - string
  1639. - 'null'
  1640. website:
  1641. type:
  1642. - string
  1643. - 'null'
  1644. logo:
  1645. 'owl:maxCardinality': 1
  1646. type:
  1647. - string
  1648. - 'null'
  1649. format: iri-reference
  1650. example: 'https://example.com/'
  1651. logoUrl:
  1652. readOnly: true
  1653. type:
  1654. - string
  1655. - 'null'
  1656. createdAt:
  1657. type:
  1658. - string
  1659. - 'null'
  1660. format: date-time
  1661. contacts:
  1662. type: array
  1663. items:
  1664. type: string
  1665. format: iri-reference
  1666. example: 'https://example.com/'
  1667. Partner.jsonld:
  1668. type: object
  1669. description: ''
  1670. deprecated: false
  1671. required:
  1672. - name
  1673. - type
  1674. properties:
  1675. '@context':
  1676. readOnly: true
  1677. oneOf:
  1678. -
  1679. type: string
  1680. -
  1681. type: object
  1682. properties:
  1683. '@vocab':
  1684. type: string
  1685. hydra:
  1686. type: string
  1687. enum: ['http://www.w3.org/ns/hydra/core#']
  1688. required:
  1689. - '@vocab'
  1690. - hydra
  1691. additionalProperties: true
  1692. '@id':
  1693. readOnly: true
  1694. type: string
  1695. '@type':
  1696. readOnly: true
  1697. type: string
  1698. name:
  1699. type: string
  1700. type:
  1701. type: string
  1702. enum:
  1703. - customer
  1704. - supplier
  1705. - service
  1706. street:
  1707. type:
  1708. - string
  1709. - 'null'
  1710. streetNo:
  1711. type:
  1712. - string
  1713. - 'null'
  1714. zip:
  1715. type:
  1716. - string
  1717. - 'null'
  1718. city:
  1719. type:
  1720. - string
  1721. - 'null'
  1722. country:
  1723. type:
  1724. - string
  1725. - 'null'
  1726. website:
  1727. type:
  1728. - string
  1729. - 'null'
  1730. logo:
  1731. 'owl:maxCardinality': 1
  1732. type:
  1733. - string
  1734. - 'null'
  1735. format: iri-reference
  1736. example: 'https://example.com/'
  1737. logoUrl:
  1738. readOnly: true
  1739. type:
  1740. - string
  1741. - 'null'
  1742. createdAt:
  1743. type:
  1744. - string
  1745. - 'null'
  1746. format: date-time
  1747. contacts:
  1748. type: array
  1749. items:
  1750. type: string
  1751. format: iri-reference
  1752. example: 'https://example.com/'
  1753. Post:
  1754. type: object
  1755. description: ''
  1756. deprecated: false
  1757. required:
  1758. - headline
  1759. - message
  1760. properties:
  1761. headline:
  1762. type:
  1763. - string
  1764. - 'null'
  1765. message:
  1766. type:
  1767. - string
  1768. - 'null'
  1769. owner:
  1770. 'owl:maxCardinality': 1
  1771. type:
  1772. - string
  1773. - 'null'
  1774. format: iri-reference
  1775. example: 'https://example.com/'
  1776. ownerName:
  1777. readOnly: true
  1778. type:
  1779. - string
  1780. - 'null'
  1781. partner:
  1782. anyOf:
  1783. -
  1784. $ref: '#/components/schemas/Partner'
  1785. -
  1786. type: 'null'
  1787. contact:
  1788. anyOf:
  1789. -
  1790. $ref: '#/components/schemas/Contact'
  1791. -
  1792. type: 'null'
  1793. createdAt:
  1794. readOnly: true
  1795. type:
  1796. - string
  1797. - 'null'
  1798. format: date-time
  1799. Post.jsonhal:
  1800. type: object
  1801. description: ''
  1802. deprecated: false
  1803. required:
  1804. - headline
  1805. - message
  1806. properties:
  1807. _links:
  1808. type: object
  1809. properties:
  1810. self:
  1811. type: object
  1812. properties:
  1813. href:
  1814. type: string
  1815. format: iri-reference
  1816. headline:
  1817. type:
  1818. - string
  1819. - 'null'
  1820. message:
  1821. type:
  1822. - string
  1823. - 'null'
  1824. owner:
  1825. 'owl:maxCardinality': 1
  1826. type:
  1827. - string
  1828. - 'null'
  1829. format: iri-reference
  1830. example: 'https://example.com/'
  1831. ownerName:
  1832. readOnly: true
  1833. type:
  1834. - string
  1835. - 'null'
  1836. partner:
  1837. anyOf:
  1838. -
  1839. $ref: '#/components/schemas/Partner.jsonhal'
  1840. -
  1841. type: 'null'
  1842. contact:
  1843. anyOf:
  1844. -
  1845. $ref: '#/components/schemas/Contact.jsonhal'
  1846. -
  1847. type: 'null'
  1848. createdAt:
  1849. readOnly: true
  1850. type:
  1851. - string
  1852. - 'null'
  1853. format: date-time
  1854. Post.jsonld:
  1855. type: object
  1856. description: ''
  1857. deprecated: false
  1858. required:
  1859. - headline
  1860. - message
  1861. properties:
  1862. '@context':
  1863. readOnly: true
  1864. oneOf:
  1865. -
  1866. type: string
  1867. -
  1868. type: object
  1869. properties:
  1870. '@vocab':
  1871. type: string
  1872. hydra:
  1873. type: string
  1874. enum: ['http://www.w3.org/ns/hydra/core#']
  1875. required:
  1876. - '@vocab'
  1877. - hydra
  1878. additionalProperties: true
  1879. '@id':
  1880. readOnly: true
  1881. type: string
  1882. '@type':
  1883. readOnly: true
  1884. type: string
  1885. headline:
  1886. type:
  1887. - string
  1888. - 'null'
  1889. message:
  1890. type:
  1891. - string
  1892. - 'null'
  1893. owner:
  1894. 'owl:maxCardinality': 1
  1895. type:
  1896. - string
  1897. - 'null'
  1898. format: iri-reference
  1899. example: 'https://example.com/'
  1900. ownerName:
  1901. readOnly: true
  1902. type:
  1903. - string
  1904. - 'null'
  1905. partner:
  1906. anyOf:
  1907. -
  1908. $ref: '#/components/schemas/Partner.jsonld'
  1909. -
  1910. type: 'null'
  1911. contact:
  1912. anyOf:
  1913. -
  1914. $ref: '#/components/schemas/Contact.jsonld'
  1915. -
  1916. type: 'null'
  1917. createdAt:
  1918. readOnly: true
  1919. type:
  1920. - string
  1921. - 'null'
  1922. format: date-time
  1923. User:
  1924. type: object
  1925. description: ''
  1926. deprecated: false
  1927. required:
  1928. - email
  1929. - firstName
  1930. - lastName
  1931. properties:
  1932. email:
  1933. format: email
  1934. externalDocs:
  1935. url: 'https://schema.org/email'
  1936. type:
  1937. - string
  1938. - 'null'
  1939. firstName:
  1940. type:
  1941. - string
  1942. - 'null'
  1943. lastName:
  1944. type:
  1945. - string
  1946. - 'null'
  1947. password:
  1948. writeOnly: true
  1949. description: 'The plaintext password when being set or changed.'
  1950. type:
  1951. - string
  1952. - 'null'
  1953. active:
  1954. type: boolean
  1955. createdAt:
  1956. readOnly: true
  1957. type:
  1958. - string
  1959. - 'null'
  1960. format: date-time
  1961. postings:
  1962. type: array
  1963. items:
  1964. type: string
  1965. format: iri-reference
  1966. example: 'https://example.com/'
  1967. User.jsonhal:
  1968. type: object
  1969. description: ''
  1970. deprecated: false
  1971. required:
  1972. - email
  1973. - firstName
  1974. - lastName
  1975. properties:
  1976. _links:
  1977. type: object
  1978. properties:
  1979. self:
  1980. type: object
  1981. properties:
  1982. href:
  1983. type: string
  1984. format: iri-reference
  1985. email:
  1986. format: email
  1987. externalDocs:
  1988. url: 'https://schema.org/email'
  1989. type:
  1990. - string
  1991. - 'null'
  1992. firstName:
  1993. type:
  1994. - string
  1995. - 'null'
  1996. lastName:
  1997. type:
  1998. - string
  1999. - 'null'
  2000. password:
  2001. writeOnly: true
  2002. description: 'The plaintext password when being set or changed.'
  2003. type:
  2004. - string
  2005. - 'null'
  2006. active:
  2007. type: boolean
  2008. createdAt:
  2009. readOnly: true
  2010. type:
  2011. - string
  2012. - 'null'
  2013. format: date-time
  2014. postings:
  2015. type: array
  2016. items:
  2017. type: string
  2018. format: iri-reference
  2019. example: 'https://example.com/'
  2020. User.jsonld:
  2021. type: object
  2022. description: ''
  2023. deprecated: false
  2024. required:
  2025. - email
  2026. - firstName
  2027. - lastName
  2028. properties:
  2029. '@context':
  2030. readOnly: true
  2031. oneOf:
  2032. -
  2033. type: string
  2034. -
  2035. type: object
  2036. properties:
  2037. '@vocab':
  2038. type: string
  2039. hydra:
  2040. type: string
  2041. enum: ['http://www.w3.org/ns/hydra/core#']
  2042. required:
  2043. - '@vocab'
  2044. - hydra
  2045. additionalProperties: true
  2046. '@id':
  2047. readOnly: true
  2048. type: string
  2049. '@type':
  2050. readOnly: true
  2051. type: string
  2052. email:
  2053. format: email
  2054. externalDocs:
  2055. url: 'https://schema.org/email'
  2056. type:
  2057. - string
  2058. - 'null'
  2059. firstName:
  2060. type:
  2061. - string
  2062. - 'null'
  2063. lastName:
  2064. type:
  2065. - string
  2066. - 'null'
  2067. password:
  2068. writeOnly: true
  2069. description: 'The plaintext password when being set or changed.'
  2070. type:
  2071. - string
  2072. - 'null'
  2073. active:
  2074. type: boolean
  2075. createdAt:
  2076. readOnly: true
  2077. type:
  2078. - string
  2079. - 'null'
  2080. format: date-time
  2081. postings:
  2082. type: array
  2083. items:
  2084. type: string
  2085. format: iri-reference
  2086. example: 'https://example.com/'
  2087. responses: { }
  2088. parameters: { }
  2089. examples: { }
  2090. requestBodies: { }
  2091. headers: { }
  2092. securitySchemes:
  2093. JWT:
  2094. type: http
  2095. scheme: bearer
  2096. bearerFormat: JWT
  2097. security:
  2098. -
  2099. JWT: []
  2100. tags: []