25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

3454 lines
95 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: custom_json_filter
  1690. in: query
  1691. description: ''
  1692. required: false
  1693. deprecated: false
  1694. allowEmptyValue: false
  1695. schema:
  1696. type: string
  1697. style: form
  1698. explode: false
  1699. allowReserved: false
  1700. -
  1701. name: custom_json_order
  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. deprecated: false
  1713. post:
  1714. operationId: api_user_trip_events_post
  1715. tags:
  1716. - UserTripEvent
  1717. responses:
  1718. '201':
  1719. description: 'UserTripEvent resource created'
  1720. content:
  1721. application/ld+json:
  1722. schema:
  1723. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1724. links: { }
  1725. '400':
  1726. description: 'Invalid input'
  1727. '422':
  1728. description: 'Unprocessable entity'
  1729. summary: 'Creates a UserTripEvent resource.'
  1730. description: 'Creates a UserTripEvent resource.'
  1731. parameters: []
  1732. requestBody:
  1733. description: 'The new UserTripEvent resource'
  1734. content:
  1735. application/ld+json:
  1736. schema:
  1737. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1738. required: true
  1739. deprecated: false
  1740. '/api/user_trip_events/{id}':
  1741. get:
  1742. operationId: api_user_trip_events_id_get
  1743. tags:
  1744. - UserTripEvent
  1745. responses:
  1746. '200':
  1747. description: 'UserTripEvent resource'
  1748. content:
  1749. application/ld+json:
  1750. schema:
  1751. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1752. '404':
  1753. description: 'Resource not found'
  1754. summary: 'Retrieves a UserTripEvent resource.'
  1755. description: 'Retrieves a UserTripEvent resource.'
  1756. parameters:
  1757. -
  1758. name: id
  1759. in: path
  1760. description: 'UserTripEvent identifier'
  1761. required: true
  1762. deprecated: false
  1763. allowEmptyValue: false
  1764. schema:
  1765. type: string
  1766. style: simple
  1767. explode: false
  1768. allowReserved: false
  1769. deprecated: false
  1770. delete:
  1771. operationId: api_user_trip_events_id_delete
  1772. tags:
  1773. - UserTripEvent
  1774. responses:
  1775. '204':
  1776. description: 'UserTripEvent resource deleted'
  1777. '404':
  1778. description: 'Resource not found'
  1779. summary: 'Removes the UserTripEvent resource.'
  1780. description: 'Removes the UserTripEvent resource.'
  1781. parameters:
  1782. -
  1783. name: id
  1784. in: path
  1785. description: 'UserTripEvent identifier'
  1786. required: true
  1787. deprecated: false
  1788. allowEmptyValue: false
  1789. schema:
  1790. type: string
  1791. style: simple
  1792. explode: false
  1793. allowReserved: false
  1794. deprecated: false
  1795. patch:
  1796. operationId: api_user_trip_events_id_patch
  1797. tags:
  1798. - UserTripEvent
  1799. responses:
  1800. '200':
  1801. description: 'UserTripEvent resource updated'
  1802. content:
  1803. application/ld+json:
  1804. schema:
  1805. $ref: '#/components/schemas/UserTripEvent.jsonld'
  1806. links: { }
  1807. '400':
  1808. description: 'Invalid input'
  1809. '422':
  1810. description: 'Unprocessable entity'
  1811. '404':
  1812. description: 'Resource not found'
  1813. summary: 'Updates the UserTripEvent resource.'
  1814. description: 'Updates the UserTripEvent resource.'
  1815. parameters:
  1816. -
  1817. name: id
  1818. in: path
  1819. description: 'UserTripEvent identifier'
  1820. required: true
  1821. deprecated: false
  1822. allowEmptyValue: false
  1823. schema:
  1824. type: string
  1825. style: simple
  1826. explode: false
  1827. allowReserved: false
  1828. requestBody:
  1829. description: 'The updated UserTripEvent resource'
  1830. content:
  1831. application/merge-patch+json:
  1832. schema:
  1833. $ref: '#/components/schemas/UserTripEvent'
  1834. required: true
  1835. deprecated: false
  1836. /api/vessels:
  1837. get:
  1838. operationId: api_vessels_get_collection
  1839. tags:
  1840. - Vessel
  1841. responses:
  1842. '200':
  1843. description: 'Vessel collection'
  1844. content:
  1845. application/ld+json:
  1846. schema:
  1847. type: object
  1848. properties:
  1849. member: { type: array, items: { $ref: '#/components/schemas/Vessel.jsonld' } }
  1850. totalItems: { type: integer, minimum: 0 }
  1851. 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 } }
  1852. 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 } } } } } }
  1853. required:
  1854. - member
  1855. summary: 'Retrieves the collection of Vessel resources.'
  1856. description: 'Retrieves the collection of Vessel resources.'
  1857. parameters:
  1858. -
  1859. name: page
  1860. in: query
  1861. description: 'The collection page number'
  1862. required: false
  1863. deprecated: false
  1864. allowEmptyValue: true
  1865. schema:
  1866. type: integer
  1867. default: 1
  1868. style: form
  1869. explode: false
  1870. allowReserved: false
  1871. -
  1872. name: itemsPerPage
  1873. in: query
  1874. description: 'The number of items per page'
  1875. required: false
  1876. deprecated: false
  1877. allowEmptyValue: true
  1878. schema:
  1879. type: integer
  1880. default: 50
  1881. minimum: 0
  1882. maximum: 200
  1883. style: form
  1884. explode: false
  1885. allowReserved: false
  1886. -
  1887. name: name
  1888. in: query
  1889. description: ''
  1890. required: false
  1891. deprecated: false
  1892. allowEmptyValue: false
  1893. schema:
  1894. type: string
  1895. style: form
  1896. explode: false
  1897. allowReserved: false
  1898. -
  1899. name: custom_json_filter
  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_order
  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. deprecated: false
  1923. post:
  1924. operationId: api_vessels_post
  1925. tags:
  1926. - Vessel
  1927. responses:
  1928. '201':
  1929. description: 'Vessel resource created'
  1930. content:
  1931. application/ld+json:
  1932. schema:
  1933. $ref: '#/components/schemas/Vessel.jsonld'
  1934. links: { }
  1935. '400':
  1936. description: 'Invalid input'
  1937. '422':
  1938. description: 'Unprocessable entity'
  1939. summary: 'Creates a Vessel resource.'
  1940. description: 'Creates a Vessel resource.'
  1941. parameters: []
  1942. requestBody:
  1943. description: 'The new Vessel resource'
  1944. content:
  1945. application/ld+json:
  1946. schema:
  1947. $ref: '#/components/schemas/Vessel.jsonld'
  1948. required: true
  1949. deprecated: false
  1950. '/api/vessels/{id}':
  1951. get:
  1952. operationId: api_vessels_id_get
  1953. tags:
  1954. - Vessel
  1955. responses:
  1956. '200':
  1957. description: 'Vessel resource'
  1958. content:
  1959. application/ld+json:
  1960. schema:
  1961. $ref: '#/components/schemas/Vessel.jsonld'
  1962. '404':
  1963. description: 'Resource not found'
  1964. summary: 'Retrieves a Vessel resource.'
  1965. description: 'Retrieves a Vessel resource.'
  1966. parameters:
  1967. -
  1968. name: id
  1969. in: path
  1970. description: 'Vessel identifier'
  1971. required: true
  1972. deprecated: false
  1973. allowEmptyValue: false
  1974. schema:
  1975. type: string
  1976. style: simple
  1977. explode: false
  1978. allowReserved: false
  1979. deprecated: false
  1980. delete:
  1981. operationId: api_vessels_id_delete
  1982. tags:
  1983. - Vessel
  1984. responses:
  1985. '204':
  1986. description: 'Vessel resource deleted'
  1987. '404':
  1988. description: 'Resource not found'
  1989. summary: 'Removes the Vessel resource.'
  1990. description: 'Removes the Vessel resource.'
  1991. parameters:
  1992. -
  1993. name: id
  1994. in: path
  1995. description: 'Vessel identifier'
  1996. required: true
  1997. deprecated: false
  1998. allowEmptyValue: false
  1999. schema:
  2000. type: string
  2001. style: simple
  2002. explode: false
  2003. allowReserved: false
  2004. deprecated: false
  2005. patch:
  2006. operationId: api_vessels_id_patch
  2007. tags:
  2008. - Vessel
  2009. responses:
  2010. '200':
  2011. description: 'Vessel resource updated'
  2012. content:
  2013. application/ld+json:
  2014. schema:
  2015. $ref: '#/components/schemas/Vessel.jsonld'
  2016. links: { }
  2017. '400':
  2018. description: 'Invalid input'
  2019. '422':
  2020. description: 'Unprocessable entity'
  2021. '404':
  2022. description: 'Resource not found'
  2023. summary: 'Updates the Vessel resource.'
  2024. description: 'Updates the Vessel resource.'
  2025. parameters:
  2026. -
  2027. name: id
  2028. in: path
  2029. description: 'Vessel identifier'
  2030. required: true
  2031. deprecated: false
  2032. allowEmptyValue: false
  2033. schema:
  2034. type: string
  2035. style: simple
  2036. explode: false
  2037. allowReserved: false
  2038. requestBody:
  2039. description: 'The updated Vessel resource'
  2040. content:
  2041. application/merge-patch+json:
  2042. schema:
  2043. $ref: '#/components/schemas/Vessel'
  2044. required: true
  2045. deprecated: false
  2046. /api/zones:
  2047. get:
  2048. operationId: api_zones_get_collection
  2049. tags:
  2050. - Zone
  2051. responses:
  2052. '200':
  2053. description: 'Zone collection'
  2054. content:
  2055. application/ld+json:
  2056. schema:
  2057. type: object
  2058. properties:
  2059. member: { type: array, items: { $ref: '#/components/schemas/Zone.jsonld' } }
  2060. totalItems: { type: integer, minimum: 0 }
  2061. 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 } }
  2062. 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 } } } } } }
  2063. required:
  2064. - member
  2065. summary: 'Retrieves the collection of Zone resources.'
  2066. description: 'Retrieves the collection of Zone resources.'
  2067. parameters:
  2068. -
  2069. name: page
  2070. in: query
  2071. description: 'The collection page number'
  2072. required: false
  2073. deprecated: false
  2074. allowEmptyValue: true
  2075. schema:
  2076. type: integer
  2077. default: 1
  2078. style: form
  2079. explode: false
  2080. allowReserved: false
  2081. -
  2082. name: itemsPerPage
  2083. in: query
  2084. description: 'The number of items per page'
  2085. required: false
  2086. deprecated: false
  2087. allowEmptyValue: true
  2088. schema:
  2089. type: integer
  2090. default: 50
  2091. minimum: 0
  2092. maximum: 200
  2093. style: form
  2094. explode: false
  2095. allowReserved: false
  2096. -
  2097. name: name
  2098. in: query
  2099. description: ''
  2100. required: false
  2101. deprecated: false
  2102. allowEmptyValue: false
  2103. schema:
  2104. type: string
  2105. style: form
  2106. explode: false
  2107. allowReserved: false
  2108. -
  2109. name: custom_json_filter
  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_order
  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. deprecated: false
  2133. post:
  2134. operationId: api_zones_post
  2135. tags:
  2136. - Zone
  2137. responses:
  2138. '201':
  2139. description: 'Zone resource created'
  2140. content:
  2141. application/ld+json:
  2142. schema:
  2143. $ref: '#/components/schemas/Zone.jsonld'
  2144. links: { }
  2145. '400':
  2146. description: 'Invalid input'
  2147. '422':
  2148. description: 'Unprocessable entity'
  2149. summary: 'Creates a Zone resource.'
  2150. description: 'Creates a Zone resource.'
  2151. parameters: []
  2152. requestBody:
  2153. description: 'The new Zone resource'
  2154. content:
  2155. application/ld+json:
  2156. schema:
  2157. $ref: '#/components/schemas/Zone.jsonld'
  2158. required: true
  2159. deprecated: false
  2160. '/api/zones/{id}':
  2161. get:
  2162. operationId: api_zones_id_get
  2163. tags:
  2164. - Zone
  2165. responses:
  2166. '200':
  2167. description: 'Zone resource'
  2168. content:
  2169. application/ld+json:
  2170. schema:
  2171. $ref: '#/components/schemas/Zone.jsonld'
  2172. '404':
  2173. description: 'Resource not found'
  2174. summary: 'Retrieves a Zone resource.'
  2175. description: 'Retrieves a Zone resource.'
  2176. parameters:
  2177. -
  2178. name: id
  2179. in: path
  2180. description: 'Zone identifier'
  2181. required: true
  2182. deprecated: false
  2183. allowEmptyValue: false
  2184. schema:
  2185. type: string
  2186. style: simple
  2187. explode: false
  2188. allowReserved: false
  2189. deprecated: false
  2190. delete:
  2191. operationId: api_zones_id_delete
  2192. tags:
  2193. - Zone
  2194. responses:
  2195. '204':
  2196. description: 'Zone resource deleted'
  2197. '404':
  2198. description: 'Resource not found'
  2199. summary: 'Removes the Zone resource.'
  2200. description: 'Removes the Zone resource.'
  2201. parameters:
  2202. -
  2203. name: id
  2204. in: path
  2205. description: 'Zone identifier'
  2206. required: true
  2207. deprecated: false
  2208. allowEmptyValue: false
  2209. schema:
  2210. type: string
  2211. style: simple
  2212. explode: false
  2213. allowReserved: false
  2214. deprecated: false
  2215. patch:
  2216. operationId: api_zones_id_patch
  2217. tags:
  2218. - Zone
  2219. responses:
  2220. '200':
  2221. description: 'Zone resource updated'
  2222. content:
  2223. application/ld+json:
  2224. schema:
  2225. $ref: '#/components/schemas/Zone.jsonld'
  2226. links: { }
  2227. '400':
  2228. description: 'Invalid input'
  2229. '422':
  2230. description: 'Unprocessable entity'
  2231. '404':
  2232. description: 'Resource not found'
  2233. summary: 'Updates the Zone resource.'
  2234. description: 'Updates the Zone resource.'
  2235. parameters:
  2236. -
  2237. name: id
  2238. in: path
  2239. description: 'Zone identifier'
  2240. required: true
  2241. deprecated: false
  2242. allowEmptyValue: false
  2243. schema:
  2244. type: string
  2245. style: simple
  2246. explode: false
  2247. allowReserved: false
  2248. requestBody:
  2249. description: 'The updated Zone resource'
  2250. content:
  2251. application/merge-patch+json:
  2252. schema:
  2253. $ref: '#/components/schemas/Zone'
  2254. required: true
  2255. deprecated: false
  2256. components:
  2257. schemas:
  2258. Event.jsonld:
  2259. type: object
  2260. description: ''
  2261. deprecated: false
  2262. properties:
  2263. '@context':
  2264. readOnly: true
  2265. oneOf:
  2266. -
  2267. type: string
  2268. -
  2269. type: object
  2270. properties:
  2271. '@vocab':
  2272. type: string
  2273. hydra:
  2274. type: string
  2275. enum: ['http://www.w3.org/ns/hydra/core#']
  2276. required:
  2277. - '@vocab'
  2278. - hydra
  2279. additionalProperties: true
  2280. '@id':
  2281. readOnly: true
  2282. type: string
  2283. '@type':
  2284. readOnly: true
  2285. type: string
  2286. dbId:
  2287. readOnly: true
  2288. type:
  2289. - integer
  2290. - 'null'
  2291. name:
  2292. type: string
  2293. identifier:
  2294. type: string
  2295. sequence:
  2296. type: integer
  2297. mandatory:
  2298. type: boolean
  2299. createdAt:
  2300. readOnly: true
  2301. type:
  2302. - string
  2303. - 'null'
  2304. format: date-time
  2305. Location:
  2306. type: object
  2307. description: ''
  2308. deprecated: false
  2309. properties:
  2310. dbId:
  2311. readOnly: true
  2312. type:
  2313. - integer
  2314. - 'null'
  2315. zone:
  2316. readOnly: true
  2317. type: string
  2318. format: iri-reference
  2319. example: 'https://example.com/'
  2320. zoneIri:
  2321. type:
  2322. - string
  2323. - 'null'
  2324. format: iri-reference
  2325. example: 'https://example.com/'
  2326. name:
  2327. type: string
  2328. code:
  2329. type: string
  2330. isZone:
  2331. type: boolean
  2332. isPlace:
  2333. type: boolean
  2334. isPort:
  2335. type: boolean
  2336. createdAt:
  2337. readOnly: true
  2338. type:
  2339. - string
  2340. - 'null'
  2341. format: date-time
  2342. required:
  2343. - zoneIri
  2344. - name
  2345. - code
  2346. Location.jsonld:
  2347. type: object
  2348. description: ''
  2349. deprecated: false
  2350. properties:
  2351. '@context':
  2352. readOnly: true
  2353. oneOf:
  2354. -
  2355. type: string
  2356. -
  2357. type: object
  2358. properties:
  2359. '@vocab':
  2360. type: string
  2361. hydra:
  2362. type: string
  2363. enum: ['http://www.w3.org/ns/hydra/core#']
  2364. required:
  2365. - '@vocab'
  2366. - hydra
  2367. additionalProperties: true
  2368. '@id':
  2369. readOnly: true
  2370. type: string
  2371. '@type':
  2372. readOnly: true
  2373. type: string
  2374. dbId:
  2375. readOnly: true
  2376. type:
  2377. - integer
  2378. - 'null'
  2379. zone:
  2380. readOnly: true
  2381. $ref: '#/components/schemas/Zone.jsonld'
  2382. zoneIri:
  2383. type:
  2384. - string
  2385. - 'null'
  2386. format: iri-reference
  2387. example: 'https://example.com/'
  2388. name:
  2389. type: string
  2390. code:
  2391. type: string
  2392. isZone:
  2393. type: boolean
  2394. isPlace:
  2395. type: boolean
  2396. isPort:
  2397. type: boolean
  2398. createdAt:
  2399. readOnly: true
  2400. type:
  2401. - string
  2402. - 'null'
  2403. format: date-time
  2404. required:
  2405. - zoneIri
  2406. - name
  2407. - code
  2408. MediaObject:
  2409. type: object
  2410. description: ''
  2411. deprecated: false
  2412. properties:
  2413. id:
  2414. readOnly: true
  2415. type: integer
  2416. file:
  2417. type:
  2418. - string
  2419. - 'null'
  2420. format: binary
  2421. filePath:
  2422. type:
  2423. - string
  2424. - 'null'
  2425. createdBy:
  2426. $ref: '#/components/schemas/User'
  2427. createdAt:
  2428. readOnly: true
  2429. type: string
  2430. format: date-time
  2431. required:
  2432. - file
  2433. MediaObject.jsonld:
  2434. type: object
  2435. description: ''
  2436. deprecated: false
  2437. properties:
  2438. '@context':
  2439. readOnly: true
  2440. oneOf:
  2441. -
  2442. type: string
  2443. -
  2444. type: object
  2445. properties:
  2446. '@vocab':
  2447. type: string
  2448. hydra:
  2449. type: string
  2450. enum: ['http://www.w3.org/ns/hydra/core#']
  2451. required:
  2452. - '@vocab'
  2453. - hydra
  2454. additionalProperties: true
  2455. '@id':
  2456. readOnly: true
  2457. type: string
  2458. '@type':
  2459. readOnly: true
  2460. type: string
  2461. dbId:
  2462. readOnly: true
  2463. type:
  2464. - integer
  2465. - 'null'
  2466. contentUrl:
  2467. externalDocs:
  2468. url: 'https://schema.org/contentUrl'
  2469. type:
  2470. - string
  2471. - 'null'
  2472. filePath:
  2473. readOnly: true
  2474. type:
  2475. - string
  2476. - 'null'
  2477. createdAt:
  2478. readOnly: true
  2479. type:
  2480. - string
  2481. - 'null'
  2482. format: date-time
  2483. ShippingCompany:
  2484. type: object
  2485. description: ''
  2486. deprecated: false
  2487. properties:
  2488. dbId:
  2489. readOnly: true
  2490. type:
  2491. - integer
  2492. - 'null'
  2493. name:
  2494. type: string
  2495. code:
  2496. type: string
  2497. createdAt:
  2498. readOnly: true
  2499. type:
  2500. - string
  2501. - 'null'
  2502. format: date-time
  2503. required:
  2504. - name
  2505. - code
  2506. ShippingCompany.jsonld:
  2507. type: object
  2508. description: ''
  2509. deprecated: false
  2510. properties:
  2511. '@context':
  2512. readOnly: true
  2513. oneOf:
  2514. -
  2515. type: string
  2516. -
  2517. type: object
  2518. properties:
  2519. '@vocab':
  2520. type: string
  2521. hydra:
  2522. type: string
  2523. enum: ['http://www.w3.org/ns/hydra/core#']
  2524. required:
  2525. - '@vocab'
  2526. - hydra
  2527. additionalProperties: true
  2528. '@id':
  2529. readOnly: true
  2530. type: string
  2531. '@type':
  2532. readOnly: true
  2533. type: string
  2534. dbId:
  2535. readOnly: true
  2536. type:
  2537. - integer
  2538. - 'null'
  2539. name:
  2540. type: string
  2541. code:
  2542. type: string
  2543. createdAt:
  2544. readOnly: true
  2545. type:
  2546. - string
  2547. - 'null'
  2548. format: date-time
  2549. required:
  2550. - name
  2551. - code
  2552. Trip:
  2553. type: object
  2554. description: ''
  2555. deprecated: false
  2556. properties:
  2557. dbId:
  2558. readOnly: true
  2559. type:
  2560. - integer
  2561. - 'null'
  2562. vessel:
  2563. readOnly: true
  2564. type: string
  2565. format: iri-reference
  2566. example: 'https://example.com/'
  2567. vesselIri:
  2568. type:
  2569. - string
  2570. - 'null'
  2571. format: iri-reference
  2572. example: 'https://example.com/'
  2573. pilotageReference:
  2574. readOnly: true
  2575. type:
  2576. - string
  2577. - 'null'
  2578. customerReference:
  2579. type:
  2580. - string
  2581. - 'null'
  2582. captainName:
  2583. type:
  2584. - string
  2585. - 'null'
  2586. startLocation:
  2587. readOnly: true
  2588. type: string
  2589. format: iri-reference
  2590. example: 'https://example.com/'
  2591. startLocationIri:
  2592. type:
  2593. - string
  2594. - 'null'
  2595. format: iri-reference
  2596. example: 'https://example.com/'
  2597. endLocation:
  2598. readOnly: true
  2599. type: string
  2600. format: iri-reference
  2601. example: 'https://example.com/'
  2602. endLocationIri:
  2603. type:
  2604. - string
  2605. - 'null'
  2606. format: iri-reference
  2607. example: 'https://example.com/'
  2608. startDate:
  2609. type: string
  2610. format: date-time
  2611. endDate:
  2612. type: string
  2613. format: date-time
  2614. note:
  2615. type:
  2616. - string
  2617. - 'null'
  2618. createdAt:
  2619. readOnly: true
  2620. type:
  2621. - string
  2622. - 'null'
  2623. format: date-time
  2624. required:
  2625. - vesselIri
  2626. - startLocationIri
  2627. - endLocationIri
  2628. - startDate
  2629. - endDate
  2630. Trip.jsonld:
  2631. type: object
  2632. description: ''
  2633. deprecated: false
  2634. properties:
  2635. '@context':
  2636. readOnly: true
  2637. oneOf:
  2638. -
  2639. type: string
  2640. -
  2641. type: object
  2642. properties:
  2643. '@vocab':
  2644. type: string
  2645. hydra:
  2646. type: string
  2647. enum: ['http://www.w3.org/ns/hydra/core#']
  2648. required:
  2649. - '@vocab'
  2650. - hydra
  2651. additionalProperties: true
  2652. '@id':
  2653. readOnly: true
  2654. type: string
  2655. '@type':
  2656. readOnly: true
  2657. type: string
  2658. dbId:
  2659. readOnly: true
  2660. type:
  2661. - integer
  2662. - 'null'
  2663. vessel:
  2664. readOnly: true
  2665. $ref: '#/components/schemas/Vessel.jsonld'
  2666. vesselIri:
  2667. type:
  2668. - string
  2669. - 'null'
  2670. format: iri-reference
  2671. example: 'https://example.com/'
  2672. pilotageReference:
  2673. readOnly: true
  2674. type:
  2675. - string
  2676. - 'null'
  2677. customerReference:
  2678. type:
  2679. - string
  2680. - 'null'
  2681. captainName:
  2682. type:
  2683. - string
  2684. - 'null'
  2685. startLocation:
  2686. readOnly: true
  2687. $ref: '#/components/schemas/Location.jsonld'
  2688. startLocationIri:
  2689. type:
  2690. - string
  2691. - 'null'
  2692. format: iri-reference
  2693. example: 'https://example.com/'
  2694. endLocation:
  2695. readOnly: true
  2696. $ref: '#/components/schemas/Location.jsonld'
  2697. endLocationIri:
  2698. type:
  2699. - string
  2700. - 'null'
  2701. format: iri-reference
  2702. example: 'https://example.com/'
  2703. startDate:
  2704. type: string
  2705. format: date-time
  2706. endDate:
  2707. type: string
  2708. format: date-time
  2709. note:
  2710. type:
  2711. - string
  2712. - 'null'
  2713. createdAt:
  2714. readOnly: true
  2715. type:
  2716. - string
  2717. - 'null'
  2718. format: date-time
  2719. required:
  2720. - vesselIri
  2721. - startLocationIri
  2722. - endLocationIri
  2723. - startDate
  2724. - endDate
  2725. TripLocation:
  2726. type: object
  2727. description: ''
  2728. deprecated: false
  2729. properties:
  2730. dbId:
  2731. readOnly: true
  2732. type:
  2733. - integer
  2734. - 'null'
  2735. trip:
  2736. $ref: '#/components/schemas/Trip'
  2737. tripIri:
  2738. type:
  2739. - string
  2740. - 'null'
  2741. format: iri-reference
  2742. example: 'https://example.com/'
  2743. location:
  2744. $ref: '#/components/schemas/Location'
  2745. locationIri:
  2746. type:
  2747. - string
  2748. - 'null'
  2749. format: iri-reference
  2750. example: 'https://example.com/'
  2751. isArrival:
  2752. type: boolean
  2753. date:
  2754. type: string
  2755. format: date-time
  2756. createdAt:
  2757. readOnly: true
  2758. type:
  2759. - string
  2760. - 'null'
  2761. format: date-time
  2762. required:
  2763. - tripIri
  2764. - locationIri
  2765. - date
  2766. TripLocation.jsonld:
  2767. type: object
  2768. description: ''
  2769. deprecated: false
  2770. properties:
  2771. '@context':
  2772. readOnly: true
  2773. oneOf:
  2774. -
  2775. type: string
  2776. -
  2777. type: object
  2778. properties:
  2779. '@vocab':
  2780. type: string
  2781. hydra:
  2782. type: string
  2783. enum: ['http://www.w3.org/ns/hydra/core#']
  2784. required:
  2785. - '@vocab'
  2786. - hydra
  2787. additionalProperties: true
  2788. '@id':
  2789. readOnly: true
  2790. type: string
  2791. '@type':
  2792. readOnly: true
  2793. type: string
  2794. dbId:
  2795. readOnly: true
  2796. type:
  2797. - integer
  2798. - 'null'
  2799. trip:
  2800. $ref: '#/components/schemas/Trip.jsonld'
  2801. tripIri:
  2802. type:
  2803. - string
  2804. - 'null'
  2805. format: iri-reference
  2806. example: 'https://example.com/'
  2807. location:
  2808. $ref: '#/components/schemas/Location.jsonld'
  2809. locationIri:
  2810. type:
  2811. - string
  2812. - 'null'
  2813. format: iri-reference
  2814. example: 'https://example.com/'
  2815. isArrival:
  2816. type: boolean
  2817. date:
  2818. type: string
  2819. format: date-time
  2820. createdAt:
  2821. readOnly: true
  2822. type:
  2823. - string
  2824. - 'null'
  2825. format: date-time
  2826. required:
  2827. - tripIri
  2828. - locationIri
  2829. - date
  2830. User:
  2831. type: object
  2832. description: ''
  2833. deprecated: false
  2834. properties:
  2835. dbId:
  2836. readOnly: true
  2837. type:
  2838. - integer
  2839. - 'null'
  2840. email:
  2841. format: email
  2842. externalDocs:
  2843. url: 'https://schema.org/email'
  2844. type: string
  2845. firstName:
  2846. type: string
  2847. referenceId:
  2848. type: string
  2849. lastName:
  2850. type: string
  2851. image:
  2852. anyOf:
  2853. -
  2854. $ref: '#/components/schemas/MediaObject'
  2855. -
  2856. type: 'null'
  2857. imageUrl:
  2858. readOnly: true
  2859. type:
  2860. - string
  2861. - 'null'
  2862. fullName:
  2863. readOnly: true
  2864. type:
  2865. - string
  2866. - 'null'
  2867. password:
  2868. writeOnly: true
  2869. description: 'The plaintext password when being set or changed.'
  2870. type: string
  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. User.jsonld:
  2890. type: object
  2891. description: ''
  2892. deprecated: false
  2893. properties:
  2894. '@context':
  2895. readOnly: true
  2896. oneOf:
  2897. -
  2898. type: string
  2899. -
  2900. type: object
  2901. properties:
  2902. '@vocab':
  2903. type: string
  2904. hydra:
  2905. type: string
  2906. enum: ['http://www.w3.org/ns/hydra/core#']
  2907. required:
  2908. - '@vocab'
  2909. - hydra
  2910. additionalProperties: true
  2911. '@id':
  2912. readOnly: true
  2913. type: string
  2914. '@type':
  2915. readOnly: true
  2916. type: string
  2917. dbId:
  2918. readOnly: true
  2919. type:
  2920. - integer
  2921. - 'null'
  2922. email:
  2923. format: email
  2924. externalDocs:
  2925. url: 'https://schema.org/email'
  2926. type: string
  2927. firstName:
  2928. type: string
  2929. referenceId:
  2930. type: string
  2931. lastName:
  2932. type: string
  2933. image:
  2934. anyOf:
  2935. -
  2936. $ref: '#/components/schemas/MediaObject.jsonld'
  2937. -
  2938. type: 'null'
  2939. imageUrl:
  2940. readOnly: true
  2941. type:
  2942. - string
  2943. - 'null'
  2944. fullName:
  2945. readOnly: true
  2946. type:
  2947. - string
  2948. - 'null'
  2949. password:
  2950. writeOnly: true
  2951. description: 'The plaintext password when being set or changed.'
  2952. type: string
  2953. active:
  2954. type: boolean
  2955. roles:
  2956. readOnly: true
  2957. type: array
  2958. items:
  2959. type: string
  2960. createdAt:
  2961. readOnly: true
  2962. type:
  2963. - string
  2964. - 'null'
  2965. format: date-time
  2966. required:
  2967. - email
  2968. - firstName
  2969. - referenceId
  2970. - lastName
  2971. UserTrip:
  2972. type: object
  2973. description: ''
  2974. deprecated: false
  2975. properties:
  2976. dbId:
  2977. readOnly: true
  2978. type:
  2979. - integer
  2980. - 'null'
  2981. trip:
  2982. readOnly: true
  2983. type: string
  2984. format: iri-reference
  2985. example: 'https://example.com/'
  2986. tripIri:
  2987. type:
  2988. - string
  2989. - 'null'
  2990. format: iri-reference
  2991. example: 'https://example.com/'
  2992. user:
  2993. readOnly: true
  2994. type: string
  2995. format: iri-reference
  2996. example: 'https://example.com/'
  2997. userIri:
  2998. type:
  2999. - string
  3000. - 'null'
  3001. format: iri-reference
  3002. example: 'https://example.com/'
  3003. captainName:
  3004. type:
  3005. - string
  3006. - 'null'
  3007. completed:
  3008. type: boolean
  3009. signature:
  3010. readOnly: true
  3011. type: string
  3012. format: iri-reference
  3013. example: 'https://example.com/'
  3014. signatureIri:
  3015. type:
  3016. - string
  3017. - 'null'
  3018. format: iri-reference
  3019. example: 'https://example.com/'
  3020. signatureUrl:
  3021. readOnly: true
  3022. type:
  3023. - string
  3024. - 'null'
  3025. completedDate:
  3026. type:
  3027. - string
  3028. - 'null'
  3029. format: date-time
  3030. createdAt:
  3031. readOnly: true
  3032. type:
  3033. - string
  3034. - 'null'
  3035. format: date-time
  3036. required:
  3037. - tripIri
  3038. - userIri
  3039. - completed
  3040. UserTrip.jsonld:
  3041. type: object
  3042. description: ''
  3043. deprecated: false
  3044. properties:
  3045. '@context':
  3046. readOnly: true
  3047. oneOf:
  3048. -
  3049. type: string
  3050. -
  3051. type: object
  3052. properties:
  3053. '@vocab':
  3054. type: string
  3055. hydra:
  3056. type: string
  3057. enum: ['http://www.w3.org/ns/hydra/core#']
  3058. required:
  3059. - '@vocab'
  3060. - hydra
  3061. additionalProperties: true
  3062. '@id':
  3063. readOnly: true
  3064. type: string
  3065. '@type':
  3066. readOnly: true
  3067. type: string
  3068. dbId:
  3069. readOnly: true
  3070. type:
  3071. - integer
  3072. - 'null'
  3073. trip:
  3074. readOnly: true
  3075. $ref: '#/components/schemas/Trip.jsonld'
  3076. tripIri:
  3077. type:
  3078. - string
  3079. - 'null'
  3080. format: iri-reference
  3081. example: 'https://example.com/'
  3082. user:
  3083. readOnly: true
  3084. $ref: '#/components/schemas/User.jsonld'
  3085. userIri:
  3086. type:
  3087. - string
  3088. - 'null'
  3089. format: iri-reference
  3090. example: 'https://example.com/'
  3091. captainName:
  3092. type:
  3093. - string
  3094. - 'null'
  3095. completed:
  3096. type: boolean
  3097. signature:
  3098. readOnly: true
  3099. $ref: '#/components/schemas/MediaObject.jsonld'
  3100. signatureIri:
  3101. type:
  3102. - string
  3103. - 'null'
  3104. format: iri-reference
  3105. example: 'https://example.com/'
  3106. signatureUrl:
  3107. readOnly: true
  3108. type:
  3109. - string
  3110. - 'null'
  3111. completedDate:
  3112. type:
  3113. - string
  3114. - 'null'
  3115. format: date-time
  3116. createdAt:
  3117. readOnly: true
  3118. type:
  3119. - string
  3120. - 'null'
  3121. format: date-time
  3122. required:
  3123. - tripIri
  3124. - userIri
  3125. - completed
  3126. UserTripEvent:
  3127. type: object
  3128. description: ''
  3129. deprecated: false
  3130. properties:
  3131. dbId:
  3132. readOnly: true
  3133. type:
  3134. - integer
  3135. - 'null'
  3136. userTrip:
  3137. readOnly: true
  3138. $ref: '#/components/schemas/UserTrip'
  3139. userTripIri:
  3140. type:
  3141. - string
  3142. - 'null'
  3143. format: iri-reference
  3144. example: 'https://example.com/'
  3145. event:
  3146. readOnly: true
  3147. type: string
  3148. format: iri-reference
  3149. example: 'https://example.com/'
  3150. eventIri:
  3151. type:
  3152. - string
  3153. - 'null'
  3154. format: iri-reference
  3155. example: 'https://example.com/'
  3156. location:
  3157. readOnly: true
  3158. type: string
  3159. format: iri-reference
  3160. example: 'https://example.com/'
  3161. locationIri:
  3162. type:
  3163. - string
  3164. - 'null'
  3165. format: iri-reference
  3166. example: 'https://example.com/'
  3167. date:
  3168. type: string
  3169. format: date-time
  3170. note:
  3171. type:
  3172. - string
  3173. - 'null'
  3174. createdAt:
  3175. readOnly: true
  3176. type:
  3177. - string
  3178. - 'null'
  3179. format: date-time
  3180. required:
  3181. - userTripIri
  3182. - eventIri
  3183. - locationIri
  3184. - date
  3185. UserTripEvent.jsonld:
  3186. type: object
  3187. description: ''
  3188. deprecated: false
  3189. properties:
  3190. '@context':
  3191. readOnly: true
  3192. oneOf:
  3193. -
  3194. type: string
  3195. -
  3196. type: object
  3197. properties:
  3198. '@vocab':
  3199. type: string
  3200. hydra:
  3201. type: string
  3202. enum: ['http://www.w3.org/ns/hydra/core#']
  3203. required:
  3204. - '@vocab'
  3205. - hydra
  3206. additionalProperties: true
  3207. '@id':
  3208. readOnly: true
  3209. type: string
  3210. '@type':
  3211. readOnly: true
  3212. type: string
  3213. dbId:
  3214. readOnly: true
  3215. type:
  3216. - integer
  3217. - 'null'
  3218. userTrip:
  3219. readOnly: true
  3220. $ref: '#/components/schemas/UserTrip.jsonld'
  3221. userTripIri:
  3222. type:
  3223. - string
  3224. - 'null'
  3225. format: iri-reference
  3226. example: 'https://example.com/'
  3227. event:
  3228. readOnly: true
  3229. $ref: '#/components/schemas/Event.jsonld'
  3230. eventIri:
  3231. type:
  3232. - string
  3233. - 'null'
  3234. format: iri-reference
  3235. example: 'https://example.com/'
  3236. location:
  3237. readOnly: true
  3238. $ref: '#/components/schemas/Location.jsonld'
  3239. locationIri:
  3240. type:
  3241. - string
  3242. - 'null'
  3243. format: iri-reference
  3244. example: 'https://example.com/'
  3245. date:
  3246. type: string
  3247. format: date-time
  3248. note:
  3249. type:
  3250. - string
  3251. - 'null'
  3252. createdAt:
  3253. readOnly: true
  3254. type:
  3255. - string
  3256. - 'null'
  3257. format: date-time
  3258. required:
  3259. - userTripIri
  3260. - eventIri
  3261. - locationIri
  3262. - date
  3263. Vessel:
  3264. type: object
  3265. description: ''
  3266. deprecated: false
  3267. properties:
  3268. dbId:
  3269. readOnly: true
  3270. type:
  3271. - integer
  3272. - 'null'
  3273. name:
  3274. type: string
  3275. code:
  3276. type: string
  3277. company:
  3278. readOnly: true
  3279. type: string
  3280. format: iri-reference
  3281. example: 'https://example.com/'
  3282. companyIri:
  3283. type:
  3284. - string
  3285. - 'null'
  3286. format: iri-reference
  3287. example: 'https://example.com/'
  3288. createdAt:
  3289. readOnly: true
  3290. type:
  3291. - string
  3292. - 'null'
  3293. format: date-time
  3294. required:
  3295. - name
  3296. - code
  3297. - companyIri
  3298. Vessel.jsonld:
  3299. type: object
  3300. description: ''
  3301. deprecated: false
  3302. properties:
  3303. '@context':
  3304. readOnly: true
  3305. oneOf:
  3306. -
  3307. type: string
  3308. -
  3309. type: object
  3310. properties:
  3311. '@vocab':
  3312. type: string
  3313. hydra:
  3314. type: string
  3315. enum: ['http://www.w3.org/ns/hydra/core#']
  3316. required:
  3317. - '@vocab'
  3318. - hydra
  3319. additionalProperties: true
  3320. '@id':
  3321. readOnly: true
  3322. type: string
  3323. '@type':
  3324. readOnly: true
  3325. type: string
  3326. dbId:
  3327. readOnly: true
  3328. type:
  3329. - integer
  3330. - 'null'
  3331. name:
  3332. type: string
  3333. code:
  3334. type: string
  3335. company:
  3336. readOnly: true
  3337. $ref: '#/components/schemas/ShippingCompany.jsonld'
  3338. companyIri:
  3339. type:
  3340. - string
  3341. - 'null'
  3342. format: iri-reference
  3343. example: 'https://example.com/'
  3344. createdAt:
  3345. readOnly: true
  3346. type:
  3347. - string
  3348. - 'null'
  3349. format: date-time
  3350. required:
  3351. - name
  3352. - code
  3353. - companyIri
  3354. Zone:
  3355. type: object
  3356. description: ''
  3357. deprecated: false
  3358. properties:
  3359. dbId:
  3360. readOnly: true
  3361. type:
  3362. - integer
  3363. - 'null'
  3364. name:
  3365. type: string
  3366. createdAt:
  3367. readOnly: true
  3368. type:
  3369. - string
  3370. - 'null'
  3371. format: date-time
  3372. required:
  3373. - name
  3374. Zone.jsonld:
  3375. type: object
  3376. description: ''
  3377. deprecated: false
  3378. properties:
  3379. '@context':
  3380. readOnly: true
  3381. oneOf:
  3382. -
  3383. type: string
  3384. -
  3385. type: object
  3386. properties:
  3387. '@vocab':
  3388. type: string
  3389. hydra:
  3390. type: string
  3391. enum: ['http://www.w3.org/ns/hydra/core#']
  3392. required:
  3393. - '@vocab'
  3394. - hydra
  3395. additionalProperties: true
  3396. '@id':
  3397. readOnly: true
  3398. type: string
  3399. '@type':
  3400. readOnly: true
  3401. type: string
  3402. dbId:
  3403. readOnly: true
  3404. type:
  3405. - integer
  3406. - 'null'
  3407. name:
  3408. type: string
  3409. createdAt:
  3410. readOnly: true
  3411. type:
  3412. - string
  3413. - 'null'
  3414. format: date-time
  3415. required:
  3416. - name
  3417. Credentials:
  3418. type: object
  3419. properties:
  3420. email:
  3421. type: string
  3422. example: user@example.com
  3423. password:
  3424. type: string
  3425. example: password123
  3426. AuthResponse:
  3427. type: object
  3428. properties:
  3429. '@id':
  3430. type: string
  3431. example: /api/users/1
  3432. dbId:
  3433. type: integer
  3434. example: 1
  3435. token:
  3436. type: string
  3437. example: JWT_TOKEN
  3438. responses: { }
  3439. parameters: { }
  3440. examples: { }
  3441. requestBodies: { }
  3442. headers: { }
  3443. securitySchemes:
  3444. JWT:
  3445. type: http
  3446. scheme: bearer
  3447. bearerFormat: JWT
  3448. security:
  3449. -
  3450. JWT: []
  3451. tags: []
  3452. webhooks: { }