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

6712 rivejä
193 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/users:
  3438. get:
  3439. operationId: api_users_get_collection
  3440. tags:
  3441. - User
  3442. responses:
  3443. 200:
  3444. description: 'User collection'
  3445. content:
  3446. application/ld+json:
  3447. schema:
  3448. type: object
  3449. properties:
  3450. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.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/User'
  3461. text/html:
  3462. schema:
  3463. type: array
  3464. items:
  3465. $ref: '#/components/schemas/User'
  3466. application/hal+json:
  3467. schema:
  3468. type: object
  3469. properties:
  3470. _embedded: { type: array, items: { $ref: '#/components/schemas/User.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 User resources.'
  3478. description: 'Retrieves the collection of User 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: firstName
  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: lastName
  3522. in: query
  3523. description: ''
  3524. required: false
  3525. deprecated: false
  3526. allowEmptyValue: true
  3527. schema:
  3528. type: string
  3529. style: form
  3530. explode: false
  3531. allowReserved: false
  3532. deprecated: false
  3533. post:
  3534. operationId: api_users_post
  3535. tags:
  3536. - User
  3537. responses:
  3538. 201:
  3539. description: 'User resource created'
  3540. content:
  3541. application/ld+json:
  3542. schema:
  3543. $ref: '#/components/schemas/User.jsonld'
  3544. application/json:
  3545. schema:
  3546. $ref: '#/components/schemas/User'
  3547. text/html:
  3548. schema:
  3549. $ref: '#/components/schemas/User'
  3550. application/hal+json:
  3551. schema:
  3552. $ref: '#/components/schemas/User.jsonhal'
  3553. links: { }
  3554. 400:
  3555. description: 'Invalid input'
  3556. 422:
  3557. description: 'Unprocessable entity'
  3558. summary: 'Creates a User resource.'
  3559. description: 'Creates a User resource.'
  3560. parameters: []
  3561. requestBody:
  3562. description: 'The new User resource'
  3563. content:
  3564. application/ld+json:
  3565. schema:
  3566. $ref: '#/components/schemas/User.jsonld'
  3567. application/json:
  3568. schema:
  3569. $ref: '#/components/schemas/User'
  3570. text/html:
  3571. schema:
  3572. $ref: '#/components/schemas/User'
  3573. application/hal+json:
  3574. schema:
  3575. $ref: '#/components/schemas/User.jsonhal'
  3576. required: true
  3577. deprecated: false
  3578. parameters: []
  3579. '/api/users/{id}':
  3580. get:
  3581. operationId: api_users_id_get
  3582. tags:
  3583. - User
  3584. responses:
  3585. 200:
  3586. description: 'User resource'
  3587. content:
  3588. application/ld+json:
  3589. schema:
  3590. $ref: '#/components/schemas/User.jsonld'
  3591. application/json:
  3592. schema:
  3593. $ref: '#/components/schemas/User'
  3594. text/html:
  3595. schema:
  3596. $ref: '#/components/schemas/User'
  3597. application/hal+json:
  3598. schema:
  3599. $ref: '#/components/schemas/User.jsonhal'
  3600. 404:
  3601. description: 'Resource not found'
  3602. summary: 'Retrieves a User resource.'
  3603. description: 'Retrieves a User resource.'
  3604. parameters:
  3605. -
  3606. name: id
  3607. in: path
  3608. description: 'User identifier'
  3609. required: true
  3610. deprecated: false
  3611. allowEmptyValue: false
  3612. schema:
  3613. type: string
  3614. style: simple
  3615. explode: false
  3616. allowReserved: false
  3617. deprecated: false
  3618. parameters: []
  3619. /auth:
  3620. post:
  3621. operationId: login_check_post
  3622. tags:
  3623. - 'Login Check'
  3624. responses:
  3625. 200:
  3626. description: 'User token created'
  3627. content:
  3628. application/json:
  3629. schema:
  3630. type: object
  3631. properties:
  3632. token: { readOnly: true, type: string, nullable: false }
  3633. required:
  3634. - token
  3635. summary: 'Creates a user token.'
  3636. description: 'Creates a user token.'
  3637. requestBody:
  3638. description: 'The login data'
  3639. content:
  3640. application/json:
  3641. schema:
  3642. type: object
  3643. properties:
  3644. email:
  3645. type: string
  3646. nullable: false
  3647. password:
  3648. type: string
  3649. nullable: false
  3650. required:
  3651. - email
  3652. - password
  3653. required: true
  3654. parameters: []
  3655. components:
  3656. schemas:
  3657. Comment:
  3658. type: object
  3659. description: ''
  3660. deprecated: false
  3661. required:
  3662. - message
  3663. properties:
  3664. message:
  3665. type:
  3666. - string
  3667. - 'null'
  3668. owner:
  3669. readOnly: true
  3670. type:
  3671. - string
  3672. - 'null'
  3673. format: iri-reference
  3674. example: 'https://example.com/'
  3675. ownerName:
  3676. readOnly: true
  3677. type:
  3678. - string
  3679. - 'null'
  3680. post:
  3681. type:
  3682. - string
  3683. - 'null'
  3684. format: iri-reference
  3685. example: 'https://example.com/'
  3686. createdAt:
  3687. readOnly: true
  3688. type:
  3689. - string
  3690. - 'null'
  3691. format: date-time
  3692. Comment.jsonhal:
  3693. type: object
  3694. description: ''
  3695. deprecated: false
  3696. required:
  3697. - message
  3698. properties:
  3699. _links:
  3700. type: object
  3701. properties:
  3702. self:
  3703. type: object
  3704. properties:
  3705. href:
  3706. type: string
  3707. format: iri-reference
  3708. message:
  3709. type:
  3710. - string
  3711. - 'null'
  3712. owner:
  3713. readOnly: true
  3714. type:
  3715. - string
  3716. - 'null'
  3717. format: iri-reference
  3718. example: 'https://example.com/'
  3719. ownerName:
  3720. readOnly: true
  3721. type:
  3722. - string
  3723. - 'null'
  3724. post:
  3725. type:
  3726. - string
  3727. - 'null'
  3728. format: iri-reference
  3729. example: 'https://example.com/'
  3730. createdAt:
  3731. readOnly: true
  3732. type:
  3733. - string
  3734. - 'null'
  3735. format: date-time
  3736. Comment.jsonld:
  3737. type: object
  3738. description: ''
  3739. deprecated: false
  3740. required:
  3741. - message
  3742. properties:
  3743. '@context':
  3744. readOnly: true
  3745. oneOf:
  3746. -
  3747. type: string
  3748. -
  3749. type: object
  3750. properties:
  3751. '@vocab':
  3752. type: string
  3753. hydra:
  3754. type: string
  3755. enum: ['http://www.w3.org/ns/hydra/core#']
  3756. required:
  3757. - '@vocab'
  3758. - hydra
  3759. additionalProperties: true
  3760. '@id':
  3761. readOnly: true
  3762. type: string
  3763. '@type':
  3764. readOnly: true
  3765. type: string
  3766. message:
  3767. type:
  3768. - string
  3769. - 'null'
  3770. owner:
  3771. readOnly: true
  3772. type:
  3773. - string
  3774. - 'null'
  3775. format: iri-reference
  3776. example: 'https://example.com/'
  3777. ownerName:
  3778. readOnly: true
  3779. type:
  3780. - string
  3781. - 'null'
  3782. post:
  3783. type:
  3784. - string
  3785. - 'null'
  3786. format: iri-reference
  3787. example: 'https://example.com/'
  3788. createdAt:
  3789. readOnly: true
  3790. type:
  3791. - string
  3792. - 'null'
  3793. format: date-time
  3794. Contact:
  3795. type: object
  3796. description: ''
  3797. deprecated: false
  3798. required:
  3799. - firstName
  3800. - lastName
  3801. - partner
  3802. properties:
  3803. firstName:
  3804. type:
  3805. - string
  3806. - 'null'
  3807. lastName:
  3808. type:
  3809. - string
  3810. - 'null'
  3811. partner:
  3812. type:
  3813. - string
  3814. - 'null'
  3815. format: iri-reference
  3816. example: 'https://example.com/'
  3817. birthday:
  3818. type:
  3819. - string
  3820. - 'null'
  3821. format: date-time
  3822. image:
  3823. type:
  3824. - string
  3825. - 'null'
  3826. format: iri-reference
  3827. example: 'https://example.com/'
  3828. imageUrl:
  3829. readOnly: true
  3830. type:
  3831. - string
  3832. - 'null'
  3833. position:
  3834. type:
  3835. - string
  3836. - 'null'
  3837. phone:
  3838. type:
  3839. - string
  3840. - 'null'
  3841. email:
  3842. format: email
  3843. externalDocs:
  3844. url: 'https://schema.org/email'
  3845. type:
  3846. - string
  3847. - 'null'
  3848. posts:
  3849. readOnly: true
  3850. type: array
  3851. items:
  3852. type: string
  3853. format: iri-reference
  3854. example: 'https://example.com/'
  3855. createdBy:
  3856. readOnly: true
  3857. type:
  3858. - string
  3859. - 'null'
  3860. format: iri-reference
  3861. example: 'https://example.com/'
  3862. createdByName:
  3863. readOnly: true
  3864. type:
  3865. - string
  3866. - 'null'
  3867. createdAt:
  3868. readOnly: true
  3869. type:
  3870. - string
  3871. - 'null'
  3872. format: date-time
  3873. Contact.jsonhal:
  3874. type: object
  3875. description: ''
  3876. deprecated: false
  3877. required:
  3878. - firstName
  3879. - lastName
  3880. - partner
  3881. properties:
  3882. _links:
  3883. type: object
  3884. properties:
  3885. self:
  3886. type: object
  3887. properties:
  3888. href:
  3889. type: string
  3890. format: iri-reference
  3891. firstName:
  3892. type:
  3893. - string
  3894. - 'null'
  3895. lastName:
  3896. type:
  3897. - string
  3898. - 'null'
  3899. partner:
  3900. type:
  3901. - string
  3902. - 'null'
  3903. format: iri-reference
  3904. example: 'https://example.com/'
  3905. birthday:
  3906. type:
  3907. - string
  3908. - 'null'
  3909. format: date-time
  3910. image:
  3911. type:
  3912. - string
  3913. - 'null'
  3914. format: iri-reference
  3915. example: 'https://example.com/'
  3916. imageUrl:
  3917. readOnly: true
  3918. type:
  3919. - string
  3920. - 'null'
  3921. position:
  3922. type:
  3923. - string
  3924. - 'null'
  3925. phone:
  3926. type:
  3927. - string
  3928. - 'null'
  3929. email:
  3930. format: email
  3931. externalDocs:
  3932. url: 'https://schema.org/email'
  3933. type:
  3934. - string
  3935. - 'null'
  3936. posts:
  3937. readOnly: true
  3938. type: array
  3939. items:
  3940. type: string
  3941. format: iri-reference
  3942. example: 'https://example.com/'
  3943. createdBy:
  3944. readOnly: true
  3945. type:
  3946. - string
  3947. - 'null'
  3948. format: iri-reference
  3949. example: 'https://example.com/'
  3950. createdByName:
  3951. readOnly: true
  3952. type:
  3953. - string
  3954. - 'null'
  3955. createdAt:
  3956. readOnly: true
  3957. type:
  3958. - string
  3959. - 'null'
  3960. format: date-time
  3961. Contact.jsonld:
  3962. type: object
  3963. description: ''
  3964. deprecated: false
  3965. required:
  3966. - firstName
  3967. - lastName
  3968. - partner
  3969. properties:
  3970. '@context':
  3971. readOnly: true
  3972. oneOf:
  3973. -
  3974. type: string
  3975. -
  3976. type: object
  3977. properties:
  3978. '@vocab':
  3979. type: string
  3980. hydra:
  3981. type: string
  3982. enum: ['http://www.w3.org/ns/hydra/core#']
  3983. required:
  3984. - '@vocab'
  3985. - hydra
  3986. additionalProperties: true
  3987. '@id':
  3988. readOnly: true
  3989. type: string
  3990. '@type':
  3991. readOnly: true
  3992. type: string
  3993. firstName:
  3994. type:
  3995. - string
  3996. - 'null'
  3997. lastName:
  3998. type:
  3999. - string
  4000. - 'null'
  4001. partner:
  4002. type:
  4003. - string
  4004. - 'null'
  4005. format: iri-reference
  4006. example: 'https://example.com/'
  4007. birthday:
  4008. type:
  4009. - string
  4010. - 'null'
  4011. format: date-time
  4012. image:
  4013. type:
  4014. - string
  4015. - 'null'
  4016. format: iri-reference
  4017. example: 'https://example.com/'
  4018. imageUrl:
  4019. readOnly: true
  4020. type:
  4021. - string
  4022. - 'null'
  4023. position:
  4024. type:
  4025. - string
  4026. - 'null'
  4027. phone:
  4028. type:
  4029. - string
  4030. - 'null'
  4031. email:
  4032. format: email
  4033. externalDocs:
  4034. url: 'https://schema.org/email'
  4035. type:
  4036. - string
  4037. - 'null'
  4038. posts:
  4039. readOnly: true
  4040. type: array
  4041. items:
  4042. type: string
  4043. format: iri-reference
  4044. example: 'https://example.com/'
  4045. createdBy:
  4046. readOnly: true
  4047. type:
  4048. - string
  4049. - 'null'
  4050. format: iri-reference
  4051. example: 'https://example.com/'
  4052. createdByName:
  4053. readOnly: true
  4054. type:
  4055. - string
  4056. - 'null'
  4057. createdAt:
  4058. readOnly: true
  4059. type:
  4060. - string
  4061. - 'null'
  4062. format: date-time
  4063. ContactPartnerProduct:
  4064. type: object
  4065. description: ''
  4066. deprecated: false
  4067. required:
  4068. - contact
  4069. - partnerProduct
  4070. properties:
  4071. contact:
  4072. type:
  4073. - string
  4074. - 'null'
  4075. format: iri-reference
  4076. example: 'https://example.com/'
  4077. partnerProduct:
  4078. type:
  4079. - string
  4080. - 'null'
  4081. format: iri-reference
  4082. example: 'https://example.com/'
  4083. productName:
  4084. readOnly: true
  4085. type:
  4086. - string
  4087. - 'null'
  4088. createdAt:
  4089. readOnly: true
  4090. type:
  4091. - string
  4092. - 'null'
  4093. format: date-time
  4094. ContactPartnerProduct.jsonhal:
  4095. type: object
  4096. description: ''
  4097. deprecated: false
  4098. required:
  4099. - contact
  4100. - partnerProduct
  4101. properties:
  4102. _links:
  4103. type: object
  4104. properties:
  4105. self:
  4106. type: object
  4107. properties:
  4108. href:
  4109. type: string
  4110. format: iri-reference
  4111. contact:
  4112. type:
  4113. - string
  4114. - 'null'
  4115. format: iri-reference
  4116. example: 'https://example.com/'
  4117. partnerProduct:
  4118. type:
  4119. - string
  4120. - 'null'
  4121. format: iri-reference
  4122. example: 'https://example.com/'
  4123. productName:
  4124. readOnly: true
  4125. type:
  4126. - string
  4127. - 'null'
  4128. createdAt:
  4129. readOnly: true
  4130. type:
  4131. - string
  4132. - 'null'
  4133. format: date-time
  4134. ContactPartnerProduct.jsonld:
  4135. type: object
  4136. description: ''
  4137. deprecated: false
  4138. required:
  4139. - contact
  4140. - partnerProduct
  4141. properties:
  4142. '@context':
  4143. readOnly: true
  4144. oneOf:
  4145. -
  4146. type: string
  4147. -
  4148. type: object
  4149. properties:
  4150. '@vocab':
  4151. type: string
  4152. hydra:
  4153. type: string
  4154. enum: ['http://www.w3.org/ns/hydra/core#']
  4155. required:
  4156. - '@vocab'
  4157. - hydra
  4158. additionalProperties: true
  4159. '@id':
  4160. readOnly: true
  4161. type: string
  4162. '@type':
  4163. readOnly: true
  4164. type: string
  4165. contact:
  4166. type:
  4167. - string
  4168. - 'null'
  4169. format: iri-reference
  4170. example: 'https://example.com/'
  4171. partnerProduct:
  4172. type:
  4173. - string
  4174. - 'null'
  4175. format: iri-reference
  4176. example: 'https://example.com/'
  4177. productName:
  4178. readOnly: true
  4179. type:
  4180. - string
  4181. - 'null'
  4182. createdAt:
  4183. readOnly: true
  4184. type:
  4185. - string
  4186. - 'null'
  4187. format: date-time
  4188. Document:
  4189. type: object
  4190. description: ''
  4191. deprecated: false
  4192. required:
  4193. - name
  4194. - documentObject
  4195. properties:
  4196. name:
  4197. type:
  4198. - string
  4199. - 'null'
  4200. description:
  4201. type:
  4202. - string
  4203. - 'null'
  4204. partner:
  4205. type:
  4206. - string
  4207. - 'null'
  4208. format: iri-reference
  4209. example: 'https://example.com/'
  4210. partnerName:
  4211. readOnly: true
  4212. type:
  4213. - string
  4214. - 'null'
  4215. product:
  4216. type:
  4217. - string
  4218. - 'null'
  4219. format: iri-reference
  4220. example: 'https://example.com/'
  4221. productName:
  4222. readOnly: true
  4223. type:
  4224. - string
  4225. - 'null'
  4226. documentObject:
  4227. type:
  4228. - string
  4229. - 'null'
  4230. format: iri-reference
  4231. example: 'https://example.com/'
  4232. documentUrl:
  4233. readOnly: true
  4234. type:
  4235. - string
  4236. - 'null'
  4237. createdBy:
  4238. readOnly: true
  4239. type:
  4240. - string
  4241. - 'null'
  4242. format: iri-reference
  4243. example: 'https://example.com/'
  4244. createdByName:
  4245. readOnly: true
  4246. type:
  4247. - string
  4248. - 'null'
  4249. createdAt:
  4250. readOnly: true
  4251. type:
  4252. - string
  4253. - 'null'
  4254. format: date-time
  4255. Document.jsonhal:
  4256. type: object
  4257. description: ''
  4258. deprecated: false
  4259. required:
  4260. - name
  4261. - documentObject
  4262. properties:
  4263. _links:
  4264. type: object
  4265. properties:
  4266. self:
  4267. type: object
  4268. properties:
  4269. href:
  4270. type: string
  4271. format: iri-reference
  4272. name:
  4273. type:
  4274. - string
  4275. - 'null'
  4276. description:
  4277. type:
  4278. - string
  4279. - 'null'
  4280. partner:
  4281. type:
  4282. - string
  4283. - 'null'
  4284. format: iri-reference
  4285. example: 'https://example.com/'
  4286. partnerName:
  4287. readOnly: true
  4288. type:
  4289. - string
  4290. - 'null'
  4291. product:
  4292. type:
  4293. - string
  4294. - 'null'
  4295. format: iri-reference
  4296. example: 'https://example.com/'
  4297. productName:
  4298. readOnly: true
  4299. type:
  4300. - string
  4301. - 'null'
  4302. documentObject:
  4303. type:
  4304. - string
  4305. - 'null'
  4306. format: iri-reference
  4307. example: 'https://example.com/'
  4308. documentUrl:
  4309. readOnly: true
  4310. type:
  4311. - string
  4312. - 'null'
  4313. createdBy:
  4314. readOnly: true
  4315. type:
  4316. - string
  4317. - 'null'
  4318. format: iri-reference
  4319. example: 'https://example.com/'
  4320. createdByName:
  4321. readOnly: true
  4322. type:
  4323. - string
  4324. - 'null'
  4325. createdAt:
  4326. readOnly: true
  4327. type:
  4328. - string
  4329. - 'null'
  4330. format: date-time
  4331. Document.jsonld:
  4332. type: object
  4333. description: ''
  4334. deprecated: false
  4335. required:
  4336. - name
  4337. - documentObject
  4338. properties:
  4339. '@context':
  4340. readOnly: true
  4341. oneOf:
  4342. -
  4343. type: string
  4344. -
  4345. type: object
  4346. properties:
  4347. '@vocab':
  4348. type: string
  4349. hydra:
  4350. type: string
  4351. enum: ['http://www.w3.org/ns/hydra/core#']
  4352. required:
  4353. - '@vocab'
  4354. - hydra
  4355. additionalProperties: true
  4356. '@id':
  4357. readOnly: true
  4358. type: string
  4359. '@type':
  4360. readOnly: true
  4361. type: string
  4362. name:
  4363. type:
  4364. - string
  4365. - 'null'
  4366. description:
  4367. type:
  4368. - string
  4369. - 'null'
  4370. partner:
  4371. type:
  4372. - string
  4373. - 'null'
  4374. format: iri-reference
  4375. example: 'https://example.com/'
  4376. partnerName:
  4377. readOnly: true
  4378. type:
  4379. - string
  4380. - 'null'
  4381. product:
  4382. type:
  4383. - string
  4384. - 'null'
  4385. format: iri-reference
  4386. example: 'https://example.com/'
  4387. productName:
  4388. readOnly: true
  4389. type:
  4390. - string
  4391. - 'null'
  4392. documentObject:
  4393. type:
  4394. - string
  4395. - 'null'
  4396. format: iri-reference
  4397. example: 'https://example.com/'
  4398. documentUrl:
  4399. readOnly: true
  4400. type:
  4401. - string
  4402. - 'null'
  4403. createdBy:
  4404. readOnly: true
  4405. type:
  4406. - string
  4407. - 'null'
  4408. format: iri-reference
  4409. example: 'https://example.com/'
  4410. createdByName:
  4411. readOnly: true
  4412. type:
  4413. - string
  4414. - 'null'
  4415. createdAt:
  4416. readOnly: true
  4417. type:
  4418. - string
  4419. - 'null'
  4420. format: date-time
  4421. DocumentObject-document_object.read:
  4422. type: object
  4423. description: ''
  4424. deprecated: false
  4425. externalDocs:
  4426. url: 'https://schema.org/MediaObject'
  4427. properties:
  4428. contentUrl:
  4429. externalDocs:
  4430. url: 'https://schema.org/contentUrl'
  4431. type:
  4432. - string
  4433. - 'null'
  4434. DocumentObject.jsonhal-document_object.read:
  4435. type: object
  4436. description: ''
  4437. deprecated: false
  4438. externalDocs:
  4439. url: 'https://schema.org/MediaObject'
  4440. properties:
  4441. _links:
  4442. type: object
  4443. properties:
  4444. self:
  4445. type: object
  4446. properties:
  4447. href:
  4448. type: string
  4449. format: iri-reference
  4450. contentUrl:
  4451. externalDocs:
  4452. url: 'https://schema.org/contentUrl'
  4453. type:
  4454. - string
  4455. - 'null'
  4456. DocumentObject.jsonld-document_object.read:
  4457. type: object
  4458. description: ''
  4459. deprecated: false
  4460. externalDocs:
  4461. url: 'https://schema.org/MediaObject'
  4462. properties:
  4463. '@context':
  4464. readOnly: true
  4465. oneOf:
  4466. -
  4467. type: string
  4468. -
  4469. type: object
  4470. properties:
  4471. '@vocab':
  4472. type: string
  4473. hydra:
  4474. type: string
  4475. enum: ['http://www.w3.org/ns/hydra/core#']
  4476. required:
  4477. - '@vocab'
  4478. - hydra
  4479. additionalProperties: true
  4480. '@id':
  4481. readOnly: true
  4482. type: string
  4483. '@type':
  4484. readOnly: true
  4485. type: string
  4486. contentUrl:
  4487. externalDocs:
  4488. url: 'https://schema.org/contentUrl'
  4489. type:
  4490. - string
  4491. - 'null'
  4492. MediaObject-media_object.read:
  4493. type: object
  4494. description: ''
  4495. deprecated: false
  4496. externalDocs:
  4497. url: 'https://schema.org/MediaObject'
  4498. properties:
  4499. contentUrl:
  4500. externalDocs:
  4501. url: 'https://schema.org/contentUrl'
  4502. type:
  4503. - string
  4504. - 'null'
  4505. MediaObject.jsonhal-media_object.read:
  4506. type: object
  4507. description: ''
  4508. deprecated: false
  4509. externalDocs:
  4510. url: 'https://schema.org/MediaObject'
  4511. properties:
  4512. _links:
  4513. type: object
  4514. properties:
  4515. self:
  4516. type: object
  4517. properties:
  4518. href:
  4519. type: string
  4520. format: iri-reference
  4521. contentUrl:
  4522. externalDocs:
  4523. url: 'https://schema.org/contentUrl'
  4524. type:
  4525. - string
  4526. - 'null'
  4527. MediaObject.jsonld-media_object.read:
  4528. type: object
  4529. description: ''
  4530. deprecated: false
  4531. externalDocs:
  4532. url: 'https://schema.org/MediaObject'
  4533. properties:
  4534. '@context':
  4535. readOnly: true
  4536. oneOf:
  4537. -
  4538. type: string
  4539. -
  4540. type: object
  4541. properties:
  4542. '@vocab':
  4543. type: string
  4544. hydra:
  4545. type: string
  4546. enum: ['http://www.w3.org/ns/hydra/core#']
  4547. required:
  4548. - '@vocab'
  4549. - hydra
  4550. additionalProperties: true
  4551. '@id':
  4552. readOnly: true
  4553. type: string
  4554. '@type':
  4555. readOnly: true
  4556. type: string
  4557. contentUrl:
  4558. externalDocs:
  4559. url: 'https://schema.org/contentUrl'
  4560. type:
  4561. - string
  4562. - 'null'
  4563. Partner:
  4564. type: object
  4565. description: ''
  4566. deprecated: false
  4567. required:
  4568. - name
  4569. - partnerType
  4570. properties:
  4571. name:
  4572. type: string
  4573. partnerType:
  4574. type: string
  4575. enum:
  4576. - customer
  4577. - supplier
  4578. - service
  4579. description:
  4580. type:
  4581. - string
  4582. - 'null'
  4583. street:
  4584. type:
  4585. - string
  4586. - 'null'
  4587. streetNo:
  4588. type:
  4589. - string
  4590. - 'null'
  4591. zip:
  4592. type:
  4593. - string
  4594. - 'null'
  4595. city:
  4596. type:
  4597. - string
  4598. - 'null'
  4599. country:
  4600. type:
  4601. - string
  4602. - 'null'
  4603. website:
  4604. type:
  4605. - string
  4606. - 'null'
  4607. logo:
  4608. type:
  4609. - string
  4610. - 'null'
  4611. format: iri-reference
  4612. example: 'https://example.com/'
  4613. logoUrl:
  4614. readOnly: true
  4615. type:
  4616. - string
  4617. - 'null'
  4618. createdBy:
  4619. readOnly: true
  4620. type:
  4621. - string
  4622. - 'null'
  4623. format: iri-reference
  4624. example: 'https://example.com/'
  4625. createdByName:
  4626. readOnly: true
  4627. type:
  4628. - string
  4629. - 'null'
  4630. createdAt:
  4631. readOnly: true
  4632. type:
  4633. - string
  4634. - 'null'
  4635. format: date-time
  4636. posts:
  4637. readOnly: true
  4638. description: 'array<int, PostingApi>'
  4639. type: array
  4640. items:
  4641. type: string
  4642. contacts:
  4643. readOnly: true
  4644. type: array
  4645. items:
  4646. type: string
  4647. format: iri-reference
  4648. example: 'https://example.com/'
  4649. partnerProducts:
  4650. readOnly: true
  4651. type: array
  4652. items:
  4653. type: string
  4654. format: iri-reference
  4655. example: 'https://example.com/'
  4656. Partner.jsonhal:
  4657. type: object
  4658. description: ''
  4659. deprecated: false
  4660. required:
  4661. - name
  4662. - partnerType
  4663. properties:
  4664. _links:
  4665. type: object
  4666. properties:
  4667. self:
  4668. type: object
  4669. properties:
  4670. href:
  4671. type: string
  4672. format: iri-reference
  4673. name:
  4674. type: string
  4675. partnerType:
  4676. type: string
  4677. enum:
  4678. - customer
  4679. - supplier
  4680. - service
  4681. description:
  4682. type:
  4683. - string
  4684. - 'null'
  4685. street:
  4686. type:
  4687. - string
  4688. - 'null'
  4689. streetNo:
  4690. type:
  4691. - string
  4692. - 'null'
  4693. zip:
  4694. type:
  4695. - string
  4696. - 'null'
  4697. city:
  4698. type:
  4699. - string
  4700. - 'null'
  4701. country:
  4702. type:
  4703. - string
  4704. - 'null'
  4705. website:
  4706. type:
  4707. - string
  4708. - 'null'
  4709. logo:
  4710. type:
  4711. - string
  4712. - 'null'
  4713. format: iri-reference
  4714. example: 'https://example.com/'
  4715. logoUrl:
  4716. readOnly: true
  4717. type:
  4718. - string
  4719. - 'null'
  4720. createdBy:
  4721. readOnly: true
  4722. type:
  4723. - string
  4724. - 'null'
  4725. format: iri-reference
  4726. example: 'https://example.com/'
  4727. createdByName:
  4728. readOnly: true
  4729. type:
  4730. - string
  4731. - 'null'
  4732. createdAt:
  4733. readOnly: true
  4734. type:
  4735. - string
  4736. - 'null'
  4737. format: date-time
  4738. posts:
  4739. readOnly: true
  4740. description: 'array<int, PostingApi>'
  4741. type: array
  4742. items:
  4743. type: string
  4744. contacts:
  4745. readOnly: true
  4746. type: array
  4747. items:
  4748. type: string
  4749. format: iri-reference
  4750. example: 'https://example.com/'
  4751. partnerProducts:
  4752. readOnly: true
  4753. type: array
  4754. items:
  4755. type: string
  4756. format: iri-reference
  4757. example: 'https://example.com/'
  4758. Partner.jsonld:
  4759. type: object
  4760. description: ''
  4761. deprecated: false
  4762. required:
  4763. - name
  4764. - partnerType
  4765. properties:
  4766. '@context':
  4767. readOnly: true
  4768. oneOf:
  4769. -
  4770. type: string
  4771. -
  4772. type: object
  4773. properties:
  4774. '@vocab':
  4775. type: string
  4776. hydra:
  4777. type: string
  4778. enum: ['http://www.w3.org/ns/hydra/core#']
  4779. required:
  4780. - '@vocab'
  4781. - hydra
  4782. additionalProperties: true
  4783. '@id':
  4784. readOnly: true
  4785. type: string
  4786. '@type':
  4787. readOnly: true
  4788. type: string
  4789. name:
  4790. type: string
  4791. partnerType:
  4792. type: string
  4793. enum:
  4794. - customer
  4795. - supplier
  4796. - service
  4797. description:
  4798. type:
  4799. - string
  4800. - 'null'
  4801. street:
  4802. type:
  4803. - string
  4804. - 'null'
  4805. streetNo:
  4806. type:
  4807. - string
  4808. - 'null'
  4809. zip:
  4810. type:
  4811. - string
  4812. - 'null'
  4813. city:
  4814. type:
  4815. - string
  4816. - 'null'
  4817. country:
  4818. type:
  4819. - string
  4820. - 'null'
  4821. website:
  4822. type:
  4823. - string
  4824. - 'null'
  4825. logo:
  4826. type:
  4827. - string
  4828. - 'null'
  4829. format: iri-reference
  4830. example: 'https://example.com/'
  4831. logoUrl:
  4832. readOnly: true
  4833. type:
  4834. - string
  4835. - 'null'
  4836. createdBy:
  4837. readOnly: true
  4838. type:
  4839. - string
  4840. - 'null'
  4841. format: iri-reference
  4842. example: 'https://example.com/'
  4843. createdByName:
  4844. readOnly: true
  4845. type:
  4846. - string
  4847. - 'null'
  4848. createdAt:
  4849. readOnly: true
  4850. type:
  4851. - string
  4852. - 'null'
  4853. format: date-time
  4854. posts:
  4855. readOnly: true
  4856. description: 'array<int, PostingApi>'
  4857. type: array
  4858. items:
  4859. type: string
  4860. contacts:
  4861. readOnly: true
  4862. type: array
  4863. items:
  4864. type: string
  4865. format: iri-reference
  4866. example: 'https://example.com/'
  4867. partnerProducts:
  4868. readOnly: true
  4869. type: array
  4870. items:
  4871. type: string
  4872. format: iri-reference
  4873. example: 'https://example.com/'
  4874. PartnerFollow:
  4875. type: object
  4876. description: ''
  4877. deprecated: false
  4878. properties:
  4879. user:
  4880. readOnly: true
  4881. type:
  4882. - string
  4883. - 'null'
  4884. format: iri-reference
  4885. example: 'https://example.com/'
  4886. userName:
  4887. readOnly: true
  4888. type:
  4889. - string
  4890. - 'null'
  4891. partner:
  4892. type:
  4893. - string
  4894. - 'null'
  4895. format: iri-reference
  4896. example: 'https://example.com/'
  4897. partnerName:
  4898. readOnly: true
  4899. type:
  4900. - string
  4901. - 'null'
  4902. createdAt:
  4903. readOnly: true
  4904. type:
  4905. - string
  4906. - 'null'
  4907. format: date-time
  4908. required:
  4909. - partner
  4910. PartnerFollow.jsonhal:
  4911. type: object
  4912. description: ''
  4913. deprecated: false
  4914. properties:
  4915. _links:
  4916. type: object
  4917. properties:
  4918. self:
  4919. type: object
  4920. properties:
  4921. href:
  4922. type: string
  4923. format: iri-reference
  4924. user:
  4925. readOnly: true
  4926. type:
  4927. - string
  4928. - 'null'
  4929. format: iri-reference
  4930. example: 'https://example.com/'
  4931. userName:
  4932. readOnly: true
  4933. type:
  4934. - string
  4935. - 'null'
  4936. partner:
  4937. type:
  4938. - string
  4939. - 'null'
  4940. format: iri-reference
  4941. example: 'https://example.com/'
  4942. partnerName:
  4943. readOnly: true
  4944. type:
  4945. - string
  4946. - 'null'
  4947. createdAt:
  4948. readOnly: true
  4949. type:
  4950. - string
  4951. - 'null'
  4952. format: date-time
  4953. required:
  4954. - partner
  4955. PartnerFollow.jsonld:
  4956. type: object
  4957. description: ''
  4958. deprecated: false
  4959. properties:
  4960. '@context':
  4961. readOnly: true
  4962. oneOf:
  4963. -
  4964. type: string
  4965. -
  4966. type: object
  4967. properties:
  4968. '@vocab':
  4969. type: string
  4970. hydra:
  4971. type: string
  4972. enum: ['http://www.w3.org/ns/hydra/core#']
  4973. required:
  4974. - '@vocab'
  4975. - hydra
  4976. additionalProperties: true
  4977. '@id':
  4978. readOnly: true
  4979. type: string
  4980. '@type':
  4981. readOnly: true
  4982. type: string
  4983. user:
  4984. readOnly: true
  4985. type:
  4986. - string
  4987. - 'null'
  4988. format: iri-reference
  4989. example: 'https://example.com/'
  4990. userName:
  4991. readOnly: true
  4992. type:
  4993. - string
  4994. - 'null'
  4995. partner:
  4996. type:
  4997. - string
  4998. - 'null'
  4999. format: iri-reference
  5000. example: 'https://example.com/'
  5001. partnerName:
  5002. readOnly: true
  5003. type:
  5004. - string
  5005. - 'null'
  5006. createdAt:
  5007. readOnly: true
  5008. type:
  5009. - string
  5010. - 'null'
  5011. format: date-time
  5012. required:
  5013. - partner
  5014. PartnerProduct:
  5015. type: object
  5016. description: ''
  5017. deprecated: false
  5018. required:
  5019. - partner
  5020. - product
  5021. properties:
  5022. partner:
  5023. type:
  5024. - string
  5025. - 'null'
  5026. format: iri-reference
  5027. example: 'https://example.com/'
  5028. partnerName:
  5029. readOnly: true
  5030. type:
  5031. - string
  5032. - 'null'
  5033. product:
  5034. type:
  5035. - string
  5036. - 'null'
  5037. format: iri-reference
  5038. example: 'https://example.com/'
  5039. productName:
  5040. readOnly: true
  5041. type:
  5042. - string
  5043. - 'null'
  5044. createdAt:
  5045. readOnly: true
  5046. type:
  5047. - string
  5048. - 'null'
  5049. format: date-time
  5050. PartnerProduct.jsonhal:
  5051. type: object
  5052. description: ''
  5053. deprecated: false
  5054. required:
  5055. - partner
  5056. - product
  5057. properties:
  5058. _links:
  5059. type: object
  5060. properties:
  5061. self:
  5062. type: object
  5063. properties:
  5064. href:
  5065. type: string
  5066. format: iri-reference
  5067. partner:
  5068. type:
  5069. - string
  5070. - 'null'
  5071. format: iri-reference
  5072. example: 'https://example.com/'
  5073. partnerName:
  5074. readOnly: true
  5075. type:
  5076. - string
  5077. - 'null'
  5078. product:
  5079. type:
  5080. - string
  5081. - 'null'
  5082. format: iri-reference
  5083. example: 'https://example.com/'
  5084. productName:
  5085. readOnly: true
  5086. type:
  5087. - string
  5088. - 'null'
  5089. createdAt:
  5090. readOnly: true
  5091. type:
  5092. - string
  5093. - 'null'
  5094. format: date-time
  5095. PartnerProduct.jsonld:
  5096. type: object
  5097. description: ''
  5098. deprecated: false
  5099. required:
  5100. - partner
  5101. - product
  5102. properties:
  5103. '@context':
  5104. readOnly: true
  5105. oneOf:
  5106. -
  5107. type: string
  5108. -
  5109. type: object
  5110. properties:
  5111. '@vocab':
  5112. type: string
  5113. hydra:
  5114. type: string
  5115. enum: ['http://www.w3.org/ns/hydra/core#']
  5116. required:
  5117. - '@vocab'
  5118. - hydra
  5119. additionalProperties: true
  5120. '@id':
  5121. readOnly: true
  5122. type: string
  5123. '@type':
  5124. readOnly: true
  5125. type: string
  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. product:
  5138. type:
  5139. - string
  5140. - 'null'
  5141. format: iri-reference
  5142. example: 'https://example.com/'
  5143. productName:
  5144. readOnly: true
  5145. type:
  5146. - string
  5147. - 'null'
  5148. createdAt:
  5149. readOnly: true
  5150. type:
  5151. - string
  5152. - 'null'
  5153. format: date-time
  5154. Post:
  5155. type: object
  5156. description: ''
  5157. deprecated: false
  5158. required:
  5159. - headline
  5160. - message
  5161. properties:
  5162. headline:
  5163. type:
  5164. - string
  5165. - 'null'
  5166. message:
  5167. type:
  5168. - string
  5169. - 'null'
  5170. owner:
  5171. readOnly: true
  5172. type:
  5173. - string
  5174. - 'null'
  5175. format: iri-reference
  5176. example: 'https://example.com/'
  5177. ownerName:
  5178. readOnly: true
  5179. type:
  5180. - string
  5181. - 'null'
  5182. partner:
  5183. type:
  5184. - string
  5185. - 'null'
  5186. format: iri-reference
  5187. example: 'https://example.com/'
  5188. partnerName:
  5189. readOnly: true
  5190. type:
  5191. - string
  5192. - 'null'
  5193. product:
  5194. type:
  5195. - string
  5196. - 'null'
  5197. format: iri-reference
  5198. example: 'https://example.com/'
  5199. productName:
  5200. readOnly: true
  5201. type:
  5202. - string
  5203. - 'null'
  5204. contact:
  5205. type:
  5206. - string
  5207. - 'null'
  5208. format: iri-reference
  5209. example: 'https://example.com/'
  5210. sale:
  5211. type:
  5212. - string
  5213. - 'null'
  5214. format: iri-reference
  5215. example: 'https://example.com/'
  5216. comments:
  5217. readOnly: true
  5218. description: 'array<int, CommentApi>'
  5219. type: array
  5220. items:
  5221. $ref: '#/components/schemas/Comment'
  5222. createdAt:
  5223. readOnly: true
  5224. type:
  5225. - string
  5226. - 'null'
  5227. format: date-time
  5228. Post-posting.create:
  5229. type: object
  5230. description: ''
  5231. deprecated: false
  5232. required:
  5233. - headline
  5234. - message
  5235. properties:
  5236. headline:
  5237. type:
  5238. - string
  5239. - 'null'
  5240. message:
  5241. type:
  5242. - string
  5243. - 'null'
  5244. partner:
  5245. type:
  5246. - string
  5247. - 'null'
  5248. format: iri-reference
  5249. example: 'https://example.com/'
  5250. product:
  5251. type:
  5252. - string
  5253. - 'null'
  5254. format: iri-reference
  5255. example: 'https://example.com/'
  5256. contact:
  5257. type:
  5258. - string
  5259. - 'null'
  5260. format: iri-reference
  5261. example: 'https://example.com/'
  5262. sale:
  5263. type:
  5264. - string
  5265. - 'null'
  5266. format: iri-reference
  5267. example: 'https://example.com/'
  5268. Post-posting.patch:
  5269. type: object
  5270. description: ''
  5271. deprecated: false
  5272. required:
  5273. - headline
  5274. - message
  5275. properties:
  5276. headline:
  5277. type:
  5278. - string
  5279. - 'null'
  5280. message:
  5281. type:
  5282. - string
  5283. - 'null'
  5284. Post.jsonhal:
  5285. type: object
  5286. description: ''
  5287. deprecated: false
  5288. required:
  5289. - headline
  5290. - message
  5291. properties:
  5292. _links:
  5293. type: object
  5294. properties:
  5295. self:
  5296. type: object
  5297. properties:
  5298. href:
  5299. type: string
  5300. format: iri-reference
  5301. headline:
  5302. type:
  5303. - string
  5304. - 'null'
  5305. message:
  5306. type:
  5307. - string
  5308. - 'null'
  5309. owner:
  5310. readOnly: true
  5311. type:
  5312. - string
  5313. - 'null'
  5314. format: iri-reference
  5315. example: 'https://example.com/'
  5316. ownerName:
  5317. readOnly: true
  5318. type:
  5319. - string
  5320. - 'null'
  5321. partner:
  5322. type:
  5323. - string
  5324. - 'null'
  5325. format: iri-reference
  5326. example: 'https://example.com/'
  5327. partnerName:
  5328. readOnly: true
  5329. type:
  5330. - string
  5331. - 'null'
  5332. product:
  5333. type:
  5334. - string
  5335. - 'null'
  5336. format: iri-reference
  5337. example: 'https://example.com/'
  5338. productName:
  5339. readOnly: true
  5340. type:
  5341. - string
  5342. - 'null'
  5343. contact:
  5344. type:
  5345. - string
  5346. - 'null'
  5347. format: iri-reference
  5348. example: 'https://example.com/'
  5349. sale:
  5350. type:
  5351. - string
  5352. - 'null'
  5353. format: iri-reference
  5354. example: 'https://example.com/'
  5355. comments:
  5356. readOnly: true
  5357. description: 'array<int, CommentApi>'
  5358. type: array
  5359. items:
  5360. $ref: '#/components/schemas/Comment.jsonhal'
  5361. createdAt:
  5362. readOnly: true
  5363. type:
  5364. - string
  5365. - 'null'
  5366. format: date-time
  5367. Post.jsonhal-posting.create:
  5368. type: object
  5369. description: ''
  5370. deprecated: false
  5371. required:
  5372. - headline
  5373. - message
  5374. properties:
  5375. _links:
  5376. type: object
  5377. properties:
  5378. self:
  5379. type: object
  5380. properties:
  5381. href:
  5382. type: string
  5383. format: iri-reference
  5384. headline:
  5385. type:
  5386. - string
  5387. - 'null'
  5388. message:
  5389. type:
  5390. - string
  5391. - 'null'
  5392. partner:
  5393. type:
  5394. - string
  5395. - 'null'
  5396. format: iri-reference
  5397. example: 'https://example.com/'
  5398. product:
  5399. type:
  5400. - string
  5401. - 'null'
  5402. format: iri-reference
  5403. example: 'https://example.com/'
  5404. contact:
  5405. type:
  5406. - string
  5407. - 'null'
  5408. format: iri-reference
  5409. example: 'https://example.com/'
  5410. sale:
  5411. type:
  5412. - string
  5413. - 'null'
  5414. format: iri-reference
  5415. example: 'https://example.com/'
  5416. Post.jsonld:
  5417. type: object
  5418. description: ''
  5419. deprecated: false
  5420. required:
  5421. - headline
  5422. - message
  5423. properties:
  5424. '@context':
  5425. readOnly: true
  5426. oneOf:
  5427. -
  5428. type: string
  5429. -
  5430. type: object
  5431. properties:
  5432. '@vocab':
  5433. type: string
  5434. hydra:
  5435. type: string
  5436. enum: ['http://www.w3.org/ns/hydra/core#']
  5437. required:
  5438. - '@vocab'
  5439. - hydra
  5440. additionalProperties: true
  5441. '@id':
  5442. readOnly: true
  5443. type: string
  5444. '@type':
  5445. readOnly: true
  5446. type: string
  5447. headline:
  5448. type:
  5449. - string
  5450. - 'null'
  5451. message:
  5452. type:
  5453. - string
  5454. - 'null'
  5455. owner:
  5456. readOnly: true
  5457. type:
  5458. - string
  5459. - 'null'
  5460. format: iri-reference
  5461. example: 'https://example.com/'
  5462. ownerName:
  5463. readOnly: true
  5464. type:
  5465. - string
  5466. - 'null'
  5467. partner:
  5468. type:
  5469. - string
  5470. - 'null'
  5471. format: iri-reference
  5472. example: 'https://example.com/'
  5473. partnerName:
  5474. readOnly: true
  5475. type:
  5476. - string
  5477. - 'null'
  5478. product:
  5479. type:
  5480. - string
  5481. - 'null'
  5482. format: iri-reference
  5483. example: 'https://example.com/'
  5484. productName:
  5485. readOnly: true
  5486. type:
  5487. - string
  5488. - 'null'
  5489. contact:
  5490. type:
  5491. - string
  5492. - 'null'
  5493. format: iri-reference
  5494. example: 'https://example.com/'
  5495. sale:
  5496. type:
  5497. - string
  5498. - 'null'
  5499. format: iri-reference
  5500. example: 'https://example.com/'
  5501. comments:
  5502. readOnly: true
  5503. description: 'array<int, CommentApi>'
  5504. type: array
  5505. items:
  5506. $ref: '#/components/schemas/Comment.jsonld'
  5507. createdAt:
  5508. readOnly: true
  5509. type:
  5510. - string
  5511. - 'null'
  5512. format: date-time
  5513. Post.jsonld-posting.create:
  5514. type: object
  5515. description: ''
  5516. deprecated: false
  5517. required:
  5518. - headline
  5519. - message
  5520. properties:
  5521. headline:
  5522. type:
  5523. - string
  5524. - 'null'
  5525. message:
  5526. type:
  5527. - string
  5528. - 'null'
  5529. partner:
  5530. type:
  5531. - string
  5532. - 'null'
  5533. format: iri-reference
  5534. example: 'https://example.com/'
  5535. product:
  5536. type:
  5537. - string
  5538. - 'null'
  5539. format: iri-reference
  5540. example: 'https://example.com/'
  5541. contact:
  5542. type:
  5543. - string
  5544. - 'null'
  5545. format: iri-reference
  5546. example: 'https://example.com/'
  5547. sale:
  5548. type:
  5549. - string
  5550. - 'null'
  5551. format: iri-reference
  5552. example: 'https://example.com/'
  5553. Product:
  5554. type: object
  5555. description: ''
  5556. deprecated: false
  5557. required:
  5558. - name
  5559. properties:
  5560. name:
  5561. type: string
  5562. description:
  5563. type:
  5564. - string
  5565. - 'null'
  5566. image:
  5567. type:
  5568. - string
  5569. - 'null'
  5570. format: iri-reference
  5571. example: 'https://example.com/'
  5572. imageUrl:
  5573. readOnly: true
  5574. type:
  5575. - string
  5576. - 'null'
  5577. createdBy:
  5578. readOnly: true
  5579. type:
  5580. - string
  5581. - 'null'
  5582. format: iri-reference
  5583. example: 'https://example.com/'
  5584. createdByName:
  5585. readOnly: true
  5586. type:
  5587. - string
  5588. - 'null'
  5589. createdAt:
  5590. type:
  5591. - string
  5592. - 'null'
  5593. format: date-time
  5594. Product.jsonhal:
  5595. type: object
  5596. description: ''
  5597. deprecated: false
  5598. required:
  5599. - name
  5600. properties:
  5601. _links:
  5602. type: object
  5603. properties:
  5604. self:
  5605. type: object
  5606. properties:
  5607. href:
  5608. type: string
  5609. format: iri-reference
  5610. name:
  5611. type: string
  5612. description:
  5613. type:
  5614. - string
  5615. - 'null'
  5616. image:
  5617. type:
  5618. - string
  5619. - 'null'
  5620. format: iri-reference
  5621. example: 'https://example.com/'
  5622. imageUrl:
  5623. readOnly: true
  5624. type:
  5625. - string
  5626. - 'null'
  5627. createdBy:
  5628. readOnly: true
  5629. type:
  5630. - string
  5631. - 'null'
  5632. format: iri-reference
  5633. example: 'https://example.com/'
  5634. createdByName:
  5635. readOnly: true
  5636. type:
  5637. - string
  5638. - 'null'
  5639. createdAt:
  5640. type:
  5641. - string
  5642. - 'null'
  5643. format: date-time
  5644. Product.jsonld:
  5645. type: object
  5646. description: ''
  5647. deprecated: false
  5648. required:
  5649. - name
  5650. properties:
  5651. '@context':
  5652. readOnly: true
  5653. oneOf:
  5654. -
  5655. type: string
  5656. -
  5657. type: object
  5658. properties:
  5659. '@vocab':
  5660. type: string
  5661. hydra:
  5662. type: string
  5663. enum: ['http://www.w3.org/ns/hydra/core#']
  5664. required:
  5665. - '@vocab'
  5666. - hydra
  5667. additionalProperties: true
  5668. '@id':
  5669. readOnly: true
  5670. type: string
  5671. '@type':
  5672. readOnly: true
  5673. type: string
  5674. name:
  5675. type: string
  5676. description:
  5677. type:
  5678. - string
  5679. - 'null'
  5680. image:
  5681. type:
  5682. - string
  5683. - 'null'
  5684. format: iri-reference
  5685. example: 'https://example.com/'
  5686. imageUrl:
  5687. readOnly: true
  5688. type:
  5689. - string
  5690. - 'null'
  5691. createdBy:
  5692. readOnly: true
  5693. type:
  5694. - string
  5695. - 'null'
  5696. format: iri-reference
  5697. example: 'https://example.com/'
  5698. createdByName:
  5699. readOnly: true
  5700. type:
  5701. - string
  5702. - 'null'
  5703. createdAt:
  5704. type:
  5705. - string
  5706. - 'null'
  5707. format: date-time
  5708. Sale:
  5709. type: object
  5710. description: ''
  5711. deprecated: false
  5712. properties:
  5713. owner:
  5714. readOnly: true
  5715. type:
  5716. - string
  5717. - 'null'
  5718. format: iri-reference
  5719. example: 'https://example.com/'
  5720. ownerName:
  5721. readOnly: true
  5722. type:
  5723. - string
  5724. - 'null'
  5725. partner:
  5726. type:
  5727. - string
  5728. - 'null'
  5729. format: iri-reference
  5730. example: 'https://example.com/'
  5731. partnerType:
  5732. readOnly: true
  5733. type: string
  5734. enum:
  5735. - customer
  5736. - supplier
  5737. - service
  5738. partnerName:
  5739. readOnly: true
  5740. type:
  5741. - string
  5742. - 'null'
  5743. product:
  5744. type:
  5745. - string
  5746. - 'null'
  5747. format: iri-reference
  5748. example: 'https://example.com/'
  5749. productName:
  5750. readOnly: true
  5751. type:
  5752. - string
  5753. - 'null'
  5754. turnover:
  5755. type:
  5756. - integer
  5757. - 'null'
  5758. profit:
  5759. type:
  5760. - integer
  5761. - 'null'
  5762. quantity:
  5763. type:
  5764. - integer
  5765. - 'null'
  5766. comment:
  5767. type:
  5768. - string
  5769. - 'null'
  5770. createdAt:
  5771. readOnly: true
  5772. type:
  5773. - string
  5774. - 'null'
  5775. format: date-time
  5776. posts:
  5777. readOnly: true
  5778. description: 'array<int, PostingApi>'
  5779. type: array
  5780. items:
  5781. type: string
  5782. required:
  5783. - turnover
  5784. - profit
  5785. - quantity
  5786. Sale.jsonhal:
  5787. type: object
  5788. description: ''
  5789. deprecated: false
  5790. properties:
  5791. _links:
  5792. type: object
  5793. properties:
  5794. self:
  5795. type: object
  5796. properties:
  5797. href:
  5798. type: string
  5799. format: iri-reference
  5800. owner:
  5801. readOnly: true
  5802. type:
  5803. - string
  5804. - 'null'
  5805. format: iri-reference
  5806. example: 'https://example.com/'
  5807. ownerName:
  5808. readOnly: true
  5809. type:
  5810. - string
  5811. - 'null'
  5812. partner:
  5813. type:
  5814. - string
  5815. - 'null'
  5816. format: iri-reference
  5817. example: 'https://example.com/'
  5818. partnerType:
  5819. readOnly: true
  5820. type: string
  5821. enum:
  5822. - customer
  5823. - supplier
  5824. - service
  5825. partnerName:
  5826. readOnly: true
  5827. type:
  5828. - string
  5829. - 'null'
  5830. product:
  5831. type:
  5832. - string
  5833. - 'null'
  5834. format: iri-reference
  5835. example: 'https://example.com/'
  5836. productName:
  5837. readOnly: true
  5838. type:
  5839. - string
  5840. - 'null'
  5841. turnover:
  5842. type:
  5843. - integer
  5844. - 'null'
  5845. profit:
  5846. type:
  5847. - integer
  5848. - 'null'
  5849. quantity:
  5850. type:
  5851. - integer
  5852. - 'null'
  5853. comment:
  5854. type:
  5855. - string
  5856. - 'null'
  5857. createdAt:
  5858. readOnly: true
  5859. type:
  5860. - string
  5861. - 'null'
  5862. format: date-time
  5863. posts:
  5864. readOnly: true
  5865. description: 'array<int, PostingApi>'
  5866. type: array
  5867. items:
  5868. type: string
  5869. required:
  5870. - turnover
  5871. - profit
  5872. - quantity
  5873. Sale.jsonld:
  5874. type: object
  5875. description: ''
  5876. deprecated: false
  5877. properties:
  5878. '@context':
  5879. readOnly: true
  5880. oneOf:
  5881. -
  5882. type: string
  5883. -
  5884. type: object
  5885. properties:
  5886. '@vocab':
  5887. type: string
  5888. hydra:
  5889. type: string
  5890. enum: ['http://www.w3.org/ns/hydra/core#']
  5891. required:
  5892. - '@vocab'
  5893. - hydra
  5894. additionalProperties: true
  5895. '@id':
  5896. readOnly: true
  5897. type: string
  5898. '@type':
  5899. readOnly: true
  5900. type: string
  5901. owner:
  5902. readOnly: true
  5903. type:
  5904. - string
  5905. - 'null'
  5906. format: iri-reference
  5907. example: 'https://example.com/'
  5908. ownerName:
  5909. readOnly: true
  5910. type:
  5911. - string
  5912. - 'null'
  5913. partner:
  5914. type:
  5915. - string
  5916. - 'null'
  5917. format: iri-reference
  5918. example: 'https://example.com/'
  5919. partnerType:
  5920. readOnly: true
  5921. type: string
  5922. enum:
  5923. - customer
  5924. - supplier
  5925. - service
  5926. partnerName:
  5927. readOnly: true
  5928. type:
  5929. - string
  5930. - 'null'
  5931. product:
  5932. type:
  5933. - string
  5934. - 'null'
  5935. format: iri-reference
  5936. example: 'https://example.com/'
  5937. productName:
  5938. readOnly: true
  5939. type:
  5940. - string
  5941. - 'null'
  5942. turnover:
  5943. type:
  5944. - integer
  5945. - 'null'
  5946. profit:
  5947. type:
  5948. - integer
  5949. - 'null'
  5950. quantity:
  5951. type:
  5952. - integer
  5953. - 'null'
  5954. comment:
  5955. type:
  5956. - string
  5957. - 'null'
  5958. createdAt:
  5959. readOnly: true
  5960. type:
  5961. - string
  5962. - 'null'
  5963. format: date-time
  5964. posts:
  5965. readOnly: true
  5966. description: 'array<int, PostingApi>'
  5967. type: array
  5968. items:
  5969. type: string
  5970. required:
  5971. - turnover
  5972. - profit
  5973. - quantity
  5974. SaleSummary:
  5975. type: object
  5976. description: ''
  5977. deprecated: false
  5978. properties:
  5979. owner:
  5980. type:
  5981. - string
  5982. - 'null'
  5983. format: iri-reference
  5984. example: 'https://example.com/'
  5985. ownerName:
  5986. type:
  5987. - string
  5988. - 'null'
  5989. turnover:
  5990. type:
  5991. - integer
  5992. - 'null'
  5993. profit:
  5994. type:
  5995. - integer
  5996. - 'null'
  5997. SaleSummary.jsonhal:
  5998. type: object
  5999. description: ''
  6000. deprecated: false
  6001. properties:
  6002. _links:
  6003. type: object
  6004. properties:
  6005. self:
  6006. type: object
  6007. properties:
  6008. href:
  6009. type: string
  6010. format: iri-reference
  6011. owner:
  6012. type:
  6013. - string
  6014. - 'null'
  6015. format: iri-reference
  6016. example: 'https://example.com/'
  6017. ownerName:
  6018. type:
  6019. - string
  6020. - 'null'
  6021. turnover:
  6022. type:
  6023. - integer
  6024. - 'null'
  6025. profit:
  6026. type:
  6027. - integer
  6028. - 'null'
  6029. SaleSummary.jsonld:
  6030. type: object
  6031. description: ''
  6032. deprecated: false
  6033. properties:
  6034. '@id':
  6035. readOnly: true
  6036. type: string
  6037. '@type':
  6038. readOnly: true
  6039. type: string
  6040. owner:
  6041. type:
  6042. - string
  6043. - 'null'
  6044. format: iri-reference
  6045. example: 'https://example.com/'
  6046. ownerName:
  6047. type:
  6048. - string
  6049. - 'null'
  6050. turnover:
  6051. type:
  6052. - integer
  6053. - 'null'
  6054. profit:
  6055. type:
  6056. - integer
  6057. - 'null'
  6058. Task:
  6059. type: object
  6060. description: ''
  6061. deprecated: false
  6062. required:
  6063. - headline
  6064. - description
  6065. - assignedTo
  6066. - dueAt
  6067. - prio
  6068. - completed
  6069. properties:
  6070. headline:
  6071. type:
  6072. - string
  6073. - 'null'
  6074. description:
  6075. type:
  6076. - string
  6077. - 'null'
  6078. createdBy:
  6079. readOnly: true
  6080. type:
  6081. - string
  6082. - 'null'
  6083. format: iri-reference
  6084. example: 'https://example.com/'
  6085. createdByName:
  6086. readOnly: true
  6087. type:
  6088. - string
  6089. - 'null'
  6090. assignedTo:
  6091. type:
  6092. - string
  6093. - 'null'
  6094. format: iri-reference
  6095. example: 'https://example.com/'
  6096. assignedToName:
  6097. readOnly: true
  6098. type:
  6099. - string
  6100. - 'null'
  6101. dueAt:
  6102. type:
  6103. - string
  6104. - 'null'
  6105. format: date-time
  6106. partner:
  6107. type:
  6108. - string
  6109. - 'null'
  6110. format: iri-reference
  6111. example: 'https://example.com/'
  6112. partnerName:
  6113. readOnly: true
  6114. type:
  6115. - string
  6116. - 'null'
  6117. partnerType:
  6118. readOnly: true
  6119. type:
  6120. - string
  6121. - 'null'
  6122. enum:
  6123. - customer
  6124. - supplier
  6125. - service
  6126. - null
  6127. contact:
  6128. type:
  6129. - string
  6130. - 'null'
  6131. format: iri-reference
  6132. example: 'https://example.com/'
  6133. contactName:
  6134. readOnly: true
  6135. type:
  6136. - string
  6137. - 'null'
  6138. prio:
  6139. type: string
  6140. enum:
  6141. - low
  6142. - medium
  6143. - high
  6144. completed:
  6145. type:
  6146. - boolean
  6147. - 'null'
  6148. taskNotes:
  6149. readOnly: true
  6150. description: 'array<int, TaskNoteApi>'
  6151. type: array
  6152. items:
  6153. $ref: '#/components/schemas/TaskNote'
  6154. createdAt:
  6155. readOnly: true
  6156. type:
  6157. - string
  6158. - 'null'
  6159. format: date-time
  6160. Task.jsonhal:
  6161. type: object
  6162. description: ''
  6163. deprecated: false
  6164. required:
  6165. - headline
  6166. - description
  6167. - assignedTo
  6168. - dueAt
  6169. - prio
  6170. - completed
  6171. properties:
  6172. _links:
  6173. type: object
  6174. properties:
  6175. self:
  6176. type: object
  6177. properties:
  6178. href:
  6179. type: string
  6180. format: iri-reference
  6181. headline:
  6182. type:
  6183. - string
  6184. - 'null'
  6185. description:
  6186. type:
  6187. - string
  6188. - 'null'
  6189. createdBy:
  6190. readOnly: true
  6191. type:
  6192. - string
  6193. - 'null'
  6194. format: iri-reference
  6195. example: 'https://example.com/'
  6196. createdByName:
  6197. readOnly: true
  6198. type:
  6199. - string
  6200. - 'null'
  6201. assignedTo:
  6202. type:
  6203. - string
  6204. - 'null'
  6205. format: iri-reference
  6206. example: 'https://example.com/'
  6207. assignedToName:
  6208. readOnly: true
  6209. type:
  6210. - string
  6211. - 'null'
  6212. dueAt:
  6213. type:
  6214. - string
  6215. - 'null'
  6216. format: date-time
  6217. partner:
  6218. type:
  6219. - string
  6220. - 'null'
  6221. format: iri-reference
  6222. example: 'https://example.com/'
  6223. partnerName:
  6224. readOnly: true
  6225. type:
  6226. - string
  6227. - 'null'
  6228. partnerType:
  6229. readOnly: true
  6230. type:
  6231. - string
  6232. - 'null'
  6233. enum:
  6234. - customer
  6235. - supplier
  6236. - service
  6237. - null
  6238. contact:
  6239. type:
  6240. - string
  6241. - 'null'
  6242. format: iri-reference
  6243. example: 'https://example.com/'
  6244. contactName:
  6245. readOnly: true
  6246. type:
  6247. - string
  6248. - 'null'
  6249. prio:
  6250. type: string
  6251. enum:
  6252. - low
  6253. - medium
  6254. - high
  6255. completed:
  6256. type:
  6257. - boolean
  6258. - 'null'
  6259. taskNotes:
  6260. readOnly: true
  6261. description: 'array<int, TaskNoteApi>'
  6262. type: array
  6263. items:
  6264. $ref: '#/components/schemas/TaskNote.jsonhal'
  6265. createdAt:
  6266. readOnly: true
  6267. type:
  6268. - string
  6269. - 'null'
  6270. format: date-time
  6271. Task.jsonld:
  6272. type: object
  6273. description: ''
  6274. deprecated: false
  6275. required:
  6276. - headline
  6277. - description
  6278. - assignedTo
  6279. - dueAt
  6280. - prio
  6281. - completed
  6282. properties:
  6283. '@context':
  6284. readOnly: true
  6285. oneOf:
  6286. -
  6287. type: string
  6288. -
  6289. type: object
  6290. properties:
  6291. '@vocab':
  6292. type: string
  6293. hydra:
  6294. type: string
  6295. enum: ['http://www.w3.org/ns/hydra/core#']
  6296. required:
  6297. - '@vocab'
  6298. - hydra
  6299. additionalProperties: true
  6300. '@id':
  6301. readOnly: true
  6302. type: string
  6303. '@type':
  6304. readOnly: true
  6305. type: string
  6306. headline:
  6307. type:
  6308. - string
  6309. - 'null'
  6310. description:
  6311. type:
  6312. - string
  6313. - 'null'
  6314. createdBy:
  6315. readOnly: true
  6316. type:
  6317. - string
  6318. - 'null'
  6319. format: iri-reference
  6320. example: 'https://example.com/'
  6321. createdByName:
  6322. readOnly: true
  6323. type:
  6324. - string
  6325. - 'null'
  6326. assignedTo:
  6327. type:
  6328. - string
  6329. - 'null'
  6330. format: iri-reference
  6331. example: 'https://example.com/'
  6332. assignedToName:
  6333. readOnly: true
  6334. type:
  6335. - string
  6336. - 'null'
  6337. dueAt:
  6338. type:
  6339. - string
  6340. - 'null'
  6341. format: date-time
  6342. partner:
  6343. type:
  6344. - string
  6345. - 'null'
  6346. format: iri-reference
  6347. example: 'https://example.com/'
  6348. partnerName:
  6349. readOnly: true
  6350. type:
  6351. - string
  6352. - 'null'
  6353. partnerType:
  6354. readOnly: true
  6355. type:
  6356. - string
  6357. - 'null'
  6358. enum:
  6359. - customer
  6360. - supplier
  6361. - service
  6362. - null
  6363. contact:
  6364. type:
  6365. - string
  6366. - 'null'
  6367. format: iri-reference
  6368. example: 'https://example.com/'
  6369. contactName:
  6370. readOnly: true
  6371. type:
  6372. - string
  6373. - 'null'
  6374. prio:
  6375. type: string
  6376. enum:
  6377. - low
  6378. - medium
  6379. - high
  6380. completed:
  6381. type:
  6382. - boolean
  6383. - 'null'
  6384. taskNotes:
  6385. readOnly: true
  6386. description: 'array<int, TaskNoteApi>'
  6387. type: array
  6388. items:
  6389. $ref: '#/components/schemas/TaskNote.jsonld'
  6390. createdAt:
  6391. readOnly: true
  6392. type:
  6393. - string
  6394. - 'null'
  6395. format: date-time
  6396. TaskNote:
  6397. type: object
  6398. description: ''
  6399. deprecated: false
  6400. required:
  6401. - message
  6402. properties:
  6403. message:
  6404. type:
  6405. - string
  6406. - 'null'
  6407. owner:
  6408. readOnly: true
  6409. type:
  6410. - string
  6411. - 'null'
  6412. format: iri-reference
  6413. example: 'https://example.com/'
  6414. ownerName:
  6415. readOnly: true
  6416. type:
  6417. - string
  6418. - 'null'
  6419. task:
  6420. type:
  6421. - string
  6422. - 'null'
  6423. format: iri-reference
  6424. example: 'https://example.com/'
  6425. createdAt:
  6426. readOnly: true
  6427. type:
  6428. - string
  6429. - 'null'
  6430. format: date-time
  6431. TaskNote.jsonhal:
  6432. type: object
  6433. description: ''
  6434. deprecated: false
  6435. required:
  6436. - message
  6437. properties:
  6438. _links:
  6439. type: object
  6440. properties:
  6441. self:
  6442. type: object
  6443. properties:
  6444. href:
  6445. type: string
  6446. format: iri-reference
  6447. message:
  6448. type:
  6449. - string
  6450. - 'null'
  6451. owner:
  6452. readOnly: true
  6453. type:
  6454. - string
  6455. - 'null'
  6456. format: iri-reference
  6457. example: 'https://example.com/'
  6458. ownerName:
  6459. readOnly: true
  6460. type:
  6461. - string
  6462. - 'null'
  6463. task:
  6464. type:
  6465. - string
  6466. - 'null'
  6467. format: iri-reference
  6468. example: 'https://example.com/'
  6469. createdAt:
  6470. readOnly: true
  6471. type:
  6472. - string
  6473. - 'null'
  6474. format: date-time
  6475. TaskNote.jsonld:
  6476. type: object
  6477. description: ''
  6478. deprecated: false
  6479. required:
  6480. - message
  6481. properties:
  6482. '@context':
  6483. readOnly: true
  6484. oneOf:
  6485. -
  6486. type: string
  6487. -
  6488. type: object
  6489. properties:
  6490. '@vocab':
  6491. type: string
  6492. hydra:
  6493. type: string
  6494. enum: ['http://www.w3.org/ns/hydra/core#']
  6495. required:
  6496. - '@vocab'
  6497. - hydra
  6498. additionalProperties: true
  6499. '@id':
  6500. readOnly: true
  6501. type: string
  6502. '@type':
  6503. readOnly: true
  6504. type: string
  6505. message:
  6506. type:
  6507. - string
  6508. - 'null'
  6509. owner:
  6510. readOnly: true
  6511. type:
  6512. - string
  6513. - 'null'
  6514. format: iri-reference
  6515. example: 'https://example.com/'
  6516. ownerName:
  6517. readOnly: true
  6518. type:
  6519. - string
  6520. - 'null'
  6521. task:
  6522. type:
  6523. - string
  6524. - 'null'
  6525. format: iri-reference
  6526. example: 'https://example.com/'
  6527. createdAt:
  6528. readOnly: true
  6529. type:
  6530. - string
  6531. - 'null'
  6532. format: date-time
  6533. User:
  6534. type: object
  6535. description: ''
  6536. deprecated: false
  6537. required:
  6538. - email
  6539. - firstName
  6540. - lastName
  6541. properties:
  6542. email:
  6543. format: email
  6544. externalDocs:
  6545. url: 'https://schema.org/email'
  6546. type:
  6547. - string
  6548. - 'null'
  6549. firstName:
  6550. type:
  6551. - string
  6552. - 'null'
  6553. lastName:
  6554. type:
  6555. - string
  6556. - 'null'
  6557. image:
  6558. type:
  6559. - string
  6560. - 'null'
  6561. format: iri-reference
  6562. example: 'https://example.com/'
  6563. password:
  6564. writeOnly: true
  6565. description: 'The plaintext password when being set or changed.'
  6566. type:
  6567. - string
  6568. - 'null'
  6569. active:
  6570. type: boolean
  6571. createdAt:
  6572. readOnly: true
  6573. type:
  6574. - string
  6575. - 'null'
  6576. format: date-time
  6577. User.jsonhal:
  6578. type: object
  6579. description: ''
  6580. deprecated: false
  6581. required:
  6582. - email
  6583. - firstName
  6584. - lastName
  6585. properties:
  6586. _links:
  6587. type: object
  6588. properties:
  6589. self:
  6590. type: object
  6591. properties:
  6592. href:
  6593. type: string
  6594. format: iri-reference
  6595. email:
  6596. format: email
  6597. externalDocs:
  6598. url: 'https://schema.org/email'
  6599. type:
  6600. - string
  6601. - 'null'
  6602. firstName:
  6603. type:
  6604. - string
  6605. - 'null'
  6606. lastName:
  6607. type:
  6608. - string
  6609. - 'null'
  6610. image:
  6611. type:
  6612. - string
  6613. - 'null'
  6614. format: iri-reference
  6615. example: 'https://example.com/'
  6616. password:
  6617. writeOnly: true
  6618. description: 'The plaintext password when being set or changed.'
  6619. type:
  6620. - string
  6621. - 'null'
  6622. active:
  6623. type: boolean
  6624. createdAt:
  6625. readOnly: true
  6626. type:
  6627. - string
  6628. - 'null'
  6629. format: date-time
  6630. User.jsonld:
  6631. type: object
  6632. description: ''
  6633. deprecated: false
  6634. required:
  6635. - email
  6636. - firstName
  6637. - lastName
  6638. properties:
  6639. '@context':
  6640. readOnly: true
  6641. oneOf:
  6642. -
  6643. type: string
  6644. -
  6645. type: object
  6646. properties:
  6647. '@vocab':
  6648. type: string
  6649. hydra:
  6650. type: string
  6651. enum: ['http://www.w3.org/ns/hydra/core#']
  6652. required:
  6653. - '@vocab'
  6654. - hydra
  6655. additionalProperties: true
  6656. '@id':
  6657. readOnly: true
  6658. type: string
  6659. '@type':
  6660. readOnly: true
  6661. type: string
  6662. email:
  6663. format: email
  6664. externalDocs:
  6665. url: 'https://schema.org/email'
  6666. type:
  6667. - string
  6668. - 'null'
  6669. firstName:
  6670. type:
  6671. - string
  6672. - 'null'
  6673. lastName:
  6674. type:
  6675. - string
  6676. - 'null'
  6677. image:
  6678. type:
  6679. - string
  6680. - 'null'
  6681. format: iri-reference
  6682. example: 'https://example.com/'
  6683. password:
  6684. writeOnly: true
  6685. description: 'The plaintext password when being set or changed.'
  6686. type:
  6687. - string
  6688. - 'null'
  6689. active:
  6690. type: boolean
  6691. createdAt:
  6692. readOnly: true
  6693. type:
  6694. - string
  6695. - 'null'
  6696. format: date-time
  6697. responses: { }
  6698. parameters: { }
  6699. examples: { }
  6700. requestBodies: { }
  6701. headers: { }
  6702. securitySchemes:
  6703. JWT:
  6704. type: http
  6705. scheme: bearer
  6706. bearerFormat: JWT
  6707. security:
  6708. -
  6709. JWT: []
  6710. tags: []