Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
 
 
 

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