Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 
 

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