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

6057 Zeilen
174 KiB

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