Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
 
 
 
 

6042 Zeilen
174 KiB

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