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

3054 lines
87 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/comments:
  12. get:
  13. operationId: api_comments_get_collection
  14. tags:
  15. - Comment
  16. responses:
  17. 200:
  18. description: 'Comment collection'
  19. content:
  20. application/ld+json:
  21. schema:
  22. type: object
  23. properties:
  24. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Comment.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/Comment'
  35. text/html:
  36. schema:
  37. type: array
  38. items:
  39. $ref: '#/components/schemas/Comment'
  40. application/hal+json:
  41. schema:
  42. type: object
  43. properties:
  44. _embedded: { type: array, items: { $ref: '#/components/schemas/Comment.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 Comment resources.'
  52. description: 'Retrieves the collection of Comment resources.'
  53. parameters:
  54. -
  55. name: page
  56. in: query
  57. description: 'The collection page number'
  58. required: false
  59. deprecated: false
  60. allowEmptyValue: true
  61. schema:
  62. type: integer
  63. default: 1
  64. style: form
  65. explode: false
  66. allowReserved: false
  67. -
  68. name: itemsPerPage
  69. in: query
  70. description: 'The number of items per page'
  71. required: false
  72. deprecated: false
  73. allowEmptyValue: true
  74. schema:
  75. type: integer
  76. default: 10
  77. minimum: 0
  78. maximum: 50
  79. style: form
  80. explode: false
  81. allowReserved: false
  82. deprecated: false
  83. post:
  84. operationId: api_comments_post
  85. tags:
  86. - Comment
  87. responses:
  88. 201:
  89. description: 'Comment resource created'
  90. content:
  91. application/ld+json:
  92. schema:
  93. $ref: '#/components/schemas/Comment.jsonld'
  94. application/json:
  95. schema:
  96. $ref: '#/components/schemas/Comment'
  97. text/html:
  98. schema:
  99. $ref: '#/components/schemas/Comment'
  100. application/hal+json:
  101. schema:
  102. $ref: '#/components/schemas/Comment.jsonhal'
  103. links: { }
  104. 400:
  105. description: 'Invalid input'
  106. 422:
  107. description: 'Unprocessable entity'
  108. summary: 'Creates a Comment resource.'
  109. description: 'Creates a Comment resource.'
  110. parameters: []
  111. requestBody:
  112. description: 'The new Comment resource'
  113. content:
  114. application/ld+json:
  115. schema:
  116. $ref: '#/components/schemas/Comment.jsonld'
  117. application/json:
  118. schema:
  119. $ref: '#/components/schemas/Comment'
  120. text/html:
  121. schema:
  122. $ref: '#/components/schemas/Comment'
  123. application/hal+json:
  124. schema:
  125. $ref: '#/components/schemas/Comment.jsonhal'
  126. required: true
  127. deprecated: false
  128. parameters: []
  129. '/api/comments/{id}':
  130. get:
  131. operationId: api_comments_id_get
  132. tags:
  133. - Comment
  134. responses:
  135. 200:
  136. description: 'Comment resource'
  137. content:
  138. application/ld+json:
  139. schema:
  140. $ref: '#/components/schemas/Comment.jsonld'
  141. application/json:
  142. schema:
  143. $ref: '#/components/schemas/Comment'
  144. text/html:
  145. schema:
  146. $ref: '#/components/schemas/Comment'
  147. application/hal+json:
  148. schema:
  149. $ref: '#/components/schemas/Comment.jsonhal'
  150. 404:
  151. description: 'Resource not found'
  152. summary: 'Retrieves a Comment resource.'
  153. description: 'Retrieves a Comment resource.'
  154. parameters:
  155. -
  156. name: id
  157. in: path
  158. description: 'CommentApi identifier'
  159. required: true
  160. deprecated: false
  161. allowEmptyValue: false
  162. schema:
  163. type: string
  164. style: simple
  165. explode: false
  166. allowReserved: false
  167. deprecated: false
  168. delete:
  169. operationId: api_comments_id_delete
  170. tags:
  171. - Comment
  172. responses:
  173. 204:
  174. description: 'Comment resource deleted'
  175. 404:
  176. description: 'Resource not found'
  177. summary: 'Removes the Comment resource.'
  178. description: 'Removes the Comment resource.'
  179. parameters:
  180. -
  181. name: id
  182. in: path
  183. description: 'CommentApi identifier'
  184. required: true
  185. deprecated: false
  186. allowEmptyValue: false
  187. schema:
  188. type: string
  189. style: simple
  190. explode: false
  191. allowReserved: false
  192. deprecated: false
  193. patch:
  194. operationId: api_comments_id_patch
  195. tags:
  196. - Comment
  197. responses:
  198. 200:
  199. description: 'Comment resource updated'
  200. content:
  201. application/ld+json:
  202. schema:
  203. $ref: '#/components/schemas/Comment.jsonld'
  204. application/json:
  205. schema:
  206. $ref: '#/components/schemas/Comment'
  207. text/html:
  208. schema:
  209. $ref: '#/components/schemas/Comment'
  210. application/hal+json:
  211. schema:
  212. $ref: '#/components/schemas/Comment.jsonhal'
  213. links: { }
  214. 400:
  215. description: 'Invalid input'
  216. 422:
  217. description: 'Unprocessable entity'
  218. 404:
  219. description: 'Resource not found'
  220. summary: 'Updates the Comment resource.'
  221. description: 'Updates the Comment resource.'
  222. parameters:
  223. -
  224. name: id
  225. in: path
  226. description: 'CommentApi identifier'
  227. required: true
  228. deprecated: false
  229. allowEmptyValue: false
  230. schema:
  231. type: string
  232. style: simple
  233. explode: false
  234. allowReserved: false
  235. requestBody:
  236. description: 'The updated Comment resource'
  237. content:
  238. application/merge-patch+json:
  239. schema:
  240. $ref: '#/components/schemas/Comment'
  241. required: true
  242. deprecated: false
  243. parameters: []
  244. /api/contacts:
  245. get:
  246. operationId: api_contacts_get_collection
  247. tags:
  248. - Contact
  249. responses:
  250. 200:
  251. description: 'Contact collection'
  252. content:
  253. application/ld+json:
  254. schema:
  255. type: object
  256. properties:
  257. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.jsonld' } }
  258. 'hydra:totalItems': { type: integer, minimum: 0 }
  259. '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 } }
  260. '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 } } } } } }
  261. required:
  262. - 'hydra:member'
  263. application/json:
  264. schema:
  265. type: array
  266. items:
  267. $ref: '#/components/schemas/Contact'
  268. text/html:
  269. schema:
  270. type: array
  271. items:
  272. $ref: '#/components/schemas/Contact'
  273. application/hal+json:
  274. schema:
  275. type: object
  276. properties:
  277. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.jsonhal' } }
  278. totalItems: { type: integer, minimum: 0 }
  279. itemsPerPage: { type: integer, minimum: 0 }
  280. _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 } } } } }
  281. required:
  282. - _links
  283. - _embedded
  284. summary: 'Retrieves the collection of Contact resources.'
  285. description: 'Retrieves the collection of Contact resources.'
  286. parameters:
  287. -
  288. name: page
  289. in: query
  290. description: 'The collection page number'
  291. required: false
  292. deprecated: false
  293. allowEmptyValue: true
  294. schema:
  295. type: integer
  296. default: 1
  297. style: form
  298. explode: false
  299. allowReserved: false
  300. -
  301. name: itemsPerPage
  302. in: query
  303. description: 'The number of items per page'
  304. required: false
  305. deprecated: false
  306. allowEmptyValue: true
  307. schema:
  308. type: integer
  309. default: 10
  310. minimum: 0
  311. maximum: 50
  312. style: form
  313. explode: false
  314. allowReserved: false
  315. -
  316. name: partner
  317. in: query
  318. description: ''
  319. required: false
  320. deprecated: false
  321. allowEmptyValue: true
  322. schema:
  323. type: string
  324. style: form
  325. explode: false
  326. allowReserved: false
  327. -
  328. name: 'partner[]'
  329. in: query
  330. description: ''
  331. required: false
  332. deprecated: false
  333. allowEmptyValue: true
  334. schema:
  335. type: array
  336. items:
  337. type: string
  338. style: form
  339. explode: true
  340. allowReserved: false
  341. deprecated: false
  342. post:
  343. operationId: api_contacts_post
  344. tags:
  345. - Contact
  346. responses:
  347. 201:
  348. description: 'Contact resource created'
  349. content:
  350. application/ld+json:
  351. schema:
  352. $ref: '#/components/schemas/Contact.jsonld'
  353. application/json:
  354. schema:
  355. $ref: '#/components/schemas/Contact'
  356. text/html:
  357. schema:
  358. $ref: '#/components/schemas/Contact'
  359. application/hal+json:
  360. schema:
  361. $ref: '#/components/schemas/Contact.jsonhal'
  362. links: { }
  363. 400:
  364. description: 'Invalid input'
  365. 422:
  366. description: 'Unprocessable entity'
  367. summary: 'Creates a Contact resource.'
  368. description: 'Creates a Contact resource.'
  369. parameters: []
  370. requestBody:
  371. description: 'The new Contact resource'
  372. content:
  373. application/ld+json:
  374. schema:
  375. $ref: '#/components/schemas/Contact.jsonld'
  376. application/json:
  377. schema:
  378. $ref: '#/components/schemas/Contact'
  379. text/html:
  380. schema:
  381. $ref: '#/components/schemas/Contact'
  382. application/hal+json:
  383. schema:
  384. $ref: '#/components/schemas/Contact.jsonhal'
  385. required: true
  386. deprecated: false
  387. parameters: []
  388. '/api/contacts/{id}':
  389. get:
  390. operationId: api_contacts_id_get
  391. tags:
  392. - Contact
  393. responses:
  394. 200:
  395. description: 'Contact resource'
  396. content:
  397. application/ld+json:
  398. schema:
  399. $ref: '#/components/schemas/Contact.jsonld'
  400. application/json:
  401. schema:
  402. $ref: '#/components/schemas/Contact'
  403. text/html:
  404. schema:
  405. $ref: '#/components/schemas/Contact'
  406. application/hal+json:
  407. schema:
  408. $ref: '#/components/schemas/Contact.jsonhal'
  409. 404:
  410. description: 'Resource not found'
  411. summary: 'Retrieves a Contact resource.'
  412. description: 'Retrieves a Contact resource.'
  413. parameters:
  414. -
  415. name: id
  416. in: path
  417. description: 'ContactApi identifier'
  418. required: true
  419. deprecated: false
  420. allowEmptyValue: false
  421. schema:
  422. type: string
  423. style: simple
  424. explode: false
  425. allowReserved: false
  426. deprecated: false
  427. delete:
  428. operationId: api_contacts_id_delete
  429. tags:
  430. - Contact
  431. responses:
  432. 204:
  433. description: 'Contact resource deleted'
  434. 404:
  435. description: 'Resource not found'
  436. summary: 'Removes the Contact resource.'
  437. description: 'Removes the Contact resource.'
  438. parameters:
  439. -
  440. name: id
  441. in: path
  442. description: 'ContactApi identifier'
  443. required: true
  444. deprecated: false
  445. allowEmptyValue: false
  446. schema:
  447. type: string
  448. style: simple
  449. explode: false
  450. allowReserved: false
  451. deprecated: false
  452. patch:
  453. operationId: api_contacts_id_patch
  454. tags:
  455. - Contact
  456. responses:
  457. 200:
  458. description: 'Contact resource updated'
  459. content:
  460. application/ld+json:
  461. schema:
  462. $ref: '#/components/schemas/Contact.jsonld'
  463. application/json:
  464. schema:
  465. $ref: '#/components/schemas/Contact'
  466. text/html:
  467. schema:
  468. $ref: '#/components/schemas/Contact'
  469. application/hal+json:
  470. schema:
  471. $ref: '#/components/schemas/Contact.jsonhal'
  472. links: { }
  473. 400:
  474. description: 'Invalid input'
  475. 422:
  476. description: 'Unprocessable entity'
  477. 404:
  478. description: 'Resource not found'
  479. summary: 'Updates the Contact resource.'
  480. description: 'Updates the Contact resource.'
  481. parameters:
  482. -
  483. name: id
  484. in: path
  485. description: 'ContactApi identifier'
  486. required: true
  487. deprecated: false
  488. allowEmptyValue: false
  489. schema:
  490. type: string
  491. style: simple
  492. explode: false
  493. allowReserved: false
  494. requestBody:
  495. description: 'The updated Contact resource'
  496. content:
  497. application/merge-patch+json:
  498. schema:
  499. $ref: '#/components/schemas/Contact'
  500. required: true
  501. deprecated: false
  502. parameters: []
  503. /api/medias:
  504. get:
  505. operationId: api_medias_get_collection
  506. tags:
  507. - Media
  508. responses:
  509. 200:
  510. description: 'Media collection'
  511. content:
  512. application/ld+json:
  513. schema:
  514. type: object
  515. properties:
  516. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Media.jsonld-media_object.read' } }
  517. 'hydra:totalItems': { type: integer, minimum: 0 }
  518. '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 } }
  519. '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 } } } } } }
  520. required:
  521. - 'hydra:member'
  522. application/json:
  523. schema:
  524. type: array
  525. items:
  526. $ref: '#/components/schemas/Media-media_object.read'
  527. text/html:
  528. schema:
  529. type: array
  530. items:
  531. $ref: '#/components/schemas/Media-media_object.read'
  532. application/hal+json:
  533. schema:
  534. type: object
  535. properties:
  536. _embedded: { type: array, items: { $ref: '#/components/schemas/Media.jsonhal-media_object.read' } }
  537. totalItems: { type: integer, minimum: 0 }
  538. itemsPerPage: { type: integer, minimum: 0 }
  539. _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 } } } } }
  540. required:
  541. - _links
  542. - _embedded
  543. summary: 'Retrieves the collection of Media resources.'
  544. description: 'Retrieves the collection of Media resources.'
  545. parameters:
  546. -
  547. name: page
  548. in: query
  549. description: 'The collection page number'
  550. required: false
  551. deprecated: false
  552. allowEmptyValue: true
  553. schema:
  554. type: integer
  555. default: 1
  556. style: form
  557. explode: false
  558. allowReserved: false
  559. -
  560. name: itemsPerPage
  561. in: query
  562. description: 'The number of items per page'
  563. required: false
  564. deprecated: false
  565. allowEmptyValue: true
  566. schema:
  567. type: integer
  568. default: 10
  569. minimum: 0
  570. maximum: 50
  571. style: form
  572. explode: false
  573. allowReserved: false
  574. deprecated: false
  575. post:
  576. operationId: api_medias_post
  577. tags:
  578. - Media
  579. responses:
  580. 201:
  581. description: 'Media resource created'
  582. content:
  583. application/ld+json:
  584. schema:
  585. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  586. application/json:
  587. schema:
  588. $ref: '#/components/schemas/Media-media_object.read'
  589. text/html:
  590. schema:
  591. $ref: '#/components/schemas/Media-media_object.read'
  592. application/hal+json:
  593. schema:
  594. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  595. links: { }
  596. 400:
  597. description: 'Invalid input'
  598. 422:
  599. description: 'Unprocessable entity'
  600. summary: 'Creates a Media resource.'
  601. description: 'Creates a Media resource.'
  602. parameters: []
  603. requestBody:
  604. description: ''
  605. content:
  606. multipart/form-data:
  607. schema:
  608. type: object
  609. properties:
  610. file:
  611. type: string
  612. format: binary
  613. required: false
  614. deprecated: false
  615. parameters: []
  616. '/api/medias/{id}':
  617. get:
  618. operationId: api_medias_id_get
  619. tags:
  620. - Media
  621. responses:
  622. 200:
  623. description: 'Media resource'
  624. content:
  625. application/ld+json:
  626. schema:
  627. $ref: '#/components/schemas/Media.jsonld-media_object.read'
  628. application/json:
  629. schema:
  630. $ref: '#/components/schemas/Media-media_object.read'
  631. text/html:
  632. schema:
  633. $ref: '#/components/schemas/Media-media_object.read'
  634. application/hal+json:
  635. schema:
  636. $ref: '#/components/schemas/Media.jsonhal-media_object.read'
  637. 404:
  638. description: 'Resource not found'
  639. summary: 'Retrieves a Media resource.'
  640. description: 'Retrieves a Media resource.'
  641. parameters:
  642. -
  643. name: id
  644. in: path
  645. description: 'MediaObject identifier'
  646. required: true
  647. deprecated: false
  648. allowEmptyValue: false
  649. schema:
  650. type: string
  651. style: simple
  652. explode: false
  653. allowReserved: false
  654. deprecated: false
  655. delete:
  656. operationId: api_medias_id_delete
  657. tags:
  658. - Media
  659. responses:
  660. 204:
  661. description: 'Media resource deleted'
  662. 404:
  663. description: 'Resource not found'
  664. summary: 'Removes the Media resource.'
  665. description: 'Removes the Media resource.'
  666. parameters:
  667. -
  668. name: id
  669. in: path
  670. description: 'MediaObject identifier'
  671. required: true
  672. deprecated: false
  673. allowEmptyValue: false
  674. schema:
  675. type: string
  676. style: simple
  677. explode: false
  678. allowReserved: false
  679. deprecated: false
  680. parameters: []
  681. /api/partners:
  682. get:
  683. operationId: api_partners_get_collection
  684. tags:
  685. - Partner
  686. responses:
  687. 200:
  688. description: 'Partner collection'
  689. content:
  690. application/ld+json:
  691. schema:
  692. type: object
  693. properties:
  694. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  695. 'hydra:totalItems': { type: integer, minimum: 0 }
  696. '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 } }
  697. '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 } } } } } }
  698. required:
  699. - 'hydra:member'
  700. application/json:
  701. schema:
  702. type: array
  703. items:
  704. $ref: '#/components/schemas/Partner'
  705. text/html:
  706. schema:
  707. type: array
  708. items:
  709. $ref: '#/components/schemas/Partner'
  710. application/hal+json:
  711. schema:
  712. type: object
  713. properties:
  714. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  715. totalItems: { type: integer, minimum: 0 }
  716. itemsPerPage: { type: integer, minimum: 0 }
  717. _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 } } } } }
  718. required:
  719. - _links
  720. - _embedded
  721. summary: 'Retrieves the collection of Partner resources.'
  722. description: 'Retrieves the collection of Partner resources.'
  723. parameters:
  724. -
  725. name: page
  726. in: query
  727. description: 'The collection page number'
  728. required: false
  729. deprecated: false
  730. allowEmptyValue: true
  731. schema:
  732. type: integer
  733. default: 1
  734. style: form
  735. explode: false
  736. allowReserved: false
  737. -
  738. name: itemsPerPage
  739. in: query
  740. description: 'The number of items per page'
  741. required: false
  742. deprecated: false
  743. allowEmptyValue: true
  744. schema:
  745. type: integer
  746. default: 10
  747. minimum: 0
  748. maximum: 50
  749. style: form
  750. explode: false
  751. allowReserved: false
  752. -
  753. name: type
  754. in: query
  755. description: ''
  756. required: false
  757. deprecated: false
  758. allowEmptyValue: true
  759. schema:
  760. type: string
  761. style: form
  762. explode: false
  763. allowReserved: false
  764. -
  765. name: 'type[]'
  766. in: query
  767. description: ''
  768. required: false
  769. deprecated: false
  770. allowEmptyValue: true
  771. schema:
  772. type: array
  773. items:
  774. type: string
  775. style: form
  776. explode: true
  777. allowReserved: false
  778. -
  779. name: 'order[name]'
  780. in: query
  781. description: ''
  782. required: false
  783. deprecated: false
  784. allowEmptyValue: true
  785. schema:
  786. type: string
  787. enum:
  788. - asc
  789. - desc
  790. style: form
  791. explode: false
  792. allowReserved: false
  793. -
  794. name: 'order[city]'
  795. in: query
  796. description: ''
  797. required: false
  798. deprecated: false
  799. allowEmptyValue: true
  800. schema:
  801. type: string
  802. enum:
  803. - asc
  804. - desc
  805. style: form
  806. explode: false
  807. allowReserved: false
  808. -
  809. name: 'order[website]'
  810. in: query
  811. description: ''
  812. required: false
  813. deprecated: false
  814. allowEmptyValue: true
  815. schema:
  816. type: string
  817. enum:
  818. - asc
  819. - desc
  820. style: form
  821. explode: false
  822. allowReserved: false
  823. deprecated: false
  824. post:
  825. operationId: api_partners_post
  826. tags:
  827. - Partner
  828. responses:
  829. 201:
  830. description: 'Partner resource created'
  831. content:
  832. application/ld+json:
  833. schema:
  834. $ref: '#/components/schemas/Partner.jsonld'
  835. application/json:
  836. schema:
  837. $ref: '#/components/schemas/Partner'
  838. text/html:
  839. schema:
  840. $ref: '#/components/schemas/Partner'
  841. application/hal+json:
  842. schema:
  843. $ref: '#/components/schemas/Partner.jsonhal'
  844. links: { }
  845. 400:
  846. description: 'Invalid input'
  847. 422:
  848. description: 'Unprocessable entity'
  849. summary: 'Creates a Partner resource.'
  850. description: 'Creates a Partner resource.'
  851. parameters: []
  852. requestBody:
  853. description: 'The new Partner resource'
  854. content:
  855. application/ld+json:
  856. schema:
  857. $ref: '#/components/schemas/Partner.jsonld'
  858. application/json:
  859. schema:
  860. $ref: '#/components/schemas/Partner'
  861. text/html:
  862. schema:
  863. $ref: '#/components/schemas/Partner'
  864. application/hal+json:
  865. schema:
  866. $ref: '#/components/schemas/Partner.jsonhal'
  867. required: true
  868. deprecated: false
  869. parameters: []
  870. '/api/partners/{id}':
  871. get:
  872. operationId: api_partners_id_get
  873. tags:
  874. - Partner
  875. responses:
  876. 200:
  877. description: 'Partner resource'
  878. content:
  879. application/ld+json:
  880. schema:
  881. $ref: '#/components/schemas/Partner.jsonld'
  882. application/json:
  883. schema:
  884. $ref: '#/components/schemas/Partner'
  885. text/html:
  886. schema:
  887. $ref: '#/components/schemas/Partner'
  888. application/hal+json:
  889. schema:
  890. $ref: '#/components/schemas/Partner.jsonhal'
  891. 404:
  892. description: 'Resource not found'
  893. summary: 'Retrieves a Partner resource.'
  894. description: 'Retrieves a Partner resource.'
  895. parameters:
  896. -
  897. name: id
  898. in: path
  899. description: 'PartnerApi identifier'
  900. required: true
  901. deprecated: false
  902. allowEmptyValue: false
  903. schema:
  904. type: string
  905. style: simple
  906. explode: false
  907. allowReserved: false
  908. deprecated: false
  909. delete:
  910. operationId: api_partners_id_delete
  911. tags:
  912. - Partner
  913. responses:
  914. 204:
  915. description: 'Partner resource deleted'
  916. 404:
  917. description: 'Resource not found'
  918. summary: 'Removes the Partner resource.'
  919. description: 'Removes the Partner resource.'
  920. parameters:
  921. -
  922. name: id
  923. in: path
  924. description: 'PartnerApi identifier'
  925. required: true
  926. deprecated: false
  927. allowEmptyValue: false
  928. schema:
  929. type: string
  930. style: simple
  931. explode: false
  932. allowReserved: false
  933. deprecated: false
  934. patch:
  935. operationId: api_partners_id_patch
  936. tags:
  937. - Partner
  938. responses:
  939. 200:
  940. description: 'Partner resource updated'
  941. content:
  942. application/ld+json:
  943. schema:
  944. $ref: '#/components/schemas/Partner.jsonld'
  945. application/json:
  946. schema:
  947. $ref: '#/components/schemas/Partner'
  948. text/html:
  949. schema:
  950. $ref: '#/components/schemas/Partner'
  951. application/hal+json:
  952. schema:
  953. $ref: '#/components/schemas/Partner.jsonhal'
  954. links: { }
  955. 400:
  956. description: 'Invalid input'
  957. 422:
  958. description: 'Unprocessable entity'
  959. 404:
  960. description: 'Resource not found'
  961. summary: 'Updates the Partner resource.'
  962. description: 'Updates the Partner resource.'
  963. parameters:
  964. -
  965. name: id
  966. in: path
  967. description: 'PartnerApi identifier'
  968. required: true
  969. deprecated: false
  970. allowEmptyValue: false
  971. schema:
  972. type: string
  973. style: simple
  974. explode: false
  975. allowReserved: false
  976. requestBody:
  977. description: 'The updated Partner resource'
  978. content:
  979. application/merge-patch+json:
  980. schema:
  981. $ref: '#/components/schemas/Partner'
  982. required: true
  983. deprecated: false
  984. parameters: []
  985. /api/posts:
  986. get:
  987. operationId: api_posts_get_collection
  988. tags:
  989. - Post
  990. responses:
  991. 200:
  992. description: 'Post collection'
  993. content:
  994. application/ld+json:
  995. schema:
  996. type: object
  997. properties:
  998. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  999. 'hydra:totalItems': { type: integer, minimum: 0 }
  1000. '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 } }
  1001. '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 } } } } } }
  1002. required:
  1003. - 'hydra:member'
  1004. application/json:
  1005. schema:
  1006. type: array
  1007. items:
  1008. $ref: '#/components/schemas/Post'
  1009. text/html:
  1010. schema:
  1011. type: array
  1012. items:
  1013. $ref: '#/components/schemas/Post'
  1014. application/hal+json:
  1015. schema:
  1016. type: object
  1017. properties:
  1018. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  1019. totalItems: { type: integer, minimum: 0 }
  1020. itemsPerPage: { type: integer, minimum: 0 }
  1021. _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 } } } } }
  1022. required:
  1023. - _links
  1024. - _embedded
  1025. summary: 'Retrieves the collection of Post resources.'
  1026. description: 'Retrieves the collection of Post resources.'
  1027. parameters:
  1028. -
  1029. name: page
  1030. in: query
  1031. description: 'The collection page number'
  1032. required: false
  1033. deprecated: false
  1034. allowEmptyValue: true
  1035. schema:
  1036. type: integer
  1037. default: 1
  1038. style: form
  1039. explode: false
  1040. allowReserved: false
  1041. -
  1042. name: itemsPerPage
  1043. in: query
  1044. description: 'The number of items per page'
  1045. required: false
  1046. deprecated: false
  1047. allowEmptyValue: true
  1048. schema:
  1049. type: integer
  1050. default: 10
  1051. minimum: 0
  1052. maximum: 50
  1053. style: form
  1054. explode: false
  1055. allowReserved: false
  1056. -
  1057. name: partner
  1058. in: query
  1059. description: ''
  1060. required: false
  1061. deprecated: false
  1062. allowEmptyValue: true
  1063. schema:
  1064. type: string
  1065. style: form
  1066. explode: false
  1067. allowReserved: false
  1068. -
  1069. name: 'partner[]'
  1070. in: query
  1071. description: ''
  1072. required: false
  1073. deprecated: false
  1074. allowEmptyValue: true
  1075. schema:
  1076. type: array
  1077. items:
  1078. type: string
  1079. style: form
  1080. explode: true
  1081. allowReserved: false
  1082. -
  1083. name: contact
  1084. in: query
  1085. description: ''
  1086. required: false
  1087. deprecated: false
  1088. allowEmptyValue: true
  1089. schema:
  1090. type: string
  1091. style: form
  1092. explode: false
  1093. allowReserved: false
  1094. -
  1095. name: 'contact[]'
  1096. in: query
  1097. description: ''
  1098. required: false
  1099. deprecated: false
  1100. allowEmptyValue: true
  1101. schema:
  1102. type: array
  1103. items:
  1104. type: string
  1105. style: form
  1106. explode: true
  1107. allowReserved: false
  1108. deprecated: false
  1109. post:
  1110. operationId: api_posts_post
  1111. tags:
  1112. - Post
  1113. responses:
  1114. 201:
  1115. description: 'Post resource created'
  1116. content:
  1117. application/ld+json:
  1118. schema:
  1119. $ref: '#/components/schemas/Post.jsonld'
  1120. application/json:
  1121. schema:
  1122. $ref: '#/components/schemas/Post'
  1123. text/html:
  1124. schema:
  1125. $ref: '#/components/schemas/Post'
  1126. application/hal+json:
  1127. schema:
  1128. $ref: '#/components/schemas/Post.jsonhal'
  1129. links: { }
  1130. 400:
  1131. description: 'Invalid input'
  1132. 422:
  1133. description: 'Unprocessable entity'
  1134. summary: 'Creates a Post resource.'
  1135. description: 'Creates a Post resource.'
  1136. parameters: []
  1137. requestBody:
  1138. description: 'The new Post resource'
  1139. content:
  1140. application/ld+json:
  1141. schema:
  1142. $ref: '#/components/schemas/Post.jsonld-posting.create'
  1143. application/json:
  1144. schema:
  1145. $ref: '#/components/schemas/Post-posting.create'
  1146. text/html:
  1147. schema:
  1148. $ref: '#/components/schemas/Post-posting.create'
  1149. application/hal+json:
  1150. schema:
  1151. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  1152. required: true
  1153. deprecated: false
  1154. parameters: []
  1155. '/api/posts/{id}':
  1156. get:
  1157. operationId: api_posts_id_get
  1158. tags:
  1159. - Post
  1160. responses:
  1161. 200:
  1162. description: 'Post resource'
  1163. content:
  1164. application/ld+json:
  1165. schema:
  1166. $ref: '#/components/schemas/Post.jsonld'
  1167. application/json:
  1168. schema:
  1169. $ref: '#/components/schemas/Post'
  1170. text/html:
  1171. schema:
  1172. $ref: '#/components/schemas/Post'
  1173. application/hal+json:
  1174. schema:
  1175. $ref: '#/components/schemas/Post.jsonhal'
  1176. 404:
  1177. description: 'Resource not found'
  1178. summary: 'Retrieves a Post resource.'
  1179. description: 'Retrieves a Post resource.'
  1180. parameters:
  1181. -
  1182. name: id
  1183. in: path
  1184. description: 'PostingApi identifier'
  1185. required: true
  1186. deprecated: false
  1187. allowEmptyValue: false
  1188. schema:
  1189. type: string
  1190. style: simple
  1191. explode: false
  1192. allowReserved: false
  1193. deprecated: false
  1194. delete:
  1195. operationId: api_posts_id_delete
  1196. tags:
  1197. - Post
  1198. responses:
  1199. 204:
  1200. description: 'Post resource deleted'
  1201. 404:
  1202. description: 'Resource not found'
  1203. summary: 'Removes the Post resource.'
  1204. description: 'Removes the Post resource.'
  1205. parameters:
  1206. -
  1207. name: id
  1208. in: path
  1209. description: 'PostingApi identifier'
  1210. required: true
  1211. deprecated: false
  1212. allowEmptyValue: false
  1213. schema:
  1214. type: string
  1215. style: simple
  1216. explode: false
  1217. allowReserved: false
  1218. deprecated: false
  1219. patch:
  1220. operationId: api_posts_id_patch
  1221. tags:
  1222. - Post
  1223. responses:
  1224. 200:
  1225. description: 'Post resource updated'
  1226. content:
  1227. application/ld+json:
  1228. schema:
  1229. $ref: '#/components/schemas/Post.jsonld'
  1230. application/json:
  1231. schema:
  1232. $ref: '#/components/schemas/Post'
  1233. text/html:
  1234. schema:
  1235. $ref: '#/components/schemas/Post'
  1236. application/hal+json:
  1237. schema:
  1238. $ref: '#/components/schemas/Post.jsonhal'
  1239. links: { }
  1240. 400:
  1241. description: 'Invalid input'
  1242. 422:
  1243. description: 'Unprocessable entity'
  1244. 404:
  1245. description: 'Resource not found'
  1246. summary: 'Updates the Post resource.'
  1247. description: 'Updates the Post resource.'
  1248. parameters:
  1249. -
  1250. name: id
  1251. in: path
  1252. description: 'PostingApi identifier'
  1253. required: true
  1254. deprecated: false
  1255. allowEmptyValue: false
  1256. schema:
  1257. type: string
  1258. style: simple
  1259. explode: false
  1260. allowReserved: false
  1261. requestBody:
  1262. description: 'The updated Post resource'
  1263. content:
  1264. application/merge-patch+json:
  1265. schema:
  1266. $ref: '#/components/schemas/Post-posting.patch'
  1267. required: true
  1268. deprecated: false
  1269. parameters: []
  1270. /api/products:
  1271. get:
  1272. operationId: api_products_get_collection
  1273. tags:
  1274. - Product
  1275. responses:
  1276. 200:
  1277. description: 'Product collection'
  1278. content:
  1279. application/ld+json:
  1280. schema:
  1281. type: object
  1282. properties:
  1283. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  1284. 'hydra:totalItems': { type: integer, minimum: 0 }
  1285. '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 } }
  1286. '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 } } } } } }
  1287. required:
  1288. - 'hydra:member'
  1289. application/json:
  1290. schema:
  1291. type: array
  1292. items:
  1293. $ref: '#/components/schemas/Product'
  1294. text/html:
  1295. schema:
  1296. type: array
  1297. items:
  1298. $ref: '#/components/schemas/Product'
  1299. application/hal+json:
  1300. schema:
  1301. type: object
  1302. properties:
  1303. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  1304. totalItems: { type: integer, minimum: 0 }
  1305. itemsPerPage: { type: integer, minimum: 0 }
  1306. _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 } } } } }
  1307. required:
  1308. - _links
  1309. - _embedded
  1310. summary: 'Retrieves the collection of Product resources.'
  1311. description: 'Retrieves the collection of Product resources.'
  1312. parameters:
  1313. -
  1314. name: page
  1315. in: query
  1316. description: 'The collection page number'
  1317. required: false
  1318. deprecated: false
  1319. allowEmptyValue: true
  1320. schema:
  1321. type: integer
  1322. default: 1
  1323. style: form
  1324. explode: false
  1325. allowReserved: false
  1326. -
  1327. name: itemsPerPage
  1328. in: query
  1329. description: 'The number of items per page'
  1330. required: false
  1331. deprecated: false
  1332. allowEmptyValue: true
  1333. schema:
  1334. type: integer
  1335. default: 10
  1336. minimum: 0
  1337. maximum: 50
  1338. style: form
  1339. explode: false
  1340. allowReserved: false
  1341. -
  1342. name: 'order[name]'
  1343. in: query
  1344. description: ''
  1345. required: false
  1346. deprecated: false
  1347. allowEmptyValue: true
  1348. schema:
  1349. type: string
  1350. enum:
  1351. - asc
  1352. - desc
  1353. style: form
  1354. explode: false
  1355. allowReserved: false
  1356. deprecated: false
  1357. post:
  1358. operationId: api_products_post
  1359. tags:
  1360. - Product
  1361. responses:
  1362. 201:
  1363. description: 'Product resource created'
  1364. content:
  1365. application/ld+json:
  1366. schema:
  1367. $ref: '#/components/schemas/Product.jsonld'
  1368. application/json:
  1369. schema:
  1370. $ref: '#/components/schemas/Product'
  1371. text/html:
  1372. schema:
  1373. $ref: '#/components/schemas/Product'
  1374. application/hal+json:
  1375. schema:
  1376. $ref: '#/components/schemas/Product.jsonhal'
  1377. links: { }
  1378. 400:
  1379. description: 'Invalid input'
  1380. 422:
  1381. description: 'Unprocessable entity'
  1382. summary: 'Creates a Product resource.'
  1383. description: 'Creates a Product resource.'
  1384. parameters: []
  1385. requestBody:
  1386. description: 'The new Product resource'
  1387. content:
  1388. application/ld+json:
  1389. schema:
  1390. $ref: '#/components/schemas/Product.jsonld'
  1391. application/json:
  1392. schema:
  1393. $ref: '#/components/schemas/Product'
  1394. text/html:
  1395. schema:
  1396. $ref: '#/components/schemas/Product'
  1397. application/hal+json:
  1398. schema:
  1399. $ref: '#/components/schemas/Product.jsonhal'
  1400. required: true
  1401. deprecated: false
  1402. parameters: []
  1403. '/api/products/{id}':
  1404. get:
  1405. operationId: api_products_id_get
  1406. tags:
  1407. - Product
  1408. responses:
  1409. 200:
  1410. description: 'Product resource'
  1411. content:
  1412. application/ld+json:
  1413. schema:
  1414. $ref: '#/components/schemas/Product.jsonld'
  1415. application/json:
  1416. schema:
  1417. $ref: '#/components/schemas/Product'
  1418. text/html:
  1419. schema:
  1420. $ref: '#/components/schemas/Product'
  1421. application/hal+json:
  1422. schema:
  1423. $ref: '#/components/schemas/Product.jsonhal'
  1424. 404:
  1425. description: 'Resource not found'
  1426. summary: 'Retrieves a Product resource.'
  1427. description: 'Retrieves a Product resource.'
  1428. parameters:
  1429. -
  1430. name: id
  1431. in: path
  1432. description: 'ProductApi identifier'
  1433. required: true
  1434. deprecated: false
  1435. allowEmptyValue: false
  1436. schema:
  1437. type: string
  1438. style: simple
  1439. explode: false
  1440. allowReserved: false
  1441. deprecated: false
  1442. delete:
  1443. operationId: api_products_id_delete
  1444. tags:
  1445. - Product
  1446. responses:
  1447. 204:
  1448. description: 'Product resource deleted'
  1449. 404:
  1450. description: 'Resource not found'
  1451. summary: 'Removes the Product resource.'
  1452. description: 'Removes the Product resource.'
  1453. parameters:
  1454. -
  1455. name: id
  1456. in: path
  1457. description: 'ProductApi identifier'
  1458. required: true
  1459. deprecated: false
  1460. allowEmptyValue: false
  1461. schema:
  1462. type: string
  1463. style: simple
  1464. explode: false
  1465. allowReserved: false
  1466. deprecated: false
  1467. patch:
  1468. operationId: api_products_id_patch
  1469. tags:
  1470. - Product
  1471. responses:
  1472. 200:
  1473. description: 'Product resource updated'
  1474. content:
  1475. application/ld+json:
  1476. schema:
  1477. $ref: '#/components/schemas/Product.jsonld'
  1478. application/json:
  1479. schema:
  1480. $ref: '#/components/schemas/Product'
  1481. text/html:
  1482. schema:
  1483. $ref: '#/components/schemas/Product'
  1484. application/hal+json:
  1485. schema:
  1486. $ref: '#/components/schemas/Product.jsonhal'
  1487. links: { }
  1488. 400:
  1489. description: 'Invalid input'
  1490. 422:
  1491. description: 'Unprocessable entity'
  1492. 404:
  1493. description: 'Resource not found'
  1494. summary: 'Updates the Product resource.'
  1495. description: 'Updates the Product resource.'
  1496. parameters:
  1497. -
  1498. name: id
  1499. in: path
  1500. description: 'ProductApi identifier'
  1501. required: true
  1502. deprecated: false
  1503. allowEmptyValue: false
  1504. schema:
  1505. type: string
  1506. style: simple
  1507. explode: false
  1508. allowReserved: false
  1509. requestBody:
  1510. description: 'The updated Product resource'
  1511. content:
  1512. application/merge-patch+json:
  1513. schema:
  1514. $ref: '#/components/schemas/Product'
  1515. required: true
  1516. deprecated: false
  1517. parameters: []
  1518. /api/users:
  1519. get:
  1520. operationId: api_users_get_collection
  1521. tags:
  1522. - User
  1523. responses:
  1524. 200:
  1525. description: 'User collection'
  1526. content:
  1527. application/ld+json:
  1528. schema:
  1529. type: object
  1530. properties:
  1531. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1532. 'hydra:totalItems': { type: integer, minimum: 0 }
  1533. '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 } }
  1534. '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 } } } } } }
  1535. required:
  1536. - 'hydra:member'
  1537. application/json:
  1538. schema:
  1539. type: array
  1540. items:
  1541. $ref: '#/components/schemas/User'
  1542. text/html:
  1543. schema:
  1544. type: array
  1545. items:
  1546. $ref: '#/components/schemas/User'
  1547. application/hal+json:
  1548. schema:
  1549. type: object
  1550. properties:
  1551. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  1552. totalItems: { type: integer, minimum: 0 }
  1553. itemsPerPage: { type: integer, minimum: 0 }
  1554. _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 } } } } }
  1555. required:
  1556. - _links
  1557. - _embedded
  1558. summary: 'Retrieves the collection of User resources.'
  1559. description: 'Retrieves the collection of User resources.'
  1560. parameters:
  1561. -
  1562. name: page
  1563. in: query
  1564. description: 'The collection page number'
  1565. required: false
  1566. deprecated: false
  1567. allowEmptyValue: true
  1568. schema:
  1569. type: integer
  1570. default: 1
  1571. style: form
  1572. explode: false
  1573. allowReserved: false
  1574. -
  1575. name: itemsPerPage
  1576. in: query
  1577. description: 'The number of items per page'
  1578. required: false
  1579. deprecated: false
  1580. allowEmptyValue: true
  1581. schema:
  1582. type: integer
  1583. default: 10
  1584. minimum: 0
  1585. maximum: 50
  1586. style: form
  1587. explode: false
  1588. allowReserved: false
  1589. deprecated: false
  1590. post:
  1591. operationId: api_users_post
  1592. tags:
  1593. - User
  1594. responses:
  1595. 201:
  1596. description: 'User resource created'
  1597. content:
  1598. application/ld+json:
  1599. schema:
  1600. $ref: '#/components/schemas/User.jsonld'
  1601. application/json:
  1602. schema:
  1603. $ref: '#/components/schemas/User'
  1604. text/html:
  1605. schema:
  1606. $ref: '#/components/schemas/User'
  1607. application/hal+json:
  1608. schema:
  1609. $ref: '#/components/schemas/User.jsonhal'
  1610. links: { }
  1611. 400:
  1612. description: 'Invalid input'
  1613. 422:
  1614. description: 'Unprocessable entity'
  1615. summary: 'Creates a User resource.'
  1616. description: 'Creates a User resource.'
  1617. parameters: []
  1618. requestBody:
  1619. description: 'The new User resource'
  1620. content:
  1621. application/ld+json:
  1622. schema:
  1623. $ref: '#/components/schemas/User.jsonld'
  1624. application/json:
  1625. schema:
  1626. $ref: '#/components/schemas/User'
  1627. text/html:
  1628. schema:
  1629. $ref: '#/components/schemas/User'
  1630. application/hal+json:
  1631. schema:
  1632. $ref: '#/components/schemas/User.jsonhal'
  1633. required: true
  1634. deprecated: false
  1635. parameters: []
  1636. '/api/users/{id}':
  1637. get:
  1638. operationId: api_users_id_get
  1639. tags:
  1640. - User
  1641. responses:
  1642. 200:
  1643. description: 'User resource'
  1644. content:
  1645. application/ld+json:
  1646. schema:
  1647. $ref: '#/components/schemas/User.jsonld'
  1648. application/json:
  1649. schema:
  1650. $ref: '#/components/schemas/User'
  1651. text/html:
  1652. schema:
  1653. $ref: '#/components/schemas/User'
  1654. application/hal+json:
  1655. schema:
  1656. $ref: '#/components/schemas/User.jsonhal'
  1657. 404:
  1658. description: 'Resource not found'
  1659. summary: 'Retrieves a User resource.'
  1660. description: 'Retrieves a User resource.'
  1661. parameters:
  1662. -
  1663. name: id
  1664. in: path
  1665. description: 'UserApi identifier'
  1666. required: true
  1667. deprecated: false
  1668. allowEmptyValue: false
  1669. schema:
  1670. type: string
  1671. style: simple
  1672. explode: false
  1673. allowReserved: false
  1674. deprecated: false
  1675. patch:
  1676. operationId: api_users_id_patch
  1677. tags:
  1678. - User
  1679. responses:
  1680. 200:
  1681. description: 'User resource updated'
  1682. content:
  1683. application/ld+json:
  1684. schema:
  1685. $ref: '#/components/schemas/User.jsonld'
  1686. application/json:
  1687. schema:
  1688. $ref: '#/components/schemas/User'
  1689. text/html:
  1690. schema:
  1691. $ref: '#/components/schemas/User'
  1692. application/hal+json:
  1693. schema:
  1694. $ref: '#/components/schemas/User.jsonhal'
  1695. links: { }
  1696. 400:
  1697. description: 'Invalid input'
  1698. 422:
  1699. description: 'Unprocessable entity'
  1700. 404:
  1701. description: 'Resource not found'
  1702. summary: 'Updates the User resource.'
  1703. description: 'Updates the User resource.'
  1704. parameters:
  1705. -
  1706. name: id
  1707. in: path
  1708. description: 'UserApi identifier'
  1709. required: true
  1710. deprecated: false
  1711. allowEmptyValue: false
  1712. schema:
  1713. type: string
  1714. style: simple
  1715. explode: false
  1716. allowReserved: false
  1717. requestBody:
  1718. description: 'The updated User resource'
  1719. content:
  1720. application/merge-patch+json:
  1721. schema:
  1722. $ref: '#/components/schemas/User'
  1723. required: true
  1724. deprecated: false
  1725. parameters: []
  1726. /auth:
  1727. post:
  1728. operationId: login_check_post
  1729. tags:
  1730. - 'Login Check'
  1731. responses:
  1732. 200:
  1733. description: 'User token created'
  1734. content:
  1735. application/json:
  1736. schema:
  1737. type: object
  1738. properties:
  1739. token: { readOnly: true, type: string, nullable: false }
  1740. required:
  1741. - token
  1742. summary: 'Creates a user token.'
  1743. description: 'Creates a user token.'
  1744. requestBody:
  1745. description: 'The login data'
  1746. content:
  1747. application/json:
  1748. schema:
  1749. type: object
  1750. properties:
  1751. email:
  1752. type: string
  1753. nullable: false
  1754. password:
  1755. type: string
  1756. nullable: false
  1757. required:
  1758. - email
  1759. - password
  1760. required: true
  1761. parameters: []
  1762. components:
  1763. schemas:
  1764. Comment:
  1765. type: object
  1766. description: ''
  1767. deprecated: false
  1768. required:
  1769. - message
  1770. properties:
  1771. message:
  1772. type:
  1773. - string
  1774. - 'null'
  1775. owner:
  1776. readOnly: true
  1777. 'owl:maxCardinality': 1
  1778. type:
  1779. - string
  1780. - 'null'
  1781. format: iri-reference
  1782. example: 'https://example.com/'
  1783. ownerName:
  1784. readOnly: true
  1785. type:
  1786. - string
  1787. - 'null'
  1788. post:
  1789. 'owl:maxCardinality': 1
  1790. type:
  1791. - string
  1792. - 'null'
  1793. format: iri-reference
  1794. example: 'https://example.com/'
  1795. createdAt:
  1796. readOnly: true
  1797. type:
  1798. - string
  1799. - 'null'
  1800. format: date-time
  1801. Comment.jsonhal:
  1802. type: object
  1803. description: ''
  1804. deprecated: false
  1805. required:
  1806. - message
  1807. properties:
  1808. _links:
  1809. type: object
  1810. properties:
  1811. self:
  1812. type: object
  1813. properties:
  1814. href:
  1815. type: string
  1816. format: iri-reference
  1817. message:
  1818. type:
  1819. - string
  1820. - 'null'
  1821. owner:
  1822. readOnly: true
  1823. 'owl:maxCardinality': 1
  1824. type:
  1825. - string
  1826. - 'null'
  1827. format: iri-reference
  1828. example: 'https://example.com/'
  1829. ownerName:
  1830. readOnly: true
  1831. type:
  1832. - string
  1833. - 'null'
  1834. post:
  1835. 'owl:maxCardinality': 1
  1836. type:
  1837. - string
  1838. - 'null'
  1839. format: iri-reference
  1840. example: 'https://example.com/'
  1841. createdAt:
  1842. readOnly: true
  1843. type:
  1844. - string
  1845. - 'null'
  1846. format: date-time
  1847. Comment.jsonld:
  1848. type: object
  1849. description: ''
  1850. deprecated: false
  1851. required:
  1852. - message
  1853. properties:
  1854. '@context':
  1855. readOnly: true
  1856. oneOf:
  1857. -
  1858. type: string
  1859. -
  1860. type: object
  1861. properties:
  1862. '@vocab':
  1863. type: string
  1864. hydra:
  1865. type: string
  1866. enum: ['http://www.w3.org/ns/hydra/core#']
  1867. required:
  1868. - '@vocab'
  1869. - hydra
  1870. additionalProperties: true
  1871. '@id':
  1872. readOnly: true
  1873. type: string
  1874. '@type':
  1875. readOnly: true
  1876. type: string
  1877. message:
  1878. type:
  1879. - string
  1880. - 'null'
  1881. owner:
  1882. readOnly: true
  1883. 'owl:maxCardinality': 1
  1884. type:
  1885. - string
  1886. - 'null'
  1887. format: iri-reference
  1888. example: 'https://example.com/'
  1889. ownerName:
  1890. readOnly: true
  1891. type:
  1892. - string
  1893. - 'null'
  1894. post:
  1895. 'owl:maxCardinality': 1
  1896. type:
  1897. - string
  1898. - 'null'
  1899. format: iri-reference
  1900. example: 'https://example.com/'
  1901. createdAt:
  1902. readOnly: true
  1903. type:
  1904. - string
  1905. - 'null'
  1906. format: date-time
  1907. Contact:
  1908. type: object
  1909. description: ''
  1910. deprecated: false
  1911. required:
  1912. - firstName
  1913. - lastName
  1914. - partner
  1915. properties:
  1916. firstName:
  1917. type:
  1918. - string
  1919. - 'null'
  1920. lastName:
  1921. type:
  1922. - string
  1923. - 'null'
  1924. partner:
  1925. 'owl:maxCardinality': 1
  1926. type:
  1927. - string
  1928. - 'null'
  1929. format: iri-reference
  1930. example: 'https://example.com/'
  1931. birthday:
  1932. type:
  1933. - string
  1934. - 'null'
  1935. image:
  1936. 'owl:maxCardinality': 1
  1937. type:
  1938. - string
  1939. - 'null'
  1940. format: iri-reference
  1941. example: 'https://example.com/'
  1942. imageUrl:
  1943. readOnly: true
  1944. type:
  1945. - string
  1946. - 'null'
  1947. position:
  1948. type:
  1949. - string
  1950. - 'null'
  1951. phone:
  1952. type:
  1953. - string
  1954. - 'null'
  1955. email:
  1956. format: email
  1957. externalDocs:
  1958. url: 'https://schema.org/email'
  1959. type:
  1960. - string
  1961. - 'null'
  1962. posts:
  1963. readOnly: true
  1964. type: array
  1965. items:
  1966. type: string
  1967. format: iri-reference
  1968. example: 'https://example.com/'
  1969. createdAt:
  1970. readOnly: true
  1971. type:
  1972. - string
  1973. - 'null'
  1974. format: date-time
  1975. Contact.jsonhal:
  1976. type: object
  1977. description: ''
  1978. deprecated: false
  1979. required:
  1980. - firstName
  1981. - lastName
  1982. - partner
  1983. properties:
  1984. _links:
  1985. type: object
  1986. properties:
  1987. self:
  1988. type: object
  1989. properties:
  1990. href:
  1991. type: string
  1992. format: iri-reference
  1993. firstName:
  1994. type:
  1995. - string
  1996. - 'null'
  1997. lastName:
  1998. type:
  1999. - string
  2000. - 'null'
  2001. partner:
  2002. 'owl:maxCardinality': 1
  2003. type:
  2004. - string
  2005. - 'null'
  2006. format: iri-reference
  2007. example: 'https://example.com/'
  2008. birthday:
  2009. type:
  2010. - string
  2011. - 'null'
  2012. image:
  2013. 'owl:maxCardinality': 1
  2014. type:
  2015. - string
  2016. - 'null'
  2017. format: iri-reference
  2018. example: 'https://example.com/'
  2019. imageUrl:
  2020. readOnly: true
  2021. type:
  2022. - string
  2023. - 'null'
  2024. position:
  2025. type:
  2026. - string
  2027. - 'null'
  2028. phone:
  2029. type:
  2030. - string
  2031. - 'null'
  2032. email:
  2033. format: email
  2034. externalDocs:
  2035. url: 'https://schema.org/email'
  2036. type:
  2037. - string
  2038. - 'null'
  2039. posts:
  2040. readOnly: true
  2041. type: array
  2042. items:
  2043. type: string
  2044. format: iri-reference
  2045. example: 'https://example.com/'
  2046. createdAt:
  2047. readOnly: true
  2048. type:
  2049. - string
  2050. - 'null'
  2051. format: date-time
  2052. Contact.jsonld:
  2053. type: object
  2054. description: ''
  2055. deprecated: false
  2056. required:
  2057. - firstName
  2058. - lastName
  2059. - partner
  2060. properties:
  2061. '@context':
  2062. readOnly: true
  2063. oneOf:
  2064. -
  2065. type: string
  2066. -
  2067. type: object
  2068. properties:
  2069. '@vocab':
  2070. type: string
  2071. hydra:
  2072. type: string
  2073. enum: ['http://www.w3.org/ns/hydra/core#']
  2074. required:
  2075. - '@vocab'
  2076. - hydra
  2077. additionalProperties: true
  2078. '@id':
  2079. readOnly: true
  2080. type: string
  2081. '@type':
  2082. readOnly: true
  2083. type: string
  2084. firstName:
  2085. type:
  2086. - string
  2087. - 'null'
  2088. lastName:
  2089. type:
  2090. - string
  2091. - 'null'
  2092. partner:
  2093. 'owl:maxCardinality': 1
  2094. type:
  2095. - string
  2096. - 'null'
  2097. format: iri-reference
  2098. example: 'https://example.com/'
  2099. birthday:
  2100. type:
  2101. - string
  2102. - 'null'
  2103. image:
  2104. 'owl:maxCardinality': 1
  2105. type:
  2106. - string
  2107. - 'null'
  2108. format: iri-reference
  2109. example: 'https://example.com/'
  2110. imageUrl:
  2111. readOnly: true
  2112. type:
  2113. - string
  2114. - 'null'
  2115. position:
  2116. type:
  2117. - string
  2118. - 'null'
  2119. phone:
  2120. type:
  2121. - string
  2122. - 'null'
  2123. email:
  2124. format: email
  2125. externalDocs:
  2126. url: 'https://schema.org/email'
  2127. type:
  2128. - string
  2129. - 'null'
  2130. posts:
  2131. readOnly: true
  2132. type: array
  2133. items:
  2134. type: string
  2135. format: iri-reference
  2136. example: 'https://example.com/'
  2137. createdAt:
  2138. readOnly: true
  2139. type:
  2140. - string
  2141. - 'null'
  2142. format: date-time
  2143. Media-media_object.read:
  2144. type: object
  2145. description: ''
  2146. deprecated: false
  2147. externalDocs:
  2148. url: 'https://schema.org/MediaObject'
  2149. properties:
  2150. contentUrl:
  2151. externalDocs:
  2152. url: 'https://schema.org/contentUrl'
  2153. type:
  2154. - string
  2155. - 'null'
  2156. Media.jsonhal-media_object.read:
  2157. type: object
  2158. description: ''
  2159. deprecated: false
  2160. externalDocs:
  2161. url: 'https://schema.org/MediaObject'
  2162. properties:
  2163. _links:
  2164. type: object
  2165. properties:
  2166. self:
  2167. type: object
  2168. properties:
  2169. href:
  2170. type: string
  2171. format: iri-reference
  2172. contentUrl:
  2173. externalDocs:
  2174. url: 'https://schema.org/contentUrl'
  2175. type:
  2176. - string
  2177. - 'null'
  2178. Media.jsonld-media_object.read:
  2179. type: object
  2180. description: ''
  2181. deprecated: false
  2182. externalDocs:
  2183. url: 'https://schema.org/MediaObject'
  2184. properties:
  2185. '@context':
  2186. readOnly: true
  2187. oneOf:
  2188. -
  2189. type: string
  2190. -
  2191. type: object
  2192. properties:
  2193. '@vocab':
  2194. type: string
  2195. hydra:
  2196. type: string
  2197. enum: ['http://www.w3.org/ns/hydra/core#']
  2198. required:
  2199. - '@vocab'
  2200. - hydra
  2201. additionalProperties: true
  2202. '@id':
  2203. readOnly: true
  2204. type: string
  2205. '@type':
  2206. readOnly: true
  2207. type: string
  2208. contentUrl:
  2209. externalDocs:
  2210. url: 'https://schema.org/contentUrl'
  2211. type:
  2212. - string
  2213. - 'null'
  2214. Partner:
  2215. type: object
  2216. description: ''
  2217. deprecated: false
  2218. required:
  2219. - name
  2220. - type
  2221. properties:
  2222. name:
  2223. type: string
  2224. type:
  2225. type: string
  2226. enum:
  2227. - customer
  2228. - supplier
  2229. - service
  2230. street:
  2231. type:
  2232. - string
  2233. - 'null'
  2234. streetNo:
  2235. type:
  2236. - string
  2237. - 'null'
  2238. zip:
  2239. type:
  2240. - string
  2241. - 'null'
  2242. city:
  2243. type:
  2244. - string
  2245. - 'null'
  2246. country:
  2247. type:
  2248. - string
  2249. - 'null'
  2250. website:
  2251. type:
  2252. - string
  2253. - 'null'
  2254. logo:
  2255. 'owl:maxCardinality': 1
  2256. type:
  2257. - string
  2258. - 'null'
  2259. format: iri-reference
  2260. example: 'https://example.com/'
  2261. logoUrl:
  2262. readOnly: true
  2263. type:
  2264. - string
  2265. - 'null'
  2266. createdAt:
  2267. readOnly: true
  2268. type:
  2269. - string
  2270. - 'null'
  2271. format: date-time
  2272. contacts:
  2273. readOnly: true
  2274. type: array
  2275. items:
  2276. type: string
  2277. format: iri-reference
  2278. example: 'https://example.com/'
  2279. Partner.jsonhal:
  2280. type: object
  2281. description: ''
  2282. deprecated: false
  2283. required:
  2284. - name
  2285. - type
  2286. properties:
  2287. _links:
  2288. type: object
  2289. properties:
  2290. self:
  2291. type: object
  2292. properties:
  2293. href:
  2294. type: string
  2295. format: iri-reference
  2296. name:
  2297. type: string
  2298. type:
  2299. type: string
  2300. enum:
  2301. - customer
  2302. - supplier
  2303. - service
  2304. street:
  2305. type:
  2306. - string
  2307. - 'null'
  2308. streetNo:
  2309. type:
  2310. - string
  2311. - 'null'
  2312. zip:
  2313. type:
  2314. - string
  2315. - 'null'
  2316. city:
  2317. type:
  2318. - string
  2319. - 'null'
  2320. country:
  2321. type:
  2322. - string
  2323. - 'null'
  2324. website:
  2325. type:
  2326. - string
  2327. - 'null'
  2328. logo:
  2329. 'owl:maxCardinality': 1
  2330. type:
  2331. - string
  2332. - 'null'
  2333. format: iri-reference
  2334. example: 'https://example.com/'
  2335. logoUrl:
  2336. readOnly: true
  2337. type:
  2338. - string
  2339. - 'null'
  2340. createdAt:
  2341. readOnly: true
  2342. type:
  2343. - string
  2344. - 'null'
  2345. format: date-time
  2346. contacts:
  2347. readOnly: true
  2348. type: array
  2349. items:
  2350. type: string
  2351. format: iri-reference
  2352. example: 'https://example.com/'
  2353. Partner.jsonld:
  2354. type: object
  2355. description: ''
  2356. deprecated: false
  2357. required:
  2358. - name
  2359. - type
  2360. properties:
  2361. '@context':
  2362. readOnly: true
  2363. oneOf:
  2364. -
  2365. type: string
  2366. -
  2367. type: object
  2368. properties:
  2369. '@vocab':
  2370. type: string
  2371. hydra:
  2372. type: string
  2373. enum: ['http://www.w3.org/ns/hydra/core#']
  2374. required:
  2375. - '@vocab'
  2376. - hydra
  2377. additionalProperties: true
  2378. '@id':
  2379. readOnly: true
  2380. type: string
  2381. '@type':
  2382. readOnly: true
  2383. type: string
  2384. name:
  2385. type: string
  2386. type:
  2387. type: string
  2388. enum:
  2389. - customer
  2390. - supplier
  2391. - service
  2392. street:
  2393. type:
  2394. - string
  2395. - 'null'
  2396. streetNo:
  2397. type:
  2398. - string
  2399. - 'null'
  2400. zip:
  2401. type:
  2402. - string
  2403. - 'null'
  2404. city:
  2405. type:
  2406. - string
  2407. - 'null'
  2408. country:
  2409. type:
  2410. - string
  2411. - 'null'
  2412. website:
  2413. type:
  2414. - string
  2415. - 'null'
  2416. logo:
  2417. 'owl:maxCardinality': 1
  2418. type:
  2419. - string
  2420. - 'null'
  2421. format: iri-reference
  2422. example: 'https://example.com/'
  2423. logoUrl:
  2424. readOnly: true
  2425. type:
  2426. - string
  2427. - 'null'
  2428. createdAt:
  2429. readOnly: true
  2430. type:
  2431. - string
  2432. - 'null'
  2433. format: date-time
  2434. contacts:
  2435. readOnly: true
  2436. type: array
  2437. items:
  2438. type: string
  2439. format: iri-reference
  2440. example: 'https://example.com/'
  2441. Post:
  2442. type: object
  2443. description: ''
  2444. deprecated: false
  2445. required:
  2446. - headline
  2447. - message
  2448. properties:
  2449. headline:
  2450. type:
  2451. - string
  2452. - 'null'
  2453. message:
  2454. type:
  2455. - string
  2456. - 'null'
  2457. owner:
  2458. readOnly: true
  2459. 'owl:maxCardinality': 1
  2460. type:
  2461. - string
  2462. - 'null'
  2463. format: iri-reference
  2464. example: 'https://example.com/'
  2465. ownerName:
  2466. readOnly: true
  2467. type:
  2468. - string
  2469. - 'null'
  2470. partner:
  2471. 'owl:maxCardinality': 1
  2472. type:
  2473. - string
  2474. - 'null'
  2475. format: iri-reference
  2476. example: 'https://example.com/'
  2477. contact:
  2478. 'owl:maxCardinality': 1
  2479. type:
  2480. - string
  2481. - 'null'
  2482. format: iri-reference
  2483. example: 'https://example.com/'
  2484. comments:
  2485. description: 'array<int, CommentApi>'
  2486. type: array
  2487. items:
  2488. type: string
  2489. createdAt:
  2490. readOnly: true
  2491. type:
  2492. - string
  2493. - 'null'
  2494. format: date-time
  2495. Post-posting.create:
  2496. type: object
  2497. description: ''
  2498. deprecated: false
  2499. required:
  2500. - headline
  2501. - message
  2502. properties:
  2503. headline:
  2504. type:
  2505. - string
  2506. - 'null'
  2507. message:
  2508. type:
  2509. - string
  2510. - 'null'
  2511. partner:
  2512. 'owl:maxCardinality': 1
  2513. type:
  2514. - string
  2515. - 'null'
  2516. format: iri-reference
  2517. example: 'https://example.com/'
  2518. contact:
  2519. 'owl:maxCardinality': 1
  2520. type:
  2521. - string
  2522. - 'null'
  2523. format: iri-reference
  2524. example: 'https://example.com/'
  2525. Post-posting.patch:
  2526. type: object
  2527. description: ''
  2528. deprecated: false
  2529. required:
  2530. - headline
  2531. - message
  2532. properties:
  2533. headline:
  2534. type:
  2535. - string
  2536. - 'null'
  2537. message:
  2538. type:
  2539. - string
  2540. - 'null'
  2541. Post.jsonhal:
  2542. type: object
  2543. description: ''
  2544. deprecated: false
  2545. required:
  2546. - headline
  2547. - message
  2548. properties:
  2549. _links:
  2550. type: object
  2551. properties:
  2552. self:
  2553. type: object
  2554. properties:
  2555. href:
  2556. type: string
  2557. format: iri-reference
  2558. headline:
  2559. type:
  2560. - string
  2561. - 'null'
  2562. message:
  2563. type:
  2564. - string
  2565. - 'null'
  2566. owner:
  2567. readOnly: true
  2568. 'owl:maxCardinality': 1
  2569. type:
  2570. - string
  2571. - 'null'
  2572. format: iri-reference
  2573. example: 'https://example.com/'
  2574. ownerName:
  2575. readOnly: true
  2576. type:
  2577. - string
  2578. - 'null'
  2579. partner:
  2580. 'owl:maxCardinality': 1
  2581. type:
  2582. - string
  2583. - 'null'
  2584. format: iri-reference
  2585. example: 'https://example.com/'
  2586. contact:
  2587. 'owl:maxCardinality': 1
  2588. type:
  2589. - string
  2590. - 'null'
  2591. format: iri-reference
  2592. example: 'https://example.com/'
  2593. comments:
  2594. description: 'array<int, CommentApi>'
  2595. type: array
  2596. items:
  2597. type: string
  2598. createdAt:
  2599. readOnly: true
  2600. type:
  2601. - string
  2602. - 'null'
  2603. format: date-time
  2604. Post.jsonhal-posting.create:
  2605. type: object
  2606. description: ''
  2607. deprecated: false
  2608. required:
  2609. - headline
  2610. - message
  2611. properties:
  2612. _links:
  2613. type: object
  2614. properties:
  2615. self:
  2616. type: object
  2617. properties:
  2618. href:
  2619. type: string
  2620. format: iri-reference
  2621. headline:
  2622. type:
  2623. - string
  2624. - 'null'
  2625. message:
  2626. type:
  2627. - string
  2628. - 'null'
  2629. partner:
  2630. 'owl:maxCardinality': 1
  2631. type:
  2632. - string
  2633. - 'null'
  2634. format: iri-reference
  2635. example: 'https://example.com/'
  2636. contact:
  2637. 'owl:maxCardinality': 1
  2638. type:
  2639. - string
  2640. - 'null'
  2641. format: iri-reference
  2642. example: 'https://example.com/'
  2643. Post.jsonld:
  2644. type: object
  2645. description: ''
  2646. deprecated: false
  2647. required:
  2648. - headline
  2649. - message
  2650. properties:
  2651. '@context':
  2652. readOnly: true
  2653. oneOf:
  2654. -
  2655. type: string
  2656. -
  2657. type: object
  2658. properties:
  2659. '@vocab':
  2660. type: string
  2661. hydra:
  2662. type: string
  2663. enum: ['http://www.w3.org/ns/hydra/core#']
  2664. required:
  2665. - '@vocab'
  2666. - hydra
  2667. additionalProperties: true
  2668. '@id':
  2669. readOnly: true
  2670. type: string
  2671. '@type':
  2672. readOnly: true
  2673. type: string
  2674. headline:
  2675. type:
  2676. - string
  2677. - 'null'
  2678. message:
  2679. type:
  2680. - string
  2681. - 'null'
  2682. owner:
  2683. readOnly: true
  2684. 'owl:maxCardinality': 1
  2685. type:
  2686. - string
  2687. - 'null'
  2688. format: iri-reference
  2689. example: 'https://example.com/'
  2690. ownerName:
  2691. readOnly: true
  2692. type:
  2693. - string
  2694. - 'null'
  2695. partner:
  2696. 'owl:maxCardinality': 1
  2697. type:
  2698. - string
  2699. - 'null'
  2700. format: iri-reference
  2701. example: 'https://example.com/'
  2702. contact:
  2703. 'owl:maxCardinality': 1
  2704. type:
  2705. - string
  2706. - 'null'
  2707. format: iri-reference
  2708. example: 'https://example.com/'
  2709. comments:
  2710. description: 'array<int, CommentApi>'
  2711. type: array
  2712. items:
  2713. type: string
  2714. createdAt:
  2715. readOnly: true
  2716. type:
  2717. - string
  2718. - 'null'
  2719. format: date-time
  2720. Post.jsonld-posting.create:
  2721. type: object
  2722. description: ''
  2723. deprecated: false
  2724. required:
  2725. - headline
  2726. - message
  2727. properties:
  2728. headline:
  2729. type:
  2730. - string
  2731. - 'null'
  2732. message:
  2733. type:
  2734. - string
  2735. - 'null'
  2736. partner:
  2737. 'owl:maxCardinality': 1
  2738. type:
  2739. - string
  2740. - 'null'
  2741. format: iri-reference
  2742. example: 'https://example.com/'
  2743. contact:
  2744. 'owl:maxCardinality': 1
  2745. type:
  2746. - string
  2747. - 'null'
  2748. format: iri-reference
  2749. example: 'https://example.com/'
  2750. Product:
  2751. type: object
  2752. description: ''
  2753. deprecated: false
  2754. required:
  2755. - name
  2756. properties:
  2757. name:
  2758. type: string
  2759. description:
  2760. type:
  2761. - string
  2762. - 'null'
  2763. image:
  2764. 'owl:maxCardinality': 1
  2765. type:
  2766. - string
  2767. - 'null'
  2768. format: iri-reference
  2769. example: 'https://example.com/'
  2770. imageUrl:
  2771. readOnly: true
  2772. type:
  2773. - string
  2774. - 'null'
  2775. createdAt:
  2776. type:
  2777. - string
  2778. - 'null'
  2779. format: date-time
  2780. Product.jsonhal:
  2781. type: object
  2782. description: ''
  2783. deprecated: false
  2784. required:
  2785. - name
  2786. properties:
  2787. _links:
  2788. type: object
  2789. properties:
  2790. self:
  2791. type: object
  2792. properties:
  2793. href:
  2794. type: string
  2795. format: iri-reference
  2796. name:
  2797. type: string
  2798. description:
  2799. type:
  2800. - string
  2801. - 'null'
  2802. image:
  2803. 'owl:maxCardinality': 1
  2804. type:
  2805. - string
  2806. - 'null'
  2807. format: iri-reference
  2808. example: 'https://example.com/'
  2809. imageUrl:
  2810. readOnly: true
  2811. type:
  2812. - string
  2813. - 'null'
  2814. createdAt:
  2815. type:
  2816. - string
  2817. - 'null'
  2818. format: date-time
  2819. Product.jsonld:
  2820. type: object
  2821. description: ''
  2822. deprecated: false
  2823. required:
  2824. - name
  2825. properties:
  2826. '@context':
  2827. readOnly: true
  2828. oneOf:
  2829. -
  2830. type: string
  2831. -
  2832. type: object
  2833. properties:
  2834. '@vocab':
  2835. type: string
  2836. hydra:
  2837. type: string
  2838. enum: ['http://www.w3.org/ns/hydra/core#']
  2839. required:
  2840. - '@vocab'
  2841. - hydra
  2842. additionalProperties: true
  2843. '@id':
  2844. readOnly: true
  2845. type: string
  2846. '@type':
  2847. readOnly: true
  2848. type: string
  2849. name:
  2850. type: string
  2851. description:
  2852. type:
  2853. - string
  2854. - 'null'
  2855. image:
  2856. 'owl:maxCardinality': 1
  2857. type:
  2858. - string
  2859. - 'null'
  2860. format: iri-reference
  2861. example: 'https://example.com/'
  2862. imageUrl:
  2863. readOnly: true
  2864. type:
  2865. - string
  2866. - 'null'
  2867. createdAt:
  2868. type:
  2869. - string
  2870. - 'null'
  2871. format: date-time
  2872. User:
  2873. type: object
  2874. description: ''
  2875. deprecated: false
  2876. required:
  2877. - email
  2878. - firstName
  2879. - lastName
  2880. properties:
  2881. email:
  2882. format: email
  2883. externalDocs:
  2884. url: 'https://schema.org/email'
  2885. type:
  2886. - string
  2887. - 'null'
  2888. firstName:
  2889. type:
  2890. - string
  2891. - 'null'
  2892. lastName:
  2893. type:
  2894. - string
  2895. - 'null'
  2896. image:
  2897. 'owl:maxCardinality': 1
  2898. type:
  2899. - string
  2900. - 'null'
  2901. format: iri-reference
  2902. example: 'https://example.com/'
  2903. password:
  2904. writeOnly: true
  2905. description: 'The plaintext password when being set or changed.'
  2906. type:
  2907. - string
  2908. - 'null'
  2909. active:
  2910. type: boolean
  2911. createdAt:
  2912. readOnly: true
  2913. type:
  2914. - string
  2915. - 'null'
  2916. format: date-time
  2917. User.jsonhal:
  2918. type: object
  2919. description: ''
  2920. deprecated: false
  2921. required:
  2922. - email
  2923. - firstName
  2924. - lastName
  2925. properties:
  2926. _links:
  2927. type: object
  2928. properties:
  2929. self:
  2930. type: object
  2931. properties:
  2932. href:
  2933. type: string
  2934. format: iri-reference
  2935. email:
  2936. format: email
  2937. externalDocs:
  2938. url: 'https://schema.org/email'
  2939. type:
  2940. - string
  2941. - 'null'
  2942. firstName:
  2943. type:
  2944. - string
  2945. - 'null'
  2946. lastName:
  2947. type:
  2948. - string
  2949. - 'null'
  2950. image:
  2951. 'owl:maxCardinality': 1
  2952. type:
  2953. - string
  2954. - 'null'
  2955. format: iri-reference
  2956. example: 'https://example.com/'
  2957. password:
  2958. writeOnly: true
  2959. description: 'The plaintext password when being set or changed.'
  2960. type:
  2961. - string
  2962. - 'null'
  2963. active:
  2964. type: boolean
  2965. createdAt:
  2966. readOnly: true
  2967. type:
  2968. - string
  2969. - 'null'
  2970. format: date-time
  2971. User.jsonld:
  2972. type: object
  2973. description: ''
  2974. deprecated: false
  2975. required:
  2976. - email
  2977. - firstName
  2978. - lastName
  2979. properties:
  2980. '@context':
  2981. readOnly: true
  2982. oneOf:
  2983. -
  2984. type: string
  2985. -
  2986. type: object
  2987. properties:
  2988. '@vocab':
  2989. type: string
  2990. hydra:
  2991. type: string
  2992. enum: ['http://www.w3.org/ns/hydra/core#']
  2993. required:
  2994. - '@vocab'
  2995. - hydra
  2996. additionalProperties: true
  2997. '@id':
  2998. readOnly: true
  2999. type: string
  3000. '@type':
  3001. readOnly: true
  3002. type: string
  3003. email:
  3004. format: email
  3005. externalDocs:
  3006. url: 'https://schema.org/email'
  3007. type:
  3008. - string
  3009. - 'null'
  3010. firstName:
  3011. type:
  3012. - string
  3013. - 'null'
  3014. lastName:
  3015. type:
  3016. - string
  3017. - 'null'
  3018. image:
  3019. 'owl:maxCardinality': 1
  3020. type:
  3021. - string
  3022. - 'null'
  3023. format: iri-reference
  3024. example: 'https://example.com/'
  3025. password:
  3026. writeOnly: true
  3027. description: 'The plaintext password when being set or changed.'
  3028. type:
  3029. - string
  3030. - 'null'
  3031. active:
  3032. type: boolean
  3033. createdAt:
  3034. readOnly: true
  3035. type:
  3036. - string
  3037. - 'null'
  3038. format: date-time
  3039. responses: { }
  3040. parameters: { }
  3041. examples: { }
  3042. requestBodies: { }
  3043. headers: { }
  3044. securitySchemes:
  3045. JWT:
  3046. type: http
  3047. scheme: bearer
  3048. bearerFormat: JWT
  3049. security:
  3050. -
  3051. JWT: []
  3052. tags: []