Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
 
 
 

7129 řádky
205 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: 'Comment 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. patch:
  169. operationId: api_comments_id_patch
  170. tags:
  171. - Comment
  172. responses:
  173. 200:
  174. description: 'Comment resource updated'
  175. content:
  176. application/ld+json:
  177. schema:
  178. $ref: '#/components/schemas/Comment.jsonld'
  179. application/json:
  180. schema:
  181. $ref: '#/components/schemas/Comment'
  182. text/html:
  183. schema:
  184. $ref: '#/components/schemas/Comment'
  185. application/hal+json:
  186. schema:
  187. $ref: '#/components/schemas/Comment.jsonhal'
  188. links: { }
  189. 400:
  190. description: 'Invalid input'
  191. 422:
  192. description: 'Unprocessable entity'
  193. 404:
  194. description: 'Resource not found'
  195. summary: 'Updates the Comment resource.'
  196. description: 'Updates the Comment resource.'
  197. parameters:
  198. -
  199. name: id
  200. in: path
  201. description: 'Comment identifier'
  202. required: true
  203. deprecated: false
  204. allowEmptyValue: false
  205. schema:
  206. type: string
  207. style: simple
  208. explode: false
  209. allowReserved: false
  210. requestBody:
  211. description: 'The updated Comment resource'
  212. content:
  213. application/merge-patch+json:
  214. schema:
  215. $ref: '#/components/schemas/Comment'
  216. required: true
  217. deprecated: false
  218. parameters: []
  219. /api/contact_partner_products:
  220. get:
  221. operationId: api_contact_partner_products_get_collection
  222. tags:
  223. - ContactPartnerProduct
  224. responses:
  225. 200:
  226. description: 'ContactPartnerProduct collection'
  227. content:
  228. application/ld+json:
  229. schema:
  230. type: object
  231. properties:
  232. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/ContactPartnerProduct.jsonld' } }
  233. 'hydra:totalItems': { type: integer, minimum: 0 }
  234. '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 } }
  235. '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 } } } } } }
  236. required:
  237. - 'hydra:member'
  238. application/json:
  239. schema:
  240. type: array
  241. items:
  242. $ref: '#/components/schemas/ContactPartnerProduct'
  243. text/html:
  244. schema:
  245. type: array
  246. items:
  247. $ref: '#/components/schemas/ContactPartnerProduct'
  248. application/hal+json:
  249. schema:
  250. type: object
  251. properties:
  252. _embedded: { type: array, items: { $ref: '#/components/schemas/ContactPartnerProduct.jsonhal' } }
  253. totalItems: { type: integer, minimum: 0 }
  254. itemsPerPage: { type: integer, minimum: 0 }
  255. _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 } } } } }
  256. required:
  257. - _links
  258. - _embedded
  259. summary: 'Retrieves the collection of ContactPartnerProduct resources.'
  260. description: 'Retrieves the collection of ContactPartnerProduct resources.'
  261. parameters:
  262. -
  263. name: page
  264. in: query
  265. description: 'The collection page number'
  266. required: false
  267. deprecated: false
  268. allowEmptyValue: true
  269. schema:
  270. type: integer
  271. default: 1
  272. style: form
  273. explode: false
  274. allowReserved: false
  275. -
  276. name: itemsPerPage
  277. in: query
  278. description: 'The number of items per page'
  279. required: false
  280. deprecated: false
  281. allowEmptyValue: true
  282. schema:
  283. type: integer
  284. default: 10
  285. minimum: 0
  286. maximum: 50
  287. style: form
  288. explode: false
  289. allowReserved: false
  290. -
  291. name: contact
  292. in: query
  293. description: ''
  294. required: false
  295. deprecated: false
  296. allowEmptyValue: true
  297. schema:
  298. type: string
  299. style: form
  300. explode: false
  301. allowReserved: false
  302. -
  303. name: 'contact[]'
  304. in: query
  305. description: ''
  306. required: false
  307. deprecated: false
  308. allowEmptyValue: true
  309. schema:
  310. type: array
  311. items:
  312. type: string
  313. style: form
  314. explode: true
  315. allowReserved: false
  316. deprecated: false
  317. post:
  318. operationId: api_contact_partner_products_post
  319. tags:
  320. - ContactPartnerProduct
  321. responses:
  322. 201:
  323. description: 'ContactPartnerProduct resource created'
  324. content:
  325. application/ld+json:
  326. schema:
  327. $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
  328. application/json:
  329. schema:
  330. $ref: '#/components/schemas/ContactPartnerProduct'
  331. text/html:
  332. schema:
  333. $ref: '#/components/schemas/ContactPartnerProduct'
  334. application/hal+json:
  335. schema:
  336. $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
  337. links: { }
  338. 400:
  339. description: 'Invalid input'
  340. 422:
  341. description: 'Unprocessable entity'
  342. summary: 'Creates a ContactPartnerProduct resource.'
  343. description: 'Creates a ContactPartnerProduct resource.'
  344. parameters: []
  345. requestBody:
  346. description: 'The new ContactPartnerProduct resource'
  347. content:
  348. application/ld+json:
  349. schema:
  350. $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
  351. application/json:
  352. schema:
  353. $ref: '#/components/schemas/ContactPartnerProduct'
  354. text/html:
  355. schema:
  356. $ref: '#/components/schemas/ContactPartnerProduct'
  357. application/hal+json:
  358. schema:
  359. $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
  360. required: true
  361. deprecated: false
  362. parameters: []
  363. '/api/contact_partner_products/{id}':
  364. get:
  365. operationId: api_contact_partner_products_id_get
  366. tags:
  367. - ContactPartnerProduct
  368. responses:
  369. 200:
  370. description: 'ContactPartnerProduct resource'
  371. content:
  372. application/ld+json:
  373. schema:
  374. $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
  375. application/json:
  376. schema:
  377. $ref: '#/components/schemas/ContactPartnerProduct'
  378. text/html:
  379. schema:
  380. $ref: '#/components/schemas/ContactPartnerProduct'
  381. application/hal+json:
  382. schema:
  383. $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
  384. 404:
  385. description: 'Resource not found'
  386. summary: 'Retrieves a ContactPartnerProduct resource.'
  387. description: 'Retrieves a ContactPartnerProduct resource.'
  388. parameters:
  389. -
  390. name: id
  391. in: path
  392. description: 'ContactPartnerProduct identifier'
  393. required: true
  394. deprecated: false
  395. allowEmptyValue: false
  396. schema:
  397. type: string
  398. style: simple
  399. explode: false
  400. allowReserved: false
  401. deprecated: false
  402. delete:
  403. operationId: api_contact_partner_products_id_delete
  404. tags:
  405. - ContactPartnerProduct
  406. responses:
  407. 204:
  408. description: 'ContactPartnerProduct resource deleted'
  409. 404:
  410. description: 'Resource not found'
  411. summary: 'Removes the ContactPartnerProduct resource.'
  412. description: 'Removes the ContactPartnerProduct resource.'
  413. parameters:
  414. -
  415. name: id
  416. in: path
  417. description: 'ContactPartnerProduct 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. parameters: []
  428. /api/contacts:
  429. get:
  430. operationId: api_contacts_get_collection
  431. tags:
  432. - Contact
  433. responses:
  434. 200:
  435. description: 'Contact collection'
  436. content:
  437. application/ld+json:
  438. schema:
  439. type: object
  440. properties:
  441. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.jsonld' } }
  442. 'hydra:totalItems': { type: integer, minimum: 0 }
  443. '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 } }
  444. '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 } } } } } }
  445. required:
  446. - 'hydra:member'
  447. application/json:
  448. schema:
  449. type: array
  450. items:
  451. $ref: '#/components/schemas/Contact'
  452. text/html:
  453. schema:
  454. type: array
  455. items:
  456. $ref: '#/components/schemas/Contact'
  457. application/hal+json:
  458. schema:
  459. type: object
  460. properties:
  461. _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.jsonhal' } }
  462. totalItems: { type: integer, minimum: 0 }
  463. itemsPerPage: { type: integer, minimum: 0 }
  464. _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 } } } } }
  465. required:
  466. - _links
  467. - _embedded
  468. summary: 'Retrieves the collection of Contact resources.'
  469. description: 'Retrieves the collection of Contact resources.'
  470. parameters:
  471. -
  472. name: page
  473. in: query
  474. description: 'The collection page number'
  475. required: false
  476. deprecated: false
  477. allowEmptyValue: true
  478. schema:
  479. type: integer
  480. default: 1
  481. style: form
  482. explode: false
  483. allowReserved: false
  484. -
  485. name: itemsPerPage
  486. in: query
  487. description: 'The number of items per page'
  488. required: false
  489. deprecated: false
  490. allowEmptyValue: true
  491. schema:
  492. type: integer
  493. default: 10
  494. minimum: 0
  495. maximum: 50
  496. style: form
  497. explode: false
  498. allowReserved: false
  499. -
  500. name: partner
  501. in: query
  502. description: ''
  503. required: false
  504. deprecated: false
  505. allowEmptyValue: true
  506. schema:
  507. type: string
  508. style: form
  509. explode: false
  510. allowReserved: false
  511. -
  512. name: 'partner[]'
  513. in: query
  514. description: ''
  515. required: false
  516. deprecated: false
  517. allowEmptyValue: true
  518. schema:
  519. type: array
  520. items:
  521. type: string
  522. style: form
  523. explode: true
  524. allowReserved: false
  525. deprecated: false
  526. post:
  527. operationId: api_contacts_post
  528. tags:
  529. - Contact
  530. responses:
  531. 201:
  532. description: 'Contact resource created'
  533. content:
  534. application/ld+json:
  535. schema:
  536. $ref: '#/components/schemas/Contact.jsonld'
  537. application/json:
  538. schema:
  539. $ref: '#/components/schemas/Contact'
  540. text/html:
  541. schema:
  542. $ref: '#/components/schemas/Contact'
  543. application/hal+json:
  544. schema:
  545. $ref: '#/components/schemas/Contact.jsonhal'
  546. links: { }
  547. 400:
  548. description: 'Invalid input'
  549. 422:
  550. description: 'Unprocessable entity'
  551. summary: 'Creates a Contact resource.'
  552. description: 'Creates a Contact resource.'
  553. parameters: []
  554. requestBody:
  555. description: 'The new Contact resource'
  556. content:
  557. application/ld+json:
  558. schema:
  559. $ref: '#/components/schemas/Contact.jsonld'
  560. application/json:
  561. schema:
  562. $ref: '#/components/schemas/Contact'
  563. text/html:
  564. schema:
  565. $ref: '#/components/schemas/Contact'
  566. application/hal+json:
  567. schema:
  568. $ref: '#/components/schemas/Contact.jsonhal'
  569. required: true
  570. deprecated: false
  571. parameters: []
  572. '/api/contacts/{id}':
  573. get:
  574. operationId: api_contacts_id_get
  575. tags:
  576. - Contact
  577. responses:
  578. 200:
  579. description: 'Contact resource'
  580. content:
  581. application/ld+json:
  582. schema:
  583. $ref: '#/components/schemas/Contact.jsonld'
  584. application/json:
  585. schema:
  586. $ref: '#/components/schemas/Contact'
  587. text/html:
  588. schema:
  589. $ref: '#/components/schemas/Contact'
  590. application/hal+json:
  591. schema:
  592. $ref: '#/components/schemas/Contact.jsonhal'
  593. 404:
  594. description: 'Resource not found'
  595. summary: 'Retrieves a Contact resource.'
  596. description: 'Retrieves a Contact resource.'
  597. parameters:
  598. -
  599. name: id
  600. in: path
  601. description: 'Contact identifier'
  602. required: true
  603. deprecated: false
  604. allowEmptyValue: false
  605. schema:
  606. type: string
  607. style: simple
  608. explode: false
  609. allowReserved: false
  610. deprecated: false
  611. patch:
  612. operationId: api_contacts_id_patch
  613. tags:
  614. - Contact
  615. responses:
  616. 200:
  617. description: 'Contact resource updated'
  618. content:
  619. application/ld+json:
  620. schema:
  621. $ref: '#/components/schemas/Contact.jsonld'
  622. application/json:
  623. schema:
  624. $ref: '#/components/schemas/Contact'
  625. text/html:
  626. schema:
  627. $ref: '#/components/schemas/Contact'
  628. application/hal+json:
  629. schema:
  630. $ref: '#/components/schemas/Contact.jsonhal'
  631. links: { }
  632. 400:
  633. description: 'Invalid input'
  634. 422:
  635. description: 'Unprocessable entity'
  636. 404:
  637. description: 'Resource not found'
  638. summary: 'Updates the Contact resource.'
  639. description: 'Updates the Contact resource.'
  640. parameters:
  641. -
  642. name: id
  643. in: path
  644. description: 'Contact identifier'
  645. required: true
  646. deprecated: false
  647. allowEmptyValue: false
  648. schema:
  649. type: string
  650. style: simple
  651. explode: false
  652. allowReserved: false
  653. requestBody:
  654. description: 'The updated Contact resource'
  655. content:
  656. application/merge-patch+json:
  657. schema:
  658. $ref: '#/components/schemas/Contact'
  659. required: true
  660. deprecated: false
  661. parameters: []
  662. /api/document_objects:
  663. get:
  664. operationId: api_document_objects_get_collection
  665. tags:
  666. - DocumentObject
  667. responses:
  668. 200:
  669. description: 'DocumentObject collection'
  670. content:
  671. application/ld+json:
  672. schema:
  673. type: object
  674. properties:
  675. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read' } }
  676. 'hydra:totalItems': { type: integer, minimum: 0 }
  677. '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 } }
  678. '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 } } } } } }
  679. required:
  680. - 'hydra:member'
  681. application/json:
  682. schema:
  683. type: array
  684. items:
  685. $ref: '#/components/schemas/DocumentObject-document_object.read'
  686. text/html:
  687. schema:
  688. type: array
  689. items:
  690. $ref: '#/components/schemas/DocumentObject-document_object.read'
  691. application/hal+json:
  692. schema:
  693. type: object
  694. properties:
  695. _embedded: { type: array, items: { $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read' } }
  696. totalItems: { type: integer, minimum: 0 }
  697. itemsPerPage: { type: integer, minimum: 0 }
  698. _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 } } } } }
  699. required:
  700. - _links
  701. - _embedded
  702. summary: 'Retrieves the collection of DocumentObject resources.'
  703. description: 'Retrieves the collection of DocumentObject resources.'
  704. parameters:
  705. -
  706. name: page
  707. in: query
  708. description: 'The collection page number'
  709. required: false
  710. deprecated: false
  711. allowEmptyValue: true
  712. schema:
  713. type: integer
  714. default: 1
  715. style: form
  716. explode: false
  717. allowReserved: false
  718. -
  719. name: itemsPerPage
  720. in: query
  721. description: 'The number of items per page'
  722. required: false
  723. deprecated: false
  724. allowEmptyValue: true
  725. schema:
  726. type: integer
  727. default: 10
  728. minimum: 0
  729. maximum: 50
  730. style: form
  731. explode: false
  732. allowReserved: false
  733. deprecated: false
  734. post:
  735. operationId: api_document_objects_post
  736. tags:
  737. - DocumentObject
  738. responses:
  739. 201:
  740. description: 'DocumentObject resource created'
  741. content:
  742. application/ld+json:
  743. schema:
  744. $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read'
  745. application/json:
  746. schema:
  747. $ref: '#/components/schemas/DocumentObject-document_object.read'
  748. text/html:
  749. schema:
  750. $ref: '#/components/schemas/DocumentObject-document_object.read'
  751. application/hal+json:
  752. schema:
  753. $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read'
  754. links: { }
  755. 400:
  756. description: 'Invalid input'
  757. 422:
  758. description: 'Unprocessable entity'
  759. summary: 'Creates a DocumentObject resource.'
  760. description: 'Creates a DocumentObject resource.'
  761. parameters: []
  762. requestBody:
  763. description: ''
  764. content:
  765. multipart/form-data:
  766. schema:
  767. type: object
  768. properties:
  769. file:
  770. type: string
  771. format: binary
  772. required: false
  773. deprecated: false
  774. parameters: []
  775. '/api/document_objects/{id}':
  776. get:
  777. operationId: api_document_objects_id_get
  778. tags:
  779. - DocumentObject
  780. responses:
  781. 200:
  782. description: 'DocumentObject resource'
  783. content:
  784. application/ld+json:
  785. schema:
  786. $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read'
  787. application/json:
  788. schema:
  789. $ref: '#/components/schemas/DocumentObject-document_object.read'
  790. text/html:
  791. schema:
  792. $ref: '#/components/schemas/DocumentObject-document_object.read'
  793. application/hal+json:
  794. schema:
  795. $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read'
  796. 404:
  797. description: 'Resource not found'
  798. summary: 'Retrieves a DocumentObject resource.'
  799. description: 'Retrieves a DocumentObject resource.'
  800. parameters:
  801. -
  802. name: id
  803. in: path
  804. description: 'DocumentObject identifier'
  805. required: true
  806. deprecated: false
  807. allowEmptyValue: false
  808. schema:
  809. type: string
  810. style: simple
  811. explode: false
  812. allowReserved: false
  813. deprecated: false
  814. delete:
  815. operationId: api_document_objects_id_delete
  816. tags:
  817. - DocumentObject
  818. responses:
  819. 204:
  820. description: 'DocumentObject resource deleted'
  821. 404:
  822. description: 'Resource not found'
  823. summary: 'Removes the DocumentObject resource.'
  824. description: 'Removes the DocumentObject resource.'
  825. parameters:
  826. -
  827. name: id
  828. in: path
  829. description: 'DocumentObject identifier'
  830. required: true
  831. deprecated: false
  832. allowEmptyValue: false
  833. schema:
  834. type: string
  835. style: simple
  836. explode: false
  837. allowReserved: false
  838. deprecated: false
  839. parameters: []
  840. /api/documents:
  841. get:
  842. operationId: api_documents_get_collection
  843. tags:
  844. - Document
  845. responses:
  846. 200:
  847. description: 'Document collection'
  848. content:
  849. application/ld+json:
  850. schema:
  851. type: object
  852. properties:
  853. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Document.jsonld' } }
  854. 'hydra:totalItems': { type: integer, minimum: 0 }
  855. '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 } }
  856. '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 } } } } } }
  857. required:
  858. - 'hydra:member'
  859. application/json:
  860. schema:
  861. type: array
  862. items:
  863. $ref: '#/components/schemas/Document'
  864. text/html:
  865. schema:
  866. type: array
  867. items:
  868. $ref: '#/components/schemas/Document'
  869. application/hal+json:
  870. schema:
  871. type: object
  872. properties:
  873. _embedded: { type: array, items: { $ref: '#/components/schemas/Document.jsonhal' } }
  874. totalItems: { type: integer, minimum: 0 }
  875. itemsPerPage: { type: integer, minimum: 0 }
  876. _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 } } } } }
  877. required:
  878. - _links
  879. - _embedded
  880. summary: 'Retrieves the collection of Document resources.'
  881. description: 'Retrieves the collection of Document resources.'
  882. parameters:
  883. -
  884. name: page
  885. in: query
  886. description: 'The collection page number'
  887. required: false
  888. deprecated: false
  889. allowEmptyValue: true
  890. schema:
  891. type: integer
  892. default: 1
  893. style: form
  894. explode: false
  895. allowReserved: false
  896. -
  897. name: itemsPerPage
  898. in: query
  899. description: 'The number of items per page'
  900. required: false
  901. deprecated: false
  902. allowEmptyValue: true
  903. schema:
  904. type: integer
  905. default: 10
  906. minimum: 0
  907. maximum: 50
  908. style: form
  909. explode: false
  910. allowReserved: false
  911. -
  912. name: partner
  913. in: query
  914. description: ''
  915. required: false
  916. deprecated: false
  917. allowEmptyValue: true
  918. schema:
  919. type: string
  920. style: form
  921. explode: false
  922. allowReserved: false
  923. -
  924. name: 'partner[]'
  925. in: query
  926. description: ''
  927. required: false
  928. deprecated: false
  929. allowEmptyValue: true
  930. schema:
  931. type: array
  932. items:
  933. type: string
  934. style: form
  935. explode: true
  936. allowReserved: false
  937. -
  938. name: product
  939. in: query
  940. description: ''
  941. required: false
  942. deprecated: false
  943. allowEmptyValue: true
  944. schema:
  945. type: string
  946. style: form
  947. explode: false
  948. allowReserved: false
  949. -
  950. name: 'product[]'
  951. in: query
  952. description: ''
  953. required: false
  954. deprecated: false
  955. allowEmptyValue: true
  956. schema:
  957. type: array
  958. items:
  959. type: string
  960. style: form
  961. explode: true
  962. allowReserved: false
  963. deprecated: false
  964. post:
  965. operationId: api_documents_post
  966. tags:
  967. - Document
  968. responses:
  969. 201:
  970. description: 'Document resource created'
  971. content:
  972. application/ld+json:
  973. schema:
  974. $ref: '#/components/schemas/Document.jsonld'
  975. application/json:
  976. schema:
  977. $ref: '#/components/schemas/Document'
  978. text/html:
  979. schema:
  980. $ref: '#/components/schemas/Document'
  981. application/hal+json:
  982. schema:
  983. $ref: '#/components/schemas/Document.jsonhal'
  984. links: { }
  985. 400:
  986. description: 'Invalid input'
  987. 422:
  988. description: 'Unprocessable entity'
  989. summary: 'Creates a Document resource.'
  990. description: 'Creates a Document resource.'
  991. parameters: []
  992. requestBody:
  993. description: 'The new Document resource'
  994. content:
  995. application/ld+json:
  996. schema:
  997. $ref: '#/components/schemas/Document.jsonld'
  998. application/json:
  999. schema:
  1000. $ref: '#/components/schemas/Document'
  1001. text/html:
  1002. schema:
  1003. $ref: '#/components/schemas/Document'
  1004. application/hal+json:
  1005. schema:
  1006. $ref: '#/components/schemas/Document.jsonhal'
  1007. required: true
  1008. deprecated: false
  1009. parameters: []
  1010. '/api/documents/{id}':
  1011. get:
  1012. operationId: api_documents_id_get
  1013. tags:
  1014. - Document
  1015. responses:
  1016. 200:
  1017. description: 'Document resource'
  1018. content:
  1019. application/ld+json:
  1020. schema:
  1021. $ref: '#/components/schemas/Document.jsonld'
  1022. application/json:
  1023. schema:
  1024. $ref: '#/components/schemas/Document'
  1025. text/html:
  1026. schema:
  1027. $ref: '#/components/schemas/Document'
  1028. application/hal+json:
  1029. schema:
  1030. $ref: '#/components/schemas/Document.jsonhal'
  1031. 404:
  1032. description: 'Resource not found'
  1033. summary: 'Retrieves a Document resource.'
  1034. description: 'Retrieves a Document resource.'
  1035. parameters:
  1036. -
  1037. name: id
  1038. in: path
  1039. description: 'Document identifier'
  1040. required: true
  1041. deprecated: false
  1042. allowEmptyValue: false
  1043. schema:
  1044. type: string
  1045. style: simple
  1046. explode: false
  1047. allowReserved: false
  1048. deprecated: false
  1049. patch:
  1050. operationId: api_documents_id_patch
  1051. tags:
  1052. - Document
  1053. responses:
  1054. 200:
  1055. description: 'Document resource updated'
  1056. content:
  1057. application/ld+json:
  1058. schema:
  1059. $ref: '#/components/schemas/Document.jsonld'
  1060. application/json:
  1061. schema:
  1062. $ref: '#/components/schemas/Document'
  1063. text/html:
  1064. schema:
  1065. $ref: '#/components/schemas/Document'
  1066. application/hal+json:
  1067. schema:
  1068. $ref: '#/components/schemas/Document.jsonhal'
  1069. links: { }
  1070. 400:
  1071. description: 'Invalid input'
  1072. 422:
  1073. description: 'Unprocessable entity'
  1074. 404:
  1075. description: 'Resource not found'
  1076. summary: 'Updates the Document resource.'
  1077. description: 'Updates the Document resource.'
  1078. parameters:
  1079. -
  1080. name: id
  1081. in: path
  1082. description: 'Document identifier'
  1083. required: true
  1084. deprecated: false
  1085. allowEmptyValue: false
  1086. schema:
  1087. type: string
  1088. style: simple
  1089. explode: false
  1090. allowReserved: false
  1091. requestBody:
  1092. description: 'The updated Document resource'
  1093. content:
  1094. application/merge-patch+json:
  1095. schema:
  1096. $ref: '#/components/schemas/Document'
  1097. required: true
  1098. deprecated: false
  1099. parameters: []
  1100. /api/media_objects:
  1101. get:
  1102. operationId: api_media_objects_get_collection
  1103. tags:
  1104. - MediaObject
  1105. responses:
  1106. 200:
  1107. description: 'MediaObject collection'
  1108. content:
  1109. application/ld+json:
  1110. schema:
  1111. type: object
  1112. properties:
  1113. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' } }
  1114. 'hydra:totalItems': { type: integer, minimum: 0 }
  1115. '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 } }
  1116. '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 } } } } } }
  1117. required:
  1118. - 'hydra:member'
  1119. application/json:
  1120. schema:
  1121. type: array
  1122. items:
  1123. $ref: '#/components/schemas/MediaObject-media_object.read'
  1124. text/html:
  1125. schema:
  1126. type: array
  1127. items:
  1128. $ref: '#/components/schemas/MediaObject-media_object.read'
  1129. application/hal+json:
  1130. schema:
  1131. type: object
  1132. properties:
  1133. _embedded: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read' } }
  1134. totalItems: { type: integer, minimum: 0 }
  1135. itemsPerPage: { type: integer, minimum: 0 }
  1136. _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 } } } } }
  1137. required:
  1138. - _links
  1139. - _embedded
  1140. summary: 'Retrieves the collection of MediaObject resources.'
  1141. description: 'Retrieves the collection of MediaObject resources.'
  1142. parameters:
  1143. -
  1144. name: page
  1145. in: query
  1146. description: 'The collection page number'
  1147. required: false
  1148. deprecated: false
  1149. allowEmptyValue: true
  1150. schema:
  1151. type: integer
  1152. default: 1
  1153. style: form
  1154. explode: false
  1155. allowReserved: false
  1156. -
  1157. name: itemsPerPage
  1158. in: query
  1159. description: 'The number of items per page'
  1160. required: false
  1161. deprecated: false
  1162. allowEmptyValue: true
  1163. schema:
  1164. type: integer
  1165. default: 10
  1166. minimum: 0
  1167. maximum: 50
  1168. style: form
  1169. explode: false
  1170. allowReserved: false
  1171. deprecated: false
  1172. post:
  1173. operationId: api_media_objects_post
  1174. tags:
  1175. - MediaObject
  1176. responses:
  1177. 201:
  1178. description: 'MediaObject resource created'
  1179. content:
  1180. application/ld+json:
  1181. schema:
  1182. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  1183. application/json:
  1184. schema:
  1185. $ref: '#/components/schemas/MediaObject-media_object.read'
  1186. text/html:
  1187. schema:
  1188. $ref: '#/components/schemas/MediaObject-media_object.read'
  1189. application/hal+json:
  1190. schema:
  1191. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  1192. links: { }
  1193. 400:
  1194. description: 'Invalid input'
  1195. 422:
  1196. description: 'Unprocessable entity'
  1197. summary: 'Creates a MediaObject resource.'
  1198. description: 'Creates a MediaObject resource.'
  1199. parameters: []
  1200. requestBody:
  1201. description: ''
  1202. content:
  1203. multipart/form-data:
  1204. schema:
  1205. type: object
  1206. properties:
  1207. file:
  1208. type: string
  1209. format: binary
  1210. required: false
  1211. deprecated: false
  1212. parameters: []
  1213. '/api/media_objects/{id}':
  1214. get:
  1215. operationId: api_media_objects_id_get
  1216. tags:
  1217. - MediaObject
  1218. responses:
  1219. 200:
  1220. description: 'MediaObject resource'
  1221. content:
  1222. application/ld+json:
  1223. schema:
  1224. $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
  1225. application/json:
  1226. schema:
  1227. $ref: '#/components/schemas/MediaObject-media_object.read'
  1228. text/html:
  1229. schema:
  1230. $ref: '#/components/schemas/MediaObject-media_object.read'
  1231. application/hal+json:
  1232. schema:
  1233. $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
  1234. 404:
  1235. description: 'Resource not found'
  1236. summary: 'Retrieves a MediaObject resource.'
  1237. description: 'Retrieves a MediaObject resource.'
  1238. parameters:
  1239. -
  1240. name: id
  1241. in: path
  1242. description: 'MediaObject identifier'
  1243. required: true
  1244. deprecated: false
  1245. allowEmptyValue: false
  1246. schema:
  1247. type: string
  1248. style: simple
  1249. explode: false
  1250. allowReserved: false
  1251. deprecated: false
  1252. delete:
  1253. operationId: api_media_objects_id_delete
  1254. tags:
  1255. - MediaObject
  1256. responses:
  1257. 204:
  1258. description: 'MediaObject resource deleted'
  1259. 404:
  1260. description: 'Resource not found'
  1261. summary: 'Removes the MediaObject resource.'
  1262. description: 'Removes the MediaObject resource.'
  1263. parameters:
  1264. -
  1265. name: id
  1266. in: path
  1267. description: 'MediaObject identifier'
  1268. required: true
  1269. deprecated: false
  1270. allowEmptyValue: false
  1271. schema:
  1272. type: string
  1273. style: simple
  1274. explode: false
  1275. allowReserved: false
  1276. deprecated: false
  1277. parameters: []
  1278. /api/partner_follows:
  1279. get:
  1280. operationId: api_partner_follows_get_collection
  1281. tags:
  1282. - PartnerFollow
  1283. responses:
  1284. 200:
  1285. description: 'PartnerFollow collection'
  1286. content:
  1287. application/ld+json:
  1288. schema:
  1289. type: object
  1290. properties:
  1291. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/PartnerFollow.jsonld' } }
  1292. 'hydra:totalItems': { type: integer, minimum: 0 }
  1293. '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 } }
  1294. '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 } } } } } }
  1295. required:
  1296. - 'hydra:member'
  1297. application/json:
  1298. schema:
  1299. type: array
  1300. items:
  1301. $ref: '#/components/schemas/PartnerFollow'
  1302. text/html:
  1303. schema:
  1304. type: array
  1305. items:
  1306. $ref: '#/components/schemas/PartnerFollow'
  1307. application/hal+json:
  1308. schema:
  1309. type: object
  1310. properties:
  1311. _embedded: { type: array, items: { $ref: '#/components/schemas/PartnerFollow.jsonhal' } }
  1312. totalItems: { type: integer, minimum: 0 }
  1313. itemsPerPage: { type: integer, minimum: 0 }
  1314. _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 } } } } }
  1315. required:
  1316. - _links
  1317. - _embedded
  1318. summary: 'Retrieves the collection of PartnerFollow resources.'
  1319. description: 'Retrieves the collection of PartnerFollow resources.'
  1320. parameters:
  1321. -
  1322. name: page
  1323. in: query
  1324. description: 'The collection page number'
  1325. required: false
  1326. deprecated: false
  1327. allowEmptyValue: true
  1328. schema:
  1329. type: integer
  1330. default: 1
  1331. style: form
  1332. explode: false
  1333. allowReserved: false
  1334. -
  1335. name: itemsPerPage
  1336. in: query
  1337. description: 'The number of items per page'
  1338. required: false
  1339. deprecated: false
  1340. allowEmptyValue: true
  1341. schema:
  1342. type: integer
  1343. default: 10
  1344. minimum: 0
  1345. maximum: 50
  1346. style: form
  1347. explode: false
  1348. allowReserved: false
  1349. -
  1350. name: partner
  1351. in: query
  1352. description: ''
  1353. required: false
  1354. deprecated: false
  1355. allowEmptyValue: true
  1356. schema:
  1357. type: string
  1358. style: form
  1359. explode: false
  1360. allowReserved: false
  1361. -
  1362. name: 'partner[]'
  1363. in: query
  1364. description: ''
  1365. required: false
  1366. deprecated: false
  1367. allowEmptyValue: true
  1368. schema:
  1369. type: array
  1370. items:
  1371. type: string
  1372. style: form
  1373. explode: true
  1374. allowReserved: false
  1375. -
  1376. name: user
  1377. in: query
  1378. description: ''
  1379. required: false
  1380. deprecated: false
  1381. allowEmptyValue: true
  1382. schema:
  1383. type: string
  1384. style: form
  1385. explode: false
  1386. allowReserved: false
  1387. -
  1388. name: 'user[]'
  1389. in: query
  1390. description: ''
  1391. required: false
  1392. deprecated: false
  1393. allowEmptyValue: true
  1394. schema:
  1395. type: array
  1396. items:
  1397. type: string
  1398. style: form
  1399. explode: true
  1400. allowReserved: false
  1401. deprecated: false
  1402. post:
  1403. operationId: api_partner_follows_post
  1404. tags:
  1405. - PartnerFollow
  1406. responses:
  1407. 201:
  1408. description: 'PartnerFollow resource created'
  1409. content:
  1410. application/ld+json:
  1411. schema:
  1412. $ref: '#/components/schemas/PartnerFollow.jsonld'
  1413. application/json:
  1414. schema:
  1415. $ref: '#/components/schemas/PartnerFollow'
  1416. text/html:
  1417. schema:
  1418. $ref: '#/components/schemas/PartnerFollow'
  1419. application/hal+json:
  1420. schema:
  1421. $ref: '#/components/schemas/PartnerFollow.jsonhal'
  1422. links: { }
  1423. 400:
  1424. description: 'Invalid input'
  1425. 422:
  1426. description: 'Unprocessable entity'
  1427. summary: 'Creates a PartnerFollow resource.'
  1428. description: 'Creates a PartnerFollow resource.'
  1429. parameters: []
  1430. requestBody:
  1431. description: 'The new PartnerFollow resource'
  1432. content:
  1433. application/ld+json:
  1434. schema:
  1435. $ref: '#/components/schemas/PartnerFollow.jsonld'
  1436. application/json:
  1437. schema:
  1438. $ref: '#/components/schemas/PartnerFollow'
  1439. text/html:
  1440. schema:
  1441. $ref: '#/components/schemas/PartnerFollow'
  1442. application/hal+json:
  1443. schema:
  1444. $ref: '#/components/schemas/PartnerFollow.jsonhal'
  1445. required: true
  1446. deprecated: false
  1447. parameters: []
  1448. '/api/partner_follows/{id}':
  1449. get:
  1450. operationId: api_partner_follows_id_get
  1451. tags:
  1452. - PartnerFollow
  1453. responses:
  1454. 200:
  1455. description: 'PartnerFollow resource'
  1456. content:
  1457. application/ld+json:
  1458. schema:
  1459. $ref: '#/components/schemas/PartnerFollow.jsonld'
  1460. application/json:
  1461. schema:
  1462. $ref: '#/components/schemas/PartnerFollow'
  1463. text/html:
  1464. schema:
  1465. $ref: '#/components/schemas/PartnerFollow'
  1466. application/hal+json:
  1467. schema:
  1468. $ref: '#/components/schemas/PartnerFollow.jsonhal'
  1469. 404:
  1470. description: 'Resource not found'
  1471. summary: 'Retrieves a PartnerFollow resource.'
  1472. description: 'Retrieves a PartnerFollow resource.'
  1473. parameters:
  1474. -
  1475. name: id
  1476. in: path
  1477. description: 'PartnerFollow identifier'
  1478. required: true
  1479. deprecated: false
  1480. allowEmptyValue: false
  1481. schema:
  1482. type: string
  1483. style: simple
  1484. explode: false
  1485. allowReserved: false
  1486. deprecated: false
  1487. delete:
  1488. operationId: api_partner_follows_id_delete
  1489. tags:
  1490. - PartnerFollow
  1491. responses:
  1492. 204:
  1493. description: 'PartnerFollow resource deleted'
  1494. 404:
  1495. description: 'Resource not found'
  1496. summary: 'Removes the PartnerFollow resource.'
  1497. description: 'Removes the PartnerFollow resource.'
  1498. parameters:
  1499. -
  1500. name: id
  1501. in: path
  1502. description: 'PartnerFollow identifier'
  1503. required: true
  1504. deprecated: false
  1505. allowEmptyValue: false
  1506. schema:
  1507. type: string
  1508. style: simple
  1509. explode: false
  1510. allowReserved: false
  1511. deprecated: false
  1512. parameters: []
  1513. /api/partner_products:
  1514. get:
  1515. operationId: api_partner_products_get_collection
  1516. tags:
  1517. - PartnerProduct
  1518. responses:
  1519. 200:
  1520. description: 'PartnerProduct collection'
  1521. content:
  1522. application/ld+json:
  1523. schema:
  1524. type: object
  1525. properties:
  1526. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/PartnerProduct.jsonld' } }
  1527. 'hydra:totalItems': { type: integer, minimum: 0 }
  1528. '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 } }
  1529. '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 } } } } } }
  1530. required:
  1531. - 'hydra:member'
  1532. application/json:
  1533. schema:
  1534. type: array
  1535. items:
  1536. $ref: '#/components/schemas/PartnerProduct'
  1537. text/html:
  1538. schema:
  1539. type: array
  1540. items:
  1541. $ref: '#/components/schemas/PartnerProduct'
  1542. application/hal+json:
  1543. schema:
  1544. type: object
  1545. properties:
  1546. _embedded: { type: array, items: { $ref: '#/components/schemas/PartnerProduct.jsonhal' } }
  1547. totalItems: { type: integer, minimum: 0 }
  1548. itemsPerPage: { type: integer, minimum: 0 }
  1549. _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 } } } } }
  1550. required:
  1551. - _links
  1552. - _embedded
  1553. summary: 'Retrieves the collection of PartnerProduct resources.'
  1554. description: 'Retrieves the collection of PartnerProduct resources.'
  1555. parameters:
  1556. -
  1557. name: page
  1558. in: query
  1559. description: 'The collection page number'
  1560. required: false
  1561. deprecated: false
  1562. allowEmptyValue: true
  1563. schema:
  1564. type: integer
  1565. default: 1
  1566. style: form
  1567. explode: false
  1568. allowReserved: false
  1569. -
  1570. name: itemsPerPage
  1571. in: query
  1572. description: 'The number of items per page'
  1573. required: false
  1574. deprecated: false
  1575. allowEmptyValue: true
  1576. schema:
  1577. type: integer
  1578. default: 10
  1579. minimum: 0
  1580. maximum: 50
  1581. style: form
  1582. explode: false
  1583. allowReserved: false
  1584. -
  1585. name: partner
  1586. in: query
  1587. description: ''
  1588. required: false
  1589. deprecated: false
  1590. allowEmptyValue: true
  1591. schema:
  1592. type: string
  1593. style: form
  1594. explode: false
  1595. allowReserved: false
  1596. -
  1597. name: 'partner[]'
  1598. in: query
  1599. description: ''
  1600. required: false
  1601. deprecated: false
  1602. allowEmptyValue: true
  1603. schema:
  1604. type: array
  1605. items:
  1606. type: string
  1607. style: form
  1608. explode: true
  1609. allowReserved: false
  1610. -
  1611. name: product
  1612. in: query
  1613. description: ''
  1614. required: false
  1615. deprecated: false
  1616. allowEmptyValue: true
  1617. schema:
  1618. type: string
  1619. style: form
  1620. explode: false
  1621. allowReserved: false
  1622. -
  1623. name: 'product[]'
  1624. in: query
  1625. description: ''
  1626. required: false
  1627. deprecated: false
  1628. allowEmptyValue: true
  1629. schema:
  1630. type: array
  1631. items:
  1632. type: string
  1633. style: form
  1634. explode: true
  1635. allowReserved: false
  1636. deprecated: false
  1637. post:
  1638. operationId: api_partner_products_post
  1639. tags:
  1640. - PartnerProduct
  1641. responses:
  1642. 201:
  1643. description: 'PartnerProduct resource created'
  1644. content:
  1645. application/ld+json:
  1646. schema:
  1647. $ref: '#/components/schemas/PartnerProduct.jsonld'
  1648. application/json:
  1649. schema:
  1650. $ref: '#/components/schemas/PartnerProduct'
  1651. text/html:
  1652. schema:
  1653. $ref: '#/components/schemas/PartnerProduct'
  1654. application/hal+json:
  1655. schema:
  1656. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  1657. links: { }
  1658. 400:
  1659. description: 'Invalid input'
  1660. 422:
  1661. description: 'Unprocessable entity'
  1662. summary: 'Creates a PartnerProduct resource.'
  1663. description: 'Creates a PartnerProduct resource.'
  1664. parameters: []
  1665. requestBody:
  1666. description: 'The new PartnerProduct resource'
  1667. content:
  1668. application/ld+json:
  1669. schema:
  1670. $ref: '#/components/schemas/PartnerProduct.jsonld'
  1671. application/json:
  1672. schema:
  1673. $ref: '#/components/schemas/PartnerProduct'
  1674. text/html:
  1675. schema:
  1676. $ref: '#/components/schemas/PartnerProduct'
  1677. application/hal+json:
  1678. schema:
  1679. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  1680. required: true
  1681. deprecated: false
  1682. parameters: []
  1683. '/api/partner_products/{id}':
  1684. get:
  1685. operationId: api_partner_products_id_get
  1686. tags:
  1687. - PartnerProduct
  1688. responses:
  1689. 200:
  1690. description: 'PartnerProduct resource'
  1691. content:
  1692. application/ld+json:
  1693. schema:
  1694. $ref: '#/components/schemas/PartnerProduct.jsonld'
  1695. application/json:
  1696. schema:
  1697. $ref: '#/components/schemas/PartnerProduct'
  1698. text/html:
  1699. schema:
  1700. $ref: '#/components/schemas/PartnerProduct'
  1701. application/hal+json:
  1702. schema:
  1703. $ref: '#/components/schemas/PartnerProduct.jsonhal'
  1704. 404:
  1705. description: 'Resource not found'
  1706. summary: 'Retrieves a PartnerProduct resource.'
  1707. description: 'Retrieves a PartnerProduct resource.'
  1708. parameters:
  1709. -
  1710. name: id
  1711. in: path
  1712. description: 'PartnerProduct identifier'
  1713. required: true
  1714. deprecated: false
  1715. allowEmptyValue: false
  1716. schema:
  1717. type: string
  1718. style: simple
  1719. explode: false
  1720. allowReserved: false
  1721. deprecated: false
  1722. delete:
  1723. operationId: api_partner_products_id_delete
  1724. tags:
  1725. - PartnerProduct
  1726. responses:
  1727. 204:
  1728. description: 'PartnerProduct resource deleted'
  1729. 404:
  1730. description: 'Resource not found'
  1731. summary: 'Removes the PartnerProduct resource.'
  1732. description: 'Removes the PartnerProduct resource.'
  1733. parameters:
  1734. -
  1735. name: id
  1736. in: path
  1737. description: 'PartnerProduct identifier'
  1738. required: true
  1739. deprecated: false
  1740. allowEmptyValue: false
  1741. schema:
  1742. type: string
  1743. style: simple
  1744. explode: false
  1745. allowReserved: false
  1746. deprecated: false
  1747. parameters: []
  1748. /api/partners:
  1749. get:
  1750. operationId: api_partners_get_collection
  1751. tags:
  1752. - Partner
  1753. responses:
  1754. 200:
  1755. description: 'Partner collection'
  1756. content:
  1757. application/ld+json:
  1758. schema:
  1759. type: object
  1760. properties:
  1761. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.jsonld' } }
  1762. 'hydra:totalItems': { type: integer, minimum: 0 }
  1763. '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 } }
  1764. '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 } } } } } }
  1765. required:
  1766. - 'hydra:member'
  1767. application/json:
  1768. schema:
  1769. type: array
  1770. items:
  1771. $ref: '#/components/schemas/Partner'
  1772. text/html:
  1773. schema:
  1774. type: array
  1775. items:
  1776. $ref: '#/components/schemas/Partner'
  1777. application/hal+json:
  1778. schema:
  1779. type: object
  1780. properties:
  1781. _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.jsonhal' } }
  1782. totalItems: { type: integer, minimum: 0 }
  1783. itemsPerPage: { type: integer, minimum: 0 }
  1784. _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 } } } } }
  1785. required:
  1786. - _links
  1787. - _embedded
  1788. summary: 'Retrieves the collection of Partner resources.'
  1789. description: 'Retrieves the collection of Partner resources.'
  1790. parameters:
  1791. -
  1792. name: page
  1793. in: query
  1794. description: 'The collection page number'
  1795. required: false
  1796. deprecated: false
  1797. allowEmptyValue: true
  1798. schema:
  1799. type: integer
  1800. default: 1
  1801. style: form
  1802. explode: false
  1803. allowReserved: false
  1804. -
  1805. name: itemsPerPage
  1806. in: query
  1807. description: 'The number of items per page'
  1808. required: false
  1809. deprecated: false
  1810. allowEmptyValue: true
  1811. schema:
  1812. type: integer
  1813. default: 10
  1814. minimum: 0
  1815. maximum: 50
  1816. style: form
  1817. explode: false
  1818. allowReserved: false
  1819. -
  1820. name: type
  1821. in: query
  1822. description: ''
  1823. required: false
  1824. deprecated: false
  1825. allowEmptyValue: true
  1826. schema:
  1827. type: string
  1828. style: form
  1829. explode: false
  1830. allowReserved: false
  1831. -
  1832. name: 'type[]'
  1833. in: query
  1834. description: ''
  1835. required: false
  1836. deprecated: false
  1837. allowEmptyValue: true
  1838. schema:
  1839. type: array
  1840. items:
  1841. type: string
  1842. style: form
  1843. explode: true
  1844. allowReserved: false
  1845. -
  1846. name: name
  1847. in: query
  1848. description: ''
  1849. required: false
  1850. deprecated: false
  1851. allowEmptyValue: true
  1852. schema:
  1853. type: string
  1854. style: form
  1855. explode: false
  1856. allowReserved: false
  1857. -
  1858. name: 'order[name]'
  1859. in: query
  1860. description: ''
  1861. required: false
  1862. deprecated: false
  1863. allowEmptyValue: true
  1864. schema:
  1865. type: string
  1866. enum:
  1867. - asc
  1868. - desc
  1869. style: form
  1870. explode: false
  1871. allowReserved: false
  1872. -
  1873. name: 'order[city]'
  1874. in: query
  1875. description: ''
  1876. required: false
  1877. deprecated: false
  1878. allowEmptyValue: true
  1879. schema:
  1880. type: string
  1881. enum:
  1882. - asc
  1883. - desc
  1884. style: form
  1885. explode: false
  1886. allowReserved: false
  1887. -
  1888. name: 'order[website]'
  1889. in: query
  1890. description: ''
  1891. required: false
  1892. deprecated: false
  1893. allowEmptyValue: true
  1894. schema:
  1895. type: string
  1896. enum:
  1897. - asc
  1898. - desc
  1899. style: form
  1900. explode: false
  1901. allowReserved: false
  1902. deprecated: false
  1903. post:
  1904. operationId: api_partners_post
  1905. tags:
  1906. - Partner
  1907. responses:
  1908. 201:
  1909. description: 'Partner resource created'
  1910. content:
  1911. application/ld+json:
  1912. schema:
  1913. $ref: '#/components/schemas/Partner.jsonld'
  1914. application/json:
  1915. schema:
  1916. $ref: '#/components/schemas/Partner'
  1917. text/html:
  1918. schema:
  1919. $ref: '#/components/schemas/Partner'
  1920. application/hal+json:
  1921. schema:
  1922. $ref: '#/components/schemas/Partner.jsonhal'
  1923. links: { }
  1924. 400:
  1925. description: 'Invalid input'
  1926. 422:
  1927. description: 'Unprocessable entity'
  1928. summary: 'Creates a Partner resource.'
  1929. description: 'Creates a Partner resource.'
  1930. parameters: []
  1931. requestBody:
  1932. description: 'The new Partner resource'
  1933. content:
  1934. application/ld+json:
  1935. schema:
  1936. $ref: '#/components/schemas/Partner.jsonld'
  1937. application/json:
  1938. schema:
  1939. $ref: '#/components/schemas/Partner'
  1940. text/html:
  1941. schema:
  1942. $ref: '#/components/schemas/Partner'
  1943. application/hal+json:
  1944. schema:
  1945. $ref: '#/components/schemas/Partner.jsonhal'
  1946. required: true
  1947. deprecated: false
  1948. parameters: []
  1949. '/api/partners/{id}':
  1950. get:
  1951. operationId: api_partners_id_get
  1952. tags:
  1953. - Partner
  1954. responses:
  1955. 200:
  1956. description: 'Partner resource'
  1957. content:
  1958. application/ld+json:
  1959. schema:
  1960. $ref: '#/components/schemas/Partner.jsonld'
  1961. application/json:
  1962. schema:
  1963. $ref: '#/components/schemas/Partner'
  1964. text/html:
  1965. schema:
  1966. $ref: '#/components/schemas/Partner'
  1967. application/hal+json:
  1968. schema:
  1969. $ref: '#/components/schemas/Partner.jsonhal'
  1970. 404:
  1971. description: 'Resource not found'
  1972. summary: 'Retrieves a Partner resource.'
  1973. description: 'Retrieves a Partner resource.'
  1974. parameters:
  1975. -
  1976. name: id
  1977. in: path
  1978. description: 'Partner identifier'
  1979. required: true
  1980. deprecated: false
  1981. allowEmptyValue: false
  1982. schema:
  1983. type: string
  1984. style: simple
  1985. explode: false
  1986. allowReserved: false
  1987. deprecated: false
  1988. patch:
  1989. operationId: api_partners_id_patch
  1990. tags:
  1991. - Partner
  1992. responses:
  1993. 200:
  1994. description: 'Partner resource updated'
  1995. content:
  1996. application/ld+json:
  1997. schema:
  1998. $ref: '#/components/schemas/Partner.jsonld'
  1999. application/json:
  2000. schema:
  2001. $ref: '#/components/schemas/Partner'
  2002. text/html:
  2003. schema:
  2004. $ref: '#/components/schemas/Partner'
  2005. application/hal+json:
  2006. schema:
  2007. $ref: '#/components/schemas/Partner.jsonhal'
  2008. links: { }
  2009. 400:
  2010. description: 'Invalid input'
  2011. 422:
  2012. description: 'Unprocessable entity'
  2013. 404:
  2014. description: 'Resource not found'
  2015. summary: 'Updates the Partner resource.'
  2016. description: 'Updates the Partner resource.'
  2017. parameters:
  2018. -
  2019. name: id
  2020. in: path
  2021. description: 'Partner identifier'
  2022. required: true
  2023. deprecated: false
  2024. allowEmptyValue: false
  2025. schema:
  2026. type: string
  2027. style: simple
  2028. explode: false
  2029. allowReserved: false
  2030. requestBody:
  2031. description: 'The updated Partner resource'
  2032. content:
  2033. application/merge-patch+json:
  2034. schema:
  2035. $ref: '#/components/schemas/Partner'
  2036. required: true
  2037. deprecated: false
  2038. parameters: []
  2039. /api/posts:
  2040. get:
  2041. operationId: api_posts_get_collection
  2042. tags:
  2043. - Post
  2044. responses:
  2045. 200:
  2046. description: 'Post collection'
  2047. content:
  2048. application/ld+json:
  2049. schema:
  2050. type: object
  2051. properties:
  2052. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.jsonld' } }
  2053. 'hydra:totalItems': { type: integer, minimum: 0 }
  2054. '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 } }
  2055. '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 } } } } } }
  2056. required:
  2057. - 'hydra:member'
  2058. application/json:
  2059. schema:
  2060. type: array
  2061. items:
  2062. $ref: '#/components/schemas/Post'
  2063. text/html:
  2064. schema:
  2065. type: array
  2066. items:
  2067. $ref: '#/components/schemas/Post'
  2068. application/hal+json:
  2069. schema:
  2070. type: object
  2071. properties:
  2072. _embedded: { type: array, items: { $ref: '#/components/schemas/Post.jsonhal' } }
  2073. totalItems: { type: integer, minimum: 0 }
  2074. itemsPerPage: { type: integer, minimum: 0 }
  2075. _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 } } } } }
  2076. required:
  2077. - _links
  2078. - _embedded
  2079. summary: 'Retrieves the collection of Post resources.'
  2080. description: 'Retrieves the collection of Post resources.'
  2081. parameters:
  2082. -
  2083. name: page
  2084. in: query
  2085. description: 'The collection page number'
  2086. required: false
  2087. deprecated: false
  2088. allowEmptyValue: true
  2089. schema:
  2090. type: integer
  2091. default: 1
  2092. style: form
  2093. explode: false
  2094. allowReserved: false
  2095. -
  2096. name: itemsPerPage
  2097. in: query
  2098. description: 'The number of items per page'
  2099. required: false
  2100. deprecated: false
  2101. allowEmptyValue: true
  2102. schema:
  2103. type: integer
  2104. default: 10
  2105. minimum: 0
  2106. maximum: 50
  2107. style: form
  2108. explode: false
  2109. allowReserved: false
  2110. -
  2111. name: partner
  2112. in: query
  2113. description: ''
  2114. required: false
  2115. deprecated: false
  2116. allowEmptyValue: true
  2117. schema:
  2118. type: string
  2119. style: form
  2120. explode: false
  2121. allowReserved: false
  2122. -
  2123. name: 'partner[]'
  2124. in: query
  2125. description: ''
  2126. required: false
  2127. deprecated: false
  2128. allowEmptyValue: true
  2129. schema:
  2130. type: array
  2131. items:
  2132. type: string
  2133. style: form
  2134. explode: true
  2135. allowReserved: false
  2136. -
  2137. name: contact
  2138. in: query
  2139. description: ''
  2140. required: false
  2141. deprecated: false
  2142. allowEmptyValue: true
  2143. schema:
  2144. type: string
  2145. style: form
  2146. explode: false
  2147. allowReserved: false
  2148. -
  2149. name: 'contact[]'
  2150. in: query
  2151. description: ''
  2152. required: false
  2153. deprecated: false
  2154. allowEmptyValue: true
  2155. schema:
  2156. type: array
  2157. items:
  2158. type: string
  2159. style: form
  2160. explode: true
  2161. allowReserved: false
  2162. -
  2163. name: sale
  2164. in: query
  2165. description: ''
  2166. required: false
  2167. deprecated: false
  2168. allowEmptyValue: true
  2169. schema:
  2170. type: string
  2171. style: form
  2172. explode: false
  2173. allowReserved: false
  2174. -
  2175. name: 'sale[]'
  2176. in: query
  2177. description: ''
  2178. required: false
  2179. deprecated: false
  2180. allowEmptyValue: true
  2181. schema:
  2182. type: array
  2183. items:
  2184. type: string
  2185. style: form
  2186. explode: true
  2187. allowReserved: false
  2188. -
  2189. name: 'exists[contact]'
  2190. in: query
  2191. description: ''
  2192. required: false
  2193. deprecated: false
  2194. allowEmptyValue: true
  2195. schema:
  2196. type: boolean
  2197. style: form
  2198. explode: false
  2199. allowReserved: false
  2200. -
  2201. name: 'exists[sale]'
  2202. in: query
  2203. description: ''
  2204. required: false
  2205. deprecated: false
  2206. allowEmptyValue: true
  2207. schema:
  2208. type: boolean
  2209. style: form
  2210. explode: false
  2211. allowReserved: false
  2212. deprecated: false
  2213. post:
  2214. operationId: api_posts_post
  2215. tags:
  2216. - Post
  2217. responses:
  2218. 201:
  2219. description: 'Post resource created'
  2220. content:
  2221. application/ld+json:
  2222. schema:
  2223. $ref: '#/components/schemas/Post.jsonld'
  2224. application/json:
  2225. schema:
  2226. $ref: '#/components/schemas/Post'
  2227. text/html:
  2228. schema:
  2229. $ref: '#/components/schemas/Post'
  2230. application/hal+json:
  2231. schema:
  2232. $ref: '#/components/schemas/Post.jsonhal'
  2233. links: { }
  2234. 400:
  2235. description: 'Invalid input'
  2236. 422:
  2237. description: 'Unprocessable entity'
  2238. summary: 'Creates a Post resource.'
  2239. description: 'Creates a Post resource.'
  2240. parameters: []
  2241. requestBody:
  2242. description: 'The new Post resource'
  2243. content:
  2244. application/ld+json:
  2245. schema:
  2246. $ref: '#/components/schemas/Post.jsonld-posting.create'
  2247. application/json:
  2248. schema:
  2249. $ref: '#/components/schemas/Post-posting.create'
  2250. text/html:
  2251. schema:
  2252. $ref: '#/components/schemas/Post-posting.create'
  2253. application/hal+json:
  2254. schema:
  2255. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  2256. required: true
  2257. deprecated: false
  2258. parameters: []
  2259. '/api/posts/{id}':
  2260. get:
  2261. operationId: api_posts_id_get
  2262. tags:
  2263. - Post
  2264. responses:
  2265. 200:
  2266. description: 'Post resource'
  2267. content:
  2268. application/ld+json:
  2269. schema:
  2270. $ref: '#/components/schemas/Post.jsonld'
  2271. application/json:
  2272. schema:
  2273. $ref: '#/components/schemas/Post'
  2274. text/html:
  2275. schema:
  2276. $ref: '#/components/schemas/Post'
  2277. application/hal+json:
  2278. schema:
  2279. $ref: '#/components/schemas/Post.jsonhal'
  2280. 404:
  2281. description: 'Resource not found'
  2282. summary: 'Retrieves a Post resource.'
  2283. description: 'Retrieves a Post resource.'
  2284. parameters:
  2285. -
  2286. name: id
  2287. in: path
  2288. description: 'Post identifier'
  2289. required: true
  2290. deprecated: false
  2291. allowEmptyValue: false
  2292. schema:
  2293. type: string
  2294. style: simple
  2295. explode: false
  2296. allowReserved: false
  2297. deprecated: false
  2298. patch:
  2299. operationId: api_posts_id_patch
  2300. tags:
  2301. - Post
  2302. responses:
  2303. 200:
  2304. description: 'Post resource updated'
  2305. content:
  2306. application/ld+json:
  2307. schema:
  2308. $ref: '#/components/schemas/Post.jsonld'
  2309. application/json:
  2310. schema:
  2311. $ref: '#/components/schemas/Post'
  2312. text/html:
  2313. schema:
  2314. $ref: '#/components/schemas/Post'
  2315. application/hal+json:
  2316. schema:
  2317. $ref: '#/components/schemas/Post.jsonhal'
  2318. links: { }
  2319. 400:
  2320. description: 'Invalid input'
  2321. 422:
  2322. description: 'Unprocessable entity'
  2323. 404:
  2324. description: 'Resource not found'
  2325. summary: 'Updates the Post resource.'
  2326. description: 'Updates the Post resource.'
  2327. parameters:
  2328. -
  2329. name: id
  2330. in: path
  2331. description: 'Post identifier'
  2332. required: true
  2333. deprecated: false
  2334. allowEmptyValue: false
  2335. schema:
  2336. type: string
  2337. style: simple
  2338. explode: false
  2339. allowReserved: false
  2340. requestBody:
  2341. description: 'The updated Post resource'
  2342. content:
  2343. application/merge-patch+json:
  2344. schema:
  2345. $ref: '#/components/schemas/Post-posting.patch'
  2346. required: true
  2347. deprecated: false
  2348. parameters: []
  2349. /api/products:
  2350. get:
  2351. operationId: api_products_get_collection
  2352. tags:
  2353. - Product
  2354. responses:
  2355. 200:
  2356. description: 'Product collection'
  2357. content:
  2358. application/ld+json:
  2359. schema:
  2360. type: object
  2361. properties:
  2362. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  2363. 'hydra:totalItems': { type: integer, minimum: 0 }
  2364. '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 } }
  2365. '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 } } } } } }
  2366. required:
  2367. - 'hydra:member'
  2368. application/json:
  2369. schema:
  2370. type: array
  2371. items:
  2372. $ref: '#/components/schemas/Product'
  2373. text/html:
  2374. schema:
  2375. type: array
  2376. items:
  2377. $ref: '#/components/schemas/Product'
  2378. application/hal+json:
  2379. schema:
  2380. type: object
  2381. properties:
  2382. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  2383. totalItems: { type: integer, minimum: 0 }
  2384. itemsPerPage: { type: integer, minimum: 0 }
  2385. _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 } } } } }
  2386. required:
  2387. - _links
  2388. - _embedded
  2389. summary: 'Retrieves the collection of Product resources.'
  2390. description: 'Retrieves the collection of Product resources.'
  2391. parameters:
  2392. -
  2393. name: page
  2394. in: query
  2395. description: 'The collection page number'
  2396. required: false
  2397. deprecated: false
  2398. allowEmptyValue: true
  2399. schema:
  2400. type: integer
  2401. default: 1
  2402. style: form
  2403. explode: false
  2404. allowReserved: false
  2405. -
  2406. name: itemsPerPage
  2407. in: query
  2408. description: 'The number of items per page'
  2409. required: false
  2410. deprecated: false
  2411. allowEmptyValue: true
  2412. schema:
  2413. type: integer
  2414. default: 10
  2415. minimum: 0
  2416. maximum: 50
  2417. style: form
  2418. explode: false
  2419. allowReserved: false
  2420. -
  2421. name: name
  2422. in: query
  2423. description: ''
  2424. required: false
  2425. deprecated: false
  2426. allowEmptyValue: true
  2427. schema:
  2428. type: string
  2429. style: form
  2430. explode: false
  2431. allowReserved: false
  2432. -
  2433. name: 'order[name]'
  2434. in: query
  2435. description: ''
  2436. required: false
  2437. deprecated: false
  2438. allowEmptyValue: true
  2439. schema:
  2440. type: string
  2441. enum:
  2442. - asc
  2443. - desc
  2444. style: form
  2445. explode: false
  2446. allowReserved: false
  2447. deprecated: false
  2448. post:
  2449. operationId: api_products_post
  2450. tags:
  2451. - Product
  2452. responses:
  2453. 201:
  2454. description: 'Product resource created'
  2455. content:
  2456. application/ld+json:
  2457. schema:
  2458. $ref: '#/components/schemas/Product.jsonld'
  2459. application/json:
  2460. schema:
  2461. $ref: '#/components/schemas/Product'
  2462. text/html:
  2463. schema:
  2464. $ref: '#/components/schemas/Product'
  2465. application/hal+json:
  2466. schema:
  2467. $ref: '#/components/schemas/Product.jsonhal'
  2468. links: { }
  2469. 400:
  2470. description: 'Invalid input'
  2471. 422:
  2472. description: 'Unprocessable entity'
  2473. summary: 'Creates a Product resource.'
  2474. description: 'Creates a Product resource.'
  2475. parameters: []
  2476. requestBody:
  2477. description: 'The new Product resource'
  2478. content:
  2479. application/ld+json:
  2480. schema:
  2481. $ref: '#/components/schemas/Product.jsonld'
  2482. application/json:
  2483. schema:
  2484. $ref: '#/components/schemas/Product'
  2485. text/html:
  2486. schema:
  2487. $ref: '#/components/schemas/Product'
  2488. application/hal+json:
  2489. schema:
  2490. $ref: '#/components/schemas/Product.jsonhal'
  2491. required: true
  2492. deprecated: false
  2493. parameters: []
  2494. '/api/products/{id}':
  2495. get:
  2496. operationId: api_products_id_get
  2497. tags:
  2498. - Product
  2499. responses:
  2500. 200:
  2501. description: 'Product resource'
  2502. content:
  2503. application/ld+json:
  2504. schema:
  2505. $ref: '#/components/schemas/Product.jsonld'
  2506. application/json:
  2507. schema:
  2508. $ref: '#/components/schemas/Product'
  2509. text/html:
  2510. schema:
  2511. $ref: '#/components/schemas/Product'
  2512. application/hal+json:
  2513. schema:
  2514. $ref: '#/components/schemas/Product.jsonhal'
  2515. 404:
  2516. description: 'Resource not found'
  2517. summary: 'Retrieves a Product resource.'
  2518. description: 'Retrieves a Product resource.'
  2519. parameters:
  2520. -
  2521. name: id
  2522. in: path
  2523. description: 'Product identifier'
  2524. required: true
  2525. deprecated: false
  2526. allowEmptyValue: false
  2527. schema:
  2528. type: string
  2529. style: simple
  2530. explode: false
  2531. allowReserved: false
  2532. deprecated: false
  2533. patch:
  2534. operationId: api_products_id_patch
  2535. tags:
  2536. - Product
  2537. responses:
  2538. 200:
  2539. description: 'Product resource updated'
  2540. content:
  2541. application/ld+json:
  2542. schema:
  2543. $ref: '#/components/schemas/Product.jsonld'
  2544. application/json:
  2545. schema:
  2546. $ref: '#/components/schemas/Product'
  2547. text/html:
  2548. schema:
  2549. $ref: '#/components/schemas/Product'
  2550. application/hal+json:
  2551. schema:
  2552. $ref: '#/components/schemas/Product.jsonhal'
  2553. links: { }
  2554. 400:
  2555. description: 'Invalid input'
  2556. 422:
  2557. description: 'Unprocessable entity'
  2558. 404:
  2559. description: 'Resource not found'
  2560. summary: 'Updates the Product resource.'
  2561. description: 'Updates the Product resource.'
  2562. parameters:
  2563. -
  2564. name: id
  2565. in: path
  2566. description: 'Product identifier'
  2567. required: true
  2568. deprecated: false
  2569. allowEmptyValue: false
  2570. schema:
  2571. type: string
  2572. style: simple
  2573. explode: false
  2574. allowReserved: false
  2575. requestBody:
  2576. description: 'The updated Product resource'
  2577. content:
  2578. application/merge-patch+json:
  2579. schema:
  2580. $ref: '#/components/schemas/Product'
  2581. required: true
  2582. deprecated: false
  2583. parameters: []
  2584. /api/sale_summaries:
  2585. get:
  2586. operationId: api_sale_summaries_get_collection
  2587. tags:
  2588. - SaleSummary
  2589. responses:
  2590. 200:
  2591. description: 'SaleSummary collection'
  2592. content:
  2593. application/ld+json:
  2594. schema:
  2595. type: object
  2596. properties:
  2597. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonld' } }
  2598. 'hydra:totalItems': { type: integer, minimum: 0 }
  2599. '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 } }
  2600. '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 } } } } } }
  2601. required:
  2602. - 'hydra:member'
  2603. application/json:
  2604. schema:
  2605. type: array
  2606. items:
  2607. $ref: '#/components/schemas/SaleSummary'
  2608. text/html:
  2609. schema:
  2610. type: array
  2611. items:
  2612. $ref: '#/components/schemas/SaleSummary'
  2613. application/hal+json:
  2614. schema:
  2615. type: object
  2616. properties:
  2617. _embedded: { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonhal' } }
  2618. totalItems: { type: integer, minimum: 0 }
  2619. itemsPerPage: { type: integer, minimum: 0 }
  2620. _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 } } } } }
  2621. required:
  2622. - _links
  2623. - _embedded
  2624. summary: 'Retrieves the collection of SaleSummary resources.'
  2625. description: 'Retrieves the collection of SaleSummary resources.'
  2626. parameters:
  2627. -
  2628. name: page
  2629. in: query
  2630. description: 'The collection page number'
  2631. required: false
  2632. deprecated: false
  2633. allowEmptyValue: true
  2634. schema:
  2635. type: integer
  2636. default: 1
  2637. style: form
  2638. explode: false
  2639. allowReserved: false
  2640. -
  2641. name: itemsPerPage
  2642. in: query
  2643. description: 'The number of items per page'
  2644. required: false
  2645. deprecated: false
  2646. allowEmptyValue: true
  2647. schema:
  2648. type: integer
  2649. default: 10
  2650. minimum: 0
  2651. maximum: 50
  2652. style: form
  2653. explode: false
  2654. allowReserved: false
  2655. deprecated: false
  2656. parameters: []
  2657. /api/sales:
  2658. get:
  2659. operationId: api_sales_get_collection
  2660. tags:
  2661. - Sale
  2662. responses:
  2663. 200:
  2664. description: 'Sale collection'
  2665. content:
  2666. application/ld+json:
  2667. schema:
  2668. type: object
  2669. properties:
  2670. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Sale.jsonld' } }
  2671. 'hydra:totalItems': { type: integer, minimum: 0 }
  2672. '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 } }
  2673. '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 } } } } } }
  2674. required:
  2675. - 'hydra:member'
  2676. application/json:
  2677. schema:
  2678. type: array
  2679. items:
  2680. $ref: '#/components/schemas/Sale'
  2681. text/html:
  2682. schema:
  2683. type: array
  2684. items:
  2685. $ref: '#/components/schemas/Sale'
  2686. application/hal+json:
  2687. schema:
  2688. type: object
  2689. properties:
  2690. _embedded: { type: array, items: { $ref: '#/components/schemas/Sale.jsonhal' } }
  2691. totalItems: { type: integer, minimum: 0 }
  2692. itemsPerPage: { type: integer, minimum: 0 }
  2693. _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 } } } } }
  2694. required:
  2695. - _links
  2696. - _embedded
  2697. summary: 'Retrieves the collection of Sale resources.'
  2698. description: 'Retrieves the collection of Sale resources.'
  2699. parameters:
  2700. -
  2701. name: page
  2702. in: query
  2703. description: 'The collection page number'
  2704. required: false
  2705. deprecated: false
  2706. allowEmptyValue: true
  2707. schema:
  2708. type: integer
  2709. default: 1
  2710. style: form
  2711. explode: false
  2712. allowReserved: false
  2713. -
  2714. name: itemsPerPage
  2715. in: query
  2716. description: 'The number of items per page'
  2717. required: false
  2718. deprecated: false
  2719. allowEmptyValue: true
  2720. schema:
  2721. type: integer
  2722. default: 10
  2723. minimum: 0
  2724. maximum: 50
  2725. style: form
  2726. explode: false
  2727. allowReserved: false
  2728. -
  2729. name: owner
  2730. in: query
  2731. description: ''
  2732. required: false
  2733. deprecated: false
  2734. allowEmptyValue: true
  2735. schema:
  2736. type: string
  2737. style: form
  2738. explode: false
  2739. allowReserved: false
  2740. -
  2741. name: 'owner[]'
  2742. in: query
  2743. description: ''
  2744. required: false
  2745. deprecated: false
  2746. allowEmptyValue: true
  2747. schema:
  2748. type: array
  2749. items:
  2750. type: string
  2751. style: form
  2752. explode: true
  2753. allowReserved: false
  2754. -
  2755. name: partner
  2756. in: query
  2757. description: ''
  2758. required: false
  2759. deprecated: false
  2760. allowEmptyValue: true
  2761. schema:
  2762. type: string
  2763. style: form
  2764. explode: false
  2765. allowReserved: false
  2766. -
  2767. name: 'partner[]'
  2768. in: query
  2769. description: ''
  2770. required: false
  2771. deprecated: false
  2772. allowEmptyValue: true
  2773. schema:
  2774. type: array
  2775. items:
  2776. type: string
  2777. style: form
  2778. explode: true
  2779. allowReserved: false
  2780. deprecated: false
  2781. post:
  2782. operationId: api_sales_post
  2783. tags:
  2784. - Sale
  2785. responses:
  2786. 201:
  2787. description: 'Sale resource created'
  2788. content:
  2789. application/ld+json:
  2790. schema:
  2791. $ref: '#/components/schemas/Sale.jsonld'
  2792. application/json:
  2793. schema:
  2794. $ref: '#/components/schemas/Sale'
  2795. text/html:
  2796. schema:
  2797. $ref: '#/components/schemas/Sale'
  2798. application/hal+json:
  2799. schema:
  2800. $ref: '#/components/schemas/Sale.jsonhal'
  2801. links: { }
  2802. 400:
  2803. description: 'Invalid input'
  2804. 422:
  2805. description: 'Unprocessable entity'
  2806. summary: 'Creates a Sale resource.'
  2807. description: 'Creates a Sale resource.'
  2808. parameters: []
  2809. requestBody:
  2810. description: 'The new Sale resource'
  2811. content:
  2812. application/ld+json:
  2813. schema:
  2814. $ref: '#/components/schemas/Sale.jsonld'
  2815. application/json:
  2816. schema:
  2817. $ref: '#/components/schemas/Sale'
  2818. text/html:
  2819. schema:
  2820. $ref: '#/components/schemas/Sale'
  2821. application/hal+json:
  2822. schema:
  2823. $ref: '#/components/schemas/Sale.jsonhal'
  2824. required: true
  2825. deprecated: false
  2826. parameters: []
  2827. '/api/sales/{id}':
  2828. get:
  2829. operationId: api_sales_id_get
  2830. tags:
  2831. - Sale
  2832. responses:
  2833. 200:
  2834. description: 'Sale resource'
  2835. content:
  2836. application/ld+json:
  2837. schema:
  2838. $ref: '#/components/schemas/Sale.jsonld'
  2839. application/json:
  2840. schema:
  2841. $ref: '#/components/schemas/Sale'
  2842. text/html:
  2843. schema:
  2844. $ref: '#/components/schemas/Sale'
  2845. application/hal+json:
  2846. schema:
  2847. $ref: '#/components/schemas/Sale.jsonhal'
  2848. 404:
  2849. description: 'Resource not found'
  2850. summary: 'Retrieves a Sale resource.'
  2851. description: 'Retrieves a Sale resource.'
  2852. parameters:
  2853. -
  2854. name: id
  2855. in: path
  2856. description: 'Sale identifier'
  2857. required: true
  2858. deprecated: false
  2859. allowEmptyValue: false
  2860. schema:
  2861. type: string
  2862. style: simple
  2863. explode: false
  2864. allowReserved: false
  2865. deprecated: false
  2866. patch:
  2867. operationId: api_sales_id_patch
  2868. tags:
  2869. - Sale
  2870. responses:
  2871. 200:
  2872. description: 'Sale resource updated'
  2873. content:
  2874. application/ld+json:
  2875. schema:
  2876. $ref: '#/components/schemas/Sale.jsonld'
  2877. application/json:
  2878. schema:
  2879. $ref: '#/components/schemas/Sale'
  2880. text/html:
  2881. schema:
  2882. $ref: '#/components/schemas/Sale'
  2883. application/hal+json:
  2884. schema:
  2885. $ref: '#/components/schemas/Sale.jsonhal'
  2886. links: { }
  2887. 400:
  2888. description: 'Invalid input'
  2889. 422:
  2890. description: 'Unprocessable entity'
  2891. 404:
  2892. description: 'Resource not found'
  2893. summary: 'Updates the Sale resource.'
  2894. description: 'Updates the Sale resource.'
  2895. parameters:
  2896. -
  2897. name: id
  2898. in: path
  2899. description: 'Sale identifier'
  2900. required: true
  2901. deprecated: false
  2902. allowEmptyValue: false
  2903. schema:
  2904. type: string
  2905. style: simple
  2906. explode: false
  2907. allowReserved: false
  2908. requestBody:
  2909. description: 'The updated Sale resource'
  2910. content:
  2911. application/merge-patch+json:
  2912. schema:
  2913. $ref: '#/components/schemas/Sale'
  2914. required: true
  2915. deprecated: false
  2916. parameters: []
  2917. /api/task_notes:
  2918. get:
  2919. operationId: api_task_notes_get_collection
  2920. tags:
  2921. - TaskNote
  2922. responses:
  2923. 200:
  2924. description: 'TaskNote collection'
  2925. content:
  2926. application/ld+json:
  2927. schema:
  2928. type: object
  2929. properties:
  2930. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonld' } }
  2931. 'hydra:totalItems': { type: integer, minimum: 0 }
  2932. '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 } }
  2933. '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 } } } } } }
  2934. required:
  2935. - 'hydra:member'
  2936. application/json:
  2937. schema:
  2938. type: array
  2939. items:
  2940. $ref: '#/components/schemas/TaskNote'
  2941. text/html:
  2942. schema:
  2943. type: array
  2944. items:
  2945. $ref: '#/components/schemas/TaskNote'
  2946. application/hal+json:
  2947. schema:
  2948. type: object
  2949. properties:
  2950. _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonhal' } }
  2951. totalItems: { type: integer, minimum: 0 }
  2952. itemsPerPage: { type: integer, minimum: 0 }
  2953. _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 } } } } }
  2954. required:
  2955. - _links
  2956. - _embedded
  2957. summary: 'Retrieves the collection of TaskNote resources.'
  2958. description: 'Retrieves the collection of TaskNote resources.'
  2959. parameters:
  2960. -
  2961. name: page
  2962. in: query
  2963. description: 'The collection page number'
  2964. required: false
  2965. deprecated: false
  2966. allowEmptyValue: true
  2967. schema:
  2968. type: integer
  2969. default: 1
  2970. style: form
  2971. explode: false
  2972. allowReserved: false
  2973. -
  2974. name: itemsPerPage
  2975. in: query
  2976. description: 'The number of items per page'
  2977. required: false
  2978. deprecated: false
  2979. allowEmptyValue: true
  2980. schema:
  2981. type: integer
  2982. default: 10
  2983. minimum: 0
  2984. maximum: 50
  2985. style: form
  2986. explode: false
  2987. allowReserved: false
  2988. -
  2989. name: task
  2990. in: query
  2991. description: ''
  2992. required: false
  2993. deprecated: false
  2994. allowEmptyValue: true
  2995. schema:
  2996. type: string
  2997. style: form
  2998. explode: false
  2999. allowReserved: false
  3000. -
  3001. name: 'task[]'
  3002. in: query
  3003. description: ''
  3004. required: false
  3005. deprecated: false
  3006. allowEmptyValue: true
  3007. schema:
  3008. type: array
  3009. items:
  3010. type: string
  3011. style: form
  3012. explode: true
  3013. allowReserved: false
  3014. deprecated: false
  3015. post:
  3016. operationId: api_task_notes_post
  3017. tags:
  3018. - TaskNote
  3019. responses:
  3020. 201:
  3021. description: 'TaskNote resource created'
  3022. content:
  3023. application/ld+json:
  3024. schema:
  3025. $ref: '#/components/schemas/TaskNote.jsonld'
  3026. application/json:
  3027. schema:
  3028. $ref: '#/components/schemas/TaskNote'
  3029. text/html:
  3030. schema:
  3031. $ref: '#/components/schemas/TaskNote'
  3032. application/hal+json:
  3033. schema:
  3034. $ref: '#/components/schemas/TaskNote.jsonhal'
  3035. links: { }
  3036. 400:
  3037. description: 'Invalid input'
  3038. 422:
  3039. description: 'Unprocessable entity'
  3040. summary: 'Creates a TaskNote resource.'
  3041. description: 'Creates a TaskNote resource.'
  3042. parameters: []
  3043. requestBody:
  3044. description: 'The new TaskNote resource'
  3045. content:
  3046. application/ld+json:
  3047. schema:
  3048. $ref: '#/components/schemas/TaskNote.jsonld'
  3049. application/json:
  3050. schema:
  3051. $ref: '#/components/schemas/TaskNote'
  3052. text/html:
  3053. schema:
  3054. $ref: '#/components/schemas/TaskNote'
  3055. application/hal+json:
  3056. schema:
  3057. $ref: '#/components/schemas/TaskNote.jsonhal'
  3058. required: true
  3059. deprecated: false
  3060. parameters: []
  3061. '/api/task_notes/{id}':
  3062. get:
  3063. operationId: api_task_notes_id_get
  3064. tags:
  3065. - TaskNote
  3066. responses:
  3067. 200:
  3068. description: 'TaskNote resource'
  3069. content:
  3070. application/ld+json:
  3071. schema:
  3072. $ref: '#/components/schemas/TaskNote.jsonld'
  3073. application/json:
  3074. schema:
  3075. $ref: '#/components/schemas/TaskNote'
  3076. text/html:
  3077. schema:
  3078. $ref: '#/components/schemas/TaskNote'
  3079. application/hal+json:
  3080. schema:
  3081. $ref: '#/components/schemas/TaskNote.jsonhal'
  3082. 404:
  3083. description: 'Resource not found'
  3084. summary: 'Retrieves a TaskNote resource.'
  3085. description: 'Retrieves a TaskNote resource.'
  3086. parameters:
  3087. -
  3088. name: id
  3089. in: path
  3090. description: 'TaskNote identifier'
  3091. required: true
  3092. deprecated: false
  3093. allowEmptyValue: false
  3094. schema:
  3095. type: string
  3096. style: simple
  3097. explode: false
  3098. allowReserved: false
  3099. deprecated: false
  3100. patch:
  3101. operationId: api_task_notes_id_patch
  3102. tags:
  3103. - TaskNote
  3104. responses:
  3105. 200:
  3106. description: 'TaskNote resource updated'
  3107. content:
  3108. application/ld+json:
  3109. schema:
  3110. $ref: '#/components/schemas/TaskNote.jsonld'
  3111. application/json:
  3112. schema:
  3113. $ref: '#/components/schemas/TaskNote'
  3114. text/html:
  3115. schema:
  3116. $ref: '#/components/schemas/TaskNote'
  3117. application/hal+json:
  3118. schema:
  3119. $ref: '#/components/schemas/TaskNote.jsonhal'
  3120. links: { }
  3121. 400:
  3122. description: 'Invalid input'
  3123. 422:
  3124. description: 'Unprocessable entity'
  3125. 404:
  3126. description: 'Resource not found'
  3127. summary: 'Updates the TaskNote resource.'
  3128. description: 'Updates the TaskNote resource.'
  3129. parameters:
  3130. -
  3131. name: id
  3132. in: path
  3133. description: 'TaskNote identifier'
  3134. required: true
  3135. deprecated: false
  3136. allowEmptyValue: false
  3137. schema:
  3138. type: string
  3139. style: simple
  3140. explode: false
  3141. allowReserved: false
  3142. requestBody:
  3143. description: 'The updated TaskNote resource'
  3144. content:
  3145. application/merge-patch+json:
  3146. schema:
  3147. $ref: '#/components/schemas/TaskNote'
  3148. required: true
  3149. deprecated: false
  3150. parameters: []
  3151. /api/tasks:
  3152. get:
  3153. operationId: api_tasks_get_collection
  3154. tags:
  3155. - Task
  3156. responses:
  3157. 200:
  3158. description: 'Task collection'
  3159. content:
  3160. application/ld+json:
  3161. schema:
  3162. type: object
  3163. properties:
  3164. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  3165. 'hydra:totalItems': { type: integer, minimum: 0 }
  3166. '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 } }
  3167. '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 } } } } } }
  3168. required:
  3169. - 'hydra:member'
  3170. application/json:
  3171. schema:
  3172. type: array
  3173. items:
  3174. $ref: '#/components/schemas/Task'
  3175. text/html:
  3176. schema:
  3177. type: array
  3178. items:
  3179. $ref: '#/components/schemas/Task'
  3180. application/hal+json:
  3181. schema:
  3182. type: object
  3183. properties:
  3184. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  3185. totalItems: { type: integer, minimum: 0 }
  3186. itemsPerPage: { type: integer, minimum: 0 }
  3187. _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 } } } } }
  3188. required:
  3189. - _links
  3190. - _embedded
  3191. summary: 'Retrieves the collection of Task resources.'
  3192. description: 'Retrieves the collection of Task resources.'
  3193. parameters:
  3194. -
  3195. name: page
  3196. in: query
  3197. description: 'The collection page number'
  3198. required: false
  3199. deprecated: false
  3200. allowEmptyValue: true
  3201. schema:
  3202. type: integer
  3203. default: 1
  3204. style: form
  3205. explode: false
  3206. allowReserved: false
  3207. -
  3208. name: itemsPerPage
  3209. in: query
  3210. description: 'The number of items per page'
  3211. required: false
  3212. deprecated: false
  3213. allowEmptyValue: true
  3214. schema:
  3215. type: integer
  3216. default: 10
  3217. minimum: 0
  3218. maximum: 50
  3219. style: form
  3220. explode: false
  3221. allowReserved: false
  3222. -
  3223. name: assignedTo
  3224. in: query
  3225. description: ''
  3226. required: false
  3227. deprecated: false
  3228. allowEmptyValue: true
  3229. schema:
  3230. type: string
  3231. style: form
  3232. explode: false
  3233. allowReserved: false
  3234. -
  3235. name: 'assignedTo[]'
  3236. in: query
  3237. description: ''
  3238. required: false
  3239. deprecated: false
  3240. allowEmptyValue: true
  3241. schema:
  3242. type: array
  3243. items:
  3244. type: string
  3245. style: form
  3246. explode: true
  3247. allowReserved: false
  3248. -
  3249. name: partner
  3250. in: query
  3251. description: ''
  3252. required: false
  3253. deprecated: false
  3254. allowEmptyValue: true
  3255. schema:
  3256. type: string
  3257. style: form
  3258. explode: false
  3259. allowReserved: false
  3260. -
  3261. name: 'partner[]'
  3262. in: query
  3263. description: ''
  3264. required: false
  3265. deprecated: false
  3266. allowEmptyValue: true
  3267. schema:
  3268. type: array
  3269. items:
  3270. type: string
  3271. style: form
  3272. explode: true
  3273. allowReserved: false
  3274. -
  3275. name: contact
  3276. in: query
  3277. description: ''
  3278. required: false
  3279. deprecated: false
  3280. allowEmptyValue: true
  3281. schema:
  3282. type: string
  3283. style: form
  3284. explode: false
  3285. allowReserved: false
  3286. -
  3287. name: 'contact[]'
  3288. in: query
  3289. description: ''
  3290. required: false
  3291. deprecated: false
  3292. allowEmptyValue: true
  3293. schema:
  3294. type: array
  3295. items:
  3296. type: string
  3297. style: form
  3298. explode: true
  3299. allowReserved: false
  3300. deprecated: false
  3301. post:
  3302. operationId: api_tasks_post
  3303. tags:
  3304. - Task
  3305. responses:
  3306. 201:
  3307. description: 'Task resource created'
  3308. content:
  3309. application/ld+json:
  3310. schema:
  3311. $ref: '#/components/schemas/Task.jsonld'
  3312. application/json:
  3313. schema:
  3314. $ref: '#/components/schemas/Task'
  3315. text/html:
  3316. schema:
  3317. $ref: '#/components/schemas/Task'
  3318. application/hal+json:
  3319. schema:
  3320. $ref: '#/components/schemas/Task.jsonhal'
  3321. links: { }
  3322. 400:
  3323. description: 'Invalid input'
  3324. 422:
  3325. description: 'Unprocessable entity'
  3326. summary: 'Creates a Task resource.'
  3327. description: 'Creates a Task resource.'
  3328. parameters: []
  3329. requestBody:
  3330. description: 'The new Task resource'
  3331. content:
  3332. application/ld+json:
  3333. schema:
  3334. $ref: '#/components/schemas/Task.jsonld'
  3335. application/json:
  3336. schema:
  3337. $ref: '#/components/schemas/Task'
  3338. text/html:
  3339. schema:
  3340. $ref: '#/components/schemas/Task'
  3341. application/hal+json:
  3342. schema:
  3343. $ref: '#/components/schemas/Task.jsonhal'
  3344. required: true
  3345. deprecated: false
  3346. parameters: []
  3347. '/api/tasks/{id}':
  3348. get:
  3349. operationId: api_tasks_id_get
  3350. tags:
  3351. - Task
  3352. responses:
  3353. 200:
  3354. description: 'Task resource'
  3355. content:
  3356. application/ld+json:
  3357. schema:
  3358. $ref: '#/components/schemas/Task.jsonld'
  3359. application/json:
  3360. schema:
  3361. $ref: '#/components/schemas/Task'
  3362. text/html:
  3363. schema:
  3364. $ref: '#/components/schemas/Task'
  3365. application/hal+json:
  3366. schema:
  3367. $ref: '#/components/schemas/Task.jsonhal'
  3368. 404:
  3369. description: 'Resource not found'
  3370. summary: 'Retrieves a Task resource.'
  3371. description: 'Retrieves a Task resource.'
  3372. parameters:
  3373. -
  3374. name: id
  3375. in: path
  3376. description: 'Task identifier'
  3377. required: true
  3378. deprecated: false
  3379. allowEmptyValue: false
  3380. schema:
  3381. type: string
  3382. style: simple
  3383. explode: false
  3384. allowReserved: false
  3385. deprecated: false
  3386. patch:
  3387. operationId: api_tasks_id_patch
  3388. tags:
  3389. - Task
  3390. responses:
  3391. 200:
  3392. description: 'Task resource updated'
  3393. content:
  3394. application/ld+json:
  3395. schema:
  3396. $ref: '#/components/schemas/Task.jsonld'
  3397. application/json:
  3398. schema:
  3399. $ref: '#/components/schemas/Task'
  3400. text/html:
  3401. schema:
  3402. $ref: '#/components/schemas/Task'
  3403. application/hal+json:
  3404. schema:
  3405. $ref: '#/components/schemas/Task.jsonhal'
  3406. links: { }
  3407. 400:
  3408. description: 'Invalid input'
  3409. 422:
  3410. description: 'Unprocessable entity'
  3411. 404:
  3412. description: 'Resource not found'
  3413. summary: 'Updates the Task resource.'
  3414. description: 'Updates the Task resource.'
  3415. parameters:
  3416. -
  3417. name: id
  3418. in: path
  3419. description: 'Task identifier'
  3420. required: true
  3421. deprecated: false
  3422. allowEmptyValue: false
  3423. schema:
  3424. type: string
  3425. style: simple
  3426. explode: false
  3427. allowReserved: false
  3428. requestBody:
  3429. description: 'The updated Task resource'
  3430. content:
  3431. application/merge-patch+json:
  3432. schema:
  3433. $ref: '#/components/schemas/Task'
  3434. required: true
  3435. deprecated: false
  3436. parameters: []
  3437. /api/user_products:
  3438. get:
  3439. operationId: api_user_products_get_collection
  3440. tags:
  3441. - UserProduct
  3442. responses:
  3443. 200:
  3444. description: 'UserProduct collection'
  3445. content:
  3446. application/ld+json:
  3447. schema:
  3448. type: object
  3449. properties:
  3450. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonld' } }
  3451. 'hydra:totalItems': { type: integer, minimum: 0 }
  3452. '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 } }
  3453. '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 } } } } } }
  3454. required:
  3455. - 'hydra:member'
  3456. application/json:
  3457. schema:
  3458. type: array
  3459. items:
  3460. $ref: '#/components/schemas/UserProduct'
  3461. text/html:
  3462. schema:
  3463. type: array
  3464. items:
  3465. $ref: '#/components/schemas/UserProduct'
  3466. application/hal+json:
  3467. schema:
  3468. type: object
  3469. properties:
  3470. _embedded: { type: array, items: { $ref: '#/components/schemas/UserProduct.jsonhal' } }
  3471. totalItems: { type: integer, minimum: 0 }
  3472. itemsPerPage: { type: integer, minimum: 0 }
  3473. _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 } } } } }
  3474. required:
  3475. - _links
  3476. - _embedded
  3477. summary: 'Retrieves the collection of UserProduct resources.'
  3478. description: 'Retrieves the collection of UserProduct resources.'
  3479. parameters:
  3480. -
  3481. name: page
  3482. in: query
  3483. description: 'The collection page number'
  3484. required: false
  3485. deprecated: false
  3486. allowEmptyValue: true
  3487. schema:
  3488. type: integer
  3489. default: 1
  3490. style: form
  3491. explode: false
  3492. allowReserved: false
  3493. -
  3494. name: itemsPerPage
  3495. in: query
  3496. description: 'The number of items per page'
  3497. required: false
  3498. deprecated: false
  3499. allowEmptyValue: true
  3500. schema:
  3501. type: integer
  3502. default: 10
  3503. minimum: 0
  3504. maximum: 50
  3505. style: form
  3506. explode: false
  3507. allowReserved: false
  3508. -
  3509. name: user
  3510. in: query
  3511. description: ''
  3512. required: false
  3513. deprecated: false
  3514. allowEmptyValue: true
  3515. schema:
  3516. type: string
  3517. style: form
  3518. explode: false
  3519. allowReserved: false
  3520. -
  3521. name: 'user[]'
  3522. in: query
  3523. description: ''
  3524. required: false
  3525. deprecated: false
  3526. allowEmptyValue: true
  3527. schema:
  3528. type: array
  3529. items:
  3530. type: string
  3531. style: form
  3532. explode: true
  3533. allowReserved: false
  3534. -
  3535. name: product
  3536. in: query
  3537. description: ''
  3538. required: false
  3539. deprecated: false
  3540. allowEmptyValue: true
  3541. schema:
  3542. type: string
  3543. style: form
  3544. explode: false
  3545. allowReserved: false
  3546. -
  3547. name: 'product[]'
  3548. in: query
  3549. description: ''
  3550. required: false
  3551. deprecated: false
  3552. allowEmptyValue: true
  3553. schema:
  3554. type: array
  3555. items:
  3556. type: string
  3557. style: form
  3558. explode: true
  3559. allowReserved: false
  3560. deprecated: false
  3561. post:
  3562. operationId: api_user_products_post
  3563. tags:
  3564. - UserProduct
  3565. responses:
  3566. 201:
  3567. description: 'UserProduct resource created'
  3568. content:
  3569. application/ld+json:
  3570. schema:
  3571. $ref: '#/components/schemas/UserProduct.jsonld'
  3572. application/json:
  3573. schema:
  3574. $ref: '#/components/schemas/UserProduct'
  3575. text/html:
  3576. schema:
  3577. $ref: '#/components/schemas/UserProduct'
  3578. application/hal+json:
  3579. schema:
  3580. $ref: '#/components/schemas/UserProduct.jsonhal'
  3581. links: { }
  3582. 400:
  3583. description: 'Invalid input'
  3584. 422:
  3585. description: 'Unprocessable entity'
  3586. summary: 'Creates a UserProduct resource.'
  3587. description: 'Creates a UserProduct resource.'
  3588. parameters: []
  3589. requestBody:
  3590. description: 'The new UserProduct resource'
  3591. content:
  3592. application/ld+json:
  3593. schema:
  3594. $ref: '#/components/schemas/UserProduct.jsonld'
  3595. application/json:
  3596. schema:
  3597. $ref: '#/components/schemas/UserProduct'
  3598. text/html:
  3599. schema:
  3600. $ref: '#/components/schemas/UserProduct'
  3601. application/hal+json:
  3602. schema:
  3603. $ref: '#/components/schemas/UserProduct.jsonhal'
  3604. required: true
  3605. deprecated: false
  3606. parameters: []
  3607. '/api/user_products/{id}':
  3608. get:
  3609. operationId: api_user_products_id_get
  3610. tags:
  3611. - UserProduct
  3612. responses:
  3613. 200:
  3614. description: 'UserProduct resource'
  3615. content:
  3616. application/ld+json:
  3617. schema:
  3618. $ref: '#/components/schemas/UserProduct.jsonld'
  3619. application/json:
  3620. schema:
  3621. $ref: '#/components/schemas/UserProduct'
  3622. text/html:
  3623. schema:
  3624. $ref: '#/components/schemas/UserProduct'
  3625. application/hal+json:
  3626. schema:
  3627. $ref: '#/components/schemas/UserProduct.jsonhal'
  3628. 404:
  3629. description: 'Resource not found'
  3630. summary: 'Retrieves a UserProduct resource.'
  3631. description: 'Retrieves a UserProduct resource.'
  3632. parameters:
  3633. -
  3634. name: id
  3635. in: path
  3636. description: 'UserProduct identifier'
  3637. required: true
  3638. deprecated: false
  3639. allowEmptyValue: false
  3640. schema:
  3641. type: string
  3642. style: simple
  3643. explode: false
  3644. allowReserved: false
  3645. deprecated: false
  3646. delete:
  3647. operationId: api_user_products_id_delete
  3648. tags:
  3649. - UserProduct
  3650. responses:
  3651. 204:
  3652. description: 'UserProduct resource deleted'
  3653. 404:
  3654. description: 'Resource not found'
  3655. summary: 'Removes the UserProduct resource.'
  3656. description: 'Removes the UserProduct resource.'
  3657. parameters:
  3658. -
  3659. name: id
  3660. in: path
  3661. description: 'UserProduct identifier'
  3662. required: true
  3663. deprecated: false
  3664. allowEmptyValue: false
  3665. schema:
  3666. type: string
  3667. style: simple
  3668. explode: false
  3669. allowReserved: false
  3670. deprecated: false
  3671. parameters: []
  3672. /api/users:
  3673. get:
  3674. operationId: api_users_get_collection
  3675. tags:
  3676. - User
  3677. responses:
  3678. 200:
  3679. description: 'User collection'
  3680. content:
  3681. application/ld+json:
  3682. schema:
  3683. type: object
  3684. properties:
  3685. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  3686. 'hydra:totalItems': { type: integer, minimum: 0 }
  3687. '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 } }
  3688. '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 } } } } } }
  3689. required:
  3690. - 'hydra:member'
  3691. application/json:
  3692. schema:
  3693. type: array
  3694. items:
  3695. $ref: '#/components/schemas/User'
  3696. text/html:
  3697. schema:
  3698. type: array
  3699. items:
  3700. $ref: '#/components/schemas/User'
  3701. application/hal+json:
  3702. schema:
  3703. type: object
  3704. properties:
  3705. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  3706. totalItems: { type: integer, minimum: 0 }
  3707. itemsPerPage: { type: integer, minimum: 0 }
  3708. _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 } } } } }
  3709. required:
  3710. - _links
  3711. - _embedded
  3712. summary: 'Retrieves the collection of User resources.'
  3713. description: 'Retrieves the collection of User resources.'
  3714. parameters:
  3715. -
  3716. name: page
  3717. in: query
  3718. description: 'The collection page number'
  3719. required: false
  3720. deprecated: false
  3721. allowEmptyValue: true
  3722. schema:
  3723. type: integer
  3724. default: 1
  3725. style: form
  3726. explode: false
  3727. allowReserved: false
  3728. -
  3729. name: itemsPerPage
  3730. in: query
  3731. description: 'The number of items per page'
  3732. required: false
  3733. deprecated: false
  3734. allowEmptyValue: true
  3735. schema:
  3736. type: integer
  3737. default: 10
  3738. minimum: 0
  3739. maximum: 50
  3740. style: form
  3741. explode: false
  3742. allowReserved: false
  3743. -
  3744. name: firstName
  3745. in: query
  3746. description: ''
  3747. required: false
  3748. deprecated: false
  3749. allowEmptyValue: true
  3750. schema:
  3751. type: string
  3752. style: form
  3753. explode: false
  3754. allowReserved: false
  3755. -
  3756. name: lastName
  3757. in: query
  3758. description: ''
  3759. required: false
  3760. deprecated: false
  3761. allowEmptyValue: true
  3762. schema:
  3763. type: string
  3764. style: form
  3765. explode: false
  3766. allowReserved: false
  3767. deprecated: false
  3768. post:
  3769. operationId: api_users_post
  3770. tags:
  3771. - User
  3772. responses:
  3773. 201:
  3774. description: 'User resource created'
  3775. content:
  3776. application/ld+json:
  3777. schema:
  3778. $ref: '#/components/schemas/User.jsonld'
  3779. application/json:
  3780. schema:
  3781. $ref: '#/components/schemas/User'
  3782. text/html:
  3783. schema:
  3784. $ref: '#/components/schemas/User'
  3785. application/hal+json:
  3786. schema:
  3787. $ref: '#/components/schemas/User.jsonhal'
  3788. links: { }
  3789. 400:
  3790. description: 'Invalid input'
  3791. 422:
  3792. description: 'Unprocessable entity'
  3793. summary: 'Creates a User resource.'
  3794. description: 'Creates a User resource.'
  3795. parameters: []
  3796. requestBody:
  3797. description: 'The new User resource'
  3798. content:
  3799. application/ld+json:
  3800. schema:
  3801. $ref: '#/components/schemas/User.jsonld'
  3802. application/json:
  3803. schema:
  3804. $ref: '#/components/schemas/User'
  3805. text/html:
  3806. schema:
  3807. $ref: '#/components/schemas/User'
  3808. application/hal+json:
  3809. schema:
  3810. $ref: '#/components/schemas/User.jsonhal'
  3811. required: true
  3812. deprecated: false
  3813. parameters: []
  3814. '/api/users/{id}':
  3815. get:
  3816. operationId: api_users_id_get
  3817. tags:
  3818. - User
  3819. responses:
  3820. 200:
  3821. description: 'User resource'
  3822. content:
  3823. application/ld+json:
  3824. schema:
  3825. $ref: '#/components/schemas/User.jsonld'
  3826. application/json:
  3827. schema:
  3828. $ref: '#/components/schemas/User'
  3829. text/html:
  3830. schema:
  3831. $ref: '#/components/schemas/User'
  3832. application/hal+json:
  3833. schema:
  3834. $ref: '#/components/schemas/User.jsonhal'
  3835. 404:
  3836. description: 'Resource not found'
  3837. summary: 'Retrieves a User resource.'
  3838. description: 'Retrieves a User resource.'
  3839. parameters:
  3840. -
  3841. name: id
  3842. in: path
  3843. description: 'User identifier'
  3844. required: true
  3845. deprecated: false
  3846. allowEmptyValue: false
  3847. schema:
  3848. type: string
  3849. style: simple
  3850. explode: false
  3851. allowReserved: false
  3852. deprecated: false
  3853. parameters: []
  3854. /auth:
  3855. post:
  3856. operationId: login_check_post
  3857. tags:
  3858. - 'Login Check'
  3859. responses:
  3860. 200:
  3861. description: 'User token created'
  3862. content:
  3863. application/json:
  3864. schema:
  3865. type: object
  3866. properties:
  3867. token: { readOnly: true, type: string, nullable: false }
  3868. required:
  3869. - token
  3870. summary: 'Creates a user token.'
  3871. description: 'Creates a user token.'
  3872. requestBody:
  3873. description: 'The login data'
  3874. content:
  3875. application/json:
  3876. schema:
  3877. type: object
  3878. properties:
  3879. email:
  3880. type: string
  3881. nullable: false
  3882. password:
  3883. type: string
  3884. nullable: false
  3885. required:
  3886. - email
  3887. - password
  3888. required: true
  3889. parameters: []
  3890. components:
  3891. schemas:
  3892. Comment:
  3893. type: object
  3894. description: ''
  3895. deprecated: false
  3896. required:
  3897. - message
  3898. properties:
  3899. message:
  3900. type:
  3901. - string
  3902. - 'null'
  3903. owner:
  3904. readOnly: true
  3905. type:
  3906. - string
  3907. - 'null'
  3908. format: iri-reference
  3909. example: 'https://example.com/'
  3910. ownerName:
  3911. readOnly: true
  3912. type:
  3913. - string
  3914. - 'null'
  3915. post:
  3916. type:
  3917. - string
  3918. - 'null'
  3919. format: iri-reference
  3920. example: 'https://example.com/'
  3921. createdAt:
  3922. readOnly: true
  3923. type:
  3924. - string
  3925. - 'null'
  3926. format: date-time
  3927. Comment.jsonhal:
  3928. type: object
  3929. description: ''
  3930. deprecated: false
  3931. required:
  3932. - message
  3933. properties:
  3934. _links:
  3935. type: object
  3936. properties:
  3937. self:
  3938. type: object
  3939. properties:
  3940. href:
  3941. type: string
  3942. format: iri-reference
  3943. message:
  3944. type:
  3945. - string
  3946. - 'null'
  3947. owner:
  3948. readOnly: true
  3949. type:
  3950. - string
  3951. - 'null'
  3952. format: iri-reference
  3953. example: 'https://example.com/'
  3954. ownerName:
  3955. readOnly: true
  3956. type:
  3957. - string
  3958. - 'null'
  3959. post:
  3960. type:
  3961. - string
  3962. - 'null'
  3963. format: iri-reference
  3964. example: 'https://example.com/'
  3965. createdAt:
  3966. readOnly: true
  3967. type:
  3968. - string
  3969. - 'null'
  3970. format: date-time
  3971. Comment.jsonld:
  3972. type: object
  3973. description: ''
  3974. deprecated: false
  3975. required:
  3976. - message
  3977. properties:
  3978. '@context':
  3979. readOnly: true
  3980. oneOf:
  3981. -
  3982. type: string
  3983. -
  3984. type: object
  3985. properties:
  3986. '@vocab':
  3987. type: string
  3988. hydra:
  3989. type: string
  3990. enum: ['http://www.w3.org/ns/hydra/core#']
  3991. required:
  3992. - '@vocab'
  3993. - hydra
  3994. additionalProperties: true
  3995. '@id':
  3996. readOnly: true
  3997. type: string
  3998. '@type':
  3999. readOnly: true
  4000. type: string
  4001. message:
  4002. type:
  4003. - string
  4004. - 'null'
  4005. owner:
  4006. readOnly: true
  4007. type:
  4008. - string
  4009. - 'null'
  4010. format: iri-reference
  4011. example: 'https://example.com/'
  4012. ownerName:
  4013. readOnly: true
  4014. type:
  4015. - string
  4016. - 'null'
  4017. post:
  4018. type:
  4019. - string
  4020. - 'null'
  4021. format: iri-reference
  4022. example: 'https://example.com/'
  4023. createdAt:
  4024. readOnly: true
  4025. type:
  4026. - string
  4027. - 'null'
  4028. format: date-time
  4029. Contact:
  4030. type: object
  4031. description: ''
  4032. deprecated: false
  4033. required:
  4034. - firstName
  4035. - lastName
  4036. - partner
  4037. properties:
  4038. firstName:
  4039. type:
  4040. - string
  4041. - 'null'
  4042. lastName:
  4043. type:
  4044. - string
  4045. - 'null'
  4046. partner:
  4047. type:
  4048. - string
  4049. - 'null'
  4050. format: iri-reference
  4051. example: 'https://example.com/'
  4052. birthday:
  4053. type:
  4054. - string
  4055. - 'null'
  4056. format: date-time
  4057. image:
  4058. type:
  4059. - string
  4060. - 'null'
  4061. format: iri-reference
  4062. example: 'https://example.com/'
  4063. imageUrl:
  4064. readOnly: true
  4065. type:
  4066. - string
  4067. - 'null'
  4068. position:
  4069. type:
  4070. - string
  4071. - 'null'
  4072. phone:
  4073. type:
  4074. - string
  4075. - 'null'
  4076. email:
  4077. format: email
  4078. externalDocs:
  4079. url: 'https://schema.org/email'
  4080. type:
  4081. - string
  4082. - 'null'
  4083. posts:
  4084. readOnly: true
  4085. type: array
  4086. items:
  4087. type: string
  4088. format: iri-reference
  4089. example: 'https://example.com/'
  4090. createdBy:
  4091. readOnly: true
  4092. type:
  4093. - string
  4094. - 'null'
  4095. format: iri-reference
  4096. example: 'https://example.com/'
  4097. createdByName:
  4098. readOnly: true
  4099. type:
  4100. - string
  4101. - 'null'
  4102. createdAt:
  4103. readOnly: true
  4104. type:
  4105. - string
  4106. - 'null'
  4107. format: date-time
  4108. Contact.jsonhal:
  4109. type: object
  4110. description: ''
  4111. deprecated: false
  4112. required:
  4113. - firstName
  4114. - lastName
  4115. - partner
  4116. properties:
  4117. _links:
  4118. type: object
  4119. properties:
  4120. self:
  4121. type: object
  4122. properties:
  4123. href:
  4124. type: string
  4125. format: iri-reference
  4126. firstName:
  4127. type:
  4128. - string
  4129. - 'null'
  4130. lastName:
  4131. type:
  4132. - string
  4133. - 'null'
  4134. partner:
  4135. type:
  4136. - string
  4137. - 'null'
  4138. format: iri-reference
  4139. example: 'https://example.com/'
  4140. birthday:
  4141. type:
  4142. - string
  4143. - 'null'
  4144. format: date-time
  4145. image:
  4146. type:
  4147. - string
  4148. - 'null'
  4149. format: iri-reference
  4150. example: 'https://example.com/'
  4151. imageUrl:
  4152. readOnly: true
  4153. type:
  4154. - string
  4155. - 'null'
  4156. position:
  4157. type:
  4158. - string
  4159. - 'null'
  4160. phone:
  4161. type:
  4162. - string
  4163. - 'null'
  4164. email:
  4165. format: email
  4166. externalDocs:
  4167. url: 'https://schema.org/email'
  4168. type:
  4169. - string
  4170. - 'null'
  4171. posts:
  4172. readOnly: true
  4173. type: array
  4174. items:
  4175. type: string
  4176. format: iri-reference
  4177. example: 'https://example.com/'
  4178. createdBy:
  4179. readOnly: true
  4180. type:
  4181. - string
  4182. - 'null'
  4183. format: iri-reference
  4184. example: 'https://example.com/'
  4185. createdByName:
  4186. readOnly: true
  4187. type:
  4188. - string
  4189. - 'null'
  4190. createdAt:
  4191. readOnly: true
  4192. type:
  4193. - string
  4194. - 'null'
  4195. format: date-time
  4196. Contact.jsonld:
  4197. type: object
  4198. description: ''
  4199. deprecated: false
  4200. required:
  4201. - firstName
  4202. - lastName
  4203. - partner
  4204. properties:
  4205. '@context':
  4206. readOnly: true
  4207. oneOf:
  4208. -
  4209. type: string
  4210. -
  4211. type: object
  4212. properties:
  4213. '@vocab':
  4214. type: string
  4215. hydra:
  4216. type: string
  4217. enum: ['http://www.w3.org/ns/hydra/core#']
  4218. required:
  4219. - '@vocab'
  4220. - hydra
  4221. additionalProperties: true
  4222. '@id':
  4223. readOnly: true
  4224. type: string
  4225. '@type':
  4226. readOnly: true
  4227. type: string
  4228. firstName:
  4229. type:
  4230. - string
  4231. - 'null'
  4232. lastName:
  4233. type:
  4234. - string
  4235. - 'null'
  4236. partner:
  4237. type:
  4238. - string
  4239. - 'null'
  4240. format: iri-reference
  4241. example: 'https://example.com/'
  4242. birthday:
  4243. type:
  4244. - string
  4245. - 'null'
  4246. format: date-time
  4247. image:
  4248. type:
  4249. - string
  4250. - 'null'
  4251. format: iri-reference
  4252. example: 'https://example.com/'
  4253. imageUrl:
  4254. readOnly: true
  4255. type:
  4256. - string
  4257. - 'null'
  4258. position:
  4259. type:
  4260. - string
  4261. - 'null'
  4262. phone:
  4263. type:
  4264. - string
  4265. - 'null'
  4266. email:
  4267. format: email
  4268. externalDocs:
  4269. url: 'https://schema.org/email'
  4270. type:
  4271. - string
  4272. - 'null'
  4273. posts:
  4274. readOnly: true
  4275. type: array
  4276. items:
  4277. type: string
  4278. format: iri-reference
  4279. example: 'https://example.com/'
  4280. createdBy:
  4281. readOnly: true
  4282. type:
  4283. - string
  4284. - 'null'
  4285. format: iri-reference
  4286. example: 'https://example.com/'
  4287. createdByName:
  4288. readOnly: true
  4289. type:
  4290. - string
  4291. - 'null'
  4292. createdAt:
  4293. readOnly: true
  4294. type:
  4295. - string
  4296. - 'null'
  4297. format: date-time
  4298. ContactPartnerProduct:
  4299. type: object
  4300. description: ''
  4301. deprecated: false
  4302. required:
  4303. - contact
  4304. - partnerProduct
  4305. properties:
  4306. contact:
  4307. type:
  4308. - string
  4309. - 'null'
  4310. format: iri-reference
  4311. example: 'https://example.com/'
  4312. partnerProduct:
  4313. type:
  4314. - string
  4315. - 'null'
  4316. format: iri-reference
  4317. example: 'https://example.com/'
  4318. productName:
  4319. readOnly: true
  4320. type:
  4321. - string
  4322. - 'null'
  4323. createdAt:
  4324. readOnly: true
  4325. type:
  4326. - string
  4327. - 'null'
  4328. format: date-time
  4329. ContactPartnerProduct.jsonhal:
  4330. type: object
  4331. description: ''
  4332. deprecated: false
  4333. required:
  4334. - contact
  4335. - partnerProduct
  4336. properties:
  4337. _links:
  4338. type: object
  4339. properties:
  4340. self:
  4341. type: object
  4342. properties:
  4343. href:
  4344. type: string
  4345. format: iri-reference
  4346. contact:
  4347. type:
  4348. - string
  4349. - 'null'
  4350. format: iri-reference
  4351. example: 'https://example.com/'
  4352. partnerProduct:
  4353. type:
  4354. - string
  4355. - 'null'
  4356. format: iri-reference
  4357. example: 'https://example.com/'
  4358. productName:
  4359. readOnly: true
  4360. type:
  4361. - string
  4362. - 'null'
  4363. createdAt:
  4364. readOnly: true
  4365. type:
  4366. - string
  4367. - 'null'
  4368. format: date-time
  4369. ContactPartnerProduct.jsonld:
  4370. type: object
  4371. description: ''
  4372. deprecated: false
  4373. required:
  4374. - contact
  4375. - partnerProduct
  4376. properties:
  4377. '@context':
  4378. readOnly: true
  4379. oneOf:
  4380. -
  4381. type: string
  4382. -
  4383. type: object
  4384. properties:
  4385. '@vocab':
  4386. type: string
  4387. hydra:
  4388. type: string
  4389. enum: ['http://www.w3.org/ns/hydra/core#']
  4390. required:
  4391. - '@vocab'
  4392. - hydra
  4393. additionalProperties: true
  4394. '@id':
  4395. readOnly: true
  4396. type: string
  4397. '@type':
  4398. readOnly: true
  4399. type: string
  4400. contact:
  4401. type:
  4402. - string
  4403. - 'null'
  4404. format: iri-reference
  4405. example: 'https://example.com/'
  4406. partnerProduct:
  4407. type:
  4408. - string
  4409. - 'null'
  4410. format: iri-reference
  4411. example: 'https://example.com/'
  4412. productName:
  4413. readOnly: true
  4414. type:
  4415. - string
  4416. - 'null'
  4417. createdAt:
  4418. readOnly: true
  4419. type:
  4420. - string
  4421. - 'null'
  4422. format: date-time
  4423. Document:
  4424. type: object
  4425. description: ''
  4426. deprecated: false
  4427. required:
  4428. - name
  4429. - documentObject
  4430. properties:
  4431. name:
  4432. type:
  4433. - string
  4434. - 'null'
  4435. description:
  4436. type:
  4437. - string
  4438. - 'null'
  4439. partner:
  4440. type:
  4441. - string
  4442. - 'null'
  4443. format: iri-reference
  4444. example: 'https://example.com/'
  4445. partnerName:
  4446. readOnly: true
  4447. type:
  4448. - string
  4449. - 'null'
  4450. product:
  4451. type:
  4452. - string
  4453. - 'null'
  4454. format: iri-reference
  4455. example: 'https://example.com/'
  4456. productName:
  4457. readOnly: true
  4458. type:
  4459. - string
  4460. - 'null'
  4461. documentObject:
  4462. type:
  4463. - string
  4464. - 'null'
  4465. format: iri-reference
  4466. example: 'https://example.com/'
  4467. documentUrl:
  4468. readOnly: true
  4469. type:
  4470. - string
  4471. - 'null'
  4472. createdBy:
  4473. readOnly: true
  4474. type:
  4475. - string
  4476. - 'null'
  4477. format: iri-reference
  4478. example: 'https://example.com/'
  4479. createdByName:
  4480. readOnly: true
  4481. type:
  4482. - string
  4483. - 'null'
  4484. createdAt:
  4485. readOnly: true
  4486. type:
  4487. - string
  4488. - 'null'
  4489. format: date-time
  4490. Document.jsonhal:
  4491. type: object
  4492. description: ''
  4493. deprecated: false
  4494. required:
  4495. - name
  4496. - documentObject
  4497. properties:
  4498. _links:
  4499. type: object
  4500. properties:
  4501. self:
  4502. type: object
  4503. properties:
  4504. href:
  4505. type: string
  4506. format: iri-reference
  4507. name:
  4508. type:
  4509. - string
  4510. - 'null'
  4511. description:
  4512. type:
  4513. - string
  4514. - 'null'
  4515. partner:
  4516. type:
  4517. - string
  4518. - 'null'
  4519. format: iri-reference
  4520. example: 'https://example.com/'
  4521. partnerName:
  4522. readOnly: true
  4523. type:
  4524. - string
  4525. - 'null'
  4526. product:
  4527. type:
  4528. - string
  4529. - 'null'
  4530. format: iri-reference
  4531. example: 'https://example.com/'
  4532. productName:
  4533. readOnly: true
  4534. type:
  4535. - string
  4536. - 'null'
  4537. documentObject:
  4538. type:
  4539. - string
  4540. - 'null'
  4541. format: iri-reference
  4542. example: 'https://example.com/'
  4543. documentUrl:
  4544. readOnly: true
  4545. type:
  4546. - string
  4547. - 'null'
  4548. createdBy:
  4549. readOnly: true
  4550. type:
  4551. - string
  4552. - 'null'
  4553. format: iri-reference
  4554. example: 'https://example.com/'
  4555. createdByName:
  4556. readOnly: true
  4557. type:
  4558. - string
  4559. - 'null'
  4560. createdAt:
  4561. readOnly: true
  4562. type:
  4563. - string
  4564. - 'null'
  4565. format: date-time
  4566. Document.jsonld:
  4567. type: object
  4568. description: ''
  4569. deprecated: false
  4570. required:
  4571. - name
  4572. - documentObject
  4573. properties:
  4574. '@context':
  4575. readOnly: true
  4576. oneOf:
  4577. -
  4578. type: string
  4579. -
  4580. type: object
  4581. properties:
  4582. '@vocab':
  4583. type: string
  4584. hydra:
  4585. type: string
  4586. enum: ['http://www.w3.org/ns/hydra/core#']
  4587. required:
  4588. - '@vocab'
  4589. - hydra
  4590. additionalProperties: true
  4591. '@id':
  4592. readOnly: true
  4593. type: string
  4594. '@type':
  4595. readOnly: true
  4596. type: string
  4597. name:
  4598. type:
  4599. - string
  4600. - 'null'
  4601. description:
  4602. type:
  4603. - string
  4604. - 'null'
  4605. partner:
  4606. type:
  4607. - string
  4608. - 'null'
  4609. format: iri-reference
  4610. example: 'https://example.com/'
  4611. partnerName:
  4612. readOnly: true
  4613. type:
  4614. - string
  4615. - 'null'
  4616. product:
  4617. type:
  4618. - string
  4619. - 'null'
  4620. format: iri-reference
  4621. example: 'https://example.com/'
  4622. productName:
  4623. readOnly: true
  4624. type:
  4625. - string
  4626. - 'null'
  4627. documentObject:
  4628. type:
  4629. - string
  4630. - 'null'
  4631. format: iri-reference
  4632. example: 'https://example.com/'
  4633. documentUrl:
  4634. readOnly: true
  4635. type:
  4636. - string
  4637. - 'null'
  4638. createdBy:
  4639. readOnly: true
  4640. type:
  4641. - string
  4642. - 'null'
  4643. format: iri-reference
  4644. example: 'https://example.com/'
  4645. createdByName:
  4646. readOnly: true
  4647. type:
  4648. - string
  4649. - 'null'
  4650. createdAt:
  4651. readOnly: true
  4652. type:
  4653. - string
  4654. - 'null'
  4655. format: date-time
  4656. DocumentObject-document_object.read:
  4657. type: object
  4658. description: ''
  4659. deprecated: false
  4660. externalDocs:
  4661. url: 'https://schema.org/MediaObject'
  4662. properties:
  4663. contentUrl:
  4664. externalDocs:
  4665. url: 'https://schema.org/contentUrl'
  4666. type:
  4667. - string
  4668. - 'null'
  4669. DocumentObject.jsonhal-document_object.read:
  4670. type: object
  4671. description: ''
  4672. deprecated: false
  4673. externalDocs:
  4674. url: 'https://schema.org/MediaObject'
  4675. properties:
  4676. _links:
  4677. type: object
  4678. properties:
  4679. self:
  4680. type: object
  4681. properties:
  4682. href:
  4683. type: string
  4684. format: iri-reference
  4685. contentUrl:
  4686. externalDocs:
  4687. url: 'https://schema.org/contentUrl'
  4688. type:
  4689. - string
  4690. - 'null'
  4691. DocumentObject.jsonld-document_object.read:
  4692. type: object
  4693. description: ''
  4694. deprecated: false
  4695. externalDocs:
  4696. url: 'https://schema.org/MediaObject'
  4697. properties:
  4698. '@context':
  4699. readOnly: true
  4700. oneOf:
  4701. -
  4702. type: string
  4703. -
  4704. type: object
  4705. properties:
  4706. '@vocab':
  4707. type: string
  4708. hydra:
  4709. type: string
  4710. enum: ['http://www.w3.org/ns/hydra/core#']
  4711. required:
  4712. - '@vocab'
  4713. - hydra
  4714. additionalProperties: true
  4715. '@id':
  4716. readOnly: true
  4717. type: string
  4718. '@type':
  4719. readOnly: true
  4720. type: string
  4721. contentUrl:
  4722. externalDocs:
  4723. url: 'https://schema.org/contentUrl'
  4724. type:
  4725. - string
  4726. - 'null'
  4727. MediaObject-media_object.read:
  4728. type: object
  4729. description: ''
  4730. deprecated: false
  4731. externalDocs:
  4732. url: 'https://schema.org/MediaObject'
  4733. properties:
  4734. contentUrl:
  4735. externalDocs:
  4736. url: 'https://schema.org/contentUrl'
  4737. type:
  4738. - string
  4739. - 'null'
  4740. MediaObject.jsonhal-media_object.read:
  4741. type: object
  4742. description: ''
  4743. deprecated: false
  4744. externalDocs:
  4745. url: 'https://schema.org/MediaObject'
  4746. properties:
  4747. _links:
  4748. type: object
  4749. properties:
  4750. self:
  4751. type: object
  4752. properties:
  4753. href:
  4754. type: string
  4755. format: iri-reference
  4756. contentUrl:
  4757. externalDocs:
  4758. url: 'https://schema.org/contentUrl'
  4759. type:
  4760. - string
  4761. - 'null'
  4762. MediaObject.jsonld-media_object.read:
  4763. type: object
  4764. description: ''
  4765. deprecated: false
  4766. externalDocs:
  4767. url: 'https://schema.org/MediaObject'
  4768. properties:
  4769. '@context':
  4770. readOnly: true
  4771. oneOf:
  4772. -
  4773. type: string
  4774. -
  4775. type: object
  4776. properties:
  4777. '@vocab':
  4778. type: string
  4779. hydra:
  4780. type: string
  4781. enum: ['http://www.w3.org/ns/hydra/core#']
  4782. required:
  4783. - '@vocab'
  4784. - hydra
  4785. additionalProperties: true
  4786. '@id':
  4787. readOnly: true
  4788. type: string
  4789. '@type':
  4790. readOnly: true
  4791. type: string
  4792. contentUrl:
  4793. externalDocs:
  4794. url: 'https://schema.org/contentUrl'
  4795. type:
  4796. - string
  4797. - 'null'
  4798. Partner:
  4799. type: object
  4800. description: ''
  4801. deprecated: false
  4802. required:
  4803. - name
  4804. - partnerType
  4805. properties:
  4806. name:
  4807. type: string
  4808. partnerType:
  4809. type: string
  4810. enum:
  4811. - customer
  4812. - supplier
  4813. - service
  4814. description:
  4815. type:
  4816. - string
  4817. - 'null'
  4818. street:
  4819. type:
  4820. - string
  4821. - 'null'
  4822. streetNo:
  4823. type:
  4824. - string
  4825. - 'null'
  4826. zip:
  4827. type:
  4828. - string
  4829. - 'null'
  4830. city:
  4831. type:
  4832. - string
  4833. - 'null'
  4834. country:
  4835. type:
  4836. - string
  4837. - 'null'
  4838. website:
  4839. type:
  4840. - string
  4841. - 'null'
  4842. logo:
  4843. type:
  4844. - string
  4845. - 'null'
  4846. format: iri-reference
  4847. example: 'https://example.com/'
  4848. logoUrl:
  4849. readOnly: true
  4850. type:
  4851. - string
  4852. - 'null'
  4853. createdBy:
  4854. readOnly: true
  4855. type:
  4856. - string
  4857. - 'null'
  4858. format: iri-reference
  4859. example: 'https://example.com/'
  4860. createdByName:
  4861. readOnly: true
  4862. type:
  4863. - string
  4864. - 'null'
  4865. createdAt:
  4866. readOnly: true
  4867. type:
  4868. - string
  4869. - 'null'
  4870. format: date-time
  4871. posts:
  4872. readOnly: true
  4873. description: 'array<int, PostingApi>'
  4874. type: array
  4875. items:
  4876. type: string
  4877. contacts:
  4878. readOnly: true
  4879. type: array
  4880. items:
  4881. type: string
  4882. format: iri-reference
  4883. example: 'https://example.com/'
  4884. partnerProducts:
  4885. readOnly: true
  4886. type: array
  4887. items:
  4888. type: string
  4889. format: iri-reference
  4890. example: 'https://example.com/'
  4891. Partner.jsonhal:
  4892. type: object
  4893. description: ''
  4894. deprecated: false
  4895. required:
  4896. - name
  4897. - partnerType
  4898. properties:
  4899. _links:
  4900. type: object
  4901. properties:
  4902. self:
  4903. type: object
  4904. properties:
  4905. href:
  4906. type: string
  4907. format: iri-reference
  4908. name:
  4909. type: string
  4910. partnerType:
  4911. type: string
  4912. enum:
  4913. - customer
  4914. - supplier
  4915. - service
  4916. description:
  4917. type:
  4918. - string
  4919. - 'null'
  4920. street:
  4921. type:
  4922. - string
  4923. - 'null'
  4924. streetNo:
  4925. type:
  4926. - string
  4927. - 'null'
  4928. zip:
  4929. type:
  4930. - string
  4931. - 'null'
  4932. city:
  4933. type:
  4934. - string
  4935. - 'null'
  4936. country:
  4937. type:
  4938. - string
  4939. - 'null'
  4940. website:
  4941. type:
  4942. - string
  4943. - 'null'
  4944. logo:
  4945. type:
  4946. - string
  4947. - 'null'
  4948. format: iri-reference
  4949. example: 'https://example.com/'
  4950. logoUrl:
  4951. readOnly: true
  4952. type:
  4953. - string
  4954. - 'null'
  4955. createdBy:
  4956. readOnly: true
  4957. type:
  4958. - string
  4959. - 'null'
  4960. format: iri-reference
  4961. example: 'https://example.com/'
  4962. createdByName:
  4963. readOnly: true
  4964. type:
  4965. - string
  4966. - 'null'
  4967. createdAt:
  4968. readOnly: true
  4969. type:
  4970. - string
  4971. - 'null'
  4972. format: date-time
  4973. posts:
  4974. readOnly: true
  4975. description: 'array<int, PostingApi>'
  4976. type: array
  4977. items:
  4978. type: string
  4979. contacts:
  4980. readOnly: true
  4981. type: array
  4982. items:
  4983. type: string
  4984. format: iri-reference
  4985. example: 'https://example.com/'
  4986. partnerProducts:
  4987. readOnly: true
  4988. type: array
  4989. items:
  4990. type: string
  4991. format: iri-reference
  4992. example: 'https://example.com/'
  4993. Partner.jsonld:
  4994. type: object
  4995. description: ''
  4996. deprecated: false
  4997. required:
  4998. - name
  4999. - partnerType
  5000. properties:
  5001. '@context':
  5002. readOnly: true
  5003. oneOf:
  5004. -
  5005. type: string
  5006. -
  5007. type: object
  5008. properties:
  5009. '@vocab':
  5010. type: string
  5011. hydra:
  5012. type: string
  5013. enum: ['http://www.w3.org/ns/hydra/core#']
  5014. required:
  5015. - '@vocab'
  5016. - hydra
  5017. additionalProperties: true
  5018. '@id':
  5019. readOnly: true
  5020. type: string
  5021. '@type':
  5022. readOnly: true
  5023. type: string
  5024. name:
  5025. type: string
  5026. partnerType:
  5027. type: string
  5028. enum:
  5029. - customer
  5030. - supplier
  5031. - service
  5032. description:
  5033. type:
  5034. - string
  5035. - 'null'
  5036. street:
  5037. type:
  5038. - string
  5039. - 'null'
  5040. streetNo:
  5041. type:
  5042. - string
  5043. - 'null'
  5044. zip:
  5045. type:
  5046. - string
  5047. - 'null'
  5048. city:
  5049. type:
  5050. - string
  5051. - 'null'
  5052. country:
  5053. type:
  5054. - string
  5055. - 'null'
  5056. website:
  5057. type:
  5058. - string
  5059. - 'null'
  5060. logo:
  5061. type:
  5062. - string
  5063. - 'null'
  5064. format: iri-reference
  5065. example: 'https://example.com/'
  5066. logoUrl:
  5067. readOnly: true
  5068. type:
  5069. - string
  5070. - 'null'
  5071. createdBy:
  5072. readOnly: true
  5073. type:
  5074. - string
  5075. - 'null'
  5076. format: iri-reference
  5077. example: 'https://example.com/'
  5078. createdByName:
  5079. readOnly: true
  5080. type:
  5081. - string
  5082. - 'null'
  5083. createdAt:
  5084. readOnly: true
  5085. type:
  5086. - string
  5087. - 'null'
  5088. format: date-time
  5089. posts:
  5090. readOnly: true
  5091. description: 'array<int, PostingApi>'
  5092. type: array
  5093. items:
  5094. type: string
  5095. contacts:
  5096. readOnly: true
  5097. type: array
  5098. items:
  5099. type: string
  5100. format: iri-reference
  5101. example: 'https://example.com/'
  5102. partnerProducts:
  5103. readOnly: true
  5104. type: array
  5105. items:
  5106. type: string
  5107. format: iri-reference
  5108. example: 'https://example.com/'
  5109. PartnerFollow:
  5110. type: object
  5111. description: ''
  5112. deprecated: false
  5113. properties:
  5114. user:
  5115. readOnly: true
  5116. type:
  5117. - string
  5118. - 'null'
  5119. format: iri-reference
  5120. example: 'https://example.com/'
  5121. userName:
  5122. readOnly: true
  5123. type:
  5124. - string
  5125. - 'null'
  5126. partner:
  5127. type:
  5128. - string
  5129. - 'null'
  5130. format: iri-reference
  5131. example: 'https://example.com/'
  5132. partnerName:
  5133. readOnly: true
  5134. type:
  5135. - string
  5136. - 'null'
  5137. createdAt:
  5138. readOnly: true
  5139. type:
  5140. - string
  5141. - 'null'
  5142. format: date-time
  5143. owner:
  5144. readOnly: true
  5145. type:
  5146. - string
  5147. - 'null'
  5148. format: iri-reference
  5149. example: 'https://example.com/'
  5150. required:
  5151. - partner
  5152. PartnerFollow.jsonhal:
  5153. type: object
  5154. description: ''
  5155. deprecated: false
  5156. properties:
  5157. _links:
  5158. type: object
  5159. properties:
  5160. self:
  5161. type: object
  5162. properties:
  5163. href:
  5164. type: string
  5165. format: iri-reference
  5166. user:
  5167. readOnly: true
  5168. type:
  5169. - string
  5170. - 'null'
  5171. format: iri-reference
  5172. example: 'https://example.com/'
  5173. userName:
  5174. readOnly: true
  5175. type:
  5176. - string
  5177. - 'null'
  5178. partner:
  5179. type:
  5180. - string
  5181. - 'null'
  5182. format: iri-reference
  5183. example: 'https://example.com/'
  5184. partnerName:
  5185. readOnly: true
  5186. type:
  5187. - string
  5188. - 'null'
  5189. createdAt:
  5190. readOnly: true
  5191. type:
  5192. - string
  5193. - 'null'
  5194. format: date-time
  5195. owner:
  5196. readOnly: true
  5197. type:
  5198. - string
  5199. - 'null'
  5200. format: iri-reference
  5201. example: 'https://example.com/'
  5202. required:
  5203. - partner
  5204. PartnerFollow.jsonld:
  5205. type: object
  5206. description: ''
  5207. deprecated: false
  5208. properties:
  5209. '@context':
  5210. readOnly: true
  5211. oneOf:
  5212. -
  5213. type: string
  5214. -
  5215. type: object
  5216. properties:
  5217. '@vocab':
  5218. type: string
  5219. hydra:
  5220. type: string
  5221. enum: ['http://www.w3.org/ns/hydra/core#']
  5222. required:
  5223. - '@vocab'
  5224. - hydra
  5225. additionalProperties: true
  5226. '@id':
  5227. readOnly: true
  5228. type: string
  5229. '@type':
  5230. readOnly: true
  5231. type: string
  5232. user:
  5233. readOnly: true
  5234. type:
  5235. - string
  5236. - 'null'
  5237. format: iri-reference
  5238. example: 'https://example.com/'
  5239. userName:
  5240. readOnly: true
  5241. type:
  5242. - string
  5243. - 'null'
  5244. partner:
  5245. type:
  5246. - string
  5247. - 'null'
  5248. format: iri-reference
  5249. example: 'https://example.com/'
  5250. partnerName:
  5251. readOnly: true
  5252. type:
  5253. - string
  5254. - 'null'
  5255. createdAt:
  5256. readOnly: true
  5257. type:
  5258. - string
  5259. - 'null'
  5260. format: date-time
  5261. owner:
  5262. readOnly: true
  5263. type:
  5264. - string
  5265. - 'null'
  5266. format: iri-reference
  5267. example: 'https://example.com/'
  5268. required:
  5269. - partner
  5270. PartnerProduct:
  5271. type: object
  5272. description: ''
  5273. deprecated: false
  5274. required:
  5275. - partner
  5276. - product
  5277. properties:
  5278. partner:
  5279. type:
  5280. - string
  5281. - 'null'
  5282. format: iri-reference
  5283. example: 'https://example.com/'
  5284. partnerName:
  5285. readOnly: true
  5286. type:
  5287. - string
  5288. - 'null'
  5289. product:
  5290. type:
  5291. - string
  5292. - 'null'
  5293. format: iri-reference
  5294. example: 'https://example.com/'
  5295. productName:
  5296. readOnly: true
  5297. type:
  5298. - string
  5299. - 'null'
  5300. createdAt:
  5301. readOnly: true
  5302. type:
  5303. - string
  5304. - 'null'
  5305. format: date-time
  5306. PartnerProduct.jsonhal:
  5307. type: object
  5308. description: ''
  5309. deprecated: false
  5310. required:
  5311. - partner
  5312. - product
  5313. properties:
  5314. _links:
  5315. type: object
  5316. properties:
  5317. self:
  5318. type: object
  5319. properties:
  5320. href:
  5321. type: string
  5322. format: iri-reference
  5323. partner:
  5324. type:
  5325. - string
  5326. - 'null'
  5327. format: iri-reference
  5328. example: 'https://example.com/'
  5329. partnerName:
  5330. readOnly: true
  5331. type:
  5332. - string
  5333. - 'null'
  5334. product:
  5335. type:
  5336. - string
  5337. - 'null'
  5338. format: iri-reference
  5339. example: 'https://example.com/'
  5340. productName:
  5341. readOnly: true
  5342. type:
  5343. - string
  5344. - 'null'
  5345. createdAt:
  5346. readOnly: true
  5347. type:
  5348. - string
  5349. - 'null'
  5350. format: date-time
  5351. PartnerProduct.jsonld:
  5352. type: object
  5353. description: ''
  5354. deprecated: false
  5355. required:
  5356. - partner
  5357. - product
  5358. properties:
  5359. '@context':
  5360. readOnly: true
  5361. oneOf:
  5362. -
  5363. type: string
  5364. -
  5365. type: object
  5366. properties:
  5367. '@vocab':
  5368. type: string
  5369. hydra:
  5370. type: string
  5371. enum: ['http://www.w3.org/ns/hydra/core#']
  5372. required:
  5373. - '@vocab'
  5374. - hydra
  5375. additionalProperties: true
  5376. '@id':
  5377. readOnly: true
  5378. type: string
  5379. '@type':
  5380. readOnly: true
  5381. type: string
  5382. partner:
  5383. type:
  5384. - string
  5385. - 'null'
  5386. format: iri-reference
  5387. example: 'https://example.com/'
  5388. partnerName:
  5389. readOnly: true
  5390. type:
  5391. - string
  5392. - 'null'
  5393. product:
  5394. type:
  5395. - string
  5396. - 'null'
  5397. format: iri-reference
  5398. example: 'https://example.com/'
  5399. productName:
  5400. readOnly: true
  5401. type:
  5402. - string
  5403. - 'null'
  5404. createdAt:
  5405. readOnly: true
  5406. type:
  5407. - string
  5408. - 'null'
  5409. format: date-time
  5410. Post:
  5411. type: object
  5412. description: ''
  5413. deprecated: false
  5414. required:
  5415. - headline
  5416. - message
  5417. properties:
  5418. headline:
  5419. type:
  5420. - string
  5421. - 'null'
  5422. message:
  5423. type:
  5424. - string
  5425. - 'null'
  5426. owner:
  5427. readOnly: true
  5428. type:
  5429. - string
  5430. - 'null'
  5431. format: iri-reference
  5432. example: 'https://example.com/'
  5433. ownerName:
  5434. readOnly: true
  5435. type:
  5436. - string
  5437. - 'null'
  5438. partner:
  5439. type:
  5440. - string
  5441. - 'null'
  5442. format: iri-reference
  5443. example: 'https://example.com/'
  5444. partnerName:
  5445. readOnly: true
  5446. type:
  5447. - string
  5448. - 'null'
  5449. product:
  5450. type:
  5451. - string
  5452. - 'null'
  5453. format: iri-reference
  5454. example: 'https://example.com/'
  5455. productName:
  5456. readOnly: true
  5457. type:
  5458. - string
  5459. - 'null'
  5460. contact:
  5461. type:
  5462. - string
  5463. - 'null'
  5464. format: iri-reference
  5465. example: 'https://example.com/'
  5466. sale:
  5467. type:
  5468. - string
  5469. - 'null'
  5470. format: iri-reference
  5471. example: 'https://example.com/'
  5472. comments:
  5473. readOnly: true
  5474. description: 'array<int, CommentApi>'
  5475. type: array
  5476. items:
  5477. $ref: '#/components/schemas/Comment'
  5478. createdAt:
  5479. readOnly: true
  5480. type:
  5481. - string
  5482. - 'null'
  5483. format: date-time
  5484. Post-posting.create:
  5485. type: object
  5486. description: ''
  5487. deprecated: false
  5488. required:
  5489. - headline
  5490. - message
  5491. properties:
  5492. headline:
  5493. type:
  5494. - string
  5495. - 'null'
  5496. message:
  5497. type:
  5498. - string
  5499. - 'null'
  5500. partner:
  5501. type:
  5502. - string
  5503. - 'null'
  5504. format: iri-reference
  5505. example: 'https://example.com/'
  5506. product:
  5507. type:
  5508. - string
  5509. - 'null'
  5510. format: iri-reference
  5511. example: 'https://example.com/'
  5512. contact:
  5513. type:
  5514. - string
  5515. - 'null'
  5516. format: iri-reference
  5517. example: 'https://example.com/'
  5518. sale:
  5519. type:
  5520. - string
  5521. - 'null'
  5522. format: iri-reference
  5523. example: 'https://example.com/'
  5524. Post-posting.patch:
  5525. type: object
  5526. description: ''
  5527. deprecated: false
  5528. required:
  5529. - headline
  5530. - message
  5531. properties:
  5532. headline:
  5533. type:
  5534. - string
  5535. - 'null'
  5536. message:
  5537. type:
  5538. - string
  5539. - 'null'
  5540. Post.jsonhal:
  5541. type: object
  5542. description: ''
  5543. deprecated: false
  5544. required:
  5545. - headline
  5546. - message
  5547. properties:
  5548. _links:
  5549. type: object
  5550. properties:
  5551. self:
  5552. type: object
  5553. properties:
  5554. href:
  5555. type: string
  5556. format: iri-reference
  5557. headline:
  5558. type:
  5559. - string
  5560. - 'null'
  5561. message:
  5562. type:
  5563. - string
  5564. - 'null'
  5565. owner:
  5566. readOnly: true
  5567. type:
  5568. - string
  5569. - 'null'
  5570. format: iri-reference
  5571. example: 'https://example.com/'
  5572. ownerName:
  5573. readOnly: true
  5574. type:
  5575. - string
  5576. - 'null'
  5577. partner:
  5578. type:
  5579. - string
  5580. - 'null'
  5581. format: iri-reference
  5582. example: 'https://example.com/'
  5583. partnerName:
  5584. readOnly: true
  5585. type:
  5586. - string
  5587. - 'null'
  5588. product:
  5589. type:
  5590. - string
  5591. - 'null'
  5592. format: iri-reference
  5593. example: 'https://example.com/'
  5594. productName:
  5595. readOnly: true
  5596. type:
  5597. - string
  5598. - 'null'
  5599. contact:
  5600. type:
  5601. - string
  5602. - 'null'
  5603. format: iri-reference
  5604. example: 'https://example.com/'
  5605. sale:
  5606. type:
  5607. - string
  5608. - 'null'
  5609. format: iri-reference
  5610. example: 'https://example.com/'
  5611. comments:
  5612. readOnly: true
  5613. description: 'array<int, CommentApi>'
  5614. type: array
  5615. items:
  5616. $ref: '#/components/schemas/Comment.jsonhal'
  5617. createdAt:
  5618. readOnly: true
  5619. type:
  5620. - string
  5621. - 'null'
  5622. format: date-time
  5623. Post.jsonhal-posting.create:
  5624. type: object
  5625. description: ''
  5626. deprecated: false
  5627. required:
  5628. - headline
  5629. - message
  5630. properties:
  5631. _links:
  5632. type: object
  5633. properties:
  5634. self:
  5635. type: object
  5636. properties:
  5637. href:
  5638. type: string
  5639. format: iri-reference
  5640. headline:
  5641. type:
  5642. - string
  5643. - 'null'
  5644. message:
  5645. type:
  5646. - string
  5647. - 'null'
  5648. partner:
  5649. type:
  5650. - string
  5651. - 'null'
  5652. format: iri-reference
  5653. example: 'https://example.com/'
  5654. product:
  5655. type:
  5656. - string
  5657. - 'null'
  5658. format: iri-reference
  5659. example: 'https://example.com/'
  5660. contact:
  5661. type:
  5662. - string
  5663. - 'null'
  5664. format: iri-reference
  5665. example: 'https://example.com/'
  5666. sale:
  5667. type:
  5668. - string
  5669. - 'null'
  5670. format: iri-reference
  5671. example: 'https://example.com/'
  5672. Post.jsonld:
  5673. type: object
  5674. description: ''
  5675. deprecated: false
  5676. required:
  5677. - headline
  5678. - message
  5679. properties:
  5680. '@context':
  5681. readOnly: true
  5682. oneOf:
  5683. -
  5684. type: string
  5685. -
  5686. type: object
  5687. properties:
  5688. '@vocab':
  5689. type: string
  5690. hydra:
  5691. type: string
  5692. enum: ['http://www.w3.org/ns/hydra/core#']
  5693. required:
  5694. - '@vocab'
  5695. - hydra
  5696. additionalProperties: true
  5697. '@id':
  5698. readOnly: true
  5699. type: string
  5700. '@type':
  5701. readOnly: true
  5702. type: string
  5703. headline:
  5704. type:
  5705. - string
  5706. - 'null'
  5707. message:
  5708. type:
  5709. - string
  5710. - 'null'
  5711. owner:
  5712. readOnly: true
  5713. type:
  5714. - string
  5715. - 'null'
  5716. format: iri-reference
  5717. example: 'https://example.com/'
  5718. ownerName:
  5719. readOnly: true
  5720. type:
  5721. - string
  5722. - 'null'
  5723. partner:
  5724. type:
  5725. - string
  5726. - 'null'
  5727. format: iri-reference
  5728. example: 'https://example.com/'
  5729. partnerName:
  5730. readOnly: true
  5731. type:
  5732. - string
  5733. - 'null'
  5734. product:
  5735. type:
  5736. - string
  5737. - 'null'
  5738. format: iri-reference
  5739. example: 'https://example.com/'
  5740. productName:
  5741. readOnly: true
  5742. type:
  5743. - string
  5744. - 'null'
  5745. contact:
  5746. type:
  5747. - string
  5748. - 'null'
  5749. format: iri-reference
  5750. example: 'https://example.com/'
  5751. sale:
  5752. type:
  5753. - string
  5754. - 'null'
  5755. format: iri-reference
  5756. example: 'https://example.com/'
  5757. comments:
  5758. readOnly: true
  5759. description: 'array<int, CommentApi>'
  5760. type: array
  5761. items:
  5762. $ref: '#/components/schemas/Comment.jsonld'
  5763. createdAt:
  5764. readOnly: true
  5765. type:
  5766. - string
  5767. - 'null'
  5768. format: date-time
  5769. Post.jsonld-posting.create:
  5770. type: object
  5771. description: ''
  5772. deprecated: false
  5773. required:
  5774. - headline
  5775. - message
  5776. properties:
  5777. headline:
  5778. type:
  5779. - string
  5780. - 'null'
  5781. message:
  5782. type:
  5783. - string
  5784. - 'null'
  5785. partner:
  5786. type:
  5787. - string
  5788. - 'null'
  5789. format: iri-reference
  5790. example: 'https://example.com/'
  5791. product:
  5792. type:
  5793. - string
  5794. - 'null'
  5795. format: iri-reference
  5796. example: 'https://example.com/'
  5797. contact:
  5798. type:
  5799. - string
  5800. - 'null'
  5801. format: iri-reference
  5802. example: 'https://example.com/'
  5803. sale:
  5804. type:
  5805. - string
  5806. - 'null'
  5807. format: iri-reference
  5808. example: 'https://example.com/'
  5809. Product:
  5810. type: object
  5811. description: ''
  5812. deprecated: false
  5813. required:
  5814. - name
  5815. properties:
  5816. name:
  5817. type: string
  5818. description:
  5819. type:
  5820. - string
  5821. - 'null'
  5822. image:
  5823. type:
  5824. - string
  5825. - 'null'
  5826. format: iri-reference
  5827. example: 'https://example.com/'
  5828. imageUrl:
  5829. readOnly: true
  5830. type:
  5831. - string
  5832. - 'null'
  5833. createdBy:
  5834. readOnly: true
  5835. type:
  5836. - string
  5837. - 'null'
  5838. format: iri-reference
  5839. example: 'https://example.com/'
  5840. createdByName:
  5841. readOnly: true
  5842. type:
  5843. - string
  5844. - 'null'
  5845. createdAt:
  5846. type:
  5847. - string
  5848. - 'null'
  5849. format: date-time
  5850. Product.jsonhal:
  5851. type: object
  5852. description: ''
  5853. deprecated: false
  5854. required:
  5855. - name
  5856. properties:
  5857. _links:
  5858. type: object
  5859. properties:
  5860. self:
  5861. type: object
  5862. properties:
  5863. href:
  5864. type: string
  5865. format: iri-reference
  5866. name:
  5867. type: string
  5868. description:
  5869. type:
  5870. - string
  5871. - 'null'
  5872. image:
  5873. type:
  5874. - string
  5875. - 'null'
  5876. format: iri-reference
  5877. example: 'https://example.com/'
  5878. imageUrl:
  5879. readOnly: true
  5880. type:
  5881. - string
  5882. - 'null'
  5883. createdBy:
  5884. readOnly: true
  5885. type:
  5886. - string
  5887. - 'null'
  5888. format: iri-reference
  5889. example: 'https://example.com/'
  5890. createdByName:
  5891. readOnly: true
  5892. type:
  5893. - string
  5894. - 'null'
  5895. createdAt:
  5896. type:
  5897. - string
  5898. - 'null'
  5899. format: date-time
  5900. Product.jsonld:
  5901. type: object
  5902. description: ''
  5903. deprecated: false
  5904. required:
  5905. - name
  5906. properties:
  5907. '@context':
  5908. readOnly: true
  5909. oneOf:
  5910. -
  5911. type: string
  5912. -
  5913. type: object
  5914. properties:
  5915. '@vocab':
  5916. type: string
  5917. hydra:
  5918. type: string
  5919. enum: ['http://www.w3.org/ns/hydra/core#']
  5920. required:
  5921. - '@vocab'
  5922. - hydra
  5923. additionalProperties: true
  5924. '@id':
  5925. readOnly: true
  5926. type: string
  5927. '@type':
  5928. readOnly: true
  5929. type: string
  5930. name:
  5931. type: string
  5932. description:
  5933. type:
  5934. - string
  5935. - 'null'
  5936. image:
  5937. type:
  5938. - string
  5939. - 'null'
  5940. format: iri-reference
  5941. example: 'https://example.com/'
  5942. imageUrl:
  5943. readOnly: true
  5944. type:
  5945. - string
  5946. - 'null'
  5947. createdBy:
  5948. readOnly: true
  5949. type:
  5950. - string
  5951. - 'null'
  5952. format: iri-reference
  5953. example: 'https://example.com/'
  5954. createdByName:
  5955. readOnly: true
  5956. type:
  5957. - string
  5958. - 'null'
  5959. createdAt:
  5960. type:
  5961. - string
  5962. - 'null'
  5963. format: date-time
  5964. Sale:
  5965. type: object
  5966. description: ''
  5967. deprecated: false
  5968. properties:
  5969. owner:
  5970. readOnly: true
  5971. type:
  5972. - string
  5973. - 'null'
  5974. format: iri-reference
  5975. example: 'https://example.com/'
  5976. ownerName:
  5977. readOnly: true
  5978. type:
  5979. - string
  5980. - 'null'
  5981. partner:
  5982. type:
  5983. - string
  5984. - 'null'
  5985. format: iri-reference
  5986. example: 'https://example.com/'
  5987. partnerType:
  5988. readOnly: true
  5989. type: string
  5990. enum:
  5991. - customer
  5992. - supplier
  5993. - service
  5994. partnerName:
  5995. readOnly: true
  5996. type:
  5997. - string
  5998. - 'null'
  5999. product:
  6000. type:
  6001. - string
  6002. - 'null'
  6003. format: iri-reference
  6004. example: 'https://example.com/'
  6005. productName:
  6006. readOnly: true
  6007. type:
  6008. - string
  6009. - 'null'
  6010. turnover:
  6011. type:
  6012. - integer
  6013. - 'null'
  6014. profit:
  6015. type:
  6016. - integer
  6017. - 'null'
  6018. quantity:
  6019. type:
  6020. - integer
  6021. - 'null'
  6022. comment:
  6023. type:
  6024. - string
  6025. - 'null'
  6026. createdAt:
  6027. readOnly: true
  6028. type:
  6029. - string
  6030. - 'null'
  6031. format: date-time
  6032. posts:
  6033. readOnly: true
  6034. description: 'array<int, PostingApi>'
  6035. type: array
  6036. items:
  6037. type: string
  6038. required:
  6039. - turnover
  6040. - profit
  6041. - quantity
  6042. Sale.jsonhal:
  6043. type: object
  6044. description: ''
  6045. deprecated: false
  6046. properties:
  6047. _links:
  6048. type: object
  6049. properties:
  6050. self:
  6051. type: object
  6052. properties:
  6053. href:
  6054. type: string
  6055. format: iri-reference
  6056. owner:
  6057. readOnly: true
  6058. type:
  6059. - string
  6060. - 'null'
  6061. format: iri-reference
  6062. example: 'https://example.com/'
  6063. ownerName:
  6064. readOnly: true
  6065. type:
  6066. - string
  6067. - 'null'
  6068. partner:
  6069. type:
  6070. - string
  6071. - 'null'
  6072. format: iri-reference
  6073. example: 'https://example.com/'
  6074. partnerType:
  6075. readOnly: true
  6076. type: string
  6077. enum:
  6078. - customer
  6079. - supplier
  6080. - service
  6081. partnerName:
  6082. readOnly: true
  6083. type:
  6084. - string
  6085. - 'null'
  6086. product:
  6087. type:
  6088. - string
  6089. - 'null'
  6090. format: iri-reference
  6091. example: 'https://example.com/'
  6092. productName:
  6093. readOnly: true
  6094. type:
  6095. - string
  6096. - 'null'
  6097. turnover:
  6098. type:
  6099. - integer
  6100. - 'null'
  6101. profit:
  6102. type:
  6103. - integer
  6104. - 'null'
  6105. quantity:
  6106. type:
  6107. - integer
  6108. - 'null'
  6109. comment:
  6110. type:
  6111. - string
  6112. - 'null'
  6113. createdAt:
  6114. readOnly: true
  6115. type:
  6116. - string
  6117. - 'null'
  6118. format: date-time
  6119. posts:
  6120. readOnly: true
  6121. description: 'array<int, PostingApi>'
  6122. type: array
  6123. items:
  6124. type: string
  6125. required:
  6126. - turnover
  6127. - profit
  6128. - quantity
  6129. Sale.jsonld:
  6130. type: object
  6131. description: ''
  6132. deprecated: false
  6133. properties:
  6134. '@context':
  6135. readOnly: true
  6136. oneOf:
  6137. -
  6138. type: string
  6139. -
  6140. type: object
  6141. properties:
  6142. '@vocab':
  6143. type: string
  6144. hydra:
  6145. type: string
  6146. enum: ['http://www.w3.org/ns/hydra/core#']
  6147. required:
  6148. - '@vocab'
  6149. - hydra
  6150. additionalProperties: true
  6151. '@id':
  6152. readOnly: true
  6153. type: string
  6154. '@type':
  6155. readOnly: true
  6156. type: string
  6157. owner:
  6158. readOnly: true
  6159. type:
  6160. - string
  6161. - 'null'
  6162. format: iri-reference
  6163. example: 'https://example.com/'
  6164. ownerName:
  6165. readOnly: true
  6166. type:
  6167. - string
  6168. - 'null'
  6169. partner:
  6170. type:
  6171. - string
  6172. - 'null'
  6173. format: iri-reference
  6174. example: 'https://example.com/'
  6175. partnerType:
  6176. readOnly: true
  6177. type: string
  6178. enum:
  6179. - customer
  6180. - supplier
  6181. - service
  6182. partnerName:
  6183. readOnly: true
  6184. type:
  6185. - string
  6186. - 'null'
  6187. product:
  6188. type:
  6189. - string
  6190. - 'null'
  6191. format: iri-reference
  6192. example: 'https://example.com/'
  6193. productName:
  6194. readOnly: true
  6195. type:
  6196. - string
  6197. - 'null'
  6198. turnover:
  6199. type:
  6200. - integer
  6201. - 'null'
  6202. profit:
  6203. type:
  6204. - integer
  6205. - 'null'
  6206. quantity:
  6207. type:
  6208. - integer
  6209. - 'null'
  6210. comment:
  6211. type:
  6212. - string
  6213. - 'null'
  6214. createdAt:
  6215. readOnly: true
  6216. type:
  6217. - string
  6218. - 'null'
  6219. format: date-time
  6220. posts:
  6221. readOnly: true
  6222. description: 'array<int, PostingApi>'
  6223. type: array
  6224. items:
  6225. type: string
  6226. required:
  6227. - turnover
  6228. - profit
  6229. - quantity
  6230. SaleSummary:
  6231. type: object
  6232. description: ''
  6233. deprecated: false
  6234. properties:
  6235. owner:
  6236. type:
  6237. - string
  6238. - 'null'
  6239. format: iri-reference
  6240. example: 'https://example.com/'
  6241. ownerName:
  6242. type:
  6243. - string
  6244. - 'null'
  6245. turnover:
  6246. type:
  6247. - integer
  6248. - 'null'
  6249. profit:
  6250. type:
  6251. - integer
  6252. - 'null'
  6253. SaleSummary.jsonhal:
  6254. type: object
  6255. description: ''
  6256. deprecated: false
  6257. properties:
  6258. _links:
  6259. type: object
  6260. properties:
  6261. self:
  6262. type: object
  6263. properties:
  6264. href:
  6265. type: string
  6266. format: iri-reference
  6267. owner:
  6268. type:
  6269. - string
  6270. - 'null'
  6271. format: iri-reference
  6272. example: 'https://example.com/'
  6273. ownerName:
  6274. type:
  6275. - string
  6276. - 'null'
  6277. turnover:
  6278. type:
  6279. - integer
  6280. - 'null'
  6281. profit:
  6282. type:
  6283. - integer
  6284. - 'null'
  6285. SaleSummary.jsonld:
  6286. type: object
  6287. description: ''
  6288. deprecated: false
  6289. properties:
  6290. '@id':
  6291. readOnly: true
  6292. type: string
  6293. '@type':
  6294. readOnly: true
  6295. type: string
  6296. owner:
  6297. type:
  6298. - string
  6299. - 'null'
  6300. format: iri-reference
  6301. example: 'https://example.com/'
  6302. ownerName:
  6303. type:
  6304. - string
  6305. - 'null'
  6306. turnover:
  6307. type:
  6308. - integer
  6309. - 'null'
  6310. profit:
  6311. type:
  6312. - integer
  6313. - 'null'
  6314. Task:
  6315. type: object
  6316. description: ''
  6317. deprecated: false
  6318. required:
  6319. - headline
  6320. - description
  6321. - assignedTo
  6322. - dueAt
  6323. - prio
  6324. - completed
  6325. properties:
  6326. headline:
  6327. type:
  6328. - string
  6329. - 'null'
  6330. description:
  6331. type:
  6332. - string
  6333. - 'null'
  6334. createdBy:
  6335. readOnly: true
  6336. type:
  6337. - string
  6338. - 'null'
  6339. format: iri-reference
  6340. example: 'https://example.com/'
  6341. createdByName:
  6342. readOnly: true
  6343. type:
  6344. - string
  6345. - 'null'
  6346. assignedTo:
  6347. type:
  6348. - string
  6349. - 'null'
  6350. format: iri-reference
  6351. example: 'https://example.com/'
  6352. assignedToName:
  6353. readOnly: true
  6354. type:
  6355. - string
  6356. - 'null'
  6357. dueAt:
  6358. type:
  6359. - string
  6360. - 'null'
  6361. format: date-time
  6362. partner:
  6363. type:
  6364. - string
  6365. - 'null'
  6366. format: iri-reference
  6367. example: 'https://example.com/'
  6368. partnerName:
  6369. readOnly: true
  6370. type:
  6371. - string
  6372. - 'null'
  6373. partnerType:
  6374. readOnly: true
  6375. type:
  6376. - string
  6377. - 'null'
  6378. enum:
  6379. - customer
  6380. - supplier
  6381. - service
  6382. - null
  6383. contact:
  6384. type:
  6385. - string
  6386. - 'null'
  6387. format: iri-reference
  6388. example: 'https://example.com/'
  6389. contactName:
  6390. readOnly: true
  6391. type:
  6392. - string
  6393. - 'null'
  6394. prio:
  6395. type: string
  6396. enum:
  6397. - low
  6398. - medium
  6399. - high
  6400. completed:
  6401. type:
  6402. - boolean
  6403. - 'null'
  6404. taskNotes:
  6405. readOnly: true
  6406. description: 'array<int, TaskNoteApi>'
  6407. type: array
  6408. items:
  6409. $ref: '#/components/schemas/TaskNote'
  6410. createdAt:
  6411. readOnly: true
  6412. type:
  6413. - string
  6414. - 'null'
  6415. format: date-time
  6416. Task.jsonhal:
  6417. type: object
  6418. description: ''
  6419. deprecated: false
  6420. required:
  6421. - headline
  6422. - description
  6423. - assignedTo
  6424. - dueAt
  6425. - prio
  6426. - completed
  6427. properties:
  6428. _links:
  6429. type: object
  6430. properties:
  6431. self:
  6432. type: object
  6433. properties:
  6434. href:
  6435. type: string
  6436. format: iri-reference
  6437. headline:
  6438. type:
  6439. - string
  6440. - 'null'
  6441. description:
  6442. type:
  6443. - string
  6444. - 'null'
  6445. createdBy:
  6446. readOnly: true
  6447. type:
  6448. - string
  6449. - 'null'
  6450. format: iri-reference
  6451. example: 'https://example.com/'
  6452. createdByName:
  6453. readOnly: true
  6454. type:
  6455. - string
  6456. - 'null'
  6457. assignedTo:
  6458. type:
  6459. - string
  6460. - 'null'
  6461. format: iri-reference
  6462. example: 'https://example.com/'
  6463. assignedToName:
  6464. readOnly: true
  6465. type:
  6466. - string
  6467. - 'null'
  6468. dueAt:
  6469. type:
  6470. - string
  6471. - 'null'
  6472. format: date-time
  6473. partner:
  6474. type:
  6475. - string
  6476. - 'null'
  6477. format: iri-reference
  6478. example: 'https://example.com/'
  6479. partnerName:
  6480. readOnly: true
  6481. type:
  6482. - string
  6483. - 'null'
  6484. partnerType:
  6485. readOnly: true
  6486. type:
  6487. - string
  6488. - 'null'
  6489. enum:
  6490. - customer
  6491. - supplier
  6492. - service
  6493. - null
  6494. contact:
  6495. type:
  6496. - string
  6497. - 'null'
  6498. format: iri-reference
  6499. example: 'https://example.com/'
  6500. contactName:
  6501. readOnly: true
  6502. type:
  6503. - string
  6504. - 'null'
  6505. prio:
  6506. type: string
  6507. enum:
  6508. - low
  6509. - medium
  6510. - high
  6511. completed:
  6512. type:
  6513. - boolean
  6514. - 'null'
  6515. taskNotes:
  6516. readOnly: true
  6517. description: 'array<int, TaskNoteApi>'
  6518. type: array
  6519. items:
  6520. $ref: '#/components/schemas/TaskNote.jsonhal'
  6521. createdAt:
  6522. readOnly: true
  6523. type:
  6524. - string
  6525. - 'null'
  6526. format: date-time
  6527. Task.jsonld:
  6528. type: object
  6529. description: ''
  6530. deprecated: false
  6531. required:
  6532. - headline
  6533. - description
  6534. - assignedTo
  6535. - dueAt
  6536. - prio
  6537. - completed
  6538. properties:
  6539. '@context':
  6540. readOnly: true
  6541. oneOf:
  6542. -
  6543. type: string
  6544. -
  6545. type: object
  6546. properties:
  6547. '@vocab':
  6548. type: string
  6549. hydra:
  6550. type: string
  6551. enum: ['http://www.w3.org/ns/hydra/core#']
  6552. required:
  6553. - '@vocab'
  6554. - hydra
  6555. additionalProperties: true
  6556. '@id':
  6557. readOnly: true
  6558. type: string
  6559. '@type':
  6560. readOnly: true
  6561. type: string
  6562. headline:
  6563. type:
  6564. - string
  6565. - 'null'
  6566. description:
  6567. type:
  6568. - string
  6569. - 'null'
  6570. createdBy:
  6571. readOnly: true
  6572. type:
  6573. - string
  6574. - 'null'
  6575. format: iri-reference
  6576. example: 'https://example.com/'
  6577. createdByName:
  6578. readOnly: true
  6579. type:
  6580. - string
  6581. - 'null'
  6582. assignedTo:
  6583. type:
  6584. - string
  6585. - 'null'
  6586. format: iri-reference
  6587. example: 'https://example.com/'
  6588. assignedToName:
  6589. readOnly: true
  6590. type:
  6591. - string
  6592. - 'null'
  6593. dueAt:
  6594. type:
  6595. - string
  6596. - 'null'
  6597. format: date-time
  6598. partner:
  6599. type:
  6600. - string
  6601. - 'null'
  6602. format: iri-reference
  6603. example: 'https://example.com/'
  6604. partnerName:
  6605. readOnly: true
  6606. type:
  6607. - string
  6608. - 'null'
  6609. partnerType:
  6610. readOnly: true
  6611. type:
  6612. - string
  6613. - 'null'
  6614. enum:
  6615. - customer
  6616. - supplier
  6617. - service
  6618. - null
  6619. contact:
  6620. type:
  6621. - string
  6622. - 'null'
  6623. format: iri-reference
  6624. example: 'https://example.com/'
  6625. contactName:
  6626. readOnly: true
  6627. type:
  6628. - string
  6629. - 'null'
  6630. prio:
  6631. type: string
  6632. enum:
  6633. - low
  6634. - medium
  6635. - high
  6636. completed:
  6637. type:
  6638. - boolean
  6639. - 'null'
  6640. taskNotes:
  6641. readOnly: true
  6642. description: 'array<int, TaskNoteApi>'
  6643. type: array
  6644. items:
  6645. $ref: '#/components/schemas/TaskNote.jsonld'
  6646. createdAt:
  6647. readOnly: true
  6648. type:
  6649. - string
  6650. - 'null'
  6651. format: date-time
  6652. TaskNote:
  6653. type: object
  6654. description: ''
  6655. deprecated: false
  6656. required:
  6657. - message
  6658. properties:
  6659. message:
  6660. type:
  6661. - string
  6662. - 'null'
  6663. owner:
  6664. readOnly: true
  6665. type:
  6666. - string
  6667. - 'null'
  6668. format: iri-reference
  6669. example: 'https://example.com/'
  6670. ownerName:
  6671. readOnly: true
  6672. type:
  6673. - string
  6674. - 'null'
  6675. task:
  6676. type:
  6677. - string
  6678. - 'null'
  6679. format: iri-reference
  6680. example: 'https://example.com/'
  6681. createdAt:
  6682. readOnly: true
  6683. type:
  6684. - string
  6685. - 'null'
  6686. format: date-time
  6687. TaskNote.jsonhal:
  6688. type: object
  6689. description: ''
  6690. deprecated: false
  6691. required:
  6692. - message
  6693. properties:
  6694. _links:
  6695. type: object
  6696. properties:
  6697. self:
  6698. type: object
  6699. properties:
  6700. href:
  6701. type: string
  6702. format: iri-reference
  6703. message:
  6704. type:
  6705. - string
  6706. - 'null'
  6707. owner:
  6708. readOnly: true
  6709. type:
  6710. - string
  6711. - 'null'
  6712. format: iri-reference
  6713. example: 'https://example.com/'
  6714. ownerName:
  6715. readOnly: true
  6716. type:
  6717. - string
  6718. - 'null'
  6719. task:
  6720. type:
  6721. - string
  6722. - 'null'
  6723. format: iri-reference
  6724. example: 'https://example.com/'
  6725. createdAt:
  6726. readOnly: true
  6727. type:
  6728. - string
  6729. - 'null'
  6730. format: date-time
  6731. TaskNote.jsonld:
  6732. type: object
  6733. description: ''
  6734. deprecated: false
  6735. required:
  6736. - message
  6737. properties:
  6738. '@context':
  6739. readOnly: true
  6740. oneOf:
  6741. -
  6742. type: string
  6743. -
  6744. type: object
  6745. properties:
  6746. '@vocab':
  6747. type: string
  6748. hydra:
  6749. type: string
  6750. enum: ['http://www.w3.org/ns/hydra/core#']
  6751. required:
  6752. - '@vocab'
  6753. - hydra
  6754. additionalProperties: true
  6755. '@id':
  6756. readOnly: true
  6757. type: string
  6758. '@type':
  6759. readOnly: true
  6760. type: string
  6761. message:
  6762. type:
  6763. - string
  6764. - 'null'
  6765. owner:
  6766. readOnly: true
  6767. type:
  6768. - string
  6769. - 'null'
  6770. format: iri-reference
  6771. example: 'https://example.com/'
  6772. ownerName:
  6773. readOnly: true
  6774. type:
  6775. - string
  6776. - 'null'
  6777. task:
  6778. type:
  6779. - string
  6780. - 'null'
  6781. format: iri-reference
  6782. example: 'https://example.com/'
  6783. createdAt:
  6784. readOnly: true
  6785. type:
  6786. - string
  6787. - 'null'
  6788. format: date-time
  6789. User:
  6790. type: object
  6791. description: ''
  6792. deprecated: false
  6793. required:
  6794. - email
  6795. - firstName
  6796. - lastName
  6797. properties:
  6798. email:
  6799. format: email
  6800. externalDocs:
  6801. url: 'https://schema.org/email'
  6802. type:
  6803. - string
  6804. - 'null'
  6805. firstName:
  6806. type:
  6807. - string
  6808. - 'null'
  6809. lastName:
  6810. type:
  6811. - string
  6812. - 'null'
  6813. image:
  6814. type:
  6815. - string
  6816. - 'null'
  6817. format: iri-reference
  6818. example: 'https://example.com/'
  6819. password:
  6820. writeOnly: true
  6821. description: 'The plaintext password when being set or changed.'
  6822. type:
  6823. - string
  6824. - 'null'
  6825. active:
  6826. type: boolean
  6827. createdAt:
  6828. readOnly: true
  6829. type:
  6830. - string
  6831. - 'null'
  6832. format: date-time
  6833. User.jsonhal:
  6834. type: object
  6835. description: ''
  6836. deprecated: false
  6837. required:
  6838. - email
  6839. - firstName
  6840. - lastName
  6841. properties:
  6842. _links:
  6843. type: object
  6844. properties:
  6845. self:
  6846. type: object
  6847. properties:
  6848. href:
  6849. type: string
  6850. format: iri-reference
  6851. email:
  6852. format: email
  6853. externalDocs:
  6854. url: 'https://schema.org/email'
  6855. type:
  6856. - string
  6857. - 'null'
  6858. firstName:
  6859. type:
  6860. - string
  6861. - 'null'
  6862. lastName:
  6863. type:
  6864. - string
  6865. - 'null'
  6866. image:
  6867. type:
  6868. - string
  6869. - 'null'
  6870. format: iri-reference
  6871. example: 'https://example.com/'
  6872. password:
  6873. writeOnly: true
  6874. description: 'The plaintext password when being set or changed.'
  6875. type:
  6876. - string
  6877. - 'null'
  6878. active:
  6879. type: boolean
  6880. createdAt:
  6881. readOnly: true
  6882. type:
  6883. - string
  6884. - 'null'
  6885. format: date-time
  6886. User.jsonld:
  6887. type: object
  6888. description: ''
  6889. deprecated: false
  6890. required:
  6891. - email
  6892. - firstName
  6893. - lastName
  6894. properties:
  6895. '@context':
  6896. readOnly: true
  6897. oneOf:
  6898. -
  6899. type: string
  6900. -
  6901. type: object
  6902. properties:
  6903. '@vocab':
  6904. type: string
  6905. hydra:
  6906. type: string
  6907. enum: ['http://www.w3.org/ns/hydra/core#']
  6908. required:
  6909. - '@vocab'
  6910. - hydra
  6911. additionalProperties: true
  6912. '@id':
  6913. readOnly: true
  6914. type: string
  6915. '@type':
  6916. readOnly: true
  6917. type: string
  6918. email:
  6919. format: email
  6920. externalDocs:
  6921. url: 'https://schema.org/email'
  6922. type:
  6923. - string
  6924. - 'null'
  6925. firstName:
  6926. type:
  6927. - string
  6928. - 'null'
  6929. lastName:
  6930. type:
  6931. - string
  6932. - 'null'
  6933. image:
  6934. type:
  6935. - string
  6936. - 'null'
  6937. format: iri-reference
  6938. example: 'https://example.com/'
  6939. password:
  6940. writeOnly: true
  6941. description: 'The plaintext password when being set or changed.'
  6942. type:
  6943. - string
  6944. - 'null'
  6945. active:
  6946. type: boolean
  6947. createdAt:
  6948. readOnly: true
  6949. type:
  6950. - string
  6951. - 'null'
  6952. format: date-time
  6953. UserProduct:
  6954. type: object
  6955. description: ''
  6956. deprecated: false
  6957. properties:
  6958. user:
  6959. readOnly: true
  6960. type:
  6961. - string
  6962. - 'null'
  6963. format: iri-reference
  6964. example: 'https://example.com/'
  6965. userName:
  6966. readOnly: true
  6967. type:
  6968. - string
  6969. - 'null'
  6970. product:
  6971. type:
  6972. - string
  6973. - 'null'
  6974. format: iri-reference
  6975. example: 'https://example.com/'
  6976. productName:
  6977. readOnly: true
  6978. type:
  6979. - string
  6980. - 'null'
  6981. createdAt:
  6982. readOnly: true
  6983. type:
  6984. - string
  6985. - 'null'
  6986. format: date-time
  6987. owner:
  6988. readOnly: true
  6989. type:
  6990. - string
  6991. - 'null'
  6992. format: iri-reference
  6993. example: 'https://example.com/'
  6994. required:
  6995. - product
  6996. UserProduct.jsonhal:
  6997. type: object
  6998. description: ''
  6999. deprecated: false
  7000. properties:
  7001. _links:
  7002. type: object
  7003. properties:
  7004. self:
  7005. type: object
  7006. properties:
  7007. href:
  7008. type: string
  7009. format: iri-reference
  7010. user:
  7011. readOnly: true
  7012. type:
  7013. - string
  7014. - 'null'
  7015. format: iri-reference
  7016. example: 'https://example.com/'
  7017. userName:
  7018. readOnly: true
  7019. type:
  7020. - string
  7021. - 'null'
  7022. product:
  7023. type:
  7024. - string
  7025. - 'null'
  7026. format: iri-reference
  7027. example: 'https://example.com/'
  7028. productName:
  7029. readOnly: true
  7030. type:
  7031. - string
  7032. - 'null'
  7033. createdAt:
  7034. readOnly: true
  7035. type:
  7036. - string
  7037. - 'null'
  7038. format: date-time
  7039. owner:
  7040. readOnly: true
  7041. type:
  7042. - string
  7043. - 'null'
  7044. format: iri-reference
  7045. example: 'https://example.com/'
  7046. required:
  7047. - product
  7048. UserProduct.jsonld:
  7049. type: object
  7050. description: ''
  7051. deprecated: false
  7052. properties:
  7053. '@context':
  7054. readOnly: true
  7055. oneOf:
  7056. -
  7057. type: string
  7058. -
  7059. type: object
  7060. properties:
  7061. '@vocab':
  7062. type: string
  7063. hydra:
  7064. type: string
  7065. enum: ['http://www.w3.org/ns/hydra/core#']
  7066. required:
  7067. - '@vocab'
  7068. - hydra
  7069. additionalProperties: true
  7070. '@id':
  7071. readOnly: true
  7072. type: string
  7073. '@type':
  7074. readOnly: true
  7075. type: string
  7076. user:
  7077. readOnly: true
  7078. type:
  7079. - string
  7080. - 'null'
  7081. format: iri-reference
  7082. example: 'https://example.com/'
  7083. userName:
  7084. readOnly: true
  7085. type:
  7086. - string
  7087. - 'null'
  7088. product:
  7089. type:
  7090. - string
  7091. - 'null'
  7092. format: iri-reference
  7093. example: 'https://example.com/'
  7094. productName:
  7095. readOnly: true
  7096. type:
  7097. - string
  7098. - 'null'
  7099. createdAt:
  7100. readOnly: true
  7101. type:
  7102. - string
  7103. - 'null'
  7104. format: date-time
  7105. owner:
  7106. readOnly: true
  7107. type:
  7108. - string
  7109. - 'null'
  7110. format: iri-reference
  7111. example: 'https://example.com/'
  7112. required:
  7113. - product
  7114. responses: { }
  7115. parameters: { }
  7116. examples: { }
  7117. requestBodies: { }
  7118. headers: { }
  7119. securitySchemes:
  7120. JWT:
  7121. type: http
  7122. scheme: bearer
  7123. bearerFormat: JWT
  7124. security:
  7125. -
  7126. JWT: []
  7127. tags: []