Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

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