25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

7182 lines
206 KiB

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