Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
 
 
 
 

1808 рядки
54 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: 'order[name]'
  425. in: query
  426. description: ''
  427. required: false
  428. deprecated: false
  429. allowEmptyValue: true
  430. schema:
  431. type: string
  432. enum:
  433. - asc
  434. - desc
  435. style: form
  436. explode: false
  437. allowReserved: false
  438. -
  439. name: type
  440. in: query
  441. description: ''
  442. required: false
  443. deprecated: false
  444. allowEmptyValue: true
  445. schema:
  446. type: string
  447. style: form
  448. explode: false
  449. allowReserved: false
  450. -
  451. name: 'type[]'
  452. in: query
  453. description: ''
  454. required: false
  455. deprecated: false
  456. allowEmptyValue: true
  457. schema:
  458. type: array
  459. items:
  460. type: string
  461. style: form
  462. explode: true
  463. allowReserved: false
  464. deprecated: false
  465. post:
  466. operationId: api_partners_post
  467. tags:
  468. - Partner
  469. responses:
  470. 201:
  471. description: 'Partner resource created'
  472. content:
  473. application/ld+json:
  474. schema:
  475. $ref: '#/components/schemas/Partner.jsonld'
  476. application/json:
  477. schema:
  478. $ref: '#/components/schemas/Partner'
  479. text/html:
  480. schema:
  481. $ref: '#/components/schemas/Partner'
  482. application/hal+json:
  483. schema:
  484. $ref: '#/components/schemas/Partner.jsonhal'
  485. links: { }
  486. 400:
  487. description: 'Invalid input'
  488. 422:
  489. description: 'Unprocessable entity'
  490. summary: 'Creates a Partner resource.'
  491. description: 'Creates a Partner resource.'
  492. parameters: []
  493. requestBody:
  494. description: 'The new Partner resource'
  495. content:
  496. application/ld+json:
  497. schema:
  498. $ref: '#/components/schemas/Partner.jsonld'
  499. application/json:
  500. schema:
  501. $ref: '#/components/schemas/Partner'
  502. text/html:
  503. schema:
  504. $ref: '#/components/schemas/Partner'
  505. application/hal+json:
  506. schema:
  507. $ref: '#/components/schemas/Partner.jsonhal'
  508. required: true
  509. deprecated: false
  510. parameters: []
  511. '/api/partners/{id}':
  512. get:
  513. operationId: api_partners_id_get
  514. tags:
  515. - Partner
  516. responses:
  517. 200:
  518. description: 'Partner resource'
  519. content:
  520. application/ld+json:
  521. schema:
  522. $ref: '#/components/schemas/Partner.jsonld'
  523. application/json:
  524. schema:
  525. $ref: '#/components/schemas/Partner'
  526. text/html:
  527. schema:
  528. $ref: '#/components/schemas/Partner'
  529. application/hal+json:
  530. schema:
  531. $ref: '#/components/schemas/Partner.jsonhal'
  532. 404:
  533. description: 'Resource not found'
  534. summary: 'Retrieves a Partner resource.'
  535. description: 'Retrieves a Partner resource.'
  536. parameters:
  537. -
  538. name: id
  539. in: path
  540. description: 'PartnerApi identifier'
  541. required: true
  542. deprecated: false
  543. allowEmptyValue: false
  544. schema:
  545. type: string
  546. style: simple
  547. explode: false
  548. allowReserved: false
  549. deprecated: false
  550. delete:
  551. operationId: api_partners_id_delete
  552. tags:
  553. - Partner
  554. responses:
  555. 204:
  556. description: 'Partner resource deleted'
  557. 404:
  558. description: 'Resource not found'
  559. summary: 'Removes the Partner resource.'
  560. description: 'Removes the Partner resource.'
  561. parameters:
  562. -
  563. name: id
  564. in: path
  565. description: 'PartnerApi identifier'
  566. required: true
  567. deprecated: false
  568. allowEmptyValue: false
  569. schema:
  570. type: string
  571. style: simple
  572. explode: false
  573. allowReserved: false
  574. deprecated: false
  575. patch:
  576. operationId: api_partners_id_patch
  577. tags:
  578. - Partner
  579. responses:
  580. 200:
  581. description: 'Partner resource updated'
  582. content:
  583. application/ld+json:
  584. schema:
  585. $ref: '#/components/schemas/Partner.jsonld'
  586. application/json:
  587. schema:
  588. $ref: '#/components/schemas/Partner'
  589. text/html:
  590. schema:
  591. $ref: '#/components/schemas/Partner'
  592. application/hal+json:
  593. schema:
  594. $ref: '#/components/schemas/Partner.jsonhal'
  595. links: { }
  596. 400:
  597. description: 'Invalid input'
  598. 422:
  599. description: 'Unprocessable entity'
  600. 404:
  601. description: 'Resource not found'
  602. summary: 'Updates the Partner resource.'
  603. description: 'Updates the Partner resource.'
  604. parameters:
  605. -
  606. name: id
  607. in: path
  608. description: 'PartnerApi identifier'
  609. required: true
  610. deprecated: false
  611. allowEmptyValue: false
  612. schema:
  613. type: string
  614. style: simple
  615. explode: false
  616. allowReserved: false
  617. requestBody:
  618. description: 'The updated Partner resource'
  619. content:
  620. application/merge-patch+json:
  621. schema:
  622. $ref: '#/components/schemas/Partner'
  623. required: true
  624. deprecated: false
  625. parameters: []
  626. /api/posts:
  627. get:
  628. operationId: api_posts_get_collection
  629. tags:
  630. - Post
  631. responses:
  632. 200:
  633. description: 'Post collection'
  634. content:
  635. application/ld+json:
  636. schema:
  637. type: object
  638. properties:
  639. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  640. 'hydra:totalItems': { type: integer, minimum: 0 }
  641. '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 } }
  642. '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 } } } } } }
  643. required:
  644. - 'hydra:member'
  645. application/json:
  646. schema:
  647. type: array
  648. items:
  649. $ref: '#/components/schemas/Post'
  650. text/html:
  651. schema:
  652. type: array
  653. items:
  654. $ref: '#/components/schemas/Post'
  655. application/hal+json:
  656. schema:
  657. type: object
  658. properties:
  659. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  660. totalItems: { type: integer, minimum: 0 }
  661. itemsPerPage: { type: integer, minimum: 0 }
  662. _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 } } } } }
  663. required:
  664. - _links
  665. - _embedded
  666. summary: 'Retrieves the collection of Post resources.'
  667. description: 'Retrieves the collection of Post resources.'
  668. parameters:
  669. -
  670. name: page
  671. in: query
  672. description: 'The collection page number'
  673. required: false
  674. deprecated: false
  675. allowEmptyValue: true
  676. schema:
  677. type: integer
  678. default: 1
  679. style: form
  680. explode: false
  681. allowReserved: false
  682. deprecated: false
  683. post:
  684. operationId: api_posts_post
  685. tags:
  686. - Post
  687. responses:
  688. 201:
  689. description: 'Post resource created'
  690. content:
  691. application/ld+json:
  692. schema:
  693. $ref: '#/components/schemas/Post.jsonld'
  694. application/json:
  695. schema:
  696. $ref: '#/components/schemas/Post'
  697. text/html:
  698. schema:
  699. $ref: '#/components/schemas/Post'
  700. application/hal+json:
  701. schema:
  702. $ref: '#/components/schemas/Post.jsonhal'
  703. links: { }
  704. 400:
  705. description: 'Invalid input'
  706. 422:
  707. description: 'Unprocessable entity'
  708. summary: 'Creates a Post resource.'
  709. description: 'Creates a Post resource.'
  710. parameters: []
  711. requestBody:
  712. description: 'The new Post resource'
  713. content:
  714. application/ld+json:
  715. schema:
  716. $ref: '#/components/schemas/Post.jsonld'
  717. application/json:
  718. schema:
  719. $ref: '#/components/schemas/Post'
  720. text/html:
  721. schema:
  722. $ref: '#/components/schemas/Post'
  723. application/hal+json:
  724. schema:
  725. $ref: '#/components/schemas/Post.jsonhal'
  726. required: true
  727. deprecated: false
  728. parameters: []
  729. '/api/posts/{id}':
  730. get:
  731. operationId: api_posts_id_get
  732. tags:
  733. - Post
  734. responses:
  735. 200:
  736. description: 'Post resource'
  737. content:
  738. application/ld+json:
  739. schema:
  740. $ref: '#/components/schemas/Post.jsonld'
  741. application/json:
  742. schema:
  743. $ref: '#/components/schemas/Post'
  744. text/html:
  745. schema:
  746. $ref: '#/components/schemas/Post'
  747. application/hal+json:
  748. schema:
  749. $ref: '#/components/schemas/Post.jsonhal'
  750. 404:
  751. description: 'Resource not found'
  752. summary: 'Retrieves a Post resource.'
  753. description: 'Retrieves a Post resource.'
  754. parameters:
  755. -
  756. name: id
  757. in: path
  758. description: 'PostingApi identifier'
  759. required: true
  760. deprecated: false
  761. allowEmptyValue: false
  762. schema:
  763. type: string
  764. style: simple
  765. explode: false
  766. allowReserved: false
  767. deprecated: false
  768. delete:
  769. operationId: api_posts_id_delete
  770. tags:
  771. - Post
  772. responses:
  773. 204:
  774. description: 'Post resource deleted'
  775. 404:
  776. description: 'Resource not found'
  777. summary: 'Removes the Post resource.'
  778. description: 'Removes the Post resource.'
  779. parameters:
  780. -
  781. name: id
  782. in: path
  783. description: 'PostingApi identifier'
  784. required: true
  785. deprecated: false
  786. allowEmptyValue: false
  787. schema:
  788. type: string
  789. style: simple
  790. explode: false
  791. allowReserved: false
  792. deprecated: false
  793. patch:
  794. operationId: api_posts_id_patch
  795. tags:
  796. - Post
  797. responses:
  798. 200:
  799. description: 'Post resource updated'
  800. content:
  801. application/ld+json:
  802. schema:
  803. $ref: '#/components/schemas/Post.jsonld'
  804. application/json:
  805. schema:
  806. $ref: '#/components/schemas/Post'
  807. text/html:
  808. schema:
  809. $ref: '#/components/schemas/Post'
  810. application/hal+json:
  811. schema:
  812. $ref: '#/components/schemas/Post.jsonhal'
  813. links: { }
  814. 400:
  815. description: 'Invalid input'
  816. 422:
  817. description: 'Unprocessable entity'
  818. 404:
  819. description: 'Resource not found'
  820. summary: 'Updates the Post resource.'
  821. description: 'Updates the Post resource.'
  822. parameters:
  823. -
  824. name: id
  825. in: path
  826. description: 'PostingApi identifier'
  827. required: true
  828. deprecated: false
  829. allowEmptyValue: false
  830. schema:
  831. type: string
  832. style: simple
  833. explode: false
  834. allowReserved: false
  835. requestBody:
  836. description: 'The updated Post resource'
  837. content:
  838. application/merge-patch+json:
  839. schema:
  840. $ref: '#/components/schemas/Post'
  841. required: true
  842. deprecated: false
  843. parameters: []
  844. /api/users:
  845. get:
  846. operationId: api_users_get_collection
  847. tags:
  848. - User
  849. responses:
  850. 200:
  851. description: 'User collection'
  852. content:
  853. application/ld+json:
  854. schema:
  855. type: object
  856. properties:
  857. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  858. 'hydra:totalItems': { type: integer, minimum: 0 }
  859. '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 } }
  860. '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 } } } } } }
  861. required:
  862. - 'hydra:member'
  863. application/json:
  864. schema:
  865. type: array
  866. items:
  867. $ref: '#/components/schemas/User'
  868. text/html:
  869. schema:
  870. type: array
  871. items:
  872. $ref: '#/components/schemas/User'
  873. application/hal+json:
  874. schema:
  875. type: object
  876. properties:
  877. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  878. totalItems: { type: integer, minimum: 0 }
  879. itemsPerPage: { type: integer, minimum: 0 }
  880. _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 } } } } }
  881. required:
  882. - _links
  883. - _embedded
  884. summary: 'Retrieves the collection of User resources.'
  885. description: 'Retrieves the collection of User resources.'
  886. parameters:
  887. -
  888. name: page
  889. in: query
  890. description: 'The collection page number'
  891. required: false
  892. deprecated: false
  893. allowEmptyValue: true
  894. schema:
  895. type: integer
  896. default: 1
  897. style: form
  898. explode: false
  899. allowReserved: false
  900. deprecated: false
  901. post:
  902. operationId: api_users_post
  903. tags:
  904. - User
  905. responses:
  906. 201:
  907. description: 'User resource created'
  908. content:
  909. application/ld+json:
  910. schema:
  911. $ref: '#/components/schemas/User.jsonld'
  912. application/json:
  913. schema:
  914. $ref: '#/components/schemas/User'
  915. text/html:
  916. schema:
  917. $ref: '#/components/schemas/User'
  918. application/hal+json:
  919. schema:
  920. $ref: '#/components/schemas/User.jsonhal'
  921. links: { }
  922. 400:
  923. description: 'Invalid input'
  924. 422:
  925. description: 'Unprocessable entity'
  926. summary: 'Creates a User resource.'
  927. description: 'Creates a User resource.'
  928. parameters: []
  929. requestBody:
  930. description: 'The new User resource'
  931. content:
  932. application/ld+json:
  933. schema:
  934. $ref: '#/components/schemas/User.jsonld'
  935. application/json:
  936. schema:
  937. $ref: '#/components/schemas/User'
  938. text/html:
  939. schema:
  940. $ref: '#/components/schemas/User'
  941. application/hal+json:
  942. schema:
  943. $ref: '#/components/schemas/User.jsonhal'
  944. required: true
  945. deprecated: false
  946. parameters: []
  947. '/api/users/{id}':
  948. get:
  949. operationId: api_users_id_get
  950. tags:
  951. - User
  952. responses:
  953. 200:
  954. description: 'User resource'
  955. content:
  956. application/ld+json:
  957. schema:
  958. $ref: '#/components/schemas/User.jsonld'
  959. application/json:
  960. schema:
  961. $ref: '#/components/schemas/User'
  962. text/html:
  963. schema:
  964. $ref: '#/components/schemas/User'
  965. application/hal+json:
  966. schema:
  967. $ref: '#/components/schemas/User.jsonhal'
  968. 404:
  969. description: 'Resource not found'
  970. summary: 'Retrieves a User resource.'
  971. description: 'Retrieves a User resource.'
  972. parameters:
  973. -
  974. name: id
  975. in: path
  976. description: 'UserApi identifier'
  977. required: true
  978. deprecated: false
  979. allowEmptyValue: false
  980. schema:
  981. type: string
  982. style: simple
  983. explode: false
  984. allowReserved: false
  985. deprecated: false
  986. patch:
  987. operationId: api_users_id_patch
  988. tags:
  989. - User
  990. responses:
  991. 200:
  992. description: 'User resource updated'
  993. content:
  994. application/ld+json:
  995. schema:
  996. $ref: '#/components/schemas/User.jsonld'
  997. application/json:
  998. schema:
  999. $ref: '#/components/schemas/User'
  1000. text/html:
  1001. schema:
  1002. $ref: '#/components/schemas/User'
  1003. application/hal+json:
  1004. schema:
  1005. $ref: '#/components/schemas/User.jsonhal'
  1006. links: { }
  1007. 400:
  1008. description: 'Invalid input'
  1009. 422:
  1010. description: 'Unprocessable entity'
  1011. 404:
  1012. description: 'Resource not found'
  1013. summary: 'Updates the User resource.'
  1014. description: 'Updates the User resource.'
  1015. parameters:
  1016. -
  1017. name: id
  1018. in: path
  1019. description: 'UserApi identifier'
  1020. required: true
  1021. deprecated: false
  1022. allowEmptyValue: false
  1023. schema:
  1024. type: string
  1025. style: simple
  1026. explode: false
  1027. allowReserved: false
  1028. requestBody:
  1029. description: 'The updated User resource'
  1030. content:
  1031. application/merge-patch+json:
  1032. schema:
  1033. $ref: '#/components/schemas/User'
  1034. required: true
  1035. deprecated: false
  1036. parameters: []
  1037. /auth:
  1038. post:
  1039. operationId: login_check_post
  1040. tags:
  1041. - 'Login Check'
  1042. responses:
  1043. 200:
  1044. description: 'User token created'
  1045. content:
  1046. application/json:
  1047. schema:
  1048. type: object
  1049. properties:
  1050. token: { readOnly: true, type: string, nullable: false }
  1051. required:
  1052. - token
  1053. summary: 'Creates a user token.'
  1054. description: 'Creates a user token.'
  1055. requestBody:
  1056. description: 'The login data'
  1057. content:
  1058. application/json:
  1059. schema:
  1060. type: object
  1061. properties:
  1062. email:
  1063. type: string
  1064. nullable: false
  1065. password:
  1066. type: string
  1067. nullable: false
  1068. required:
  1069. - email
  1070. - password
  1071. required: true
  1072. parameters: []
  1073. components:
  1074. schemas:
  1075. Contact:
  1076. type: object
  1077. description: ''
  1078. deprecated: false
  1079. required:
  1080. - firstName
  1081. - lastName
  1082. properties:
  1083. firstName:
  1084. type:
  1085. - string
  1086. - 'null'
  1087. lastName:
  1088. type:
  1089. - string
  1090. - 'null'
  1091. partner:
  1092. anyOf:
  1093. -
  1094. $ref: '#/components/schemas/Partner'
  1095. -
  1096. type: 'null'
  1097. birthday:
  1098. type:
  1099. - string
  1100. - 'null'
  1101. format: date-time
  1102. image:
  1103. 'owl:maxCardinality': 1
  1104. type:
  1105. - string
  1106. - 'null'
  1107. format: iri-reference
  1108. example: 'https://example.com/'
  1109. position:
  1110. type:
  1111. - string
  1112. - 'null'
  1113. phone:
  1114. type:
  1115. - string
  1116. - 'null'
  1117. email:
  1118. type:
  1119. - string
  1120. - 'null'
  1121. createdAt:
  1122. type:
  1123. - string
  1124. - 'null'
  1125. format: date-time
  1126. Contact.jsonhal:
  1127. type: object
  1128. description: ''
  1129. deprecated: false
  1130. required:
  1131. - firstName
  1132. - lastName
  1133. properties:
  1134. _links:
  1135. type: object
  1136. properties:
  1137. self:
  1138. type: object
  1139. properties:
  1140. href:
  1141. type: string
  1142. format: iri-reference
  1143. firstName:
  1144. type:
  1145. - string
  1146. - 'null'
  1147. lastName:
  1148. type:
  1149. - string
  1150. - 'null'
  1151. partner:
  1152. anyOf:
  1153. -
  1154. $ref: '#/components/schemas/Partner.jsonhal'
  1155. -
  1156. type: 'null'
  1157. birthday:
  1158. type:
  1159. - string
  1160. - 'null'
  1161. format: date-time
  1162. image:
  1163. 'owl:maxCardinality': 1
  1164. type:
  1165. - string
  1166. - 'null'
  1167. format: iri-reference
  1168. example: 'https://example.com/'
  1169. position:
  1170. type:
  1171. - string
  1172. - 'null'
  1173. phone:
  1174. type:
  1175. - string
  1176. - 'null'
  1177. email:
  1178. type:
  1179. - string
  1180. - 'null'
  1181. createdAt:
  1182. type:
  1183. - string
  1184. - 'null'
  1185. format: date-time
  1186. Contact.jsonld:
  1187. type: object
  1188. description: ''
  1189. deprecated: false
  1190. required:
  1191. - firstName
  1192. - lastName
  1193. properties:
  1194. '@context':
  1195. readOnly: true
  1196. oneOf:
  1197. -
  1198. type: string
  1199. -
  1200. type: object
  1201. properties:
  1202. '@vocab':
  1203. type: string
  1204. hydra:
  1205. type: string
  1206. enum: ['http://www.w3.org/ns/hydra/core#']
  1207. required:
  1208. - '@vocab'
  1209. - hydra
  1210. additionalProperties: true
  1211. '@id':
  1212. readOnly: true
  1213. type: string
  1214. '@type':
  1215. readOnly: true
  1216. type: string
  1217. firstName:
  1218. type:
  1219. - string
  1220. - 'null'
  1221. lastName:
  1222. type:
  1223. - string
  1224. - 'null'
  1225. partner:
  1226. anyOf:
  1227. -
  1228. $ref: '#/components/schemas/Partner.jsonld'
  1229. -
  1230. type: 'null'
  1231. birthday:
  1232. type:
  1233. - string
  1234. - 'null'
  1235. format: date-time
  1236. image:
  1237. 'owl:maxCardinality': 1
  1238. type:
  1239. - string
  1240. - 'null'
  1241. format: iri-reference
  1242. example: 'https://example.com/'
  1243. position:
  1244. type:
  1245. - string
  1246. - 'null'
  1247. phone:
  1248. type:
  1249. - string
  1250. - 'null'
  1251. email:
  1252. type:
  1253. - string
  1254. - 'null'
  1255. createdAt:
  1256. type:
  1257. - string
  1258. - 'null'
  1259. format: date-time
  1260. MediaObject-media_object.read:
  1261. type: object
  1262. description: ''
  1263. deprecated: false
  1264. externalDocs:
  1265. url: 'https://schema.org/MediaObject'
  1266. properties:
  1267. contentUrl:
  1268. externalDocs:
  1269. url: 'https://schema.org/contentUrl'
  1270. type:
  1271. - string
  1272. - 'null'
  1273. MediaObject.jsonhal-media_object.read:
  1274. type: object
  1275. description: ''
  1276. deprecated: false
  1277. externalDocs:
  1278. url: 'https://schema.org/MediaObject'
  1279. properties:
  1280. _links:
  1281. type: object
  1282. properties:
  1283. self:
  1284. type: object
  1285. properties:
  1286. href:
  1287. type: string
  1288. format: iri-reference
  1289. contentUrl:
  1290. externalDocs:
  1291. url: 'https://schema.org/contentUrl'
  1292. type:
  1293. - string
  1294. - 'null'
  1295. MediaObject.jsonld-media_object.read:
  1296. type: object
  1297. description: ''
  1298. deprecated: false
  1299. externalDocs:
  1300. url: 'https://schema.org/MediaObject'
  1301. properties:
  1302. '@context':
  1303. readOnly: true
  1304. oneOf:
  1305. -
  1306. type: string
  1307. -
  1308. type: object
  1309. properties:
  1310. '@vocab':
  1311. type: string
  1312. hydra:
  1313. type: string
  1314. enum: ['http://www.w3.org/ns/hydra/core#']
  1315. required:
  1316. - '@vocab'
  1317. - hydra
  1318. additionalProperties: true
  1319. '@id':
  1320. readOnly: true
  1321. type: string
  1322. '@type':
  1323. readOnly: true
  1324. type: string
  1325. contentUrl:
  1326. externalDocs:
  1327. url: 'https://schema.org/contentUrl'
  1328. type:
  1329. - string
  1330. - 'null'
  1331. Partner:
  1332. type: object
  1333. description: ''
  1334. deprecated: false
  1335. properties:
  1336. id:
  1337. readOnly: true
  1338. type: integer
  1339. name:
  1340. type: string
  1341. type:
  1342. type: string
  1343. enum:
  1344. - customer
  1345. - supplier
  1346. - service
  1347. street:
  1348. type:
  1349. - string
  1350. - 'null'
  1351. streetNo:
  1352. type:
  1353. - string
  1354. - 'null'
  1355. zip:
  1356. type:
  1357. - string
  1358. - 'null'
  1359. city:
  1360. type:
  1361. - string
  1362. - 'null'
  1363. country:
  1364. type:
  1365. - string
  1366. - 'null'
  1367. website:
  1368. type:
  1369. - string
  1370. - 'null'
  1371. createdAt:
  1372. type: string
  1373. format: date-time
  1374. contacts:
  1375. type: array
  1376. items:
  1377. $ref: '#/components/schemas/Contact'
  1378. logo:
  1379. 'owl:maxCardinality': 1
  1380. type:
  1381. - string
  1382. - 'null'
  1383. format: iri-reference
  1384. example: 'https://example.com/'
  1385. Partner.jsonhal:
  1386. type: object
  1387. description: ''
  1388. deprecated: false
  1389. properties:
  1390. _links:
  1391. type: object
  1392. properties:
  1393. self:
  1394. type: object
  1395. properties:
  1396. href:
  1397. type: string
  1398. format: iri-reference
  1399. id:
  1400. readOnly: true
  1401. type: integer
  1402. name:
  1403. type: string
  1404. type:
  1405. type: string
  1406. enum:
  1407. - customer
  1408. - supplier
  1409. - service
  1410. street:
  1411. type:
  1412. - string
  1413. - 'null'
  1414. streetNo:
  1415. type:
  1416. - string
  1417. - 'null'
  1418. zip:
  1419. type:
  1420. - string
  1421. - 'null'
  1422. city:
  1423. type:
  1424. - string
  1425. - 'null'
  1426. country:
  1427. type:
  1428. - string
  1429. - 'null'
  1430. website:
  1431. type:
  1432. - string
  1433. - 'null'
  1434. createdAt:
  1435. type: string
  1436. format: date-time
  1437. contacts:
  1438. type: array
  1439. items:
  1440. $ref: '#/components/schemas/Contact.jsonhal'
  1441. logo:
  1442. 'owl:maxCardinality': 1
  1443. type:
  1444. - string
  1445. - 'null'
  1446. format: iri-reference
  1447. example: 'https://example.com/'
  1448. Partner.jsonld:
  1449. type: object
  1450. description: ''
  1451. deprecated: false
  1452. properties:
  1453. '@context':
  1454. readOnly: true
  1455. oneOf:
  1456. -
  1457. type: string
  1458. -
  1459. type: object
  1460. properties:
  1461. '@vocab':
  1462. type: string
  1463. hydra:
  1464. type: string
  1465. enum: ['http://www.w3.org/ns/hydra/core#']
  1466. required:
  1467. - '@vocab'
  1468. - hydra
  1469. additionalProperties: true
  1470. '@id':
  1471. readOnly: true
  1472. type: string
  1473. '@type':
  1474. readOnly: true
  1475. type: string
  1476. id:
  1477. readOnly: true
  1478. type: integer
  1479. name:
  1480. type: string
  1481. type:
  1482. type: string
  1483. enum:
  1484. - customer
  1485. - supplier
  1486. - service
  1487. street:
  1488. type:
  1489. - string
  1490. - 'null'
  1491. streetNo:
  1492. type:
  1493. - string
  1494. - 'null'
  1495. zip:
  1496. type:
  1497. - string
  1498. - 'null'
  1499. city:
  1500. type:
  1501. - string
  1502. - 'null'
  1503. country:
  1504. type:
  1505. - string
  1506. - 'null'
  1507. website:
  1508. type:
  1509. - string
  1510. - 'null'
  1511. createdAt:
  1512. type: string
  1513. format: date-time
  1514. contacts:
  1515. type: array
  1516. items:
  1517. $ref: '#/components/schemas/Contact.jsonld'
  1518. logo:
  1519. 'owl:maxCardinality': 1
  1520. type:
  1521. - string
  1522. - 'null'
  1523. format: iri-reference
  1524. example: 'https://example.com/'
  1525. Post:
  1526. type: object
  1527. description: ''
  1528. deprecated: false
  1529. required:
  1530. - message
  1531. properties:
  1532. message:
  1533. type:
  1534. - string
  1535. - 'null'
  1536. owner:
  1537. 'owl:maxCardinality': 1
  1538. type:
  1539. - string
  1540. - 'null'
  1541. format: iri-reference
  1542. example: 'https://example.com/'
  1543. createdAt:
  1544. readOnly: true
  1545. type:
  1546. - string
  1547. - 'null'
  1548. format: date-time
  1549. Post.jsonhal:
  1550. type: object
  1551. description: ''
  1552. deprecated: false
  1553. required:
  1554. - message
  1555. properties:
  1556. _links:
  1557. type: object
  1558. properties:
  1559. self:
  1560. type: object
  1561. properties:
  1562. href:
  1563. type: string
  1564. format: iri-reference
  1565. message:
  1566. type:
  1567. - string
  1568. - 'null'
  1569. owner:
  1570. 'owl:maxCardinality': 1
  1571. type:
  1572. - string
  1573. - 'null'
  1574. format: iri-reference
  1575. example: 'https://example.com/'
  1576. createdAt:
  1577. readOnly: true
  1578. type:
  1579. - string
  1580. - 'null'
  1581. format: date-time
  1582. Post.jsonld:
  1583. type: object
  1584. description: ''
  1585. deprecated: false
  1586. required:
  1587. - message
  1588. properties:
  1589. '@context':
  1590. readOnly: true
  1591. oneOf:
  1592. -
  1593. type: string
  1594. -
  1595. type: object
  1596. properties:
  1597. '@vocab':
  1598. type: string
  1599. hydra:
  1600. type: string
  1601. enum: ['http://www.w3.org/ns/hydra/core#']
  1602. required:
  1603. - '@vocab'
  1604. - hydra
  1605. additionalProperties: true
  1606. '@id':
  1607. readOnly: true
  1608. type: string
  1609. '@type':
  1610. readOnly: true
  1611. type: string
  1612. message:
  1613. type:
  1614. - string
  1615. - 'null'
  1616. owner:
  1617. 'owl:maxCardinality': 1
  1618. type:
  1619. - string
  1620. - 'null'
  1621. format: iri-reference
  1622. example: 'https://example.com/'
  1623. createdAt:
  1624. readOnly: true
  1625. type:
  1626. - string
  1627. - 'null'
  1628. format: date-time
  1629. User:
  1630. type: object
  1631. description: ''
  1632. deprecated: false
  1633. required:
  1634. - email
  1635. - firstName
  1636. - lastName
  1637. properties:
  1638. email:
  1639. format: email
  1640. externalDocs:
  1641. url: 'https://schema.org/email'
  1642. type:
  1643. - string
  1644. - 'null'
  1645. firstName:
  1646. type:
  1647. - string
  1648. - 'null'
  1649. lastName:
  1650. type:
  1651. - string
  1652. - 'null'
  1653. password:
  1654. writeOnly: true
  1655. description: 'The plaintext password when being set or changed.'
  1656. type:
  1657. - string
  1658. - 'null'
  1659. active:
  1660. type: boolean
  1661. createdAt:
  1662. readOnly: true
  1663. type:
  1664. - string
  1665. - 'null'
  1666. format: date-time
  1667. postings:
  1668. type: array
  1669. items:
  1670. type: string
  1671. format: iri-reference
  1672. example: 'https://example.com/'
  1673. User.jsonhal:
  1674. type: object
  1675. description: ''
  1676. deprecated: false
  1677. required:
  1678. - email
  1679. - firstName
  1680. - lastName
  1681. properties:
  1682. _links:
  1683. type: object
  1684. properties:
  1685. self:
  1686. type: object
  1687. properties:
  1688. href:
  1689. type: string
  1690. format: iri-reference
  1691. email:
  1692. format: email
  1693. externalDocs:
  1694. url: 'https://schema.org/email'
  1695. type:
  1696. - string
  1697. - 'null'
  1698. firstName:
  1699. type:
  1700. - string
  1701. - 'null'
  1702. lastName:
  1703. type:
  1704. - string
  1705. - 'null'
  1706. password:
  1707. writeOnly: true
  1708. description: 'The plaintext password when being set or changed.'
  1709. type:
  1710. - string
  1711. - 'null'
  1712. active:
  1713. type: boolean
  1714. createdAt:
  1715. readOnly: true
  1716. type:
  1717. - string
  1718. - 'null'
  1719. format: date-time
  1720. postings:
  1721. type: array
  1722. items:
  1723. type: string
  1724. format: iri-reference
  1725. example: 'https://example.com/'
  1726. User.jsonld:
  1727. type: object
  1728. description: ''
  1729. deprecated: false
  1730. required:
  1731. - email
  1732. - firstName
  1733. - lastName
  1734. properties:
  1735. '@context':
  1736. readOnly: true
  1737. oneOf:
  1738. -
  1739. type: string
  1740. -
  1741. type: object
  1742. properties:
  1743. '@vocab':
  1744. type: string
  1745. hydra:
  1746. type: string
  1747. enum: ['http://www.w3.org/ns/hydra/core#']
  1748. required:
  1749. - '@vocab'
  1750. - hydra
  1751. additionalProperties: true
  1752. '@id':
  1753. readOnly: true
  1754. type: string
  1755. '@type':
  1756. readOnly: true
  1757. type: string
  1758. email:
  1759. format: email
  1760. externalDocs:
  1761. url: 'https://schema.org/email'
  1762. type:
  1763. - string
  1764. - 'null'
  1765. firstName:
  1766. type:
  1767. - string
  1768. - 'null'
  1769. lastName:
  1770. type:
  1771. - string
  1772. - 'null'
  1773. password:
  1774. writeOnly: true
  1775. description: 'The plaintext password when being set or changed.'
  1776. type:
  1777. - string
  1778. - 'null'
  1779. active:
  1780. type: boolean
  1781. createdAt:
  1782. readOnly: true
  1783. type:
  1784. - string
  1785. - 'null'
  1786. format: date-time
  1787. postings:
  1788. type: array
  1789. items:
  1790. type: string
  1791. format: iri-reference
  1792. example: 'https://example.com/'
  1793. responses: { }
  1794. parameters: { }
  1795. examples: { }
  1796. requestBodies: { }
  1797. headers: { }
  1798. securitySchemes:
  1799. JWT:
  1800. type: http
  1801. scheme: bearer
  1802. bearerFormat: JWT
  1803. security:
  1804. -
  1805. JWT: []
  1806. tags: []