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.
 
 
 
 
 

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