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.
 
 
 
 
 

3469 regels
96 KiB

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