Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
 
 
 

6474 righe
186 KiB

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