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

1903 line
56 KiB

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