Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 
 
 
 

3128 wiersze
87 KiB

  1. openapi: 3.1.0
  2. info:
  3. title: 'Imaq Platform'
  4. description: ''
  5. version: 1.0.0
  6. servers:
  7. -
  8. url: /
  9. description: ''
  10. paths:
  11. /api/auth:
  12. post:
  13. operationId: postCredentialsItem
  14. tags:
  15. - Auth
  16. responses:
  17. '200':
  18. description: 'Get JWT token'
  19. content:
  20. application/json:
  21. schema:
  22. $ref: '#/components/schemas/AuthResponse'
  23. summary: 'Get JWT token to login.'
  24. requestBody:
  25. description: 'Generate new JWT Token'
  26. content:
  27. application/json:
  28. schema:
  29. $ref: '#/components/schemas/Credentials'
  30. required: false
  31. security: []
  32. /api/events:
  33. get:
  34. operationId: api_events_get_collection
  35. tags:
  36. - Event
  37. responses:
  38. '200':
  39. description: 'Event collection'
  40. content:
  41. application/ld+json:
  42. schema:
  43. type: object
  44. properties:
  45. member: { type: array, items: { $ref: '#/components/schemas/Event.jsonld' } }
  46. totalItems: { type: integer, minimum: 0 }
  47. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  48. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  49. required:
  50. - member
  51. summary: 'Retrieves the collection of Event resources.'
  52. description: 'Retrieves the collection of Event 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: 50
  77. minimum: 0
  78. maximum: 200
  79. style: form
  80. explode: false
  81. allowReserved: false
  82. -
  83. name: name
  84. in: query
  85. description: ''
  86. required: false
  87. deprecated: false
  88. allowEmptyValue: false
  89. schema:
  90. type: string
  91. style: form
  92. explode: false
  93. allowReserved: false
  94. -
  95. name: custom_json_filter
  96. in: query
  97. description: ''
  98. required: false
  99. deprecated: false
  100. allowEmptyValue: false
  101. schema:
  102. type: string
  103. style: form
  104. explode: false
  105. allowReserved: false
  106. -
  107. name: custom_json_order
  108. in: query
  109. description: ''
  110. required: false
  111. deprecated: false
  112. allowEmptyValue: false
  113. schema:
  114. type: string
  115. style: form
  116. explode: false
  117. allowReserved: false
  118. deprecated: false
  119. '/api/events/{id}':
  120. get:
  121. operationId: api_events_id_get
  122. tags:
  123. - Event
  124. responses:
  125. '200':
  126. description: 'Event resource'
  127. content:
  128. application/ld+json:
  129. schema:
  130. $ref: '#/components/schemas/Event.jsonld'
  131. '404':
  132. description: 'Resource not found'
  133. summary: 'Retrieves a Event resource.'
  134. description: 'Retrieves a Event resource.'
  135. parameters:
  136. -
  137. name: id
  138. in: path
  139. description: 'Event identifier'
  140. required: true
  141. deprecated: false
  142. allowEmptyValue: false
  143. schema:
  144. type: string
  145. style: simple
  146. explode: false
  147. allowReserved: false
  148. deprecated: false
  149. /api/locations:
  150. get:
  151. operationId: api_locations_get_collection
  152. tags:
  153. - Location
  154. responses:
  155. '200':
  156. description: 'Location collection'
  157. content:
  158. application/ld+json:
  159. schema:
  160. type: object
  161. properties:
  162. member: { type: array, items: { $ref: '#/components/schemas/Location.jsonld' } }
  163. totalItems: { type: integer, minimum: 0 }
  164. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  165. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  166. required:
  167. - member
  168. summary: 'Retrieves the collection of Location resources.'
  169. description: 'Retrieves the collection of Location resources.'
  170. parameters:
  171. -
  172. name: page
  173. in: query
  174. description: 'The collection page number'
  175. required: false
  176. deprecated: false
  177. allowEmptyValue: true
  178. schema:
  179. type: integer
  180. default: 1
  181. style: form
  182. explode: false
  183. allowReserved: false
  184. -
  185. name: itemsPerPage
  186. in: query
  187. description: 'The number of items per page'
  188. required: false
  189. deprecated: false
  190. allowEmptyValue: true
  191. schema:
  192. type: integer
  193. default: 50
  194. minimum: 0
  195. maximum: 200
  196. style: form
  197. explode: false
  198. allowReserved: false
  199. -
  200. name: name
  201. in: query
  202. description: ''
  203. required: false
  204. deprecated: false
  205. allowEmptyValue: false
  206. schema:
  207. type: string
  208. style: form
  209. explode: false
  210. allowReserved: false
  211. -
  212. name: custom_json_filter
  213. in: query
  214. description: ''
  215. required: false
  216. deprecated: false
  217. allowEmptyValue: false
  218. schema:
  219. type: string
  220. style: form
  221. explode: false
  222. allowReserved: false
  223. -
  224. name: custom_json_order
  225. in: query
  226. description: ''
  227. required: false
  228. deprecated: false
  229. allowEmptyValue: false
  230. schema:
  231. type: string
  232. style: form
  233. explode: false
  234. allowReserved: false
  235. deprecated: false
  236. post:
  237. operationId: api_locations_post
  238. tags:
  239. - Location
  240. responses:
  241. '201':
  242. description: 'Location resource created'
  243. content:
  244. application/ld+json:
  245. schema:
  246. $ref: '#/components/schemas/Location.jsonld'
  247. links: { }
  248. '400':
  249. description: 'Invalid input'
  250. '422':
  251. description: 'Unprocessable entity'
  252. summary: 'Creates a Location resource.'
  253. description: 'Creates a Location resource.'
  254. parameters: []
  255. requestBody:
  256. description: 'The new Location resource'
  257. content:
  258. application/ld+json:
  259. schema:
  260. $ref: '#/components/schemas/Location.jsonld'
  261. required: true
  262. deprecated: false
  263. '/api/locations/{id}':
  264. get:
  265. operationId: api_locations_id_get
  266. tags:
  267. - Location
  268. responses:
  269. '200':
  270. description: 'Location resource'
  271. content:
  272. application/ld+json:
  273. schema:
  274. $ref: '#/components/schemas/Location.jsonld'
  275. '404':
  276. description: 'Resource not found'
  277. summary: 'Retrieves a Location resource.'
  278. description: 'Retrieves a Location resource.'
  279. parameters:
  280. -
  281. name: id
  282. in: path
  283. description: 'Location identifier'
  284. required: true
  285. deprecated: false
  286. allowEmptyValue: false
  287. schema:
  288. type: string
  289. style: simple
  290. explode: false
  291. allowReserved: false
  292. deprecated: false
  293. delete:
  294. operationId: api_locations_id_delete
  295. tags:
  296. - Location
  297. responses:
  298. '204':
  299. description: 'Location resource deleted'
  300. '404':
  301. description: 'Resource not found'
  302. summary: 'Removes the Location resource.'
  303. description: 'Removes the Location resource.'
  304. parameters:
  305. -
  306. name: id
  307. in: path
  308. description: 'Location identifier'
  309. required: true
  310. deprecated: false
  311. allowEmptyValue: false
  312. schema:
  313. type: string
  314. style: simple
  315. explode: false
  316. allowReserved: false
  317. deprecated: false
  318. patch:
  319. operationId: api_locations_id_patch
  320. tags:
  321. - Location
  322. responses:
  323. '200':
  324. description: 'Location resource updated'
  325. content:
  326. application/ld+json:
  327. schema:
  328. $ref: '#/components/schemas/Location.jsonld'
  329. links: { }
  330. '400':
  331. description: 'Invalid input'
  332. '422':
  333. description: 'Unprocessable entity'
  334. '404':
  335. description: 'Resource not found'
  336. summary: 'Updates the Location resource.'
  337. description: 'Updates the Location resource.'
  338. parameters:
  339. -
  340. name: id
  341. in: path
  342. description: 'Location identifier'
  343. required: true
  344. deprecated: false
  345. allowEmptyValue: false
  346. schema:
  347. type: string
  348. style: simple
  349. explode: false
  350. allowReserved: false
  351. requestBody:
  352. description: 'The updated Location resource'
  353. content:
  354. application/merge-patch+json:
  355. schema:
  356. $ref: '#/components/schemas/Location'
  357. required: true
  358. deprecated: false
  359. /api/media_objects:
  360. get:
  361. operationId: api_media_objects_get_collection
  362. tags:
  363. - MediaObject
  364. responses:
  365. '200':
  366. description: 'MediaObject collection'
  367. content:
  368. application/ld+json:
  369. schema:
  370. type: object
  371. properties:
  372. member: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld' } }
  373. totalItems: { type: integer, minimum: 0 }
  374. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  375. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  376. required:
  377. - member
  378. summary: 'Retrieves the collection of MediaObject resources.'
  379. description: 'Retrieves the collection of MediaObject resources.'
  380. parameters:
  381. -
  382. name: page
  383. in: query
  384. description: 'The collection page number'
  385. required: false
  386. deprecated: false
  387. allowEmptyValue: true
  388. schema:
  389. type: integer
  390. default: 1
  391. style: form
  392. explode: false
  393. allowReserved: false
  394. -
  395. name: itemsPerPage
  396. in: query
  397. description: 'The number of items per page'
  398. required: false
  399. deprecated: false
  400. allowEmptyValue: true
  401. schema:
  402. type: integer
  403. default: 50
  404. minimum: 0
  405. maximum: 200
  406. style: form
  407. explode: false
  408. allowReserved: false
  409. deprecated: false
  410. post:
  411. operationId: api_media_objects_post
  412. tags:
  413. - MediaObject
  414. responses:
  415. '201':
  416. description: 'MediaObject resource created'
  417. content:
  418. application/ld+json:
  419. schema:
  420. $ref: '#/components/schemas/MediaObject.jsonld'
  421. links: { }
  422. '400':
  423. description: 'Invalid input'
  424. '422':
  425. description: 'Unprocessable entity'
  426. summary: 'Creates a MediaObject resource.'
  427. description: 'Creates a MediaObject resource.'
  428. parameters: []
  429. requestBody:
  430. description: 'The new MediaObject resource'
  431. content:
  432. multipart/form-data:
  433. schema:
  434. type: object
  435. properties:
  436. file:
  437. type: string
  438. format: binary
  439. required: false
  440. deprecated: false
  441. '/api/media_objects/{id}':
  442. get:
  443. operationId: api_media_objects_id_get
  444. tags:
  445. - MediaObject
  446. responses:
  447. '200':
  448. description: 'MediaObject resource'
  449. content:
  450. application/ld+json:
  451. schema:
  452. $ref: '#/components/schemas/MediaObject.jsonld'
  453. '404':
  454. description: 'Resource not found'
  455. summary: 'Retrieves a MediaObject resource.'
  456. description: 'Retrieves a MediaObject resource.'
  457. parameters:
  458. -
  459. name: id
  460. in: path
  461. description: 'MediaObject identifier'
  462. required: true
  463. deprecated: false
  464. allowEmptyValue: false
  465. schema:
  466. type: string
  467. style: simple
  468. explode: false
  469. allowReserved: false
  470. deprecated: false
  471. delete:
  472. operationId: api_media_objects_id_delete
  473. tags:
  474. - MediaObject
  475. responses:
  476. '204':
  477. description: 'MediaObject resource deleted'
  478. '404':
  479. description: 'Resource not found'
  480. summary: 'Removes the MediaObject resource.'
  481. description: 'Removes the MediaObject resource.'
  482. parameters:
  483. -
  484. name: id
  485. in: path
  486. description: 'MediaObject identifier'
  487. required: true
  488. deprecated: false
  489. allowEmptyValue: false
  490. schema:
  491. type: string
  492. style: simple
  493. explode: false
  494. allowReserved: false
  495. deprecated: false
  496. /api/shipping_companies:
  497. get:
  498. operationId: api_shipping_companies_get_collection
  499. tags:
  500. - ShippingCompany
  501. responses:
  502. '200':
  503. description: 'ShippingCompany collection'
  504. content:
  505. application/ld+json:
  506. schema:
  507. type: object
  508. properties:
  509. member: { type: array, items: { $ref: '#/components/schemas/ShippingCompany.jsonld' } }
  510. totalItems: { type: integer, minimum: 0 }
  511. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  512. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  513. required:
  514. - member
  515. summary: 'Retrieves the collection of ShippingCompany resources.'
  516. description: 'Retrieves the collection of ShippingCompany resources.'
  517. parameters:
  518. -
  519. name: page
  520. in: query
  521. description: 'The collection page number'
  522. required: false
  523. deprecated: false
  524. allowEmptyValue: true
  525. schema:
  526. type: integer
  527. default: 1
  528. style: form
  529. explode: false
  530. allowReserved: false
  531. -
  532. name: itemsPerPage
  533. in: query
  534. description: 'The number of items per page'
  535. required: false
  536. deprecated: false
  537. allowEmptyValue: true
  538. schema:
  539. type: integer
  540. default: 50
  541. minimum: 0
  542. maximum: 200
  543. style: form
  544. explode: false
  545. allowReserved: false
  546. -
  547. name: name
  548. in: query
  549. description: ''
  550. required: false
  551. deprecated: false
  552. allowEmptyValue: false
  553. schema:
  554. type: string
  555. style: form
  556. explode: false
  557. allowReserved: false
  558. -
  559. name: custom_json_filter
  560. in: query
  561. description: ''
  562. required: false
  563. deprecated: false
  564. allowEmptyValue: false
  565. schema:
  566. type: string
  567. style: form
  568. explode: false
  569. allowReserved: false
  570. -
  571. name: custom_json_order
  572. in: query
  573. description: ''
  574. required: false
  575. deprecated: false
  576. allowEmptyValue: false
  577. schema:
  578. type: string
  579. style: form
  580. explode: false
  581. allowReserved: false
  582. deprecated: false
  583. post:
  584. operationId: api_shipping_companies_post
  585. tags:
  586. - ShippingCompany
  587. responses:
  588. '201':
  589. description: 'ShippingCompany resource created'
  590. content:
  591. application/ld+json:
  592. schema:
  593. $ref: '#/components/schemas/ShippingCompany.jsonld'
  594. links: { }
  595. '400':
  596. description: 'Invalid input'
  597. '422':
  598. description: 'Unprocessable entity'
  599. summary: 'Creates a ShippingCompany resource.'
  600. description: 'Creates a ShippingCompany resource.'
  601. parameters: []
  602. requestBody:
  603. description: 'The new ShippingCompany resource'
  604. content:
  605. application/ld+json:
  606. schema:
  607. $ref: '#/components/schemas/ShippingCompany.jsonld'
  608. required: true
  609. deprecated: false
  610. '/api/shipping_companies/{id}':
  611. get:
  612. operationId: api_shipping_companies_id_get
  613. tags:
  614. - ShippingCompany
  615. responses:
  616. '200':
  617. description: 'ShippingCompany resource'
  618. content:
  619. application/ld+json:
  620. schema:
  621. $ref: '#/components/schemas/ShippingCompany.jsonld'
  622. '404':
  623. description: 'Resource not found'
  624. summary: 'Retrieves a ShippingCompany resource.'
  625. description: 'Retrieves a ShippingCompany resource.'
  626. parameters:
  627. -
  628. name: id
  629. in: path
  630. description: 'ShippingCompany identifier'
  631. required: true
  632. deprecated: false
  633. allowEmptyValue: false
  634. schema:
  635. type: string
  636. style: simple
  637. explode: false
  638. allowReserved: false
  639. deprecated: false
  640. delete:
  641. operationId: api_shipping_companies_id_delete
  642. tags:
  643. - ShippingCompany
  644. responses:
  645. '204':
  646. description: 'ShippingCompany resource deleted'
  647. '404':
  648. description: 'Resource not found'
  649. summary: 'Removes the ShippingCompany resource.'
  650. description: 'Removes the ShippingCompany resource.'
  651. parameters:
  652. -
  653. name: id
  654. in: path
  655. description: 'ShippingCompany identifier'
  656. required: true
  657. deprecated: false
  658. allowEmptyValue: false
  659. schema:
  660. type: string
  661. style: simple
  662. explode: false
  663. allowReserved: false
  664. deprecated: false
  665. patch:
  666. operationId: api_shipping_companies_id_patch
  667. tags:
  668. - ShippingCompany
  669. responses:
  670. '200':
  671. description: 'ShippingCompany resource updated'
  672. content:
  673. application/ld+json:
  674. schema:
  675. $ref: '#/components/schemas/ShippingCompany.jsonld'
  676. links: { }
  677. '400':
  678. description: 'Invalid input'
  679. '422':
  680. description: 'Unprocessable entity'
  681. '404':
  682. description: 'Resource not found'
  683. summary: 'Updates the ShippingCompany resource.'
  684. description: 'Updates the ShippingCompany resource.'
  685. parameters:
  686. -
  687. name: id
  688. in: path
  689. description: 'ShippingCompany identifier'
  690. required: true
  691. deprecated: false
  692. allowEmptyValue: false
  693. schema:
  694. type: string
  695. style: simple
  696. explode: false
  697. allowReserved: false
  698. requestBody:
  699. description: 'The updated ShippingCompany resource'
  700. content:
  701. application/merge-patch+json:
  702. schema:
  703. $ref: '#/components/schemas/ShippingCompany'
  704. required: true
  705. deprecated: false
  706. /api/trips:
  707. get:
  708. operationId: api_trips_get_collection
  709. tags:
  710. - Trip
  711. responses:
  712. '200':
  713. description: 'Trip collection'
  714. content:
  715. application/ld+json:
  716. schema:
  717. type: object
  718. properties:
  719. member: { type: array, items: { $ref: '#/components/schemas/Trip.jsonld' } }
  720. totalItems: { type: integer, minimum: 0 }
  721. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  722. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  723. required:
  724. - member
  725. summary: 'Retrieves the collection of Trip resources.'
  726. description: 'Retrieves the collection of Trip resources.'
  727. parameters:
  728. -
  729. name: page
  730. in: query
  731. description: 'The collection page number'
  732. required: false
  733. deprecated: false
  734. allowEmptyValue: true
  735. schema:
  736. type: integer
  737. default: 1
  738. style: form
  739. explode: false
  740. allowReserved: false
  741. -
  742. name: itemsPerPage
  743. in: query
  744. description: 'The number of items per page'
  745. required: false
  746. deprecated: false
  747. allowEmptyValue: true
  748. schema:
  749. type: integer
  750. default: 50
  751. minimum: 0
  752. maximum: 200
  753. style: form
  754. explode: false
  755. allowReserved: false
  756. -
  757. name: id
  758. in: query
  759. description: ''
  760. required: false
  761. deprecated: false
  762. allowEmptyValue: false
  763. schema:
  764. type: integer
  765. style: form
  766. explode: false
  767. allowReserved: false
  768. -
  769. name: custom_json_filter
  770. in: query
  771. description: ''
  772. required: false
  773. deprecated: false
  774. allowEmptyValue: false
  775. schema:
  776. type: string
  777. style: form
  778. explode: false
  779. allowReserved: false
  780. -
  781. name: custom_json_order
  782. in: query
  783. description: ''
  784. required: false
  785. deprecated: false
  786. allowEmptyValue: false
  787. schema:
  788. type: string
  789. style: form
  790. explode: false
  791. allowReserved: false
  792. deprecated: false
  793. post:
  794. operationId: api_trips_post
  795. tags:
  796. - Trip
  797. responses:
  798. '201':
  799. description: 'Trip resource created'
  800. content:
  801. application/ld+json:
  802. schema:
  803. $ref: '#/components/schemas/Trip.jsonld'
  804. links: { }
  805. '400':
  806. description: 'Invalid input'
  807. '422':
  808. description: 'Unprocessable entity'
  809. summary: 'Creates a Trip resource.'
  810. description: 'Creates a Trip resource.'
  811. parameters: []
  812. requestBody:
  813. description: 'The new Trip resource'
  814. content:
  815. application/ld+json:
  816. schema:
  817. $ref: '#/components/schemas/Trip.jsonld'
  818. required: true
  819. deprecated: false
  820. '/api/trips/{id}':
  821. get:
  822. operationId: api_trips_id_get
  823. tags:
  824. - Trip
  825. responses:
  826. '200':
  827. description: 'Trip resource'
  828. content:
  829. application/ld+json:
  830. schema:
  831. $ref: '#/components/schemas/Trip.jsonld'
  832. '404':
  833. description: 'Resource not found'
  834. summary: 'Retrieves a Trip resource.'
  835. description: 'Retrieves a Trip resource.'
  836. parameters:
  837. -
  838. name: id
  839. in: path
  840. description: 'Trip identifier'
  841. required: true
  842. deprecated: false
  843. allowEmptyValue: false
  844. schema:
  845. type: string
  846. style: simple
  847. explode: false
  848. allowReserved: false
  849. deprecated: false
  850. delete:
  851. operationId: api_trips_id_delete
  852. tags:
  853. - Trip
  854. responses:
  855. '204':
  856. description: 'Trip resource deleted'
  857. '404':
  858. description: 'Resource not found'
  859. summary: 'Removes the Trip resource.'
  860. description: 'Removes the Trip resource.'
  861. parameters:
  862. -
  863. name: id
  864. in: path
  865. description: 'Trip identifier'
  866. required: true
  867. deprecated: false
  868. allowEmptyValue: false
  869. schema:
  870. type: string
  871. style: simple
  872. explode: false
  873. allowReserved: false
  874. deprecated: false
  875. patch:
  876. operationId: api_trips_id_patch
  877. tags:
  878. - Trip
  879. responses:
  880. '200':
  881. description: 'Trip resource updated'
  882. content:
  883. application/ld+json:
  884. schema:
  885. $ref: '#/components/schemas/Trip.jsonld'
  886. links: { }
  887. '400':
  888. description: 'Invalid input'
  889. '422':
  890. description: 'Unprocessable entity'
  891. '404':
  892. description: 'Resource not found'
  893. summary: 'Updates the Trip resource.'
  894. description: 'Updates the Trip resource.'
  895. parameters:
  896. -
  897. name: id
  898. in: path
  899. description: 'Trip identifier'
  900. required: true
  901. deprecated: false
  902. allowEmptyValue: false
  903. schema:
  904. type: string
  905. style: simple
  906. explode: false
  907. allowReserved: false
  908. requestBody:
  909. description: 'The updated Trip resource'
  910. content:
  911. application/merge-patch+json:
  912. schema:
  913. $ref: '#/components/schemas/Trip'
  914. required: true
  915. deprecated: false
  916. /api/trip_locations:
  917. get:
  918. operationId: api_trip_locations_get_collection
  919. tags:
  920. - TripLocation
  921. responses:
  922. '200':
  923. description: 'TripLocation collection'
  924. content:
  925. application/ld+json:
  926. schema:
  927. type: object
  928. properties:
  929. member: { type: array, items: { $ref: '#/components/schemas/TripLocation.jsonld' } }
  930. totalItems: { type: integer, minimum: 0 }
  931. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  932. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  933. required:
  934. - member
  935. summary: 'Retrieves the collection of TripLocation resources.'
  936. description: 'Retrieves the collection of TripLocation resources.'
  937. parameters:
  938. -
  939. name: page
  940. in: query
  941. description: 'The collection page number'
  942. required: false
  943. deprecated: false
  944. allowEmptyValue: true
  945. schema:
  946. type: integer
  947. default: 1
  948. style: form
  949. explode: false
  950. allowReserved: false
  951. -
  952. name: itemsPerPage
  953. in: query
  954. description: 'The number of items per page'
  955. required: false
  956. deprecated: false
  957. allowEmptyValue: true
  958. schema:
  959. type: integer
  960. default: 50
  961. minimum: 0
  962. maximum: 200
  963. style: form
  964. explode: false
  965. allowReserved: false
  966. -
  967. name: trip
  968. in: query
  969. description: ''
  970. required: false
  971. deprecated: false
  972. allowEmptyValue: false
  973. schema:
  974. type: string
  975. style: form
  976. explode: false
  977. allowReserved: false
  978. -
  979. name: 'trip[]'
  980. in: query
  981. description: ''
  982. required: false
  983. deprecated: false
  984. allowEmptyValue: false
  985. schema:
  986. type: array
  987. items:
  988. type: string
  989. style: form
  990. explode: true
  991. allowReserved: false
  992. -
  993. name: custom_json_filter
  994. in: query
  995. description: ''
  996. required: false
  997. deprecated: false
  998. allowEmptyValue: false
  999. schema:
  1000. type: string
  1001. style: form
  1002. explode: false
  1003. allowReserved: false
  1004. -
  1005. name: custom_json_order
  1006. in: query
  1007. description: ''
  1008. required: false
  1009. deprecated: false
  1010. allowEmptyValue: false
  1011. schema:
  1012. type: string
  1013. style: form
  1014. explode: false
  1015. allowReserved: false
  1016. deprecated: false
  1017. post:
  1018. operationId: api_trip_locations_post
  1019. tags:
  1020. - TripLocation
  1021. responses:
  1022. '201':
  1023. description: 'TripLocation resource created'
  1024. content:
  1025. application/ld+json:
  1026. schema:
  1027. $ref: '#/components/schemas/TripLocation.jsonld'
  1028. links: { }
  1029. '400':
  1030. description: 'Invalid input'
  1031. '422':
  1032. description: 'Unprocessable entity'
  1033. summary: 'Creates a TripLocation resource.'
  1034. description: 'Creates a TripLocation resource.'
  1035. parameters: []
  1036. requestBody:
  1037. description: 'The new TripLocation resource'
  1038. content:
  1039. application/ld+json:
  1040. schema:
  1041. $ref: '#/components/schemas/TripLocation.jsonld'
  1042. required: true
  1043. deprecated: false
  1044. '/api/trip_locations/{id}':
  1045. get:
  1046. operationId: api_trip_locations_id_get
  1047. tags:
  1048. - TripLocation
  1049. responses:
  1050. '200':
  1051. description: 'TripLocation resource'
  1052. content:
  1053. application/ld+json:
  1054. schema:
  1055. $ref: '#/components/schemas/TripLocation.jsonld'
  1056. '404':
  1057. description: 'Resource not found'
  1058. summary: 'Retrieves a TripLocation resource.'
  1059. description: 'Retrieves a TripLocation resource.'
  1060. parameters:
  1061. -
  1062. name: id
  1063. in: path
  1064. description: 'TripLocation identifier'
  1065. required: true
  1066. deprecated: false
  1067. allowEmptyValue: false
  1068. schema:
  1069. type: string
  1070. style: simple
  1071. explode: false
  1072. allowReserved: false
  1073. deprecated: false
  1074. delete:
  1075. operationId: api_trip_locations_id_delete
  1076. tags:
  1077. - TripLocation
  1078. responses:
  1079. '204':
  1080. description: 'TripLocation resource deleted'
  1081. '404':
  1082. description: 'Resource not found'
  1083. summary: 'Removes the TripLocation resource.'
  1084. description: 'Removes the TripLocation resource.'
  1085. parameters:
  1086. -
  1087. name: id
  1088. in: path
  1089. description: 'TripLocation identifier'
  1090. required: true
  1091. deprecated: false
  1092. allowEmptyValue: false
  1093. schema:
  1094. type: string
  1095. style: simple
  1096. explode: false
  1097. allowReserved: false
  1098. deprecated: false
  1099. patch:
  1100. operationId: api_trip_locations_id_patch
  1101. tags:
  1102. - TripLocation
  1103. responses:
  1104. '200':
  1105. description: 'TripLocation resource updated'
  1106. content:
  1107. application/ld+json:
  1108. schema:
  1109. $ref: '#/components/schemas/TripLocation.jsonld'
  1110. links: { }
  1111. '400':
  1112. description: 'Invalid input'
  1113. '422':
  1114. description: 'Unprocessable entity'
  1115. '404':
  1116. description: 'Resource not found'
  1117. summary: 'Updates the TripLocation resource.'
  1118. description: 'Updates the TripLocation resource.'
  1119. parameters:
  1120. -
  1121. name: id
  1122. in: path
  1123. description: 'TripLocation identifier'
  1124. required: true
  1125. deprecated: false
  1126. allowEmptyValue: false
  1127. schema:
  1128. type: string
  1129. style: simple
  1130. explode: false
  1131. allowReserved: false
  1132. requestBody:
  1133. description: 'The updated TripLocation resource'
  1134. content:
  1135. application/merge-patch+json:
  1136. schema:
  1137. $ref: '#/components/schemas/TripLocation'
  1138. required: true
  1139. deprecated: false
  1140. /api/users:
  1141. get:
  1142. operationId: api_users_get_collection
  1143. tags:
  1144. - User
  1145. responses:
  1146. '200':
  1147. description: 'User collection'
  1148. content:
  1149. application/ld+json:
  1150. schema:
  1151. type: object
  1152. properties:
  1153. member: { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1154. totalItems: { type: integer, minimum: 0 }
  1155. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  1156. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1157. required:
  1158. - member
  1159. summary: 'Retrieves the collection of User resources.'
  1160. description: 'Retrieves the collection of User resources.'
  1161. parameters:
  1162. -
  1163. name: page
  1164. in: query
  1165. description: 'The collection page number'
  1166. required: false
  1167. deprecated: false
  1168. allowEmptyValue: true
  1169. schema:
  1170. type: integer
  1171. default: 1
  1172. style: form
  1173. explode: false
  1174. allowReserved: false
  1175. -
  1176. name: itemsPerPage
  1177. in: query
  1178. description: 'The number of items per page'
  1179. required: false
  1180. deprecated: false
  1181. allowEmptyValue: true
  1182. schema:
  1183. type: integer
  1184. default: 50
  1185. minimum: 0
  1186. maximum: 200
  1187. style: form
  1188. explode: false
  1189. allowReserved: false
  1190. -
  1191. name: firstName
  1192. in: query
  1193. description: ''
  1194. required: false
  1195. deprecated: false
  1196. allowEmptyValue: false
  1197. schema:
  1198. type: string
  1199. style: form
  1200. explode: false
  1201. allowReserved: false
  1202. -
  1203. name: lastName
  1204. in: query
  1205. description: ''
  1206. required: false
  1207. deprecated: false
  1208. allowEmptyValue: false
  1209. schema:
  1210. type: string
  1211. style: form
  1212. explode: false
  1213. allowReserved: false
  1214. -
  1215. name: userNameSearch
  1216. in: query
  1217. description: ''
  1218. required: false
  1219. deprecated: false
  1220. allowEmptyValue: false
  1221. schema:
  1222. type: string
  1223. style: form
  1224. explode: false
  1225. allowReserved: false
  1226. -
  1227. name: custom_json_order
  1228. in: query
  1229. description: ''
  1230. required: false
  1231. deprecated: false
  1232. allowEmptyValue: false
  1233. schema:
  1234. type: string
  1235. style: form
  1236. explode: false
  1237. allowReserved: false
  1238. deprecated: false
  1239. post:
  1240. operationId: api_users_post
  1241. tags:
  1242. - User
  1243. responses:
  1244. '201':
  1245. description: 'User resource created'
  1246. content:
  1247. application/ld+json:
  1248. schema:
  1249. $ref: '#/components/schemas/User.jsonld'
  1250. links: { }
  1251. '400':
  1252. description: 'Invalid input'
  1253. '422':
  1254. description: 'Unprocessable entity'
  1255. summary: 'Creates a User resource.'
  1256. description: 'Creates a User resource.'
  1257. parameters: []
  1258. requestBody:
  1259. description: 'The new User resource'
  1260. content:
  1261. application/ld+json:
  1262. schema:
  1263. $ref: '#/components/schemas/User.jsonld'
  1264. required: true
  1265. deprecated: false
  1266. '/api/users/{id}':
  1267. get:
  1268. operationId: api_users_id_get
  1269. tags:
  1270. - User
  1271. responses:
  1272. '200':
  1273. description: 'User resource'
  1274. content:
  1275. application/ld+json:
  1276. schema:
  1277. $ref: '#/components/schemas/User.jsonld'
  1278. '404':
  1279. description: 'Resource not found'
  1280. summary: 'Retrieves a User resource.'
  1281. description: 'Retrieves a User resource.'
  1282. parameters:
  1283. -
  1284. name: id
  1285. in: path
  1286. description: 'User identifier'
  1287. required: true
  1288. deprecated: false
  1289. allowEmptyValue: false
  1290. schema:
  1291. type: string
  1292. style: simple
  1293. explode: false
  1294. allowReserved: false
  1295. deprecated: false
  1296. delete:
  1297. operationId: api_users_id_delete
  1298. tags:
  1299. - User
  1300. responses:
  1301. '204':
  1302. description: 'User resource deleted'
  1303. '404':
  1304. description: 'Resource not found'
  1305. summary: 'Removes the User resource.'
  1306. description: 'Removes the User resource.'
  1307. parameters:
  1308. -
  1309. name: id
  1310. in: path
  1311. description: 'User identifier'
  1312. required: true
  1313. deprecated: false
  1314. allowEmptyValue: false
  1315. schema:
  1316. type: string
  1317. style: simple
  1318. explode: false
  1319. allowReserved: false
  1320. deprecated: false
  1321. patch:
  1322. operationId: api_users_id_patch
  1323. tags:
  1324. - User
  1325. responses:
  1326. '200':
  1327. description: 'User resource updated'
  1328. content:
  1329. application/ld+json:
  1330. schema:
  1331. $ref: '#/components/schemas/User.jsonld'
  1332. links: { }
  1333. '400':
  1334. description: 'Invalid input'
  1335. '422':
  1336. description: 'Unprocessable entity'
  1337. '404':
  1338. description: 'Resource not found'
  1339. summary: 'Updates the User resource.'
  1340. description: 'Updates the User resource.'
  1341. parameters:
  1342. -
  1343. name: id
  1344. in: path
  1345. description: 'User identifier'
  1346. required: true
  1347. deprecated: false
  1348. allowEmptyValue: false
  1349. schema:
  1350. type: string
  1351. style: simple
  1352. explode: false
  1353. allowReserved: false
  1354. requestBody:
  1355. description: 'The updated User resource'
  1356. content:
  1357. application/merge-patch+json:
  1358. schema:
  1359. $ref: '#/components/schemas/User'
  1360. required: true
  1361. deprecated: false
  1362. /api/user_trips:
  1363. get:
  1364. operationId: api_user_trips_get_collection
  1365. tags:
  1366. - UserTrip
  1367. responses:
  1368. '200':
  1369. description: 'UserTrip collection'
  1370. content:
  1371. application/ld+json:
  1372. schema:
  1373. type: object
  1374. properties:
  1375. member: { type: array, items: { $ref: '#/components/schemas/UserTrip.jsonld' } }
  1376. totalItems: { type: integer, minimum: 0 }
  1377. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  1378. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1379. required:
  1380. - member
  1381. summary: 'Retrieves the collection of UserTrip resources.'
  1382. description: 'Retrieves the collection of UserTrip resources.'
  1383. parameters:
  1384. -
  1385. name: page
  1386. in: query
  1387. description: 'The collection page number'
  1388. required: false
  1389. deprecated: false
  1390. allowEmptyValue: true
  1391. schema:
  1392. type: integer
  1393. default: 1
  1394. style: form
  1395. explode: false
  1396. allowReserved: false
  1397. -
  1398. name: itemsPerPage
  1399. in: query
  1400. description: 'The number of items per page'
  1401. required: false
  1402. deprecated: false
  1403. allowEmptyValue: true
  1404. schema:
  1405. type: integer
  1406. default: 50
  1407. minimum: 0
  1408. maximum: 200
  1409. style: form
  1410. explode: false
  1411. allowReserved: false
  1412. -
  1413. name: trip
  1414. in: query
  1415. description: ''
  1416. required: false
  1417. deprecated: false
  1418. allowEmptyValue: false
  1419. schema:
  1420. type: string
  1421. style: form
  1422. explode: false
  1423. allowReserved: false
  1424. -
  1425. name: 'trip[]'
  1426. in: query
  1427. description: ''
  1428. required: false
  1429. deprecated: false
  1430. allowEmptyValue: false
  1431. schema:
  1432. type: array
  1433. items:
  1434. type: string
  1435. style: form
  1436. explode: true
  1437. allowReserved: false
  1438. -
  1439. name: user
  1440. in: query
  1441. description: ''
  1442. required: false
  1443. deprecated: false
  1444. allowEmptyValue: false
  1445. schema:
  1446. type: string
  1447. style: form
  1448. explode: false
  1449. allowReserved: false
  1450. -
  1451. name: 'user[]'
  1452. in: query
  1453. description: ''
  1454. required: false
  1455. deprecated: false
  1456. allowEmptyValue: false
  1457. schema:
  1458. type: array
  1459. items:
  1460. type: string
  1461. style: form
  1462. explode: true
  1463. allowReserved: false
  1464. -
  1465. name: custom_json_filter
  1466. in: query
  1467. description: ''
  1468. required: false
  1469. deprecated: false
  1470. allowEmptyValue: false
  1471. schema:
  1472. type: string
  1473. style: form
  1474. explode: false
  1475. allowReserved: false
  1476. -
  1477. name: custom_json_order
  1478. in: query
  1479. description: ''
  1480. required: false
  1481. deprecated: false
  1482. allowEmptyValue: false
  1483. schema:
  1484. type: string
  1485. style: form
  1486. explode: false
  1487. allowReserved: false
  1488. deprecated: false
  1489. post:
  1490. operationId: api_user_trips_post
  1491. tags:
  1492. - UserTrip
  1493. responses:
  1494. '201':
  1495. description: 'UserTrip resource created'
  1496. content:
  1497. application/ld+json:
  1498. schema:
  1499. $ref: '#/components/schemas/UserTrip.jsonld'
  1500. links: { }
  1501. '400':
  1502. description: 'Invalid input'
  1503. '422':
  1504. description: 'Unprocessable entity'
  1505. summary: 'Creates a UserTrip resource.'
  1506. description: 'Creates a UserTrip resource.'
  1507. parameters: []
  1508. requestBody:
  1509. description: 'The new UserTrip resource'
  1510. content:
  1511. application/ld+json:
  1512. schema:
  1513. $ref: '#/components/schemas/UserTrip.jsonld'
  1514. required: true
  1515. deprecated: false
  1516. '/api/user_trips/{id}':
  1517. get:
  1518. operationId: api_user_trips_id_get
  1519. tags:
  1520. - UserTrip
  1521. responses:
  1522. '200':
  1523. description: 'UserTrip resource'
  1524. content:
  1525. application/ld+json:
  1526. schema:
  1527. $ref: '#/components/schemas/UserTrip.jsonld'
  1528. '404':
  1529. description: 'Resource not found'
  1530. summary: 'Retrieves a UserTrip resource.'
  1531. description: 'Retrieves a UserTrip resource.'
  1532. parameters:
  1533. -
  1534. name: id
  1535. in: path
  1536. description: 'UserTrip identifier'
  1537. required: true
  1538. deprecated: false
  1539. allowEmptyValue: false
  1540. schema:
  1541. type: string
  1542. style: simple
  1543. explode: false
  1544. allowReserved: false
  1545. deprecated: false
  1546. delete:
  1547. operationId: api_user_trips_id_delete
  1548. tags:
  1549. - UserTrip
  1550. responses:
  1551. '204':
  1552. description: 'UserTrip resource deleted'
  1553. '404':
  1554. description: 'Resource not found'
  1555. summary: 'Removes the UserTrip resource.'
  1556. description: 'Removes the UserTrip resource.'
  1557. parameters:
  1558. -
  1559. name: id
  1560. in: path
  1561. description: 'UserTrip identifier'
  1562. required: true
  1563. deprecated: false
  1564. allowEmptyValue: false
  1565. schema:
  1566. type: string
  1567. style: simple
  1568. explode: false
  1569. allowReserved: false
  1570. deprecated: false
  1571. patch:
  1572. operationId: api_user_trips_id_patch
  1573. tags:
  1574. - UserTrip
  1575. responses:
  1576. '200':
  1577. description: 'UserTrip resource updated'
  1578. content:
  1579. application/ld+json:
  1580. schema:
  1581. $ref: '#/components/schemas/UserTrip.jsonld'
  1582. links: { }
  1583. '400':
  1584. description: 'Invalid input'
  1585. '422':
  1586. description: 'Unprocessable entity'
  1587. '404':
  1588. description: 'Resource not found'
  1589. summary: 'Updates the UserTrip resource.'
  1590. description: 'Updates the UserTrip resource.'
  1591. parameters:
  1592. -
  1593. name: id
  1594. in: path
  1595. description: 'UserTrip identifier'
  1596. required: true
  1597. deprecated: false
  1598. allowEmptyValue: false
  1599. schema:
  1600. type: string
  1601. style: simple
  1602. explode: false
  1603. allowReserved: false
  1604. requestBody:
  1605. description: 'The updated UserTrip resource'
  1606. content:
  1607. application/merge-patch+json:
  1608. schema:
  1609. $ref: '#/components/schemas/UserTrip'
  1610. required: true
  1611. deprecated: false
  1612. /api/user_trip_events:
  1613. get:
  1614. operationId: api_user_trip_events_get_collection
  1615. tags:
  1616. - UserTripEvent
  1617. responses:
  1618. '200':
  1619. description: 'UserTripEvent collection'
  1620. content:
  1621. application/ld+json:
  1622. schema:
  1623. type: object
  1624. properties:
  1625. member: { type: array, items: { $ref: '#/components/schemas/UserTripEvent.jsonld' } }
  1626. totalItems: { type: integer, minimum: 0 }
  1627. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  1628. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1629. required:
  1630. - member
  1631. summary: 'Retrieves the collection of UserTripEvent resources.'
  1632. description: 'Retrieves the collection of UserTripEvent resources.'
  1633. parameters:
  1634. -
  1635. name: page
  1636. in: query
  1637. description: 'The collection page number'
  1638. required: false
  1639. deprecated: false
  1640. allowEmptyValue: true
  1641. schema:
  1642. type: integer
  1643. default: 1
  1644. style: form
  1645. explode: false
  1646. allowReserved: false
  1647. -
  1648. name: itemsPerPage
  1649. in: query
  1650. description: 'The number of items per page'
  1651. required: false
  1652. deprecated: false
  1653. allowEmptyValue: true
  1654. schema:
  1655. type: integer
  1656. default: 50
  1657. minimum: 0
  1658. maximum: 200
  1659. style: form
  1660. explode: false
  1661. allowReserved: false
  1662. deprecated: false
  1663. post:
  1664. operationId: api_user_trip_events_post
  1665. tags:
  1666. - UserTripEvent
  1667. responses:
  1668. '201':
  1669. description: 'UserTripEvent resource created'
  1670. content:
  1671. application/ld+json:
  1672. schema:
  1673. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1674. links: { }
  1675. '400':
  1676. description: 'Invalid input'
  1677. '422':
  1678. description: 'Unprocessable entity'
  1679. summary: 'Creates a UserTripEvent resource.'
  1680. description: 'Creates a UserTripEvent resource.'
  1681. parameters: []
  1682. requestBody:
  1683. description: 'The new UserTripEvent resource'
  1684. content:
  1685. application/ld+json:
  1686. schema:
  1687. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1688. required: true
  1689. deprecated: false
  1690. '/api/user_trip_events/{id}':
  1691. get:
  1692. operationId: api_user_trip_events_id_get
  1693. tags:
  1694. - UserTripEvent
  1695. responses:
  1696. '200':
  1697. description: 'UserTripEvent resource'
  1698. content:
  1699. application/ld+json:
  1700. schema:
  1701. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1702. '404':
  1703. description: 'Resource not found'
  1704. summary: 'Retrieves a UserTripEvent resource.'
  1705. description: 'Retrieves a UserTripEvent resource.'
  1706. parameters:
  1707. -
  1708. name: id
  1709. in: path
  1710. description: 'UserTripEvent identifier'
  1711. required: true
  1712. deprecated: false
  1713. allowEmptyValue: false
  1714. schema:
  1715. type: string
  1716. style: simple
  1717. explode: false
  1718. allowReserved: false
  1719. deprecated: false
  1720. patch:
  1721. operationId: api_user_trip_events_id_patch
  1722. tags:
  1723. - UserTripEvent
  1724. responses:
  1725. '200':
  1726. description: 'UserTripEvent resource updated'
  1727. content:
  1728. application/ld+json:
  1729. schema:
  1730. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1731. links: { }
  1732. '400':
  1733. description: 'Invalid input'
  1734. '422':
  1735. description: 'Unprocessable entity'
  1736. '404':
  1737. description: 'Resource not found'
  1738. summary: 'Updates the UserTripEvent resource.'
  1739. description: 'Updates the UserTripEvent resource.'
  1740. parameters:
  1741. -
  1742. name: id
  1743. in: path
  1744. description: 'UserTripEvent identifier'
  1745. required: true
  1746. deprecated: false
  1747. allowEmptyValue: false
  1748. schema:
  1749. type: string
  1750. style: simple
  1751. explode: false
  1752. allowReserved: false
  1753. requestBody:
  1754. description: 'The updated UserTripEvent resource'
  1755. content:
  1756. application/merge-patch+json:
  1757. schema:
  1758. $ref: '#/components/schemas/UserTripEvent'
  1759. required: true
  1760. deprecated: false
  1761. /api/vessels:
  1762. get:
  1763. operationId: api_vessels_get_collection
  1764. tags:
  1765. - Vessel
  1766. responses:
  1767. '200':
  1768. description: 'Vessel collection'
  1769. content:
  1770. application/ld+json:
  1771. schema:
  1772. type: object
  1773. properties:
  1774. member: { type: array, items: { $ref: '#/components/schemas/Vessel.jsonld' } }
  1775. totalItems: { type: integer, minimum: 0 }
  1776. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  1777. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1778. required:
  1779. - member
  1780. summary: 'Retrieves the collection of Vessel resources.'
  1781. description: 'Retrieves the collection of Vessel resources.'
  1782. parameters:
  1783. -
  1784. name: page
  1785. in: query
  1786. description: 'The collection page number'
  1787. required: false
  1788. deprecated: false
  1789. allowEmptyValue: true
  1790. schema:
  1791. type: integer
  1792. default: 1
  1793. style: form
  1794. explode: false
  1795. allowReserved: false
  1796. -
  1797. name: itemsPerPage
  1798. in: query
  1799. description: 'The number of items per page'
  1800. required: false
  1801. deprecated: false
  1802. allowEmptyValue: true
  1803. schema:
  1804. type: integer
  1805. default: 50
  1806. minimum: 0
  1807. maximum: 200
  1808. style: form
  1809. explode: false
  1810. allowReserved: false
  1811. -
  1812. name: name
  1813. in: query
  1814. description: ''
  1815. required: false
  1816. deprecated: false
  1817. allowEmptyValue: false
  1818. schema:
  1819. type: string
  1820. style: form
  1821. explode: false
  1822. allowReserved: false
  1823. -
  1824. name: custom_json_filter
  1825. in: query
  1826. description: ''
  1827. required: false
  1828. deprecated: false
  1829. allowEmptyValue: false
  1830. schema:
  1831. type: string
  1832. style: form
  1833. explode: false
  1834. allowReserved: false
  1835. -
  1836. name: custom_json_order
  1837. in: query
  1838. description: ''
  1839. required: false
  1840. deprecated: false
  1841. allowEmptyValue: false
  1842. schema:
  1843. type: string
  1844. style: form
  1845. explode: false
  1846. allowReserved: false
  1847. deprecated: false
  1848. post:
  1849. operationId: api_vessels_post
  1850. tags:
  1851. - Vessel
  1852. responses:
  1853. '201':
  1854. description: 'Vessel resource created'
  1855. content:
  1856. application/ld+json:
  1857. schema:
  1858. $ref: '#/components/schemas/Vessel.jsonld'
  1859. links: { }
  1860. '400':
  1861. description: 'Invalid input'
  1862. '422':
  1863. description: 'Unprocessable entity'
  1864. summary: 'Creates a Vessel resource.'
  1865. description: 'Creates a Vessel resource.'
  1866. parameters: []
  1867. requestBody:
  1868. description: 'The new Vessel resource'
  1869. content:
  1870. application/ld+json:
  1871. schema:
  1872. $ref: '#/components/schemas/Vessel.jsonld'
  1873. required: true
  1874. deprecated: false
  1875. '/api/vessels/{id}':
  1876. get:
  1877. operationId: api_vessels_id_get
  1878. tags:
  1879. - Vessel
  1880. responses:
  1881. '200':
  1882. description: 'Vessel resource'
  1883. content:
  1884. application/ld+json:
  1885. schema:
  1886. $ref: '#/components/schemas/Vessel.jsonld'
  1887. '404':
  1888. description: 'Resource not found'
  1889. summary: 'Retrieves a Vessel resource.'
  1890. description: 'Retrieves a Vessel resource.'
  1891. parameters:
  1892. -
  1893. name: id
  1894. in: path
  1895. description: 'Vessel identifier'
  1896. required: true
  1897. deprecated: false
  1898. allowEmptyValue: false
  1899. schema:
  1900. type: string
  1901. style: simple
  1902. explode: false
  1903. allowReserved: false
  1904. deprecated: false
  1905. delete:
  1906. operationId: api_vessels_id_delete
  1907. tags:
  1908. - Vessel
  1909. responses:
  1910. '204':
  1911. description: 'Vessel resource deleted'
  1912. '404':
  1913. description: 'Resource not found'
  1914. summary: 'Removes the Vessel resource.'
  1915. description: 'Removes the Vessel resource.'
  1916. parameters:
  1917. -
  1918. name: id
  1919. in: path
  1920. description: 'Vessel identifier'
  1921. required: true
  1922. deprecated: false
  1923. allowEmptyValue: false
  1924. schema:
  1925. type: string
  1926. style: simple
  1927. explode: false
  1928. allowReserved: false
  1929. deprecated: false
  1930. patch:
  1931. operationId: api_vessels_id_patch
  1932. tags:
  1933. - Vessel
  1934. responses:
  1935. '200':
  1936. description: 'Vessel resource updated'
  1937. content:
  1938. application/ld+json:
  1939. schema:
  1940. $ref: '#/components/schemas/Vessel.jsonld'
  1941. links: { }
  1942. '400':
  1943. description: 'Invalid input'
  1944. '422':
  1945. description: 'Unprocessable entity'
  1946. '404':
  1947. description: 'Resource not found'
  1948. summary: 'Updates the Vessel resource.'
  1949. description: 'Updates the Vessel resource.'
  1950. parameters:
  1951. -
  1952. name: id
  1953. in: path
  1954. description: 'Vessel identifier'
  1955. required: true
  1956. deprecated: false
  1957. allowEmptyValue: false
  1958. schema:
  1959. type: string
  1960. style: simple
  1961. explode: false
  1962. allowReserved: false
  1963. requestBody:
  1964. description: 'The updated Vessel resource'
  1965. content:
  1966. application/merge-patch+json:
  1967. schema:
  1968. $ref: '#/components/schemas/Vessel'
  1969. required: true
  1970. deprecated: false
  1971. /api/zones:
  1972. get:
  1973. operationId: api_zones_get_collection
  1974. tags:
  1975. - Zone
  1976. responses:
  1977. '200':
  1978. description: 'Zone collection'
  1979. content:
  1980. application/ld+json:
  1981. schema:
  1982. type: object
  1983. properties:
  1984. member: { type: array, items: { $ref: '#/components/schemas/Zone.jsonld' } }
  1985. totalItems: { type: integer, minimum: 0 }
  1986. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  1987. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1988. required:
  1989. - member
  1990. summary: 'Retrieves the collection of Zone resources.'
  1991. description: 'Retrieves the collection of Zone resources.'
  1992. parameters:
  1993. -
  1994. name: page
  1995. in: query
  1996. description: 'The collection page number'
  1997. required: false
  1998. deprecated: false
  1999. allowEmptyValue: true
  2000. schema:
  2001. type: integer
  2002. default: 1
  2003. style: form
  2004. explode: false
  2005. allowReserved: false
  2006. -
  2007. name: itemsPerPage
  2008. in: query
  2009. description: 'The number of items per page'
  2010. required: false
  2011. deprecated: false
  2012. allowEmptyValue: true
  2013. schema:
  2014. type: integer
  2015. default: 50
  2016. minimum: 0
  2017. maximum: 200
  2018. style: form
  2019. explode: false
  2020. allowReserved: false
  2021. -
  2022. name: name
  2023. in: query
  2024. description: ''
  2025. required: false
  2026. deprecated: false
  2027. allowEmptyValue: false
  2028. schema:
  2029. type: string
  2030. style: form
  2031. explode: false
  2032. allowReserved: false
  2033. -
  2034. name: custom_json_filter
  2035. in: query
  2036. description: ''
  2037. required: false
  2038. deprecated: false
  2039. allowEmptyValue: false
  2040. schema:
  2041. type: string
  2042. style: form
  2043. explode: false
  2044. allowReserved: false
  2045. -
  2046. name: custom_json_order
  2047. in: query
  2048. description: ''
  2049. required: false
  2050. deprecated: false
  2051. allowEmptyValue: false
  2052. schema:
  2053. type: string
  2054. style: form
  2055. explode: false
  2056. allowReserved: false
  2057. deprecated: false
  2058. post:
  2059. operationId: api_zones_post
  2060. tags:
  2061. - Zone
  2062. responses:
  2063. '201':
  2064. description: 'Zone resource created'
  2065. content:
  2066. application/ld+json:
  2067. schema:
  2068. $ref: '#/components/schemas/Zone.jsonld'
  2069. links: { }
  2070. '400':
  2071. description: 'Invalid input'
  2072. '422':
  2073. description: 'Unprocessable entity'
  2074. summary: 'Creates a Zone resource.'
  2075. description: 'Creates a Zone resource.'
  2076. parameters: []
  2077. requestBody:
  2078. description: 'The new Zone resource'
  2079. content:
  2080. application/ld+json:
  2081. schema:
  2082. $ref: '#/components/schemas/Zone.jsonld'
  2083. required: true
  2084. deprecated: false
  2085. '/api/zones/{id}':
  2086. get:
  2087. operationId: api_zones_id_get
  2088. tags:
  2089. - Zone
  2090. responses:
  2091. '200':
  2092. description: 'Zone resource'
  2093. content:
  2094. application/ld+json:
  2095. schema:
  2096. $ref: '#/components/schemas/Zone.jsonld'
  2097. '404':
  2098. description: 'Resource not found'
  2099. summary: 'Retrieves a Zone resource.'
  2100. description: 'Retrieves a Zone resource.'
  2101. parameters:
  2102. -
  2103. name: id
  2104. in: path
  2105. description: 'Zone identifier'
  2106. required: true
  2107. deprecated: false
  2108. allowEmptyValue: false
  2109. schema:
  2110. type: string
  2111. style: simple
  2112. explode: false
  2113. allowReserved: false
  2114. deprecated: false
  2115. delete:
  2116. operationId: api_zones_id_delete
  2117. tags:
  2118. - Zone
  2119. responses:
  2120. '204':
  2121. description: 'Zone resource deleted'
  2122. '404':
  2123. description: 'Resource not found'
  2124. summary: 'Removes the Zone resource.'
  2125. description: 'Removes the Zone resource.'
  2126. parameters:
  2127. -
  2128. name: id
  2129. in: path
  2130. description: 'Zone identifier'
  2131. required: true
  2132. deprecated: false
  2133. allowEmptyValue: false
  2134. schema:
  2135. type: string
  2136. style: simple
  2137. explode: false
  2138. allowReserved: false
  2139. deprecated: false
  2140. patch:
  2141. operationId: api_zones_id_patch
  2142. tags:
  2143. - Zone
  2144. responses:
  2145. '200':
  2146. description: 'Zone resource updated'
  2147. content:
  2148. application/ld+json:
  2149. schema:
  2150. $ref: '#/components/schemas/Zone.jsonld'
  2151. links: { }
  2152. '400':
  2153. description: 'Invalid input'
  2154. '422':
  2155. description: 'Unprocessable entity'
  2156. '404':
  2157. description: 'Resource not found'
  2158. summary: 'Updates the Zone resource.'
  2159. description: 'Updates the Zone resource.'
  2160. parameters:
  2161. -
  2162. name: id
  2163. in: path
  2164. description: 'Zone identifier'
  2165. required: true
  2166. deprecated: false
  2167. allowEmptyValue: false
  2168. schema:
  2169. type: string
  2170. style: simple
  2171. explode: false
  2172. allowReserved: false
  2173. requestBody:
  2174. description: 'The updated Zone resource'
  2175. content:
  2176. application/merge-patch+json:
  2177. schema:
  2178. $ref: '#/components/schemas/Zone'
  2179. required: true
  2180. deprecated: false
  2181. components:
  2182. schemas:
  2183. Event.jsonld:
  2184. type: object
  2185. description: ''
  2186. deprecated: false
  2187. properties:
  2188. '@context':
  2189. readOnly: true
  2190. oneOf:
  2191. -
  2192. type: string
  2193. -
  2194. type: object
  2195. properties:
  2196. '@vocab':
  2197. type: string
  2198. hydra:
  2199. type: string
  2200. enum: ['http://www.w3.org/ns/hydra/core#']
  2201. required:
  2202. - '@vocab'
  2203. - hydra
  2204. additionalProperties: true
  2205. '@id':
  2206. readOnly: true
  2207. type: string
  2208. '@type':
  2209. readOnly: true
  2210. type: string
  2211. dbId:
  2212. readOnly: true
  2213. type:
  2214. - integer
  2215. - 'null'
  2216. name:
  2217. type: string
  2218. identifier:
  2219. type: string
  2220. sequence:
  2221. type: integer
  2222. mandatory:
  2223. type: boolean
  2224. createdAt:
  2225. readOnly: true
  2226. type:
  2227. - string
  2228. - 'null'
  2229. format: date-time
  2230. Location:
  2231. type: object
  2232. description: ''
  2233. deprecated: false
  2234. properties:
  2235. dbId:
  2236. readOnly: true
  2237. type:
  2238. - integer
  2239. - 'null'
  2240. zone:
  2241. $ref: '#/components/schemas/Zone'
  2242. name:
  2243. type: string
  2244. code:
  2245. type: string
  2246. isZone:
  2247. type: boolean
  2248. isPlace:
  2249. type: boolean
  2250. isPort:
  2251. type: boolean
  2252. createdAt:
  2253. readOnly: true
  2254. type:
  2255. - string
  2256. - 'null'
  2257. format: date-time
  2258. required:
  2259. - name
  2260. - code
  2261. Location.jsonld:
  2262. type: object
  2263. description: ''
  2264. deprecated: false
  2265. properties:
  2266. '@context':
  2267. readOnly: true
  2268. oneOf:
  2269. -
  2270. type: string
  2271. -
  2272. type: object
  2273. properties:
  2274. '@vocab':
  2275. type: string
  2276. hydra:
  2277. type: string
  2278. enum: ['http://www.w3.org/ns/hydra/core#']
  2279. required:
  2280. - '@vocab'
  2281. - hydra
  2282. additionalProperties: true
  2283. '@id':
  2284. readOnly: true
  2285. type: string
  2286. '@type':
  2287. readOnly: true
  2288. type: string
  2289. dbId:
  2290. readOnly: true
  2291. type:
  2292. - integer
  2293. - 'null'
  2294. zone:
  2295. $ref: '#/components/schemas/Zone.jsonld'
  2296. name:
  2297. type: string
  2298. code:
  2299. type: string
  2300. isZone:
  2301. type: boolean
  2302. isPlace:
  2303. type: boolean
  2304. isPort:
  2305. type: boolean
  2306. createdAt:
  2307. readOnly: true
  2308. type:
  2309. - string
  2310. - 'null'
  2311. format: date-time
  2312. required:
  2313. - name
  2314. - code
  2315. MediaObject.jsonld:
  2316. type: object
  2317. description: ''
  2318. deprecated: false
  2319. properties:
  2320. '@context':
  2321. readOnly: true
  2322. oneOf:
  2323. -
  2324. type: string
  2325. -
  2326. type: object
  2327. properties:
  2328. '@vocab':
  2329. type: string
  2330. hydra:
  2331. type: string
  2332. enum: ['http://www.w3.org/ns/hydra/core#']
  2333. required:
  2334. - '@vocab'
  2335. - hydra
  2336. additionalProperties: true
  2337. '@id':
  2338. readOnly: true
  2339. type: string
  2340. '@type':
  2341. readOnly: true
  2342. type: string
  2343. dbId:
  2344. readOnly: true
  2345. type:
  2346. - integer
  2347. - 'null'
  2348. contentUrl:
  2349. externalDocs:
  2350. url: 'https://schema.org/contentUrl'
  2351. type:
  2352. - string
  2353. - 'null'
  2354. filePath:
  2355. readOnly: true
  2356. type:
  2357. - string
  2358. - 'null'
  2359. createdAt:
  2360. readOnly: true
  2361. type:
  2362. - string
  2363. - 'null'
  2364. format: date-time
  2365. ShippingCompany:
  2366. type: object
  2367. description: ''
  2368. deprecated: false
  2369. properties:
  2370. dbId:
  2371. readOnly: true
  2372. type:
  2373. - integer
  2374. - 'null'
  2375. name:
  2376. type: string
  2377. code:
  2378. type: string
  2379. createdAt:
  2380. readOnly: true
  2381. type:
  2382. - string
  2383. - 'null'
  2384. format: date-time
  2385. required:
  2386. - name
  2387. - code
  2388. ShippingCompany.jsonld:
  2389. type: object
  2390. description: ''
  2391. deprecated: false
  2392. properties:
  2393. '@context':
  2394. readOnly: true
  2395. oneOf:
  2396. -
  2397. type: string
  2398. -
  2399. type: object
  2400. properties:
  2401. '@vocab':
  2402. type: string
  2403. hydra:
  2404. type: string
  2405. enum: ['http://www.w3.org/ns/hydra/core#']
  2406. required:
  2407. - '@vocab'
  2408. - hydra
  2409. additionalProperties: true
  2410. '@id':
  2411. readOnly: true
  2412. type: string
  2413. '@type':
  2414. readOnly: true
  2415. type: string
  2416. dbId:
  2417. readOnly: true
  2418. type:
  2419. - integer
  2420. - 'null'
  2421. name:
  2422. type: string
  2423. code:
  2424. type: string
  2425. createdAt:
  2426. readOnly: true
  2427. type:
  2428. - string
  2429. - 'null'
  2430. format: date-time
  2431. required:
  2432. - name
  2433. - code
  2434. Trip:
  2435. type: object
  2436. description: ''
  2437. deprecated: false
  2438. properties:
  2439. dbId:
  2440. readOnly: true
  2441. type:
  2442. - integer
  2443. - 'null'
  2444. vessel:
  2445. $ref: '#/components/schemas/Vessel'
  2446. pilotageReference:
  2447. readOnly: true
  2448. type:
  2449. - string
  2450. - 'null'
  2451. customerReference:
  2452. type:
  2453. - string
  2454. - 'null'
  2455. captainName:
  2456. type:
  2457. - string
  2458. - 'null'
  2459. startLocation:
  2460. $ref: '#/components/schemas/Location'
  2461. endLocation:
  2462. $ref: '#/components/schemas/Location'
  2463. startDate:
  2464. type: string
  2465. format: date-time
  2466. endDate:
  2467. type: string
  2468. format: date-time
  2469. note:
  2470. type:
  2471. - string
  2472. - 'null'
  2473. createdAt:
  2474. readOnly: true
  2475. type:
  2476. - string
  2477. - 'null'
  2478. format: date-time
  2479. required:
  2480. - startDate
  2481. - endDate
  2482. Trip.jsonld:
  2483. type: object
  2484. description: ''
  2485. deprecated: false
  2486. properties:
  2487. '@context':
  2488. readOnly: true
  2489. oneOf:
  2490. -
  2491. type: string
  2492. -
  2493. type: object
  2494. properties:
  2495. '@vocab':
  2496. type: string
  2497. hydra:
  2498. type: string
  2499. enum: ['http://www.w3.org/ns/hydra/core#']
  2500. required:
  2501. - '@vocab'
  2502. - hydra
  2503. additionalProperties: true
  2504. '@id':
  2505. readOnly: true
  2506. type: string
  2507. '@type':
  2508. readOnly: true
  2509. type: string
  2510. dbId:
  2511. readOnly: true
  2512. type:
  2513. - integer
  2514. - 'null'
  2515. vessel:
  2516. $ref: '#/components/schemas/Vessel.jsonld'
  2517. pilotageReference:
  2518. readOnly: true
  2519. type:
  2520. - string
  2521. - 'null'
  2522. customerReference:
  2523. type:
  2524. - string
  2525. - 'null'
  2526. captainName:
  2527. type:
  2528. - string
  2529. - 'null'
  2530. startLocation:
  2531. $ref: '#/components/schemas/Location.jsonld'
  2532. endLocation:
  2533. $ref: '#/components/schemas/Location.jsonld'
  2534. startDate:
  2535. type: string
  2536. format: date-time
  2537. endDate:
  2538. type: string
  2539. format: date-time
  2540. note:
  2541. type:
  2542. - string
  2543. - 'null'
  2544. createdAt:
  2545. readOnly: true
  2546. type:
  2547. - string
  2548. - 'null'
  2549. format: date-time
  2550. required:
  2551. - startDate
  2552. - endDate
  2553. TripLocation:
  2554. type: object
  2555. description: ''
  2556. deprecated: false
  2557. properties:
  2558. dbId:
  2559. readOnly: true
  2560. type:
  2561. - integer
  2562. - 'null'
  2563. trip:
  2564. $ref: '#/components/schemas/Trip'
  2565. location:
  2566. $ref: '#/components/schemas/Location'
  2567. isArrival:
  2568. type: boolean
  2569. date:
  2570. type: string
  2571. format: date-time
  2572. createdAt:
  2573. readOnly: true
  2574. type:
  2575. - string
  2576. - 'null'
  2577. format: date-time
  2578. required:
  2579. - date
  2580. TripLocation.jsonld:
  2581. type: object
  2582. description: ''
  2583. deprecated: false
  2584. properties:
  2585. '@context':
  2586. readOnly: true
  2587. oneOf:
  2588. -
  2589. type: string
  2590. -
  2591. type: object
  2592. properties:
  2593. '@vocab':
  2594. type: string
  2595. hydra:
  2596. type: string
  2597. enum: ['http://www.w3.org/ns/hydra/core#']
  2598. required:
  2599. - '@vocab'
  2600. - hydra
  2601. additionalProperties: true
  2602. '@id':
  2603. readOnly: true
  2604. type: string
  2605. '@type':
  2606. readOnly: true
  2607. type: string
  2608. dbId:
  2609. readOnly: true
  2610. type:
  2611. - integer
  2612. - 'null'
  2613. trip:
  2614. $ref: '#/components/schemas/Trip.jsonld'
  2615. location:
  2616. $ref: '#/components/schemas/Location.jsonld'
  2617. isArrival:
  2618. type: boolean
  2619. date:
  2620. type: string
  2621. format: date-time
  2622. createdAt:
  2623. readOnly: true
  2624. type:
  2625. - string
  2626. - 'null'
  2627. format: date-time
  2628. required:
  2629. - date
  2630. User:
  2631. type: object
  2632. description: ''
  2633. deprecated: false
  2634. properties:
  2635. dbId:
  2636. readOnly: true
  2637. type:
  2638. - integer
  2639. - 'null'
  2640. email:
  2641. format: email
  2642. externalDocs:
  2643. url: 'https://schema.org/email'
  2644. type: string
  2645. firstName:
  2646. type: string
  2647. referenceId:
  2648. type: string
  2649. lastName:
  2650. type: string
  2651. image:
  2652. type:
  2653. - string
  2654. - 'null'
  2655. format: iri-reference
  2656. example: 'https://example.com/'
  2657. imageUrl:
  2658. readOnly: true
  2659. type:
  2660. - string
  2661. - 'null'
  2662. fullName:
  2663. readOnly: true
  2664. type:
  2665. - string
  2666. - 'null'
  2667. password:
  2668. writeOnly: true
  2669. description: 'The plaintext password when being set or changed.'
  2670. type: string
  2671. active:
  2672. type: boolean
  2673. roles:
  2674. readOnly: true
  2675. type: array
  2676. items:
  2677. type: string
  2678. createdAt:
  2679. readOnly: true
  2680. type:
  2681. - string
  2682. - 'null'
  2683. format: date-time
  2684. required:
  2685. - email
  2686. - firstName
  2687. - referenceId
  2688. - lastName
  2689. User.jsonld:
  2690. type: object
  2691. description: ''
  2692. deprecated: false
  2693. properties:
  2694. '@context':
  2695. readOnly: true
  2696. oneOf:
  2697. -
  2698. type: string
  2699. -
  2700. type: object
  2701. properties:
  2702. '@vocab':
  2703. type: string
  2704. hydra:
  2705. type: string
  2706. enum: ['http://www.w3.org/ns/hydra/core#']
  2707. required:
  2708. - '@vocab'
  2709. - hydra
  2710. additionalProperties: true
  2711. '@id':
  2712. readOnly: true
  2713. type: string
  2714. '@type':
  2715. readOnly: true
  2716. type: string
  2717. dbId:
  2718. readOnly: true
  2719. type:
  2720. - integer
  2721. - 'null'
  2722. email:
  2723. format: email
  2724. externalDocs:
  2725. url: 'https://schema.org/email'
  2726. type: string
  2727. firstName:
  2728. type: string
  2729. referenceId:
  2730. type: string
  2731. lastName:
  2732. type: string
  2733. image:
  2734. type:
  2735. - string
  2736. - 'null'
  2737. format: iri-reference
  2738. example: 'https://example.com/'
  2739. imageUrl:
  2740. readOnly: true
  2741. type:
  2742. - string
  2743. - 'null'
  2744. fullName:
  2745. readOnly: true
  2746. type:
  2747. - string
  2748. - 'null'
  2749. password:
  2750. writeOnly: true
  2751. description: 'The plaintext password when being set or changed.'
  2752. type: string
  2753. active:
  2754. type: boolean
  2755. roles:
  2756. readOnly: true
  2757. type: array
  2758. items:
  2759. type: string
  2760. createdAt:
  2761. readOnly: true
  2762. type:
  2763. - string
  2764. - 'null'
  2765. format: date-time
  2766. required:
  2767. - email
  2768. - firstName
  2769. - referenceId
  2770. - lastName
  2771. UserTrip:
  2772. type: object
  2773. description: ''
  2774. deprecated: false
  2775. properties:
  2776. dbId:
  2777. readOnly: true
  2778. type:
  2779. - integer
  2780. - 'null'
  2781. trip:
  2782. $ref: '#/components/schemas/Trip'
  2783. user:
  2784. $ref: '#/components/schemas/User'
  2785. captainName:
  2786. type:
  2787. - string
  2788. - 'null'
  2789. signatureUrl:
  2790. readOnly: true
  2791. type:
  2792. - string
  2793. - 'null'
  2794. completedDate:
  2795. type:
  2796. - string
  2797. - 'null'
  2798. format: date-time
  2799. createdAt:
  2800. readOnly: true
  2801. type:
  2802. - string
  2803. - 'null'
  2804. format: date-time
  2805. required:
  2806. - trip
  2807. - user
  2808. UserTrip.jsonld:
  2809. type: object
  2810. description: ''
  2811. deprecated: false
  2812. properties:
  2813. '@context':
  2814. readOnly: true
  2815. oneOf:
  2816. -
  2817. type: string
  2818. -
  2819. type: object
  2820. properties:
  2821. '@vocab':
  2822. type: string
  2823. hydra:
  2824. type: string
  2825. enum: ['http://www.w3.org/ns/hydra/core#']
  2826. required:
  2827. - '@vocab'
  2828. - hydra
  2829. additionalProperties: true
  2830. '@id':
  2831. readOnly: true
  2832. type: string
  2833. '@type':
  2834. readOnly: true
  2835. type: string
  2836. dbId:
  2837. readOnly: true
  2838. type:
  2839. - integer
  2840. - 'null'
  2841. trip:
  2842. $ref: '#/components/schemas/Trip.jsonld'
  2843. user:
  2844. $ref: '#/components/schemas/User.jsonld'
  2845. captainName:
  2846. type:
  2847. - string
  2848. - 'null'
  2849. signatureUrl:
  2850. readOnly: true
  2851. type:
  2852. - string
  2853. - 'null'
  2854. completedDate:
  2855. type:
  2856. - string
  2857. - 'null'
  2858. format: date-time
  2859. createdAt:
  2860. readOnly: true
  2861. type:
  2862. - string
  2863. - 'null'
  2864. format: date-time
  2865. required:
  2866. - trip
  2867. - user
  2868. UserTripEvent:
  2869. type: object
  2870. description: ''
  2871. deprecated: false
  2872. properties:
  2873. dbId:
  2874. readOnly: true
  2875. type:
  2876. - integer
  2877. - 'null'
  2878. userTrip:
  2879. readOnly: true
  2880. $ref: '#/components/schemas/UserTrip'
  2881. event:
  2882. readOnly: true
  2883. type: string
  2884. format: iri-reference
  2885. example: 'https://example.com/'
  2886. date:
  2887. type: string
  2888. format: date-time
  2889. note:
  2890. type:
  2891. - string
  2892. - 'null'
  2893. createdAt:
  2894. readOnly: true
  2895. type:
  2896. - string
  2897. - 'null'
  2898. format: date-time
  2899. required:
  2900. - date
  2901. UserTripEvent.jsonld:
  2902. type: object
  2903. description: ''
  2904. deprecated: false
  2905. properties:
  2906. '@context':
  2907. readOnly: true
  2908. oneOf:
  2909. -
  2910. type: string
  2911. -
  2912. type: object
  2913. properties:
  2914. '@vocab':
  2915. type: string
  2916. hydra:
  2917. type: string
  2918. enum: ['http://www.w3.org/ns/hydra/core#']
  2919. required:
  2920. - '@vocab'
  2921. - hydra
  2922. additionalProperties: true
  2923. '@id':
  2924. readOnly: true
  2925. type: string
  2926. '@type':
  2927. readOnly: true
  2928. type: string
  2929. dbId:
  2930. readOnly: true
  2931. type:
  2932. - integer
  2933. - 'null'
  2934. userTrip:
  2935. readOnly: true
  2936. $ref: '#/components/schemas/UserTrip.jsonld'
  2937. event:
  2938. readOnly: true
  2939. $ref: '#/components/schemas/Event.jsonld'
  2940. date:
  2941. type: string
  2942. format: date-time
  2943. note:
  2944. type:
  2945. - string
  2946. - 'null'
  2947. createdAt:
  2948. readOnly: true
  2949. type:
  2950. - string
  2951. - 'null'
  2952. format: date-time
  2953. required:
  2954. - date
  2955. Vessel:
  2956. type: object
  2957. description: ''
  2958. deprecated: false
  2959. properties:
  2960. dbId:
  2961. readOnly: true
  2962. type:
  2963. - integer
  2964. - 'null'
  2965. name:
  2966. type: string
  2967. code:
  2968. type: string
  2969. company:
  2970. $ref: '#/components/schemas/ShippingCompany'
  2971. createdAt:
  2972. readOnly: true
  2973. type:
  2974. - string
  2975. - 'null'
  2976. format: date-time
  2977. required:
  2978. - name
  2979. - code
  2980. Vessel.jsonld:
  2981. type: object
  2982. description: ''
  2983. deprecated: false
  2984. properties:
  2985. '@context':
  2986. readOnly: true
  2987. oneOf:
  2988. -
  2989. type: string
  2990. -
  2991. type: object
  2992. properties:
  2993. '@vocab':
  2994. type: string
  2995. hydra:
  2996. type: string
  2997. enum: ['http://www.w3.org/ns/hydra/core#']
  2998. required:
  2999. - '@vocab'
  3000. - hydra
  3001. additionalProperties: true
  3002. '@id':
  3003. readOnly: true
  3004. type: string
  3005. '@type':
  3006. readOnly: true
  3007. type: string
  3008. dbId:
  3009. readOnly: true
  3010. type:
  3011. - integer
  3012. - 'null'
  3013. name:
  3014. type: string
  3015. code:
  3016. type: string
  3017. company:
  3018. $ref: '#/components/schemas/ShippingCompany.jsonld'
  3019. createdAt:
  3020. readOnly: true
  3021. type:
  3022. - string
  3023. - 'null'
  3024. format: date-time
  3025. required:
  3026. - name
  3027. - code
  3028. Zone:
  3029. type: object
  3030. description: ''
  3031. deprecated: false
  3032. properties:
  3033. dbId:
  3034. readOnly: true
  3035. type:
  3036. - integer
  3037. - 'null'
  3038. name:
  3039. type: string
  3040. createdAt:
  3041. readOnly: true
  3042. type:
  3043. - string
  3044. - 'null'
  3045. format: date-time
  3046. required:
  3047. - name
  3048. Zone.jsonld:
  3049. type: object
  3050. description: ''
  3051. deprecated: false
  3052. properties:
  3053. '@context':
  3054. readOnly: true
  3055. oneOf:
  3056. -
  3057. type: string
  3058. -
  3059. type: object
  3060. properties:
  3061. '@vocab':
  3062. type: string
  3063. hydra:
  3064. type: string
  3065. enum: ['http://www.w3.org/ns/hydra/core#']
  3066. required:
  3067. - '@vocab'
  3068. - hydra
  3069. additionalProperties: true
  3070. '@id':
  3071. readOnly: true
  3072. type: string
  3073. '@type':
  3074. readOnly: true
  3075. type: string
  3076. dbId:
  3077. readOnly: true
  3078. type:
  3079. - integer
  3080. - 'null'
  3081. name:
  3082. type: string
  3083. createdAt:
  3084. readOnly: true
  3085. type:
  3086. - string
  3087. - 'null'
  3088. format: date-time
  3089. required:
  3090. - name
  3091. Credentials:
  3092. type: object
  3093. properties:
  3094. email:
  3095. type: string
  3096. example: user@example.com
  3097. password:
  3098. type: string
  3099. example: password123
  3100. AuthResponse:
  3101. type: object
  3102. properties:
  3103. '@id':
  3104. type: string
  3105. example: /api/users/1
  3106. dbId:
  3107. type: integer
  3108. example: 1
  3109. token:
  3110. type: string
  3111. example: JWT_TOKEN
  3112. responses: { }
  3113. parameters: { }
  3114. examples: { }
  3115. requestBodies: { }
  3116. headers: { }
  3117. securitySchemes:
  3118. JWT:
  3119. type: http
  3120. scheme: bearer
  3121. bearerFormat: JWT
  3122. security:
  3123. -
  3124. JWT: []
  3125. tags: []
  3126. webhooks: { }