You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

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