Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 
 
 

5976 rader
172 KiB

  1. openapi: 3.1.0
  2. info:
  3. title: 'Matsen API Platform'
  4. description: ''
  5. version: 1.0.0
  6. servers:
  7. -
  8. url: /
  9. description: ''
  10. paths:
  11. /api/comments:
  12. get:
  13. operationId: api_comments_get_collection
  14. tags:
  15. - Comment
  16. responses:
  17. 200:
  18. description: 'Comment collection'
  19. content:
  20. application/ld+json:
  21. schema:
  22. type: object
  23. properties:
  24. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Comment.jsonld' } }
  25. 'hydra:totalItems': { type: integer, minimum: 0 }
  26. 'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
  27. 'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  28. required:
  29. - 'hydra:member'
  30. application/json:
  31. schema:
  32. type: array
  33. items:
  34. $ref: '#/components/schemas/Comment'
  35. text/html:
  36. schema:
  37. type: array
  38. items:
  39. $ref: '#/components/schemas/Comment'
  40. application/hal+json:
  41. schema:
  42. type: object
  43. properties:
  44. _embedded: { type: array, items: { $ref: '#/components/schemas/Comment.jsonhal' } }
  45. totalItems: { type: integer, minimum: 0 }
  46. itemsPerPage: { type: integer, minimum: 0 }
  47. _links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
  48. required:
  49. - _links
  50. - _embedded
  51. summary: 'Retrieves the collection of Comment resources.'
  52. description: 'Retrieves the collection of Comment resources.'
  53. parameters:
  54. -
  55. name: page
  56. in: query
  57. description: 'The collection page number'
  58. required: false
  59. deprecated: false
  60. allowEmptyValue: true
  61. schema:
  62. type: integer
  63. default: 1
  64. style: form
  65. explode: false
  66. allowReserved: false
  67. -
  68. name: itemsPerPage
  69. in: query
  70. description: 'The number of items per page'
  71. required: false
  72. deprecated: false
  73. allowEmptyValue: true
  74. schema:
  75. type: integer
  76. default: 10
  77. minimum: 0
  78. maximum: 50
  79. style: form
  80. explode: false
  81. allowReserved: false
  82. deprecated: false
  83. post:
  84. operationId: api_comments_post
  85. tags:
  86. - Comment
  87. responses:
  88. 201:
  89. description: 'Comment resource created'
  90. content:
  91. application/ld+json:
  92. schema:
  93. $ref: '#/components/schemas/Comment.jsonld'
  94. application/json:
  95. schema:
  96. $ref: '#/components/schemas/Comment'
  97. text/html:
  98. schema:
  99. $ref: '#/components/schemas/Comment'
  100. application/hal+json:
  101. schema:
  102. $ref: '#/components/schemas/Comment.jsonhal'
  103. links: { }
  104. 400:
  105. description: 'Invalid input'
  106. 422:
  107. description: 'Unprocessable entity'
  108. summary: 'Creates a Comment resource.'
  109. description: 'Creates a Comment resource.'
  110. parameters: []
  111. requestBody:
  112. description: 'The new Comment resource'
  113. content:
  114. application/ld+json:
  115. schema:
  116. $ref: '#/components/schemas/Comment.jsonld'
  117. application/json:
  118. schema:
  119. $ref: '#/components/schemas/Comment'
  120. text/html:
  121. schema:
  122. $ref: '#/components/schemas/Comment'
  123. application/hal+json:
  124. schema:
  125. $ref: '#/components/schemas/Comment.jsonhal'
  126. required: true
  127. deprecated: false
  128. parameters: []
  129. '/api/comments/{id}':
  130. get:
  131. operationId: api_comments_id_get
  132. tags:
  133. - Comment
  134. responses:
  135. 200:
  136. description: 'Comment resource'
  137. content:
  138. application/ld+json:
  139. schema:
  140. $ref: '#/components/schemas/Comment.jsonld'
  141. application/json:
  142. schema:
  143. $ref: '#/components/schemas/Comment'
  144. text/html:
  145. schema:
  146. $ref: '#/components/schemas/Comment'
  147. application/hal+json:
  148. schema:
  149. $ref: '#/components/schemas/Comment.jsonhal'
  150. 404:
  151. description: 'Resource not found'
  152. summary: 'Retrieves a Comment resource.'
  153. description: 'Retrieves a Comment resource.'
  154. parameters:
  155. -
  156. name: id
  157. in: path
  158. description: 'Comment identifier'
  159. required: true
  160. deprecated: false
  161. allowEmptyValue: false
  162. schema:
  163. type: string
  164. style: simple
  165. explode: false
  166. allowReserved: false
  167. deprecated: false
  168. 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: 'Comment 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: 'Comment 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: 'Contact 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: 'Contact 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: 'Contact 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: 'Document 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: 'Document 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: 'Document 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: 'PartnerFollow 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: 'PartnerFollow 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: 'Partner 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: 'Partner 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: 'Partner 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. -
  1819. name: 'exists[contact]'
  1820. in: query
  1821. description: ''
  1822. required: false
  1823. deprecated: false
  1824. allowEmptyValue: true
  1825. schema:
  1826. type: boolean
  1827. style: form
  1828. explode: false
  1829. allowReserved: false
  1830. -
  1831. name: 'exists[sale]'
  1832. in: query
  1833. description: ''
  1834. required: false
  1835. deprecated: false
  1836. allowEmptyValue: true
  1837. schema:
  1838. type: boolean
  1839. style: form
  1840. explode: false
  1841. allowReserved: false
  1842. deprecated: false
  1843. post:
  1844. operationId: api_posts_post
  1845. tags:
  1846. - Post
  1847. responses:
  1848. 201:
  1849. description: 'Post resource created'
  1850. content:
  1851. application/ld+json:
  1852. schema:
  1853. $ref: '#/components/schemas/Post.jsonld'
  1854. application/json:
  1855. schema:
  1856. $ref: '#/components/schemas/Post'
  1857. text/html:
  1858. schema:
  1859. $ref: '#/components/schemas/Post'
  1860. application/hal+json:
  1861. schema:
  1862. $ref: '#/components/schemas/Post.jsonhal'
  1863. links: { }
  1864. 400:
  1865. description: 'Invalid input'
  1866. 422:
  1867. description: 'Unprocessable entity'
  1868. summary: 'Creates a Post resource.'
  1869. description: 'Creates a Post resource.'
  1870. parameters: []
  1871. requestBody:
  1872. description: 'The new Post resource'
  1873. content:
  1874. application/ld+json:
  1875. schema:
  1876. $ref: '#/components/schemas/Post.jsonld-posting.create'
  1877. application/json:
  1878. schema:
  1879. $ref: '#/components/schemas/Post-posting.create'
  1880. text/html:
  1881. schema:
  1882. $ref: '#/components/schemas/Post-posting.create'
  1883. application/hal+json:
  1884. schema:
  1885. $ref: '#/components/schemas/Post.jsonhal-posting.create'
  1886. required: true
  1887. deprecated: false
  1888. parameters: []
  1889. '/api/posts/{id}':
  1890. get:
  1891. operationId: api_posts_id_get
  1892. tags:
  1893. - Post
  1894. responses:
  1895. 200:
  1896. description: 'Post resource'
  1897. content:
  1898. application/ld+json:
  1899. schema:
  1900. $ref: '#/components/schemas/Post.jsonld'
  1901. application/json:
  1902. schema:
  1903. $ref: '#/components/schemas/Post'
  1904. text/html:
  1905. schema:
  1906. $ref: '#/components/schemas/Post'
  1907. application/hal+json:
  1908. schema:
  1909. $ref: '#/components/schemas/Post.jsonhal'
  1910. 404:
  1911. description: 'Resource not found'
  1912. summary: 'Retrieves a Post resource.'
  1913. description: 'Retrieves a Post resource.'
  1914. parameters:
  1915. -
  1916. name: id
  1917. in: path
  1918. description: 'Post identifier'
  1919. required: true
  1920. deprecated: false
  1921. allowEmptyValue: false
  1922. schema:
  1923. type: string
  1924. style: simple
  1925. explode: false
  1926. allowReserved: false
  1927. deprecated: false
  1928. delete:
  1929. operationId: api_posts_id_delete
  1930. tags:
  1931. - Post
  1932. responses:
  1933. 204:
  1934. description: 'Post resource deleted'
  1935. 404:
  1936. description: 'Resource not found'
  1937. summary: 'Removes the Post resource.'
  1938. description: 'Removes the Post resource.'
  1939. parameters:
  1940. -
  1941. name: id
  1942. in: path
  1943. description: 'Post identifier'
  1944. required: true
  1945. deprecated: false
  1946. allowEmptyValue: false
  1947. schema:
  1948. type: string
  1949. style: simple
  1950. explode: false
  1951. allowReserved: false
  1952. deprecated: false
  1953. patch:
  1954. operationId: api_posts_id_patch
  1955. tags:
  1956. - Post
  1957. responses:
  1958. 200:
  1959. description: 'Post resource updated'
  1960. content:
  1961. application/ld+json:
  1962. schema:
  1963. $ref: '#/components/schemas/Post.jsonld'
  1964. application/json:
  1965. schema:
  1966. $ref: '#/components/schemas/Post'
  1967. text/html:
  1968. schema:
  1969. $ref: '#/components/schemas/Post'
  1970. application/hal+json:
  1971. schema:
  1972. $ref: '#/components/schemas/Post.jsonhal'
  1973. links: { }
  1974. 400:
  1975. description: 'Invalid input'
  1976. 422:
  1977. description: 'Unprocessable entity'
  1978. 404:
  1979. description: 'Resource not found'
  1980. summary: 'Updates the Post resource.'
  1981. description: 'Updates the Post resource.'
  1982. parameters:
  1983. -
  1984. name: id
  1985. in: path
  1986. description: 'Post identifier'
  1987. required: true
  1988. deprecated: false
  1989. allowEmptyValue: false
  1990. schema:
  1991. type: string
  1992. style: simple
  1993. explode: false
  1994. allowReserved: false
  1995. requestBody:
  1996. description: 'The updated Post resource'
  1997. content:
  1998. application/merge-patch+json:
  1999. schema:
  2000. $ref: '#/components/schemas/Post-posting.patch'
  2001. required: true
  2002. deprecated: false
  2003. parameters: []
  2004. /api/products:
  2005. get:
  2006. operationId: api_products_get_collection
  2007. tags:
  2008. - Product
  2009. responses:
  2010. 200:
  2011. description: 'Product collection'
  2012. content:
  2013. application/ld+json:
  2014. schema:
  2015. type: object
  2016. properties:
  2017. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.jsonld' } }
  2018. 'hydra:totalItems': { type: integer, minimum: 0 }
  2019. '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 } }
  2020. '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 } } } } } }
  2021. required:
  2022. - 'hydra:member'
  2023. application/json:
  2024. schema:
  2025. type: array
  2026. items:
  2027. $ref: '#/components/schemas/Product'
  2028. text/html:
  2029. schema:
  2030. type: array
  2031. items:
  2032. $ref: '#/components/schemas/Product'
  2033. application/hal+json:
  2034. schema:
  2035. type: object
  2036. properties:
  2037. _embedded: { type: array, items: { $ref: '#/components/schemas/Product.jsonhal' } }
  2038. totalItems: { type: integer, minimum: 0 }
  2039. itemsPerPage: { type: integer, minimum: 0 }
  2040. _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 } } } } }
  2041. required:
  2042. - _links
  2043. - _embedded
  2044. summary: 'Retrieves the collection of Product resources.'
  2045. description: 'Retrieves the collection of Product resources.'
  2046. parameters:
  2047. -
  2048. name: page
  2049. in: query
  2050. description: 'The collection page number'
  2051. required: false
  2052. deprecated: false
  2053. allowEmptyValue: true
  2054. schema:
  2055. type: integer
  2056. default: 1
  2057. style: form
  2058. explode: false
  2059. allowReserved: false
  2060. -
  2061. name: itemsPerPage
  2062. in: query
  2063. description: 'The number of items per page'
  2064. required: false
  2065. deprecated: false
  2066. allowEmptyValue: true
  2067. schema:
  2068. type: integer
  2069. default: 10
  2070. minimum: 0
  2071. maximum: 50
  2072. style: form
  2073. explode: false
  2074. allowReserved: false
  2075. -
  2076. name: name
  2077. in: query
  2078. description: ''
  2079. required: false
  2080. deprecated: false
  2081. allowEmptyValue: true
  2082. schema:
  2083. type: string
  2084. style: form
  2085. explode: false
  2086. allowReserved: false
  2087. -
  2088. name: 'order[name]'
  2089. in: query
  2090. description: ''
  2091. required: false
  2092. deprecated: false
  2093. allowEmptyValue: true
  2094. schema:
  2095. type: string
  2096. enum:
  2097. - asc
  2098. - desc
  2099. style: form
  2100. explode: false
  2101. allowReserved: false
  2102. deprecated: false
  2103. post:
  2104. operationId: api_products_post
  2105. tags:
  2106. - Product
  2107. responses:
  2108. 201:
  2109. description: 'Product resource created'
  2110. content:
  2111. application/ld+json:
  2112. schema:
  2113. $ref: '#/components/schemas/Product.jsonld'
  2114. application/json:
  2115. schema:
  2116. $ref: '#/components/schemas/Product'
  2117. text/html:
  2118. schema:
  2119. $ref: '#/components/schemas/Product'
  2120. application/hal+json:
  2121. schema:
  2122. $ref: '#/components/schemas/Product.jsonhal'
  2123. links: { }
  2124. 400:
  2125. description: 'Invalid input'
  2126. 422:
  2127. description: 'Unprocessable entity'
  2128. summary: 'Creates a Product resource.'
  2129. description: 'Creates a Product resource.'
  2130. parameters: []
  2131. requestBody:
  2132. description: 'The new 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. required: true
  2147. deprecated: false
  2148. parameters: []
  2149. '/api/products/{id}':
  2150. get:
  2151. operationId: api_products_id_get
  2152. tags:
  2153. - Product
  2154. responses:
  2155. 200:
  2156. description: 'Product resource'
  2157. content:
  2158. application/ld+json:
  2159. schema:
  2160. $ref: '#/components/schemas/Product.jsonld'
  2161. application/json:
  2162. schema:
  2163. $ref: '#/components/schemas/Product'
  2164. text/html:
  2165. schema:
  2166. $ref: '#/components/schemas/Product'
  2167. application/hal+json:
  2168. schema:
  2169. $ref: '#/components/schemas/Product.jsonhal'
  2170. 404:
  2171. description: 'Resource not found'
  2172. summary: 'Retrieves a Product resource.'
  2173. description: 'Retrieves a Product resource.'
  2174. parameters:
  2175. -
  2176. name: id
  2177. in: path
  2178. description: 'Product identifier'
  2179. required: true
  2180. deprecated: false
  2181. allowEmptyValue: false
  2182. schema:
  2183. type: string
  2184. style: simple
  2185. explode: false
  2186. allowReserved: false
  2187. deprecated: false
  2188. delete:
  2189. operationId: api_products_id_delete
  2190. tags:
  2191. - Product
  2192. responses:
  2193. 204:
  2194. description: 'Product resource deleted'
  2195. 404:
  2196. description: 'Resource not found'
  2197. summary: 'Removes the Product resource.'
  2198. description: 'Removes the Product resource.'
  2199. parameters:
  2200. -
  2201. name: id
  2202. in: path
  2203. description: 'Product identifier'
  2204. required: true
  2205. deprecated: false
  2206. allowEmptyValue: false
  2207. schema:
  2208. type: string
  2209. style: simple
  2210. explode: false
  2211. allowReserved: false
  2212. deprecated: false
  2213. patch:
  2214. operationId: api_products_id_patch
  2215. tags:
  2216. - Product
  2217. responses:
  2218. 200:
  2219. description: 'Product resource updated'
  2220. content:
  2221. application/ld+json:
  2222. schema:
  2223. $ref: '#/components/schemas/Product.jsonld'
  2224. application/json:
  2225. schema:
  2226. $ref: '#/components/schemas/Product'
  2227. text/html:
  2228. schema:
  2229. $ref: '#/components/schemas/Product'
  2230. application/hal+json:
  2231. schema:
  2232. $ref: '#/components/schemas/Product.jsonhal'
  2233. links: { }
  2234. 400:
  2235. description: 'Invalid input'
  2236. 422:
  2237. description: 'Unprocessable entity'
  2238. 404:
  2239. description: 'Resource not found'
  2240. summary: 'Updates the Product resource.'
  2241. description: 'Updates the Product resource.'
  2242. parameters:
  2243. -
  2244. name: id
  2245. in: path
  2246. description: 'Product identifier'
  2247. required: true
  2248. deprecated: false
  2249. allowEmptyValue: false
  2250. schema:
  2251. type: string
  2252. style: simple
  2253. explode: false
  2254. allowReserved: false
  2255. requestBody:
  2256. description: 'The updated Product resource'
  2257. content:
  2258. application/merge-patch+json:
  2259. schema:
  2260. $ref: '#/components/schemas/Product'
  2261. required: true
  2262. deprecated: false
  2263. parameters: []
  2264. /api/sale_summaries:
  2265. get:
  2266. operationId: api_sale_summaries_get_collection
  2267. tags:
  2268. - SaleSummary
  2269. responses:
  2270. 200:
  2271. description: 'SaleSummary collection'
  2272. content:
  2273. application/ld+json:
  2274. schema:
  2275. type: object
  2276. properties:
  2277. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonld' } }
  2278. 'hydra:totalItems': { type: integer, minimum: 0 }
  2279. '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 } }
  2280. '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 } } } } } }
  2281. required:
  2282. - 'hydra:member'
  2283. application/json:
  2284. schema:
  2285. type: array
  2286. items:
  2287. $ref: '#/components/schemas/SaleSummary'
  2288. text/html:
  2289. schema:
  2290. type: array
  2291. items:
  2292. $ref: '#/components/schemas/SaleSummary'
  2293. application/hal+json:
  2294. schema:
  2295. type: object
  2296. properties:
  2297. _embedded: { type: array, items: { $ref: '#/components/schemas/SaleSummary.jsonhal' } }
  2298. totalItems: { type: integer, minimum: 0 }
  2299. itemsPerPage: { type: integer, minimum: 0 }
  2300. _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 } } } } }
  2301. required:
  2302. - _links
  2303. - _embedded
  2304. summary: 'Retrieves the collection of SaleSummary resources.'
  2305. description: 'Retrieves the collection of SaleSummary resources.'
  2306. parameters:
  2307. -
  2308. name: page
  2309. in: query
  2310. description: 'The collection page number'
  2311. required: false
  2312. deprecated: false
  2313. allowEmptyValue: true
  2314. schema:
  2315. type: integer
  2316. default: 1
  2317. style: form
  2318. explode: false
  2319. allowReserved: false
  2320. -
  2321. name: itemsPerPage
  2322. in: query
  2323. description: 'The number of items per page'
  2324. required: false
  2325. deprecated: false
  2326. allowEmptyValue: true
  2327. schema:
  2328. type: integer
  2329. default: 10
  2330. minimum: 0
  2331. maximum: 50
  2332. style: form
  2333. explode: false
  2334. allowReserved: false
  2335. deprecated: false
  2336. parameters: []
  2337. /api/sales:
  2338. get:
  2339. operationId: api_sales_get_collection
  2340. tags:
  2341. - Sale
  2342. responses:
  2343. 200:
  2344. description: 'Sale collection'
  2345. content:
  2346. application/ld+json:
  2347. schema:
  2348. type: object
  2349. properties:
  2350. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Sale.jsonld' } }
  2351. 'hydra:totalItems': { type: integer, minimum: 0 }
  2352. '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 } }
  2353. '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 } } } } } }
  2354. required:
  2355. - 'hydra:member'
  2356. application/json:
  2357. schema:
  2358. type: array
  2359. items:
  2360. $ref: '#/components/schemas/Sale'
  2361. text/html:
  2362. schema:
  2363. type: array
  2364. items:
  2365. $ref: '#/components/schemas/Sale'
  2366. application/hal+json:
  2367. schema:
  2368. type: object
  2369. properties:
  2370. _embedded: { type: array, items: { $ref: '#/components/schemas/Sale.jsonhal' } }
  2371. totalItems: { type: integer, minimum: 0 }
  2372. itemsPerPage: { type: integer, minimum: 0 }
  2373. _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 } } } } }
  2374. required:
  2375. - _links
  2376. - _embedded
  2377. summary: 'Retrieves the collection of Sale resources.'
  2378. description: 'Retrieves the collection of Sale resources.'
  2379. parameters:
  2380. -
  2381. name: page
  2382. in: query
  2383. description: 'The collection page number'
  2384. required: false
  2385. deprecated: false
  2386. allowEmptyValue: true
  2387. schema:
  2388. type: integer
  2389. default: 1
  2390. style: form
  2391. explode: false
  2392. allowReserved: false
  2393. -
  2394. name: itemsPerPage
  2395. in: query
  2396. description: 'The number of items per page'
  2397. required: false
  2398. deprecated: false
  2399. allowEmptyValue: true
  2400. schema:
  2401. type: integer
  2402. default: 10
  2403. minimum: 0
  2404. maximum: 50
  2405. style: form
  2406. explode: false
  2407. allowReserved: false
  2408. -
  2409. name: owner
  2410. in: query
  2411. description: ''
  2412. required: false
  2413. deprecated: false
  2414. allowEmptyValue: true
  2415. schema:
  2416. type: string
  2417. style: form
  2418. explode: false
  2419. allowReserved: false
  2420. -
  2421. name: 'owner[]'
  2422. in: query
  2423. description: ''
  2424. required: false
  2425. deprecated: false
  2426. allowEmptyValue: true
  2427. schema:
  2428. type: array
  2429. items:
  2430. type: string
  2431. style: form
  2432. explode: true
  2433. allowReserved: false
  2434. -
  2435. name: partner
  2436. in: query
  2437. description: ''
  2438. required: false
  2439. deprecated: false
  2440. allowEmptyValue: true
  2441. schema:
  2442. type: string
  2443. style: form
  2444. explode: false
  2445. allowReserved: false
  2446. -
  2447. name: 'partner[]'
  2448. in: query
  2449. description: ''
  2450. required: false
  2451. deprecated: false
  2452. allowEmptyValue: true
  2453. schema:
  2454. type: array
  2455. items:
  2456. type: string
  2457. style: form
  2458. explode: true
  2459. allowReserved: false
  2460. deprecated: false
  2461. post:
  2462. operationId: api_sales_post
  2463. tags:
  2464. - Sale
  2465. responses:
  2466. 201:
  2467. description: 'Sale resource created'
  2468. content:
  2469. application/ld+json:
  2470. schema:
  2471. $ref: '#/components/schemas/Sale.jsonld'
  2472. application/json:
  2473. schema:
  2474. $ref: '#/components/schemas/Sale'
  2475. text/html:
  2476. schema:
  2477. $ref: '#/components/schemas/Sale'
  2478. application/hal+json:
  2479. schema:
  2480. $ref: '#/components/schemas/Sale.jsonhal'
  2481. links: { }
  2482. 400:
  2483. description: 'Invalid input'
  2484. 422:
  2485. description: 'Unprocessable entity'
  2486. summary: 'Creates a Sale resource.'
  2487. description: 'Creates a Sale resource.'
  2488. parameters: []
  2489. requestBody:
  2490. description: 'The new 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. required: true
  2505. deprecated: false
  2506. parameters: []
  2507. '/api/sales/{id}':
  2508. get:
  2509. operationId: api_sales_id_get
  2510. tags:
  2511. - Sale
  2512. responses:
  2513. 200:
  2514. description: 'Sale resource'
  2515. content:
  2516. application/ld+json:
  2517. schema:
  2518. $ref: '#/components/schemas/Sale.jsonld'
  2519. application/json:
  2520. schema:
  2521. $ref: '#/components/schemas/Sale'
  2522. text/html:
  2523. schema:
  2524. $ref: '#/components/schemas/Sale'
  2525. application/hal+json:
  2526. schema:
  2527. $ref: '#/components/schemas/Sale.jsonhal'
  2528. 404:
  2529. description: 'Resource not found'
  2530. summary: 'Retrieves a Sale resource.'
  2531. description: 'Retrieves a Sale resource.'
  2532. parameters:
  2533. -
  2534. name: id
  2535. in: path
  2536. description: 'Sale identifier'
  2537. required: true
  2538. deprecated: false
  2539. allowEmptyValue: false
  2540. schema:
  2541. type: string
  2542. style: simple
  2543. explode: false
  2544. allowReserved: false
  2545. deprecated: false
  2546. delete:
  2547. operationId: api_sales_id_delete
  2548. tags:
  2549. - Sale
  2550. responses:
  2551. 204:
  2552. description: 'Sale resource deleted'
  2553. 404:
  2554. description: 'Resource not found'
  2555. summary: 'Removes the Sale resource.'
  2556. description: 'Removes the Sale resource.'
  2557. parameters:
  2558. -
  2559. name: id
  2560. in: path
  2561. description: 'Sale identifier'
  2562. required: true
  2563. deprecated: false
  2564. allowEmptyValue: false
  2565. schema:
  2566. type: string
  2567. style: simple
  2568. explode: false
  2569. allowReserved: false
  2570. deprecated: false
  2571. patch:
  2572. operationId: api_sales_id_patch
  2573. tags:
  2574. - Sale
  2575. responses:
  2576. 200:
  2577. description: 'Sale resource updated'
  2578. content:
  2579. application/ld+json:
  2580. schema:
  2581. $ref: '#/components/schemas/Sale.jsonld'
  2582. application/json:
  2583. schema:
  2584. $ref: '#/components/schemas/Sale'
  2585. text/html:
  2586. schema:
  2587. $ref: '#/components/schemas/Sale'
  2588. application/hal+json:
  2589. schema:
  2590. $ref: '#/components/schemas/Sale.jsonhal'
  2591. links: { }
  2592. 400:
  2593. description: 'Invalid input'
  2594. 422:
  2595. description: 'Unprocessable entity'
  2596. 404:
  2597. description: 'Resource not found'
  2598. summary: 'Updates the Sale resource.'
  2599. description: 'Updates the Sale resource.'
  2600. parameters:
  2601. -
  2602. name: id
  2603. in: path
  2604. description: 'Sale identifier'
  2605. required: true
  2606. deprecated: false
  2607. allowEmptyValue: false
  2608. schema:
  2609. type: string
  2610. style: simple
  2611. explode: false
  2612. allowReserved: false
  2613. requestBody:
  2614. description: 'The updated Sale resource'
  2615. content:
  2616. application/merge-patch+json:
  2617. schema:
  2618. $ref: '#/components/schemas/Sale'
  2619. required: true
  2620. deprecated: false
  2621. parameters: []
  2622. /api/task_notes:
  2623. get:
  2624. operationId: api_task_notes_get_collection
  2625. tags:
  2626. - TaskNote
  2627. responses:
  2628. 200:
  2629. description: 'TaskNote collection'
  2630. content:
  2631. application/ld+json:
  2632. schema:
  2633. type: object
  2634. properties:
  2635. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonld' } }
  2636. 'hydra:totalItems': { type: integer, minimum: 0 }
  2637. '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 } }
  2638. '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 } } } } } }
  2639. required:
  2640. - 'hydra:member'
  2641. application/json:
  2642. schema:
  2643. type: array
  2644. items:
  2645. $ref: '#/components/schemas/TaskNote'
  2646. text/html:
  2647. schema:
  2648. type: array
  2649. items:
  2650. $ref: '#/components/schemas/TaskNote'
  2651. application/hal+json:
  2652. schema:
  2653. type: object
  2654. properties:
  2655. _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.jsonhal' } }
  2656. totalItems: { type: integer, minimum: 0 }
  2657. itemsPerPage: { type: integer, minimum: 0 }
  2658. _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 } } } } }
  2659. required:
  2660. - _links
  2661. - _embedded
  2662. summary: 'Retrieves the collection of TaskNote resources.'
  2663. description: 'Retrieves the collection of TaskNote resources.'
  2664. parameters:
  2665. -
  2666. name: page
  2667. in: query
  2668. description: 'The collection page number'
  2669. required: false
  2670. deprecated: false
  2671. allowEmptyValue: true
  2672. schema:
  2673. type: integer
  2674. default: 1
  2675. style: form
  2676. explode: false
  2677. allowReserved: false
  2678. -
  2679. name: itemsPerPage
  2680. in: query
  2681. description: 'The number of items per page'
  2682. required: false
  2683. deprecated: false
  2684. allowEmptyValue: true
  2685. schema:
  2686. type: integer
  2687. default: 10
  2688. minimum: 0
  2689. maximum: 50
  2690. style: form
  2691. explode: false
  2692. allowReserved: false
  2693. -
  2694. name: task
  2695. in: query
  2696. description: ''
  2697. required: false
  2698. deprecated: false
  2699. allowEmptyValue: true
  2700. schema:
  2701. type: string
  2702. style: form
  2703. explode: false
  2704. allowReserved: false
  2705. -
  2706. name: 'task[]'
  2707. in: query
  2708. description: ''
  2709. required: false
  2710. deprecated: false
  2711. allowEmptyValue: true
  2712. schema:
  2713. type: array
  2714. items:
  2715. type: string
  2716. style: form
  2717. explode: true
  2718. allowReserved: false
  2719. deprecated: false
  2720. post:
  2721. operationId: api_task_notes_post
  2722. tags:
  2723. - TaskNote
  2724. responses:
  2725. 201:
  2726. description: 'TaskNote resource created'
  2727. content:
  2728. application/ld+json:
  2729. schema:
  2730. $ref: '#/components/schemas/TaskNote.jsonld'
  2731. application/json:
  2732. schema:
  2733. $ref: '#/components/schemas/TaskNote'
  2734. text/html:
  2735. schema:
  2736. $ref: '#/components/schemas/TaskNote'
  2737. application/hal+json:
  2738. schema:
  2739. $ref: '#/components/schemas/TaskNote.jsonhal'
  2740. links: { }
  2741. 400:
  2742. description: 'Invalid input'
  2743. 422:
  2744. description: 'Unprocessable entity'
  2745. summary: 'Creates a TaskNote resource.'
  2746. description: 'Creates a TaskNote resource.'
  2747. parameters: []
  2748. requestBody:
  2749. description: 'The new 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. required: true
  2764. deprecated: false
  2765. parameters: []
  2766. '/api/task_notes/{id}':
  2767. get:
  2768. operationId: api_task_notes_id_get
  2769. tags:
  2770. - TaskNote
  2771. responses:
  2772. 200:
  2773. description: 'TaskNote resource'
  2774. content:
  2775. application/ld+json:
  2776. schema:
  2777. $ref: '#/components/schemas/TaskNote.jsonld'
  2778. application/json:
  2779. schema:
  2780. $ref: '#/components/schemas/TaskNote'
  2781. text/html:
  2782. schema:
  2783. $ref: '#/components/schemas/TaskNote'
  2784. application/hal+json:
  2785. schema:
  2786. $ref: '#/components/schemas/TaskNote.jsonhal'
  2787. 404:
  2788. description: 'Resource not found'
  2789. summary: 'Retrieves a TaskNote resource.'
  2790. description: 'Retrieves a TaskNote resource.'
  2791. parameters:
  2792. -
  2793. name: id
  2794. in: path
  2795. description: 'TaskNote identifier'
  2796. required: true
  2797. deprecated: false
  2798. allowEmptyValue: false
  2799. schema:
  2800. type: string
  2801. style: simple
  2802. explode: false
  2803. allowReserved: false
  2804. deprecated: false
  2805. delete:
  2806. operationId: api_task_notes_id_delete
  2807. tags:
  2808. - TaskNote
  2809. responses:
  2810. 204:
  2811. description: 'TaskNote resource deleted'
  2812. 404:
  2813. description: 'Resource not found'
  2814. summary: 'Removes the TaskNote resource.'
  2815. description: 'Removes the TaskNote resource.'
  2816. parameters:
  2817. -
  2818. name: id
  2819. in: path
  2820. description: 'TaskNote identifier'
  2821. required: true
  2822. deprecated: false
  2823. allowEmptyValue: false
  2824. schema:
  2825. type: string
  2826. style: simple
  2827. explode: false
  2828. allowReserved: false
  2829. deprecated: false
  2830. patch:
  2831. operationId: api_task_notes_id_patch
  2832. tags:
  2833. - TaskNote
  2834. responses:
  2835. 200:
  2836. description: 'TaskNote resource updated'
  2837. content:
  2838. application/ld+json:
  2839. schema:
  2840. $ref: '#/components/schemas/TaskNote.jsonld'
  2841. application/json:
  2842. schema:
  2843. $ref: '#/components/schemas/TaskNote'
  2844. text/html:
  2845. schema:
  2846. $ref: '#/components/schemas/TaskNote'
  2847. application/hal+json:
  2848. schema:
  2849. $ref: '#/components/schemas/TaskNote.jsonhal'
  2850. links: { }
  2851. 400:
  2852. description: 'Invalid input'
  2853. 422:
  2854. description: 'Unprocessable entity'
  2855. 404:
  2856. description: 'Resource not found'
  2857. summary: 'Updates the TaskNote resource.'
  2858. description: 'Updates the TaskNote resource.'
  2859. parameters:
  2860. -
  2861. name: id
  2862. in: path
  2863. description: 'TaskNote identifier'
  2864. required: true
  2865. deprecated: false
  2866. allowEmptyValue: false
  2867. schema:
  2868. type: string
  2869. style: simple
  2870. explode: false
  2871. allowReserved: false
  2872. requestBody:
  2873. description: 'The updated TaskNote resource'
  2874. content:
  2875. application/merge-patch+json:
  2876. schema:
  2877. $ref: '#/components/schemas/TaskNote'
  2878. required: true
  2879. deprecated: false
  2880. parameters: []
  2881. /api/tasks:
  2882. get:
  2883. operationId: api_tasks_get_collection
  2884. tags:
  2885. - Task
  2886. responses:
  2887. 200:
  2888. description: 'Task collection'
  2889. content:
  2890. application/ld+json:
  2891. schema:
  2892. type: object
  2893. properties:
  2894. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
  2895. 'hydra:totalItems': { type: integer, minimum: 0 }
  2896. '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 } }
  2897. '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 } } } } } }
  2898. required:
  2899. - 'hydra:member'
  2900. application/json:
  2901. schema:
  2902. type: array
  2903. items:
  2904. $ref: '#/components/schemas/Task'
  2905. text/html:
  2906. schema:
  2907. type: array
  2908. items:
  2909. $ref: '#/components/schemas/Task'
  2910. application/hal+json:
  2911. schema:
  2912. type: object
  2913. properties:
  2914. _embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
  2915. totalItems: { type: integer, minimum: 0 }
  2916. itemsPerPage: { type: integer, minimum: 0 }
  2917. _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 } } } } }
  2918. required:
  2919. - _links
  2920. - _embedded
  2921. summary: 'Retrieves the collection of Task resources.'
  2922. description: 'Retrieves the collection of Task resources.'
  2923. parameters:
  2924. -
  2925. name: page
  2926. in: query
  2927. description: 'The collection page number'
  2928. required: false
  2929. deprecated: false
  2930. allowEmptyValue: true
  2931. schema:
  2932. type: integer
  2933. default: 1
  2934. style: form
  2935. explode: false
  2936. allowReserved: false
  2937. -
  2938. name: itemsPerPage
  2939. in: query
  2940. description: 'The number of items per page'
  2941. required: false
  2942. deprecated: false
  2943. allowEmptyValue: true
  2944. schema:
  2945. type: integer
  2946. default: 10
  2947. minimum: 0
  2948. maximum: 50
  2949. style: form
  2950. explode: false
  2951. allowReserved: false
  2952. -
  2953. name: assignedTo
  2954. in: query
  2955. description: ''
  2956. required: false
  2957. deprecated: false
  2958. allowEmptyValue: true
  2959. schema:
  2960. type: string
  2961. style: form
  2962. explode: false
  2963. allowReserved: false
  2964. -
  2965. name: 'assignedTo[]'
  2966. in: query
  2967. description: ''
  2968. required: false
  2969. deprecated: false
  2970. allowEmptyValue: true
  2971. schema:
  2972. type: array
  2973. items:
  2974. type: string
  2975. style: form
  2976. explode: true
  2977. allowReserved: false
  2978. -
  2979. name: partner
  2980. in: query
  2981. description: ''
  2982. required: false
  2983. deprecated: false
  2984. allowEmptyValue: true
  2985. schema:
  2986. type: string
  2987. style: form
  2988. explode: false
  2989. allowReserved: false
  2990. -
  2991. name: 'partner[]'
  2992. in: query
  2993. description: ''
  2994. required: false
  2995. deprecated: false
  2996. allowEmptyValue: true
  2997. schema:
  2998. type: array
  2999. items:
  3000. type: string
  3001. style: form
  3002. explode: true
  3003. allowReserved: false
  3004. -
  3005. name: contact
  3006. in: query
  3007. description: ''
  3008. required: false
  3009. deprecated: false
  3010. allowEmptyValue: true
  3011. schema:
  3012. type: string
  3013. style: form
  3014. explode: false
  3015. allowReserved: false
  3016. -
  3017. name: 'contact[]'
  3018. in: query
  3019. description: ''
  3020. required: false
  3021. deprecated: false
  3022. allowEmptyValue: true
  3023. schema:
  3024. type: array
  3025. items:
  3026. type: string
  3027. style: form
  3028. explode: true
  3029. allowReserved: false
  3030. deprecated: false
  3031. post:
  3032. operationId: api_tasks_post
  3033. tags:
  3034. - Task
  3035. responses:
  3036. 201:
  3037. description: 'Task resource created'
  3038. content:
  3039. application/ld+json:
  3040. schema:
  3041. $ref: '#/components/schemas/Task.jsonld'
  3042. application/json:
  3043. schema:
  3044. $ref: '#/components/schemas/Task'
  3045. text/html:
  3046. schema:
  3047. $ref: '#/components/schemas/Task'
  3048. application/hal+json:
  3049. schema:
  3050. $ref: '#/components/schemas/Task.jsonhal'
  3051. links: { }
  3052. 400:
  3053. description: 'Invalid input'
  3054. 422:
  3055. description: 'Unprocessable entity'
  3056. summary: 'Creates a Task resource.'
  3057. description: 'Creates a Task resource.'
  3058. parameters: []
  3059. requestBody:
  3060. description: 'The new 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. required: true
  3075. deprecated: false
  3076. parameters: []
  3077. '/api/tasks/{id}':
  3078. get:
  3079. operationId: api_tasks_id_get
  3080. tags:
  3081. - Task
  3082. responses:
  3083. 200:
  3084. description: 'Task resource'
  3085. content:
  3086. application/ld+json:
  3087. schema:
  3088. $ref: '#/components/schemas/Task.jsonld'
  3089. application/json:
  3090. schema:
  3091. $ref: '#/components/schemas/Task'
  3092. text/html:
  3093. schema:
  3094. $ref: '#/components/schemas/Task'
  3095. application/hal+json:
  3096. schema:
  3097. $ref: '#/components/schemas/Task.jsonhal'
  3098. 404:
  3099. description: 'Resource not found'
  3100. summary: 'Retrieves a Task resource.'
  3101. description: 'Retrieves a Task resource.'
  3102. parameters:
  3103. -
  3104. name: id
  3105. in: path
  3106. description: 'Task identifier'
  3107. required: true
  3108. deprecated: false
  3109. allowEmptyValue: false
  3110. schema:
  3111. type: string
  3112. style: simple
  3113. explode: false
  3114. allowReserved: false
  3115. deprecated: false
  3116. delete:
  3117. operationId: api_tasks_id_delete
  3118. tags:
  3119. - Task
  3120. responses:
  3121. 204:
  3122. description: 'Task resource deleted'
  3123. 404:
  3124. description: 'Resource not found'
  3125. summary: 'Removes the Task resource.'
  3126. description: 'Removes the Task resource.'
  3127. parameters:
  3128. -
  3129. name: id
  3130. in: path
  3131. description: 'Task identifier'
  3132. required: true
  3133. deprecated: false
  3134. allowEmptyValue: false
  3135. schema:
  3136. type: string
  3137. style: simple
  3138. explode: false
  3139. allowReserved: false
  3140. deprecated: false
  3141. patch:
  3142. operationId: api_tasks_id_patch
  3143. tags:
  3144. - Task
  3145. responses:
  3146. 200:
  3147. description: 'Task resource updated'
  3148. content:
  3149. application/ld+json:
  3150. schema:
  3151. $ref: '#/components/schemas/Task.jsonld'
  3152. application/json:
  3153. schema:
  3154. $ref: '#/components/schemas/Task'
  3155. text/html:
  3156. schema:
  3157. $ref: '#/components/schemas/Task'
  3158. application/hal+json:
  3159. schema:
  3160. $ref: '#/components/schemas/Task.jsonhal'
  3161. links: { }
  3162. 400:
  3163. description: 'Invalid input'
  3164. 422:
  3165. description: 'Unprocessable entity'
  3166. 404:
  3167. description: 'Resource not found'
  3168. summary: 'Updates the Task resource.'
  3169. description: 'Updates the Task resource.'
  3170. parameters:
  3171. -
  3172. name: id
  3173. in: path
  3174. description: 'Task identifier'
  3175. required: true
  3176. deprecated: false
  3177. allowEmptyValue: false
  3178. schema:
  3179. type: string
  3180. style: simple
  3181. explode: false
  3182. allowReserved: false
  3183. requestBody:
  3184. description: 'The updated Task resource'
  3185. content:
  3186. application/merge-patch+json:
  3187. schema:
  3188. $ref: '#/components/schemas/Task'
  3189. required: true
  3190. deprecated: false
  3191. parameters: []
  3192. /api/users:
  3193. get:
  3194. operationId: api_users_get_collection
  3195. tags:
  3196. - User
  3197. responses:
  3198. 200:
  3199. description: 'User collection'
  3200. content:
  3201. application/ld+json:
  3202. schema:
  3203. type: object
  3204. properties:
  3205. 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  3206. 'hydra:totalItems': { type: integer, minimum: 0 }
  3207. '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 } }
  3208. '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 } } } } } }
  3209. required:
  3210. - 'hydra:member'
  3211. application/json:
  3212. schema:
  3213. type: array
  3214. items:
  3215. $ref: '#/components/schemas/User'
  3216. text/html:
  3217. schema:
  3218. type: array
  3219. items:
  3220. $ref: '#/components/schemas/User'
  3221. application/hal+json:
  3222. schema:
  3223. type: object
  3224. properties:
  3225. _embedded: { type: array, items: { $ref: '#/components/schemas/User.jsonhal' } }
  3226. totalItems: { type: integer, minimum: 0 }
  3227. itemsPerPage: { type: integer, minimum: 0 }
  3228. _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 } } } } }
  3229. required:
  3230. - _links
  3231. - _embedded
  3232. summary: 'Retrieves the collection of User resources.'
  3233. description: 'Retrieves the collection of User resources.'
  3234. parameters:
  3235. -
  3236. name: page
  3237. in: query
  3238. description: 'The collection page number'
  3239. required: false
  3240. deprecated: false
  3241. allowEmptyValue: true
  3242. schema:
  3243. type: integer
  3244. default: 1
  3245. style: form
  3246. explode: false
  3247. allowReserved: false
  3248. -
  3249. name: itemsPerPage
  3250. in: query
  3251. description: 'The number of items per page'
  3252. required: false
  3253. deprecated: false
  3254. allowEmptyValue: true
  3255. schema:
  3256. type: integer
  3257. default: 10
  3258. minimum: 0
  3259. maximum: 50
  3260. style: form
  3261. explode: false
  3262. allowReserved: false
  3263. -
  3264. name: firstName
  3265. in: query
  3266. description: ''
  3267. required: false
  3268. deprecated: false
  3269. allowEmptyValue: true
  3270. schema:
  3271. type: string
  3272. style: form
  3273. explode: false
  3274. allowReserved: false
  3275. -
  3276. name: lastName
  3277. in: query
  3278. description: ''
  3279. required: false
  3280. deprecated: false
  3281. allowEmptyValue: true
  3282. schema:
  3283. type: string
  3284. style: form
  3285. explode: false
  3286. allowReserved: false
  3287. deprecated: false
  3288. post:
  3289. operationId: api_users_post
  3290. tags:
  3291. - User
  3292. responses:
  3293. 201:
  3294. description: 'User resource created'
  3295. content:
  3296. application/ld+json:
  3297. schema:
  3298. $ref: '#/components/schemas/User.jsonld'
  3299. application/json:
  3300. schema:
  3301. $ref: '#/components/schemas/User'
  3302. text/html:
  3303. schema:
  3304. $ref: '#/components/schemas/User'
  3305. application/hal+json:
  3306. schema:
  3307. $ref: '#/components/schemas/User.jsonhal'
  3308. links: { }
  3309. 400:
  3310. description: 'Invalid input'
  3311. 422:
  3312. description: 'Unprocessable entity'
  3313. summary: 'Creates a User resource.'
  3314. description: 'Creates a User resource.'
  3315. parameters: []
  3316. requestBody:
  3317. description: 'The new 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. required: true
  3332. deprecated: false
  3333. parameters: []
  3334. '/api/users/{id}':
  3335. get:
  3336. operationId: api_users_id_get
  3337. tags:
  3338. - User
  3339. responses:
  3340. 200:
  3341. description: 'User resource'
  3342. content:
  3343. application/ld+json:
  3344. schema:
  3345. $ref: '#/components/schemas/User.jsonld'
  3346. application/json:
  3347. schema:
  3348. $ref: '#/components/schemas/User'
  3349. text/html:
  3350. schema:
  3351. $ref: '#/components/schemas/User'
  3352. application/hal+json:
  3353. schema:
  3354. $ref: '#/components/schemas/User.jsonhal'
  3355. 404:
  3356. description: 'Resource not found'
  3357. summary: 'Retrieves a User resource.'
  3358. description: 'Retrieves a User resource.'
  3359. parameters:
  3360. -
  3361. name: id
  3362. in: path
  3363. description: 'User identifier'
  3364. required: true
  3365. deprecated: false
  3366. allowEmptyValue: false
  3367. schema:
  3368. type: string
  3369. style: simple
  3370. explode: false
  3371. allowReserved: false
  3372. deprecated: false
  3373. patch:
  3374. operationId: api_users_id_patch
  3375. tags:
  3376. - User
  3377. responses:
  3378. 200:
  3379. description: 'User resource updated'
  3380. content:
  3381. application/ld+json:
  3382. schema:
  3383. $ref: '#/components/schemas/User.jsonld'
  3384. application/json:
  3385. schema:
  3386. $ref: '#/components/schemas/User'
  3387. text/html:
  3388. schema:
  3389. $ref: '#/components/schemas/User'
  3390. application/hal+json:
  3391. schema:
  3392. $ref: '#/components/schemas/User.jsonhal'
  3393. links: { }
  3394. 400:
  3395. description: 'Invalid input'
  3396. 422:
  3397. description: 'Unprocessable entity'
  3398. 404:
  3399. description: 'Resource not found'
  3400. summary: 'Updates the User resource.'
  3401. description: 'Updates the User resource.'
  3402. parameters:
  3403. -
  3404. name: id
  3405. in: path
  3406. description: 'User identifier'
  3407. required: true
  3408. deprecated: false
  3409. allowEmptyValue: false
  3410. schema:
  3411. type: string
  3412. style: simple
  3413. explode: false
  3414. allowReserved: false
  3415. requestBody:
  3416. description: 'The updated User resource'
  3417. content:
  3418. application/merge-patch+json:
  3419. schema:
  3420. $ref: '#/components/schemas/User'
  3421. required: true
  3422. deprecated: false
  3423. parameters: []
  3424. /auth:
  3425. post:
  3426. operationId: login_check_post
  3427. tags:
  3428. - 'Login Check'
  3429. responses:
  3430. 200:
  3431. description: 'User token created'
  3432. content:
  3433. application/json:
  3434. schema:
  3435. type: object
  3436. properties:
  3437. token: { readOnly: true, type: string, nullable: false }
  3438. required:
  3439. - token
  3440. summary: 'Creates a user token.'
  3441. description: 'Creates a user token.'
  3442. requestBody:
  3443. description: 'The login data'
  3444. content:
  3445. application/json:
  3446. schema:
  3447. type: object
  3448. properties:
  3449. email:
  3450. type: string
  3451. nullable: false
  3452. password:
  3453. type: string
  3454. nullable: false
  3455. required:
  3456. - email
  3457. - password
  3458. required: true
  3459. parameters: []
  3460. components:
  3461. schemas:
  3462. Comment:
  3463. type: object
  3464. description: ''
  3465. deprecated: false
  3466. required:
  3467. - message
  3468. properties:
  3469. message:
  3470. type:
  3471. - string
  3472. - 'null'
  3473. owner:
  3474. readOnly: true
  3475. type:
  3476. - string
  3477. - 'null'
  3478. format: iri-reference
  3479. example: 'https://example.com/'
  3480. ownerName:
  3481. readOnly: true
  3482. type:
  3483. - string
  3484. - 'null'
  3485. post:
  3486. type:
  3487. - string
  3488. - 'null'
  3489. format: iri-reference
  3490. example: 'https://example.com/'
  3491. createdAt:
  3492. readOnly: true
  3493. type:
  3494. - string
  3495. - 'null'
  3496. format: date-time
  3497. Comment.jsonhal:
  3498. type: object
  3499. description: ''
  3500. deprecated: false
  3501. required:
  3502. - message
  3503. properties:
  3504. _links:
  3505. type: object
  3506. properties:
  3507. self:
  3508. type: object
  3509. properties:
  3510. href:
  3511. type: string
  3512. format: iri-reference
  3513. message:
  3514. type:
  3515. - string
  3516. - 'null'
  3517. owner:
  3518. readOnly: true
  3519. type:
  3520. - string
  3521. - 'null'
  3522. format: iri-reference
  3523. example: 'https://example.com/'
  3524. ownerName:
  3525. readOnly: true
  3526. type:
  3527. - string
  3528. - 'null'
  3529. post:
  3530. type:
  3531. - string
  3532. - 'null'
  3533. format: iri-reference
  3534. example: 'https://example.com/'
  3535. createdAt:
  3536. readOnly: true
  3537. type:
  3538. - string
  3539. - 'null'
  3540. format: date-time
  3541. Comment.jsonld:
  3542. type: object
  3543. description: ''
  3544. deprecated: false
  3545. required:
  3546. - message
  3547. properties:
  3548. '@context':
  3549. readOnly: true
  3550. oneOf:
  3551. -
  3552. type: string
  3553. -
  3554. type: object
  3555. properties:
  3556. '@vocab':
  3557. type: string
  3558. hydra:
  3559. type: string
  3560. enum: ['http://www.w3.org/ns/hydra/core#']
  3561. required:
  3562. - '@vocab'
  3563. - hydra
  3564. additionalProperties: true
  3565. '@id':
  3566. readOnly: true
  3567. type: string
  3568. '@type':
  3569. readOnly: true
  3570. type: string
  3571. message:
  3572. type:
  3573. - string
  3574. - 'null'
  3575. owner:
  3576. readOnly: true
  3577. type:
  3578. - string
  3579. - 'null'
  3580. format: iri-reference
  3581. example: 'https://example.com/'
  3582. ownerName:
  3583. readOnly: true
  3584. type:
  3585. - string
  3586. - 'null'
  3587. post:
  3588. type:
  3589. - string
  3590. - 'null'
  3591. format: iri-reference
  3592. example: 'https://example.com/'
  3593. createdAt:
  3594. readOnly: true
  3595. type:
  3596. - string
  3597. - 'null'
  3598. format: date-time
  3599. Contact:
  3600. type: object
  3601. description: ''
  3602. deprecated: false
  3603. required:
  3604. - firstName
  3605. - lastName
  3606. - partner
  3607. properties:
  3608. firstName:
  3609. type:
  3610. - string
  3611. - 'null'
  3612. lastName:
  3613. type:
  3614. - string
  3615. - 'null'
  3616. partner:
  3617. type:
  3618. - string
  3619. - 'null'
  3620. format: iri-reference
  3621. example: 'https://example.com/'
  3622. birthday:
  3623. type:
  3624. - string
  3625. - 'null'
  3626. format: date-time
  3627. image:
  3628. type:
  3629. - string
  3630. - 'null'
  3631. format: iri-reference
  3632. example: 'https://example.com/'
  3633. imageUrl:
  3634. readOnly: true
  3635. type:
  3636. - string
  3637. - 'null'
  3638. position:
  3639. type:
  3640. - string
  3641. - 'null'
  3642. phone:
  3643. type:
  3644. - string
  3645. - 'null'
  3646. email:
  3647. format: email
  3648. externalDocs:
  3649. url: 'https://schema.org/email'
  3650. type:
  3651. - string
  3652. - 'null'
  3653. posts:
  3654. readOnly: true
  3655. type: array
  3656. items:
  3657. type: string
  3658. format: iri-reference
  3659. example: 'https://example.com/'
  3660. createdAt:
  3661. readOnly: true
  3662. type:
  3663. - string
  3664. - 'null'
  3665. format: date-time
  3666. Contact.jsonhal:
  3667. type: object
  3668. description: ''
  3669. deprecated: false
  3670. required:
  3671. - firstName
  3672. - lastName
  3673. - partner
  3674. properties:
  3675. _links:
  3676. type: object
  3677. properties:
  3678. self:
  3679. type: object
  3680. properties:
  3681. href:
  3682. type: string
  3683. format: iri-reference
  3684. firstName:
  3685. type:
  3686. - string
  3687. - 'null'
  3688. lastName:
  3689. type:
  3690. - string
  3691. - 'null'
  3692. partner:
  3693. type:
  3694. - string
  3695. - 'null'
  3696. format: iri-reference
  3697. example: 'https://example.com/'
  3698. birthday:
  3699. type:
  3700. - string
  3701. - 'null'
  3702. format: date-time
  3703. image:
  3704. type:
  3705. - string
  3706. - 'null'
  3707. format: iri-reference
  3708. example: 'https://example.com/'
  3709. imageUrl:
  3710. readOnly: true
  3711. type:
  3712. - string
  3713. - 'null'
  3714. position:
  3715. type:
  3716. - string
  3717. - 'null'
  3718. phone:
  3719. type:
  3720. - string
  3721. - 'null'
  3722. email:
  3723. format: email
  3724. externalDocs:
  3725. url: 'https://schema.org/email'
  3726. type:
  3727. - string
  3728. - 'null'
  3729. posts:
  3730. readOnly: true
  3731. type: array
  3732. items:
  3733. type: string
  3734. format: iri-reference
  3735. example: 'https://example.com/'
  3736. createdAt:
  3737. readOnly: true
  3738. type:
  3739. - string
  3740. - 'null'
  3741. format: date-time
  3742. Contact.jsonld:
  3743. type: object
  3744. description: ''
  3745. deprecated: false
  3746. required:
  3747. - firstName
  3748. - lastName
  3749. - partner
  3750. properties:
  3751. '@context':
  3752. readOnly: true
  3753. oneOf:
  3754. -
  3755. type: string
  3756. -
  3757. type: object
  3758. properties:
  3759. '@vocab':
  3760. type: string
  3761. hydra:
  3762. type: string
  3763. enum: ['http://www.w3.org/ns/hydra/core#']
  3764. required:
  3765. - '@vocab'
  3766. - hydra
  3767. additionalProperties: true
  3768. '@id':
  3769. readOnly: true
  3770. type: string
  3771. '@type':
  3772. readOnly: true
  3773. type: string
  3774. firstName:
  3775. type:
  3776. - string
  3777. - 'null'
  3778. lastName:
  3779. type:
  3780. - string
  3781. - 'null'
  3782. partner:
  3783. type:
  3784. - string
  3785. - 'null'
  3786. format: iri-reference
  3787. example: 'https://example.com/'
  3788. birthday:
  3789. type:
  3790. - string
  3791. - 'null'
  3792. format: date-time
  3793. image:
  3794. type:
  3795. - string
  3796. - 'null'
  3797. format: iri-reference
  3798. example: 'https://example.com/'
  3799. imageUrl:
  3800. readOnly: true
  3801. type:
  3802. - string
  3803. - 'null'
  3804. position:
  3805. type:
  3806. - string
  3807. - 'null'
  3808. phone:
  3809. type:
  3810. - string
  3811. - 'null'
  3812. email:
  3813. format: email
  3814. externalDocs:
  3815. url: 'https://schema.org/email'
  3816. type:
  3817. - string
  3818. - 'null'
  3819. posts:
  3820. readOnly: true
  3821. type: array
  3822. items:
  3823. type: string
  3824. format: iri-reference
  3825. example: 'https://example.com/'
  3826. createdAt:
  3827. readOnly: true
  3828. type:
  3829. - string
  3830. - 'null'
  3831. format: date-time
  3832. Document:
  3833. type: object
  3834. description: ''
  3835. deprecated: false
  3836. properties:
  3837. createdBy:
  3838. readOnly: true
  3839. type:
  3840. - string
  3841. - 'null'
  3842. format: iri-reference
  3843. example: 'https://example.com/'
  3844. createdByName:
  3845. readOnly: true
  3846. type:
  3847. - string
  3848. - 'null'
  3849. name:
  3850. type:
  3851. - string
  3852. - 'null'
  3853. description:
  3854. type:
  3855. - string
  3856. - 'null'
  3857. partner:
  3858. type:
  3859. - string
  3860. - 'null'
  3861. format: iri-reference
  3862. example: 'https://example.com/'
  3863. partnerName:
  3864. readOnly: true
  3865. type:
  3866. - string
  3867. - 'null'
  3868. product:
  3869. type:
  3870. - string
  3871. - 'null'
  3872. format: iri-reference
  3873. example: 'https://example.com/'
  3874. productName:
  3875. readOnly: true
  3876. type:
  3877. - string
  3878. - 'null'
  3879. documentObject:
  3880. type:
  3881. - string
  3882. - 'null'
  3883. format: iri-reference
  3884. example: 'https://example.com/'
  3885. documentUrl:
  3886. readOnly: true
  3887. type:
  3888. - string
  3889. - 'null'
  3890. createdAt:
  3891. readOnly: true
  3892. type:
  3893. - string
  3894. - 'null'
  3895. format: date-time
  3896. required:
  3897. - name
  3898. - documentObject
  3899. Document.jsonhal:
  3900. type: object
  3901. description: ''
  3902. deprecated: false
  3903. properties:
  3904. _links:
  3905. type: object
  3906. properties:
  3907. self:
  3908. type: object
  3909. properties:
  3910. href:
  3911. type: string
  3912. format: iri-reference
  3913. createdBy:
  3914. readOnly: true
  3915. type:
  3916. - string
  3917. - 'null'
  3918. format: iri-reference
  3919. example: 'https://example.com/'
  3920. createdByName:
  3921. readOnly: true
  3922. type:
  3923. - string
  3924. - 'null'
  3925. name:
  3926. type:
  3927. - string
  3928. - 'null'
  3929. description:
  3930. type:
  3931. - string
  3932. - 'null'
  3933. partner:
  3934. type:
  3935. - string
  3936. - 'null'
  3937. format: iri-reference
  3938. example: 'https://example.com/'
  3939. partnerName:
  3940. readOnly: true
  3941. type:
  3942. - string
  3943. - 'null'
  3944. product:
  3945. type:
  3946. - string
  3947. - 'null'
  3948. format: iri-reference
  3949. example: 'https://example.com/'
  3950. productName:
  3951. readOnly: true
  3952. type:
  3953. - string
  3954. - 'null'
  3955. documentObject:
  3956. type:
  3957. - string
  3958. - 'null'
  3959. format: iri-reference
  3960. example: 'https://example.com/'
  3961. documentUrl:
  3962. readOnly: true
  3963. type:
  3964. - string
  3965. - 'null'
  3966. createdAt:
  3967. readOnly: true
  3968. type:
  3969. - string
  3970. - 'null'
  3971. format: date-time
  3972. required:
  3973. - name
  3974. - documentObject
  3975. Document.jsonld:
  3976. type: object
  3977. description: ''
  3978. deprecated: false
  3979. properties:
  3980. '@context':
  3981. readOnly: true
  3982. oneOf:
  3983. -
  3984. type: string
  3985. -
  3986. type: object
  3987. properties:
  3988. '@vocab':
  3989. type: string
  3990. hydra:
  3991. type: string
  3992. enum: ['http://www.w3.org/ns/hydra/core#']
  3993. required:
  3994. - '@vocab'
  3995. - hydra
  3996. additionalProperties: true
  3997. '@id':
  3998. readOnly: true
  3999. type: string
  4000. '@type':
  4001. readOnly: true
  4002. type: string
  4003. createdBy:
  4004. readOnly: true
  4005. type:
  4006. - string
  4007. - 'null'
  4008. format: iri-reference
  4009. example: 'https://example.com/'
  4010. createdByName:
  4011. readOnly: true
  4012. type:
  4013. - string
  4014. - 'null'
  4015. name:
  4016. type:
  4017. - string
  4018. - 'null'
  4019. description:
  4020. type:
  4021. - string
  4022. - 'null'
  4023. partner:
  4024. type:
  4025. - string
  4026. - 'null'
  4027. format: iri-reference
  4028. example: 'https://example.com/'
  4029. partnerName:
  4030. readOnly: true
  4031. type:
  4032. - string
  4033. - 'null'
  4034. product:
  4035. type:
  4036. - string
  4037. - 'null'
  4038. format: iri-reference
  4039. example: 'https://example.com/'
  4040. productName:
  4041. readOnly: true
  4042. type:
  4043. - string
  4044. - 'null'
  4045. documentObject:
  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. type:
  4249. - string
  4250. - 'null'
  4251. format: iri-reference
  4252. example: 'https://example.com/'
  4253. logoUrl:
  4254. readOnly: true
  4255. type:
  4256. - string
  4257. - 'null'
  4258. createdAt:
  4259. readOnly: true
  4260. type:
  4261. - string
  4262. - 'null'
  4263. format: date-time
  4264. posts:
  4265. readOnly: true
  4266. description: 'array<int, PostingApi>'
  4267. type: array
  4268. items:
  4269. type: string
  4270. contacts:
  4271. readOnly: true
  4272. type: array
  4273. items:
  4274. type: string
  4275. format: iri-reference
  4276. example: 'https://example.com/'
  4277. Partner.jsonhal:
  4278. type: object
  4279. description: ''
  4280. deprecated: false
  4281. required:
  4282. - name
  4283. - partnerType
  4284. properties:
  4285. _links:
  4286. type: object
  4287. properties:
  4288. self:
  4289. type: object
  4290. properties:
  4291. href:
  4292. type: string
  4293. format: iri-reference
  4294. name:
  4295. type: string
  4296. partnerType:
  4297. type: string
  4298. enum:
  4299. - customer
  4300. - supplier
  4301. - service
  4302. street:
  4303. type:
  4304. - string
  4305. - 'null'
  4306. streetNo:
  4307. type:
  4308. - string
  4309. - 'null'
  4310. zip:
  4311. type:
  4312. - string
  4313. - 'null'
  4314. city:
  4315. type:
  4316. - string
  4317. - 'null'
  4318. country:
  4319. type:
  4320. - string
  4321. - 'null'
  4322. website:
  4323. type:
  4324. - string
  4325. - 'null'
  4326. logo:
  4327. type:
  4328. - string
  4329. - 'null'
  4330. format: iri-reference
  4331. example: 'https://example.com/'
  4332. logoUrl:
  4333. readOnly: true
  4334. type:
  4335. - string
  4336. - 'null'
  4337. createdAt:
  4338. readOnly: true
  4339. type:
  4340. - string
  4341. - 'null'
  4342. format: date-time
  4343. posts:
  4344. readOnly: true
  4345. description: 'array<int, PostingApi>'
  4346. type: array
  4347. items:
  4348. type: string
  4349. contacts:
  4350. readOnly: true
  4351. type: array
  4352. items:
  4353. type: string
  4354. format: iri-reference
  4355. example: 'https://example.com/'
  4356. Partner.jsonld:
  4357. type: object
  4358. description: ''
  4359. deprecated: false
  4360. required:
  4361. - name
  4362. - partnerType
  4363. properties:
  4364. '@context':
  4365. readOnly: true
  4366. oneOf:
  4367. -
  4368. type: string
  4369. -
  4370. type: object
  4371. properties:
  4372. '@vocab':
  4373. type: string
  4374. hydra:
  4375. type: string
  4376. enum: ['http://www.w3.org/ns/hydra/core#']
  4377. required:
  4378. - '@vocab'
  4379. - hydra
  4380. additionalProperties: true
  4381. '@id':
  4382. readOnly: true
  4383. type: string
  4384. '@type':
  4385. readOnly: true
  4386. type: string
  4387. name:
  4388. type: string
  4389. partnerType:
  4390. type: string
  4391. enum:
  4392. - customer
  4393. - supplier
  4394. - service
  4395. street:
  4396. type:
  4397. - string
  4398. - 'null'
  4399. streetNo:
  4400. type:
  4401. - string
  4402. - 'null'
  4403. zip:
  4404. type:
  4405. - string
  4406. - 'null'
  4407. city:
  4408. type:
  4409. - string
  4410. - 'null'
  4411. country:
  4412. type:
  4413. - string
  4414. - 'null'
  4415. website:
  4416. type:
  4417. - string
  4418. - 'null'
  4419. logo:
  4420. type:
  4421. - string
  4422. - 'null'
  4423. format: iri-reference
  4424. example: 'https://example.com/'
  4425. logoUrl:
  4426. readOnly: true
  4427. type:
  4428. - string
  4429. - 'null'
  4430. createdAt:
  4431. readOnly: true
  4432. type:
  4433. - string
  4434. - 'null'
  4435. format: date-time
  4436. posts:
  4437. readOnly: true
  4438. description: 'array<int, PostingApi>'
  4439. type: array
  4440. items:
  4441. type: string
  4442. contacts:
  4443. readOnly: true
  4444. type: array
  4445. items:
  4446. type: string
  4447. format: iri-reference
  4448. example: 'https://example.com/'
  4449. PartnerFollow:
  4450. type: object
  4451. description: ''
  4452. deprecated: false
  4453. properties:
  4454. user:
  4455. readOnly: true
  4456. type:
  4457. - string
  4458. - 'null'
  4459. format: iri-reference
  4460. example: 'https://example.com/'
  4461. userName:
  4462. readOnly: true
  4463. type:
  4464. - string
  4465. - 'null'
  4466. partner:
  4467. type:
  4468. - string
  4469. - 'null'
  4470. format: iri-reference
  4471. example: 'https://example.com/'
  4472. partnerName:
  4473. readOnly: true
  4474. type:
  4475. - string
  4476. - 'null'
  4477. createdAt:
  4478. readOnly: true
  4479. type:
  4480. - string
  4481. - 'null'
  4482. format: date-time
  4483. required:
  4484. - partner
  4485. PartnerFollow.jsonhal:
  4486. type: object
  4487. description: ''
  4488. deprecated: false
  4489. properties:
  4490. _links:
  4491. type: object
  4492. properties:
  4493. self:
  4494. type: object
  4495. properties:
  4496. href:
  4497. type: string
  4498. format: iri-reference
  4499. user:
  4500. readOnly: true
  4501. type:
  4502. - string
  4503. - 'null'
  4504. format: iri-reference
  4505. example: 'https://example.com/'
  4506. userName:
  4507. readOnly: true
  4508. type:
  4509. - string
  4510. - 'null'
  4511. partner:
  4512. type:
  4513. - string
  4514. - 'null'
  4515. format: iri-reference
  4516. example: 'https://example.com/'
  4517. partnerName:
  4518. readOnly: true
  4519. type:
  4520. - string
  4521. - 'null'
  4522. createdAt:
  4523. readOnly: true
  4524. type:
  4525. - string
  4526. - 'null'
  4527. format: date-time
  4528. required:
  4529. - partner
  4530. PartnerFollow.jsonld:
  4531. type: object
  4532. description: ''
  4533. deprecated: false
  4534. properties:
  4535. '@context':
  4536. readOnly: true
  4537. oneOf:
  4538. -
  4539. type: string
  4540. -
  4541. type: object
  4542. properties:
  4543. '@vocab':
  4544. type: string
  4545. hydra:
  4546. type: string
  4547. enum: ['http://www.w3.org/ns/hydra/core#']
  4548. required:
  4549. - '@vocab'
  4550. - hydra
  4551. additionalProperties: true
  4552. '@id':
  4553. readOnly: true
  4554. type: string
  4555. '@type':
  4556. readOnly: true
  4557. type: string
  4558. user:
  4559. readOnly: true
  4560. type:
  4561. - string
  4562. - 'null'
  4563. format: iri-reference
  4564. example: 'https://example.com/'
  4565. userName:
  4566. readOnly: true
  4567. type:
  4568. - string
  4569. - 'null'
  4570. partner:
  4571. type:
  4572. - string
  4573. - 'null'
  4574. format: iri-reference
  4575. example: 'https://example.com/'
  4576. partnerName:
  4577. readOnly: true
  4578. type:
  4579. - string
  4580. - 'null'
  4581. createdAt:
  4582. readOnly: true
  4583. type:
  4584. - string
  4585. - 'null'
  4586. format: date-time
  4587. required:
  4588. - partner
  4589. Post:
  4590. type: object
  4591. description: ''
  4592. deprecated: false
  4593. required:
  4594. - headline
  4595. - message
  4596. properties:
  4597. headline:
  4598. type:
  4599. - string
  4600. - 'null'
  4601. message:
  4602. type:
  4603. - string
  4604. - 'null'
  4605. owner:
  4606. readOnly: true
  4607. type:
  4608. - string
  4609. - 'null'
  4610. format: iri-reference
  4611. example: 'https://example.com/'
  4612. ownerName:
  4613. readOnly: true
  4614. type:
  4615. - string
  4616. - 'null'
  4617. partner:
  4618. type:
  4619. - string
  4620. - 'null'
  4621. format: iri-reference
  4622. example: 'https://example.com/'
  4623. contact:
  4624. type:
  4625. - string
  4626. - 'null'
  4627. format: iri-reference
  4628. example: 'https://example.com/'
  4629. sale:
  4630. type:
  4631. - string
  4632. - 'null'
  4633. format: iri-reference
  4634. example: 'https://example.com/'
  4635. comments:
  4636. readOnly: true
  4637. description: 'array<int, CommentApi>'
  4638. type: array
  4639. items:
  4640. $ref: '#/components/schemas/Comment'
  4641. createdAt:
  4642. readOnly: true
  4643. type:
  4644. - string
  4645. - 'null'
  4646. format: date-time
  4647. Post-posting.create:
  4648. type: object
  4649. description: ''
  4650. deprecated: false
  4651. required:
  4652. - headline
  4653. - message
  4654. properties:
  4655. headline:
  4656. type:
  4657. - string
  4658. - 'null'
  4659. message:
  4660. type:
  4661. - string
  4662. - 'null'
  4663. partner:
  4664. type:
  4665. - string
  4666. - 'null'
  4667. format: iri-reference
  4668. example: 'https://example.com/'
  4669. contact:
  4670. type:
  4671. - string
  4672. - 'null'
  4673. format: iri-reference
  4674. example: 'https://example.com/'
  4675. sale:
  4676. type:
  4677. - string
  4678. - 'null'
  4679. format: iri-reference
  4680. example: 'https://example.com/'
  4681. Post-posting.patch:
  4682. type: object
  4683. description: ''
  4684. deprecated: false
  4685. required:
  4686. - headline
  4687. - message
  4688. properties:
  4689. headline:
  4690. type:
  4691. - string
  4692. - 'null'
  4693. message:
  4694. type:
  4695. - string
  4696. - 'null'
  4697. Post.jsonhal:
  4698. type: object
  4699. description: ''
  4700. deprecated: false
  4701. required:
  4702. - headline
  4703. - message
  4704. properties:
  4705. _links:
  4706. type: object
  4707. properties:
  4708. self:
  4709. type: object
  4710. properties:
  4711. href:
  4712. type: string
  4713. format: iri-reference
  4714. headline:
  4715. type:
  4716. - string
  4717. - 'null'
  4718. message:
  4719. type:
  4720. - string
  4721. - 'null'
  4722. owner:
  4723. readOnly: true
  4724. type:
  4725. - string
  4726. - 'null'
  4727. format: iri-reference
  4728. example: 'https://example.com/'
  4729. ownerName:
  4730. readOnly: true
  4731. type:
  4732. - string
  4733. - 'null'
  4734. partner:
  4735. type:
  4736. - string
  4737. - 'null'
  4738. format: iri-reference
  4739. example: 'https://example.com/'
  4740. contact:
  4741. type:
  4742. - string
  4743. - 'null'
  4744. format: iri-reference
  4745. example: 'https://example.com/'
  4746. sale:
  4747. type:
  4748. - string
  4749. - 'null'
  4750. format: iri-reference
  4751. example: 'https://example.com/'
  4752. comments:
  4753. readOnly: true
  4754. description: 'array<int, CommentApi>'
  4755. type: array
  4756. items:
  4757. $ref: '#/components/schemas/Comment.jsonhal'
  4758. createdAt:
  4759. readOnly: true
  4760. type:
  4761. - string
  4762. - 'null'
  4763. format: date-time
  4764. Post.jsonhal-posting.create:
  4765. type: object
  4766. description: ''
  4767. deprecated: false
  4768. required:
  4769. - headline
  4770. - message
  4771. properties:
  4772. _links:
  4773. type: object
  4774. properties:
  4775. self:
  4776. type: object
  4777. properties:
  4778. href:
  4779. type: string
  4780. format: iri-reference
  4781. headline:
  4782. type:
  4783. - string
  4784. - 'null'
  4785. message:
  4786. type:
  4787. - string
  4788. - 'null'
  4789. partner:
  4790. type:
  4791. - string
  4792. - 'null'
  4793. format: iri-reference
  4794. example: 'https://example.com/'
  4795. contact:
  4796. type:
  4797. - string
  4798. - 'null'
  4799. format: iri-reference
  4800. example: 'https://example.com/'
  4801. sale:
  4802. type:
  4803. - string
  4804. - 'null'
  4805. format: iri-reference
  4806. example: 'https://example.com/'
  4807. Post.jsonld:
  4808. type: object
  4809. description: ''
  4810. deprecated: false
  4811. required:
  4812. - headline
  4813. - message
  4814. properties:
  4815. '@context':
  4816. readOnly: true
  4817. oneOf:
  4818. -
  4819. type: string
  4820. -
  4821. type: object
  4822. properties:
  4823. '@vocab':
  4824. type: string
  4825. hydra:
  4826. type: string
  4827. enum: ['http://www.w3.org/ns/hydra/core#']
  4828. required:
  4829. - '@vocab'
  4830. - hydra
  4831. additionalProperties: true
  4832. '@id':
  4833. readOnly: true
  4834. type: string
  4835. '@type':
  4836. readOnly: true
  4837. type: string
  4838. headline:
  4839. type:
  4840. - string
  4841. - 'null'
  4842. message:
  4843. type:
  4844. - string
  4845. - 'null'
  4846. owner:
  4847. readOnly: true
  4848. type:
  4849. - string
  4850. - 'null'
  4851. format: iri-reference
  4852. example: 'https://example.com/'
  4853. ownerName:
  4854. readOnly: true
  4855. type:
  4856. - string
  4857. - 'null'
  4858. partner:
  4859. type:
  4860. - string
  4861. - 'null'
  4862. format: iri-reference
  4863. example: 'https://example.com/'
  4864. contact:
  4865. type:
  4866. - string
  4867. - 'null'
  4868. format: iri-reference
  4869. example: 'https://example.com/'
  4870. sale:
  4871. type:
  4872. - string
  4873. - 'null'
  4874. format: iri-reference
  4875. example: 'https://example.com/'
  4876. comments:
  4877. readOnly: true
  4878. description: 'array<int, CommentApi>'
  4879. type: array
  4880. items:
  4881. $ref: '#/components/schemas/Comment.jsonld'
  4882. createdAt:
  4883. readOnly: true
  4884. type:
  4885. - string
  4886. - 'null'
  4887. format: date-time
  4888. Post.jsonld-posting.create:
  4889. type: object
  4890. description: ''
  4891. deprecated: false
  4892. required:
  4893. - headline
  4894. - message
  4895. properties:
  4896. headline:
  4897. type:
  4898. - string
  4899. - 'null'
  4900. message:
  4901. type:
  4902. - string
  4903. - 'null'
  4904. partner:
  4905. type:
  4906. - string
  4907. - 'null'
  4908. format: iri-reference
  4909. example: 'https://example.com/'
  4910. contact:
  4911. type:
  4912. - string
  4913. - 'null'
  4914. format: iri-reference
  4915. example: 'https://example.com/'
  4916. sale:
  4917. type:
  4918. - string
  4919. - 'null'
  4920. format: iri-reference
  4921. example: 'https://example.com/'
  4922. Product:
  4923. type: object
  4924. description: ''
  4925. deprecated: false
  4926. required:
  4927. - name
  4928. properties:
  4929. name:
  4930. type: string
  4931. description:
  4932. type:
  4933. - string
  4934. - 'null'
  4935. image:
  4936. type:
  4937. - string
  4938. - 'null'
  4939. format: iri-reference
  4940. example: 'https://example.com/'
  4941. imageUrl:
  4942. readOnly: true
  4943. type:
  4944. - string
  4945. - 'null'
  4946. createdAt:
  4947. type:
  4948. - string
  4949. - 'null'
  4950. format: date-time
  4951. Product.jsonhal:
  4952. type: object
  4953. description: ''
  4954. deprecated: false
  4955. required:
  4956. - name
  4957. properties:
  4958. _links:
  4959. type: object
  4960. properties:
  4961. self:
  4962. type: object
  4963. properties:
  4964. href:
  4965. type: string
  4966. format: iri-reference
  4967. name:
  4968. type: string
  4969. description:
  4970. type:
  4971. - string
  4972. - 'null'
  4973. image:
  4974. type:
  4975. - string
  4976. - 'null'
  4977. format: iri-reference
  4978. example: 'https://example.com/'
  4979. imageUrl:
  4980. readOnly: true
  4981. type:
  4982. - string
  4983. - 'null'
  4984. createdAt:
  4985. type:
  4986. - string
  4987. - 'null'
  4988. format: date-time
  4989. Product.jsonld:
  4990. type: object
  4991. description: ''
  4992. deprecated: false
  4993. required:
  4994. - name
  4995. properties:
  4996. '@context':
  4997. readOnly: true
  4998. oneOf:
  4999. -
  5000. type: string
  5001. -
  5002. type: object
  5003. properties:
  5004. '@vocab':
  5005. type: string
  5006. hydra:
  5007. type: string
  5008. enum: ['http://www.w3.org/ns/hydra/core#']
  5009. required:
  5010. - '@vocab'
  5011. - hydra
  5012. additionalProperties: true
  5013. '@id':
  5014. readOnly: true
  5015. type: string
  5016. '@type':
  5017. readOnly: true
  5018. type: string
  5019. name:
  5020. type: string
  5021. description:
  5022. type:
  5023. - string
  5024. - 'null'
  5025. image:
  5026. type:
  5027. - string
  5028. - 'null'
  5029. format: iri-reference
  5030. example: 'https://example.com/'
  5031. imageUrl:
  5032. readOnly: true
  5033. type:
  5034. - string
  5035. - 'null'
  5036. createdAt:
  5037. type:
  5038. - string
  5039. - 'null'
  5040. format: date-time
  5041. Sale:
  5042. type: object
  5043. description: ''
  5044. deprecated: false
  5045. properties:
  5046. owner:
  5047. readOnly: true
  5048. type:
  5049. - string
  5050. - 'null'
  5051. format: iri-reference
  5052. example: 'https://example.com/'
  5053. ownerName:
  5054. readOnly: true
  5055. type:
  5056. - string
  5057. - 'null'
  5058. partner:
  5059. type:
  5060. - string
  5061. - 'null'
  5062. format: iri-reference
  5063. example: 'https://example.com/'
  5064. partnerName:
  5065. readOnly: true
  5066. type:
  5067. - string
  5068. - 'null'
  5069. product:
  5070. type:
  5071. - string
  5072. - 'null'
  5073. format: iri-reference
  5074. example: 'https://example.com/'
  5075. productName:
  5076. readOnly: true
  5077. type:
  5078. - string
  5079. - 'null'
  5080. turnover:
  5081. type:
  5082. - integer
  5083. - 'null'
  5084. profit:
  5085. type:
  5086. - integer
  5087. - 'null'
  5088. comment:
  5089. type:
  5090. - string
  5091. - 'null'
  5092. createdAt:
  5093. readOnly: true
  5094. type:
  5095. - string
  5096. - 'null'
  5097. format: date-time
  5098. posts:
  5099. readOnly: true
  5100. description: 'array<int, PostingApi>'
  5101. type: array
  5102. items:
  5103. type: string
  5104. required:
  5105. - turnover
  5106. Sale.jsonhal:
  5107. type: object
  5108. description: ''
  5109. deprecated: false
  5110. properties:
  5111. _links:
  5112. type: object
  5113. properties:
  5114. self:
  5115. type: object
  5116. properties:
  5117. href:
  5118. type: string
  5119. format: iri-reference
  5120. owner:
  5121. readOnly: true
  5122. type:
  5123. - string
  5124. - 'null'
  5125. format: iri-reference
  5126. example: 'https://example.com/'
  5127. ownerName:
  5128. readOnly: true
  5129. type:
  5130. - string
  5131. - 'null'
  5132. partner:
  5133. type:
  5134. - string
  5135. - 'null'
  5136. format: iri-reference
  5137. example: 'https://example.com/'
  5138. partnerName:
  5139. readOnly: true
  5140. type:
  5141. - string
  5142. - 'null'
  5143. product:
  5144. type:
  5145. - string
  5146. - 'null'
  5147. format: iri-reference
  5148. example: 'https://example.com/'
  5149. productName:
  5150. readOnly: true
  5151. type:
  5152. - string
  5153. - 'null'
  5154. turnover:
  5155. type:
  5156. - integer
  5157. - 'null'
  5158. profit:
  5159. type:
  5160. - integer
  5161. - 'null'
  5162. comment:
  5163. type:
  5164. - string
  5165. - 'null'
  5166. createdAt:
  5167. readOnly: true
  5168. type:
  5169. - string
  5170. - 'null'
  5171. format: date-time
  5172. posts:
  5173. readOnly: true
  5174. description: 'array<int, PostingApi>'
  5175. type: array
  5176. items:
  5177. type: string
  5178. required:
  5179. - turnover
  5180. Sale.jsonld:
  5181. type: object
  5182. description: ''
  5183. deprecated: false
  5184. properties:
  5185. '@context':
  5186. readOnly: true
  5187. oneOf:
  5188. -
  5189. type: string
  5190. -
  5191. type: object
  5192. properties:
  5193. '@vocab':
  5194. type: string
  5195. hydra:
  5196. type: string
  5197. enum: ['http://www.w3.org/ns/hydra/core#']
  5198. required:
  5199. - '@vocab'
  5200. - hydra
  5201. additionalProperties: true
  5202. '@id':
  5203. readOnly: true
  5204. type: string
  5205. '@type':
  5206. readOnly: true
  5207. type: string
  5208. owner:
  5209. readOnly: true
  5210. type:
  5211. - string
  5212. - 'null'
  5213. format: iri-reference
  5214. example: 'https://example.com/'
  5215. ownerName:
  5216. readOnly: true
  5217. type:
  5218. - string
  5219. - 'null'
  5220. partner:
  5221. type:
  5222. - string
  5223. - 'null'
  5224. format: iri-reference
  5225. example: 'https://example.com/'
  5226. partnerName:
  5227. readOnly: true
  5228. type:
  5229. - string
  5230. - 'null'
  5231. product:
  5232. type:
  5233. - string
  5234. - 'null'
  5235. format: iri-reference
  5236. example: 'https://example.com/'
  5237. productName:
  5238. readOnly: true
  5239. type:
  5240. - string
  5241. - 'null'
  5242. turnover:
  5243. type:
  5244. - integer
  5245. - 'null'
  5246. profit:
  5247. type:
  5248. - integer
  5249. - 'null'
  5250. comment:
  5251. type:
  5252. - string
  5253. - 'null'
  5254. createdAt:
  5255. readOnly: true
  5256. type:
  5257. - string
  5258. - 'null'
  5259. format: date-time
  5260. posts:
  5261. readOnly: true
  5262. description: 'array<int, PostingApi>'
  5263. type: array
  5264. items:
  5265. type: string
  5266. required:
  5267. - turnover
  5268. SaleSummary:
  5269. type: object
  5270. description: ''
  5271. deprecated: false
  5272. properties:
  5273. owner:
  5274. type:
  5275. - string
  5276. - 'null'
  5277. format: iri-reference
  5278. example: 'https://example.com/'
  5279. ownerName:
  5280. type:
  5281. - string
  5282. - 'null'
  5283. turnover:
  5284. type:
  5285. - integer
  5286. - 'null'
  5287. profit:
  5288. type:
  5289. - integer
  5290. - 'null'
  5291. SaleSummary.jsonhal:
  5292. type: object
  5293. description: ''
  5294. deprecated: false
  5295. properties:
  5296. _links:
  5297. type: object
  5298. properties:
  5299. self:
  5300. type: object
  5301. properties:
  5302. href:
  5303. type: string
  5304. format: iri-reference
  5305. owner:
  5306. type:
  5307. - string
  5308. - 'null'
  5309. format: iri-reference
  5310. example: 'https://example.com/'
  5311. ownerName:
  5312. type:
  5313. - string
  5314. - 'null'
  5315. turnover:
  5316. type:
  5317. - integer
  5318. - 'null'
  5319. profit:
  5320. type:
  5321. - integer
  5322. - 'null'
  5323. SaleSummary.jsonld:
  5324. type: object
  5325. description: ''
  5326. deprecated: false
  5327. properties:
  5328. '@id':
  5329. readOnly: true
  5330. type: string
  5331. '@type':
  5332. readOnly: true
  5333. type: string
  5334. owner:
  5335. type:
  5336. - string
  5337. - 'null'
  5338. format: iri-reference
  5339. example: 'https://example.com/'
  5340. ownerName:
  5341. type:
  5342. - string
  5343. - 'null'
  5344. turnover:
  5345. type:
  5346. - integer
  5347. - 'null'
  5348. profit:
  5349. type:
  5350. - integer
  5351. - 'null'
  5352. Task:
  5353. type: object
  5354. description: ''
  5355. deprecated: false
  5356. required:
  5357. - headline
  5358. - description
  5359. - assignedTo
  5360. - dueAt
  5361. - prio
  5362. - completed
  5363. properties:
  5364. headline:
  5365. type:
  5366. - string
  5367. - 'null'
  5368. description:
  5369. type:
  5370. - string
  5371. - 'null'
  5372. createdBy:
  5373. readOnly: true
  5374. type:
  5375. - string
  5376. - 'null'
  5377. format: iri-reference
  5378. example: 'https://example.com/'
  5379. createdByName:
  5380. readOnly: true
  5381. type:
  5382. - string
  5383. - 'null'
  5384. assignedTo:
  5385. type:
  5386. - string
  5387. - 'null'
  5388. format: iri-reference
  5389. example: 'https://example.com/'
  5390. assignedToName:
  5391. readOnly: true
  5392. type:
  5393. - string
  5394. - 'null'
  5395. dueAt:
  5396. type:
  5397. - string
  5398. - 'null'
  5399. format: date-time
  5400. partner:
  5401. type:
  5402. - string
  5403. - 'null'
  5404. format: iri-reference
  5405. example: 'https://example.com/'
  5406. partnerName:
  5407. readOnly: true
  5408. type:
  5409. - string
  5410. - 'null'
  5411. contact:
  5412. type:
  5413. - string
  5414. - 'null'
  5415. format: iri-reference
  5416. example: 'https://example.com/'
  5417. contactName:
  5418. readOnly: true
  5419. type:
  5420. - string
  5421. - 'null'
  5422. prio:
  5423. type: string
  5424. enum:
  5425. - low
  5426. - medium
  5427. - high
  5428. completed:
  5429. type:
  5430. - boolean
  5431. - 'null'
  5432. taskNotes:
  5433. readOnly: true
  5434. description: 'array<int, TaskNoteApi>'
  5435. type: array
  5436. items:
  5437. $ref: '#/components/schemas/TaskNote'
  5438. createdAt:
  5439. readOnly: true
  5440. type:
  5441. - string
  5442. - 'null'
  5443. format: date-time
  5444. Task.jsonhal:
  5445. type: object
  5446. description: ''
  5447. deprecated: false
  5448. required:
  5449. - headline
  5450. - description
  5451. - assignedTo
  5452. - dueAt
  5453. - prio
  5454. - completed
  5455. properties:
  5456. _links:
  5457. type: object
  5458. properties:
  5459. self:
  5460. type: object
  5461. properties:
  5462. href:
  5463. type: string
  5464. format: iri-reference
  5465. headline:
  5466. type:
  5467. - string
  5468. - 'null'
  5469. description:
  5470. type:
  5471. - string
  5472. - 'null'
  5473. createdBy:
  5474. readOnly: true
  5475. type:
  5476. - string
  5477. - 'null'
  5478. format: iri-reference
  5479. example: 'https://example.com/'
  5480. createdByName:
  5481. readOnly: true
  5482. type:
  5483. - string
  5484. - 'null'
  5485. assignedTo:
  5486. type:
  5487. - string
  5488. - 'null'
  5489. format: iri-reference
  5490. example: 'https://example.com/'
  5491. assignedToName:
  5492. readOnly: true
  5493. type:
  5494. - string
  5495. - 'null'
  5496. dueAt:
  5497. type:
  5498. - string
  5499. - 'null'
  5500. format: date-time
  5501. partner:
  5502. type:
  5503. - string
  5504. - 'null'
  5505. format: iri-reference
  5506. example: 'https://example.com/'
  5507. partnerName:
  5508. readOnly: true
  5509. type:
  5510. - string
  5511. - 'null'
  5512. contact:
  5513. type:
  5514. - string
  5515. - 'null'
  5516. format: iri-reference
  5517. example: 'https://example.com/'
  5518. contactName:
  5519. readOnly: true
  5520. type:
  5521. - string
  5522. - 'null'
  5523. prio:
  5524. type: string
  5525. enum:
  5526. - low
  5527. - medium
  5528. - high
  5529. completed:
  5530. type:
  5531. - boolean
  5532. - 'null'
  5533. taskNotes:
  5534. readOnly: true
  5535. description: 'array<int, TaskNoteApi>'
  5536. type: array
  5537. items:
  5538. $ref: '#/components/schemas/TaskNote.jsonhal'
  5539. createdAt:
  5540. readOnly: true
  5541. type:
  5542. - string
  5543. - 'null'
  5544. format: date-time
  5545. Task.jsonld:
  5546. type: object
  5547. description: ''
  5548. deprecated: false
  5549. required:
  5550. - headline
  5551. - description
  5552. - assignedTo
  5553. - dueAt
  5554. - prio
  5555. - completed
  5556. properties:
  5557. '@context':
  5558. readOnly: true
  5559. oneOf:
  5560. -
  5561. type: string
  5562. -
  5563. type: object
  5564. properties:
  5565. '@vocab':
  5566. type: string
  5567. hydra:
  5568. type: string
  5569. enum: ['http://www.w3.org/ns/hydra/core#']
  5570. required:
  5571. - '@vocab'
  5572. - hydra
  5573. additionalProperties: true
  5574. '@id':
  5575. readOnly: true
  5576. type: string
  5577. '@type':
  5578. readOnly: true
  5579. type: string
  5580. headline:
  5581. type:
  5582. - string
  5583. - 'null'
  5584. description:
  5585. type:
  5586. - string
  5587. - 'null'
  5588. createdBy:
  5589. readOnly: true
  5590. type:
  5591. - string
  5592. - 'null'
  5593. format: iri-reference
  5594. example: 'https://example.com/'
  5595. createdByName:
  5596. readOnly: true
  5597. type:
  5598. - string
  5599. - 'null'
  5600. assignedTo:
  5601. type:
  5602. - string
  5603. - 'null'
  5604. format: iri-reference
  5605. example: 'https://example.com/'
  5606. assignedToName:
  5607. readOnly: true
  5608. type:
  5609. - string
  5610. - 'null'
  5611. dueAt:
  5612. type:
  5613. - string
  5614. - 'null'
  5615. format: date-time
  5616. partner:
  5617. type:
  5618. - string
  5619. - 'null'
  5620. format: iri-reference
  5621. example: 'https://example.com/'
  5622. partnerName:
  5623. readOnly: true
  5624. type:
  5625. - string
  5626. - 'null'
  5627. contact:
  5628. type:
  5629. - string
  5630. - 'null'
  5631. format: iri-reference
  5632. example: 'https://example.com/'
  5633. contactName:
  5634. readOnly: true
  5635. type:
  5636. - string
  5637. - 'null'
  5638. prio:
  5639. type: string
  5640. enum:
  5641. - low
  5642. - medium
  5643. - high
  5644. completed:
  5645. type:
  5646. - boolean
  5647. - 'null'
  5648. taskNotes:
  5649. readOnly: true
  5650. description: 'array<int, TaskNoteApi>'
  5651. type: array
  5652. items:
  5653. $ref: '#/components/schemas/TaskNote.jsonld'
  5654. createdAt:
  5655. readOnly: true
  5656. type:
  5657. - string
  5658. - 'null'
  5659. format: date-time
  5660. TaskNote:
  5661. type: object
  5662. description: ''
  5663. deprecated: false
  5664. required:
  5665. - message
  5666. properties:
  5667. message:
  5668. type:
  5669. - string
  5670. - 'null'
  5671. owner:
  5672. readOnly: true
  5673. type:
  5674. - string
  5675. - 'null'
  5676. format: iri-reference
  5677. example: 'https://example.com/'
  5678. ownerName:
  5679. readOnly: true
  5680. type:
  5681. - string
  5682. - 'null'
  5683. task:
  5684. type:
  5685. - string
  5686. - 'null'
  5687. format: iri-reference
  5688. example: 'https://example.com/'
  5689. createdAt:
  5690. readOnly: true
  5691. type:
  5692. - string
  5693. - 'null'
  5694. format: date-time
  5695. TaskNote.jsonhal:
  5696. type: object
  5697. description: ''
  5698. deprecated: false
  5699. required:
  5700. - message
  5701. properties:
  5702. _links:
  5703. type: object
  5704. properties:
  5705. self:
  5706. type: object
  5707. properties:
  5708. href:
  5709. type: string
  5710. format: iri-reference
  5711. message:
  5712. type:
  5713. - string
  5714. - 'null'
  5715. owner:
  5716. readOnly: true
  5717. type:
  5718. - string
  5719. - 'null'
  5720. format: iri-reference
  5721. example: 'https://example.com/'
  5722. ownerName:
  5723. readOnly: true
  5724. type:
  5725. - string
  5726. - 'null'
  5727. task:
  5728. type:
  5729. - string
  5730. - 'null'
  5731. format: iri-reference
  5732. example: 'https://example.com/'
  5733. createdAt:
  5734. readOnly: true
  5735. type:
  5736. - string
  5737. - 'null'
  5738. format: date-time
  5739. TaskNote.jsonld:
  5740. type: object
  5741. description: ''
  5742. deprecated: false
  5743. required:
  5744. - message
  5745. properties:
  5746. '@context':
  5747. readOnly: true
  5748. oneOf:
  5749. -
  5750. type: string
  5751. -
  5752. type: object
  5753. properties:
  5754. '@vocab':
  5755. type: string
  5756. hydra:
  5757. type: string
  5758. enum: ['http://www.w3.org/ns/hydra/core#']
  5759. required:
  5760. - '@vocab'
  5761. - hydra
  5762. additionalProperties: true
  5763. '@id':
  5764. readOnly: true
  5765. type: string
  5766. '@type':
  5767. readOnly: true
  5768. type: string
  5769. message:
  5770. type:
  5771. - string
  5772. - 'null'
  5773. owner:
  5774. readOnly: true
  5775. type:
  5776. - string
  5777. - 'null'
  5778. format: iri-reference
  5779. example: 'https://example.com/'
  5780. ownerName:
  5781. readOnly: true
  5782. type:
  5783. - string
  5784. - 'null'
  5785. task:
  5786. type:
  5787. - string
  5788. - 'null'
  5789. format: iri-reference
  5790. example: 'https://example.com/'
  5791. createdAt:
  5792. readOnly: true
  5793. type:
  5794. - string
  5795. - 'null'
  5796. format: date-time
  5797. User:
  5798. type: object
  5799. description: ''
  5800. deprecated: false
  5801. required:
  5802. - email
  5803. - firstName
  5804. - lastName
  5805. properties:
  5806. email:
  5807. format: email
  5808. externalDocs:
  5809. url: 'https://schema.org/email'
  5810. type:
  5811. - string
  5812. - 'null'
  5813. firstName:
  5814. type:
  5815. - string
  5816. - 'null'
  5817. lastName:
  5818. type:
  5819. - string
  5820. - 'null'
  5821. image:
  5822. type:
  5823. - string
  5824. - 'null'
  5825. format: iri-reference
  5826. example: 'https://example.com/'
  5827. password:
  5828. writeOnly: true
  5829. description: 'The plaintext password when being set or changed.'
  5830. type:
  5831. - string
  5832. - 'null'
  5833. active:
  5834. type: boolean
  5835. createdAt:
  5836. readOnly: true
  5837. type:
  5838. - string
  5839. - 'null'
  5840. format: date-time
  5841. User.jsonhal:
  5842. type: object
  5843. description: ''
  5844. deprecated: false
  5845. required:
  5846. - email
  5847. - firstName
  5848. - lastName
  5849. properties:
  5850. _links:
  5851. type: object
  5852. properties:
  5853. self:
  5854. type: object
  5855. properties:
  5856. href:
  5857. type: string
  5858. format: iri-reference
  5859. email:
  5860. format: email
  5861. externalDocs:
  5862. url: 'https://schema.org/email'
  5863. type:
  5864. - string
  5865. - 'null'
  5866. firstName:
  5867. type:
  5868. - string
  5869. - 'null'
  5870. lastName:
  5871. type:
  5872. - string
  5873. - 'null'
  5874. image:
  5875. type:
  5876. - string
  5877. - 'null'
  5878. format: iri-reference
  5879. example: 'https://example.com/'
  5880. password:
  5881. writeOnly: true
  5882. description: 'The plaintext password when being set or changed.'
  5883. type:
  5884. - string
  5885. - 'null'
  5886. active:
  5887. type: boolean
  5888. createdAt:
  5889. readOnly: true
  5890. type:
  5891. - string
  5892. - 'null'
  5893. format: date-time
  5894. User.jsonld:
  5895. type: object
  5896. description: ''
  5897. deprecated: false
  5898. required:
  5899. - email
  5900. - firstName
  5901. - lastName
  5902. properties:
  5903. '@context':
  5904. readOnly: true
  5905. oneOf:
  5906. -
  5907. type: string
  5908. -
  5909. type: object
  5910. properties:
  5911. '@vocab':
  5912. type: string
  5913. hydra:
  5914. type: string
  5915. enum: ['http://www.w3.org/ns/hydra/core#']
  5916. required:
  5917. - '@vocab'
  5918. - hydra
  5919. additionalProperties: true
  5920. '@id':
  5921. readOnly: true
  5922. type: string
  5923. '@type':
  5924. readOnly: true
  5925. type: string
  5926. email:
  5927. format: email
  5928. externalDocs:
  5929. url: 'https://schema.org/email'
  5930. type:
  5931. - string
  5932. - 'null'
  5933. firstName:
  5934. type:
  5935. - string
  5936. - 'null'
  5937. lastName:
  5938. type:
  5939. - string
  5940. - 'null'
  5941. image:
  5942. type:
  5943. - string
  5944. - 'null'
  5945. format: iri-reference
  5946. example: 'https://example.com/'
  5947. password:
  5948. writeOnly: true
  5949. description: 'The plaintext password when being set or changed.'
  5950. type:
  5951. - string
  5952. - 'null'
  5953. active:
  5954. type: boolean
  5955. createdAt:
  5956. readOnly: true
  5957. type:
  5958. - string
  5959. - 'null'
  5960. format: date-time
  5961. responses: { }
  5962. parameters: { }
  5963. examples: { }
  5964. requestBodies: { }
  5965. headers: { }
  5966. securitySchemes:
  5967. JWT:
  5968. type: http
  5969. scheme: bearer
  5970. bearerFormat: JWT
  5971. security:
  5972. -
  5973. JWT: []
  5974. tags: []