Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 
 

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