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

5651 строка
162 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. '403':
  52. description: Forbidden
  53. content:
  54. application/ld+json:
  55. schema:
  56. $ref: '#/components/schemas/Error.jsonld'
  57. application/problem+json:
  58. schema:
  59. $ref: '#/components/schemas/Error'
  60. application/json:
  61. schema:
  62. $ref: '#/components/schemas/Error'
  63. links: { }
  64. summary: 'Retrieves the collection of Event resources.'
  65. description: 'Retrieves the collection of Event resources.'
  66. parameters:
  67. -
  68. name: page
  69. in: query
  70. description: 'The collection page number'
  71. required: false
  72. deprecated: false
  73. allowEmptyValue: true
  74. schema:
  75. type: integer
  76. default: 1
  77. style: form
  78. explode: false
  79. allowReserved: false
  80. -
  81. name: itemsPerPage
  82. in: query
  83. description: 'The number of items per page'
  84. required: false
  85. deprecated: false
  86. allowEmptyValue: true
  87. schema:
  88. type: integer
  89. default: 50
  90. minimum: 0
  91. maximum: 200
  92. style: form
  93. explode: false
  94. allowReserved: false
  95. -
  96. name: name
  97. in: query
  98. description: ''
  99. required: false
  100. deprecated: false
  101. allowEmptyValue: false
  102. schema:
  103. type: string
  104. style: form
  105. explode: false
  106. allowReserved: false
  107. -
  108. name: custom_json_filter
  109. in: query
  110. description: ''
  111. required: false
  112. deprecated: false
  113. allowEmptyValue: false
  114. schema:
  115. type: string
  116. style: form
  117. explode: false
  118. allowReserved: false
  119. -
  120. name: custom_json_order
  121. in: query
  122. description: ''
  123. required: false
  124. deprecated: false
  125. allowEmptyValue: true
  126. schema:
  127. type: string
  128. style: form
  129. explode: false
  130. allowReserved: false
  131. deprecated: false
  132. '/api/events/{id}':
  133. get:
  134. operationId: api_events_id_get
  135. tags:
  136. - Event
  137. responses:
  138. '200':
  139. description: 'Event resource'
  140. content:
  141. application/ld+json:
  142. schema:
  143. $ref: '#/components/schemas/Event.jsonld'
  144. '403':
  145. description: Forbidden
  146. content:
  147. application/ld+json:
  148. schema:
  149. $ref: '#/components/schemas/Error.jsonld'
  150. application/problem+json:
  151. schema:
  152. $ref: '#/components/schemas/Error'
  153. application/json:
  154. schema:
  155. $ref: '#/components/schemas/Error'
  156. links: { }
  157. '404':
  158. description: 'Not found'
  159. content:
  160. application/ld+json:
  161. schema:
  162. $ref: '#/components/schemas/Error.jsonld'
  163. application/problem+json:
  164. schema:
  165. $ref: '#/components/schemas/Error'
  166. application/json:
  167. schema:
  168. $ref: '#/components/schemas/Error'
  169. links: { }
  170. summary: 'Retrieves a Event resource.'
  171. description: 'Retrieves a Event resource.'
  172. parameters:
  173. -
  174. name: id
  175. in: path
  176. description: 'Event identifier'
  177. required: true
  178. deprecated: false
  179. allowEmptyValue: false
  180. schema:
  181. type: string
  182. style: simple
  183. explode: false
  184. allowReserved: false
  185. deprecated: false
  186. /api/locations:
  187. get:
  188. operationId: api_locations_get_collection
  189. tags:
  190. - Location
  191. responses:
  192. '200':
  193. description: 'Location collection'
  194. content:
  195. application/ld+json:
  196. schema:
  197. type: object
  198. properties:
  199. member: { type: array, items: { $ref: '#/components/schemas/Location.jsonld' } }
  200. totalItems: { type: integer, minimum: 0 }
  201. 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 } }
  202. 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 } } } } } }
  203. required:
  204. - member
  205. '403':
  206. description: Forbidden
  207. content:
  208. application/ld+json:
  209. schema:
  210. $ref: '#/components/schemas/Error.jsonld'
  211. application/problem+json:
  212. schema:
  213. $ref: '#/components/schemas/Error'
  214. application/json:
  215. schema:
  216. $ref: '#/components/schemas/Error'
  217. links: { }
  218. summary: 'Retrieves the collection of Location resources.'
  219. description: 'Retrieves the collection of Location resources.'
  220. parameters:
  221. -
  222. name: page
  223. in: query
  224. description: 'The collection page number'
  225. required: false
  226. deprecated: false
  227. allowEmptyValue: true
  228. schema:
  229. type: integer
  230. default: 1
  231. style: form
  232. explode: false
  233. allowReserved: false
  234. -
  235. name: itemsPerPage
  236. in: query
  237. description: 'The number of items per page'
  238. required: false
  239. deprecated: false
  240. allowEmptyValue: true
  241. schema:
  242. type: integer
  243. default: 50
  244. minimum: 0
  245. maximum: 200
  246. style: form
  247. explode: false
  248. allowReserved: false
  249. -
  250. name: locationNameCodeSearch
  251. in: query
  252. description: ''
  253. required: false
  254. deprecated: false
  255. allowEmptyValue: true
  256. schema:
  257. type: string
  258. style: form
  259. explode: false
  260. allowReserved: false
  261. -
  262. name: custom_json_filter
  263. in: query
  264. description: ''
  265. required: false
  266. deprecated: false
  267. allowEmptyValue: false
  268. schema:
  269. type: string
  270. style: form
  271. explode: false
  272. allowReserved: false
  273. -
  274. name: custom_json_order
  275. in: query
  276. description: ''
  277. required: false
  278. deprecated: false
  279. allowEmptyValue: true
  280. schema:
  281. type: string
  282. style: form
  283. explode: false
  284. allowReserved: false
  285. deprecated: false
  286. post:
  287. operationId: api_locations_post
  288. tags:
  289. - Location
  290. responses:
  291. '201':
  292. description: 'Location resource created'
  293. content:
  294. application/ld+json:
  295. schema:
  296. $ref: '#/components/schemas/Location.jsonld'
  297. links: { }
  298. '400':
  299. description: 'Invalid input'
  300. content:
  301. application/ld+json:
  302. schema:
  303. $ref: '#/components/schemas/Error.jsonld'
  304. application/problem+json:
  305. schema:
  306. $ref: '#/components/schemas/Error'
  307. application/json:
  308. schema:
  309. $ref: '#/components/schemas/Error'
  310. links: { }
  311. '422':
  312. description: 'An error occurred'
  313. content:
  314. application/ld+json:
  315. schema:
  316. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  317. application/problem+json:
  318. schema:
  319. $ref: '#/components/schemas/ConstraintViolation-json'
  320. application/json:
  321. schema:
  322. $ref: '#/components/schemas/ConstraintViolation-json'
  323. links: { }
  324. '403':
  325. description: Forbidden
  326. content:
  327. application/ld+json:
  328. schema:
  329. $ref: '#/components/schemas/Error.jsonld'
  330. application/problem+json:
  331. schema:
  332. $ref: '#/components/schemas/Error'
  333. application/json:
  334. schema:
  335. $ref: '#/components/schemas/Error'
  336. links: { }
  337. summary: 'Creates a Location resource.'
  338. description: 'Creates a Location resource.'
  339. parameters: []
  340. requestBody:
  341. description: 'The new Location resource'
  342. content:
  343. application/ld+json:
  344. schema:
  345. $ref: '#/components/schemas/Location.jsonld'
  346. required: true
  347. deprecated: false
  348. '/api/locations/{id}':
  349. get:
  350. operationId: api_locations_id_get
  351. tags:
  352. - Location
  353. responses:
  354. '200':
  355. description: 'Location resource'
  356. content:
  357. application/ld+json:
  358. schema:
  359. $ref: '#/components/schemas/Location.jsonld'
  360. '403':
  361. description: Forbidden
  362. content:
  363. application/ld+json:
  364. schema:
  365. $ref: '#/components/schemas/Error.jsonld'
  366. application/problem+json:
  367. schema:
  368. $ref: '#/components/schemas/Error'
  369. application/json:
  370. schema:
  371. $ref: '#/components/schemas/Error'
  372. links: { }
  373. '404':
  374. description: 'Not found'
  375. content:
  376. application/ld+json:
  377. schema:
  378. $ref: '#/components/schemas/Error.jsonld'
  379. application/problem+json:
  380. schema:
  381. $ref: '#/components/schemas/Error'
  382. application/json:
  383. schema:
  384. $ref: '#/components/schemas/Error'
  385. links: { }
  386. summary: 'Retrieves a Location resource.'
  387. description: 'Retrieves a Location resource.'
  388. parameters:
  389. -
  390. name: id
  391. in: path
  392. description: 'Location identifier'
  393. required: true
  394. deprecated: false
  395. allowEmptyValue: false
  396. schema:
  397. type: string
  398. style: simple
  399. explode: false
  400. allowReserved: false
  401. deprecated: false
  402. delete:
  403. operationId: api_locations_id_delete
  404. tags:
  405. - Location
  406. responses:
  407. '204':
  408. description: 'Location resource deleted'
  409. '403':
  410. description: Forbidden
  411. content:
  412. application/ld+json:
  413. schema:
  414. $ref: '#/components/schemas/Error.jsonld'
  415. application/problem+json:
  416. schema:
  417. $ref: '#/components/schemas/Error'
  418. application/json:
  419. schema:
  420. $ref: '#/components/schemas/Error'
  421. links: { }
  422. '404':
  423. description: 'Not found'
  424. content:
  425. application/ld+json:
  426. schema:
  427. $ref: '#/components/schemas/Error.jsonld'
  428. application/problem+json:
  429. schema:
  430. $ref: '#/components/schemas/Error'
  431. application/json:
  432. schema:
  433. $ref: '#/components/schemas/Error'
  434. links: { }
  435. summary: 'Removes the Location resource.'
  436. description: 'Removes the Location resource.'
  437. parameters:
  438. -
  439. name: id
  440. in: path
  441. description: 'Location identifier'
  442. required: true
  443. deprecated: false
  444. allowEmptyValue: false
  445. schema:
  446. type: string
  447. style: simple
  448. explode: false
  449. allowReserved: false
  450. deprecated: false
  451. patch:
  452. operationId: api_locations_id_patch
  453. tags:
  454. - Location
  455. responses:
  456. '200':
  457. description: 'Location resource updated'
  458. content:
  459. application/ld+json:
  460. schema:
  461. $ref: '#/components/schemas/Location.jsonld'
  462. links: { }
  463. '400':
  464. description: 'Invalid input'
  465. content:
  466. application/ld+json:
  467. schema:
  468. $ref: '#/components/schemas/Error.jsonld'
  469. application/problem+json:
  470. schema:
  471. $ref: '#/components/schemas/Error'
  472. application/json:
  473. schema:
  474. $ref: '#/components/schemas/Error'
  475. links: { }
  476. '422':
  477. description: 'An error occurred'
  478. content:
  479. application/ld+json:
  480. schema:
  481. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  482. application/problem+json:
  483. schema:
  484. $ref: '#/components/schemas/ConstraintViolation-json'
  485. application/json:
  486. schema:
  487. $ref: '#/components/schemas/ConstraintViolation-json'
  488. links: { }
  489. '403':
  490. description: Forbidden
  491. content:
  492. application/ld+json:
  493. schema:
  494. $ref: '#/components/schemas/Error.jsonld'
  495. application/problem+json:
  496. schema:
  497. $ref: '#/components/schemas/Error'
  498. application/json:
  499. schema:
  500. $ref: '#/components/schemas/Error'
  501. links: { }
  502. '404':
  503. description: 'Not found'
  504. content:
  505. application/ld+json:
  506. schema:
  507. $ref: '#/components/schemas/Error.jsonld'
  508. application/problem+json:
  509. schema:
  510. $ref: '#/components/schemas/Error'
  511. application/json:
  512. schema:
  513. $ref: '#/components/schemas/Error'
  514. links: { }
  515. summary: 'Updates the Location resource.'
  516. description: 'Updates the Location resource.'
  517. parameters:
  518. -
  519. name: id
  520. in: path
  521. description: 'Location identifier'
  522. required: true
  523. deprecated: false
  524. allowEmptyValue: false
  525. schema:
  526. type: string
  527. style: simple
  528. explode: false
  529. allowReserved: false
  530. requestBody:
  531. description: 'The updated Location resource'
  532. content:
  533. application/merge-patch+json:
  534. schema:
  535. $ref: '#/components/schemas/Location'
  536. required: true
  537. deprecated: false
  538. /api/media_objects:
  539. get:
  540. operationId: api_media_objects_get_collection
  541. tags:
  542. - MediaObject
  543. responses:
  544. '200':
  545. description: 'MediaObject collection'
  546. content:
  547. application/ld+json:
  548. schema:
  549. type: object
  550. properties:
  551. member: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld' } }
  552. totalItems: { type: integer, minimum: 0 }
  553. 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 } }
  554. 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 } } } } } }
  555. required:
  556. - member
  557. '403':
  558. description: Forbidden
  559. content:
  560. application/ld+json:
  561. schema:
  562. $ref: '#/components/schemas/Error.jsonld'
  563. application/problem+json:
  564. schema:
  565. $ref: '#/components/schemas/Error'
  566. application/json:
  567. schema:
  568. $ref: '#/components/schemas/Error'
  569. links: { }
  570. summary: 'Retrieves the collection of MediaObject resources.'
  571. description: 'Retrieves the collection of MediaObject resources.'
  572. parameters:
  573. -
  574. name: page
  575. in: query
  576. description: 'The collection page number'
  577. required: false
  578. deprecated: false
  579. allowEmptyValue: true
  580. schema:
  581. type: integer
  582. default: 1
  583. style: form
  584. explode: false
  585. allowReserved: false
  586. -
  587. name: itemsPerPage
  588. in: query
  589. description: 'The number of items per page'
  590. required: false
  591. deprecated: false
  592. allowEmptyValue: true
  593. schema:
  594. type: integer
  595. default: 50
  596. minimum: 0
  597. maximum: 200
  598. style: form
  599. explode: false
  600. allowReserved: false
  601. deprecated: false
  602. post:
  603. operationId: api_media_objects_post
  604. tags:
  605. - MediaObject
  606. responses:
  607. '201':
  608. description: 'MediaObject resource created'
  609. content:
  610. application/ld+json:
  611. schema:
  612. $ref: '#/components/schemas/MediaObject.jsonld'
  613. links: { }
  614. '400':
  615. description: 'Invalid input'
  616. content:
  617. application/ld+json:
  618. schema:
  619. $ref: '#/components/schemas/Error.jsonld'
  620. application/problem+json:
  621. schema:
  622. $ref: '#/components/schemas/Error'
  623. application/json:
  624. schema:
  625. $ref: '#/components/schemas/Error'
  626. links: { }
  627. '422':
  628. description: 'An error occurred'
  629. content:
  630. application/ld+json:
  631. schema:
  632. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  633. application/problem+json:
  634. schema:
  635. $ref: '#/components/schemas/ConstraintViolation-json'
  636. application/json:
  637. schema:
  638. $ref: '#/components/schemas/ConstraintViolation-json'
  639. links: { }
  640. '403':
  641. description: Forbidden
  642. content:
  643. application/ld+json:
  644. schema:
  645. $ref: '#/components/schemas/Error.jsonld'
  646. application/problem+json:
  647. schema:
  648. $ref: '#/components/schemas/Error'
  649. application/json:
  650. schema:
  651. $ref: '#/components/schemas/Error'
  652. links: { }
  653. summary: 'Creates a MediaObject resource.'
  654. description: 'Creates a MediaObject resource.'
  655. parameters: []
  656. requestBody:
  657. description: 'The new MediaObject resource'
  658. content:
  659. multipart/form-data:
  660. schema:
  661. type: object
  662. properties:
  663. file:
  664. type: string
  665. format: binary
  666. required: false
  667. deprecated: false
  668. '/api/media_objects/{id}':
  669. get:
  670. operationId: api_media_objects_id_get
  671. tags:
  672. - MediaObject
  673. responses:
  674. '200':
  675. description: 'MediaObject resource'
  676. content:
  677. application/ld+json:
  678. schema:
  679. $ref: '#/components/schemas/MediaObject.jsonld'
  680. '403':
  681. description: Forbidden
  682. content:
  683. application/ld+json:
  684. schema:
  685. $ref: '#/components/schemas/Error.jsonld'
  686. application/problem+json:
  687. schema:
  688. $ref: '#/components/schemas/Error'
  689. application/json:
  690. schema:
  691. $ref: '#/components/schemas/Error'
  692. links: { }
  693. '404':
  694. description: 'Not found'
  695. content:
  696. application/ld+json:
  697. schema:
  698. $ref: '#/components/schemas/Error.jsonld'
  699. application/problem+json:
  700. schema:
  701. $ref: '#/components/schemas/Error'
  702. application/json:
  703. schema:
  704. $ref: '#/components/schemas/Error'
  705. links: { }
  706. summary: 'Retrieves a MediaObject resource.'
  707. description: 'Retrieves a MediaObject resource.'
  708. parameters:
  709. -
  710. name: id
  711. in: path
  712. description: 'MediaObject identifier'
  713. required: true
  714. deprecated: false
  715. allowEmptyValue: false
  716. schema:
  717. type: string
  718. style: simple
  719. explode: false
  720. allowReserved: false
  721. deprecated: false
  722. delete:
  723. operationId: api_media_objects_id_delete
  724. tags:
  725. - MediaObject
  726. responses:
  727. '204':
  728. description: 'MediaObject resource deleted'
  729. '403':
  730. description: Forbidden
  731. content:
  732. application/ld+json:
  733. schema:
  734. $ref: '#/components/schemas/Error.jsonld'
  735. application/problem+json:
  736. schema:
  737. $ref: '#/components/schemas/Error'
  738. application/json:
  739. schema:
  740. $ref: '#/components/schemas/Error'
  741. links: { }
  742. '404':
  743. description: 'Not found'
  744. content:
  745. application/ld+json:
  746. schema:
  747. $ref: '#/components/schemas/Error.jsonld'
  748. application/problem+json:
  749. schema:
  750. $ref: '#/components/schemas/Error'
  751. application/json:
  752. schema:
  753. $ref: '#/components/schemas/Error'
  754. links: { }
  755. summary: 'Removes the MediaObject resource.'
  756. description: 'Removes the MediaObject resource.'
  757. parameters:
  758. -
  759. name: id
  760. in: path
  761. description: 'MediaObject identifier'
  762. required: true
  763. deprecated: false
  764. allowEmptyValue: false
  765. schema:
  766. type: string
  767. style: simple
  768. explode: false
  769. allowReserved: false
  770. deprecated: false
  771. /api/shipping_companies:
  772. get:
  773. operationId: api_shipping_companies_get_collection
  774. tags:
  775. - ShippingCompany
  776. responses:
  777. '200':
  778. description: 'ShippingCompany collection'
  779. content:
  780. application/ld+json:
  781. schema:
  782. type: object
  783. properties:
  784. member: { type: array, items: { $ref: '#/components/schemas/ShippingCompany.jsonld' } }
  785. totalItems: { type: integer, minimum: 0 }
  786. 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 } }
  787. 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 } } } } } }
  788. required:
  789. - member
  790. '403':
  791. description: Forbidden
  792. content:
  793. application/ld+json:
  794. schema:
  795. $ref: '#/components/schemas/Error.jsonld'
  796. application/problem+json:
  797. schema:
  798. $ref: '#/components/schemas/Error'
  799. application/json:
  800. schema:
  801. $ref: '#/components/schemas/Error'
  802. links: { }
  803. summary: 'Retrieves the collection of ShippingCompany resources.'
  804. description: 'Retrieves the collection of ShippingCompany resources.'
  805. parameters:
  806. -
  807. name: page
  808. in: query
  809. description: 'The collection page number'
  810. required: false
  811. deprecated: false
  812. allowEmptyValue: true
  813. schema:
  814. type: integer
  815. default: 1
  816. style: form
  817. explode: false
  818. allowReserved: false
  819. -
  820. name: itemsPerPage
  821. in: query
  822. description: 'The number of items per page'
  823. required: false
  824. deprecated: false
  825. allowEmptyValue: true
  826. schema:
  827. type: integer
  828. default: 50
  829. minimum: 0
  830. maximum: 200
  831. style: form
  832. explode: false
  833. allowReserved: false
  834. -
  835. name: name
  836. in: query
  837. description: ''
  838. required: false
  839. deprecated: false
  840. allowEmptyValue: false
  841. schema:
  842. type: string
  843. style: form
  844. explode: false
  845. allowReserved: false
  846. -
  847. name: custom_json_filter
  848. in: query
  849. description: ''
  850. required: false
  851. deprecated: false
  852. allowEmptyValue: false
  853. schema:
  854. type: string
  855. style: form
  856. explode: false
  857. allowReserved: false
  858. -
  859. name: custom_json_order
  860. in: query
  861. description: ''
  862. required: false
  863. deprecated: false
  864. allowEmptyValue: true
  865. schema:
  866. type: string
  867. style: form
  868. explode: false
  869. allowReserved: false
  870. deprecated: false
  871. post:
  872. operationId: api_shipping_companies_post
  873. tags:
  874. - ShippingCompany
  875. responses:
  876. '201':
  877. description: 'ShippingCompany resource created'
  878. content:
  879. application/ld+json:
  880. schema:
  881. $ref: '#/components/schemas/ShippingCompany.jsonld'
  882. links: { }
  883. '400':
  884. description: 'Invalid input'
  885. content:
  886. application/ld+json:
  887. schema:
  888. $ref: '#/components/schemas/Error.jsonld'
  889. application/problem+json:
  890. schema:
  891. $ref: '#/components/schemas/Error'
  892. application/json:
  893. schema:
  894. $ref: '#/components/schemas/Error'
  895. links: { }
  896. '422':
  897. description: 'An error occurred'
  898. content:
  899. application/ld+json:
  900. schema:
  901. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  902. application/problem+json:
  903. schema:
  904. $ref: '#/components/schemas/ConstraintViolation-json'
  905. application/json:
  906. schema:
  907. $ref: '#/components/schemas/ConstraintViolation-json'
  908. links: { }
  909. '403':
  910. description: Forbidden
  911. content:
  912. application/ld+json:
  913. schema:
  914. $ref: '#/components/schemas/Error.jsonld'
  915. application/problem+json:
  916. schema:
  917. $ref: '#/components/schemas/Error'
  918. application/json:
  919. schema:
  920. $ref: '#/components/schemas/Error'
  921. links: { }
  922. summary: 'Creates a ShippingCompany resource.'
  923. description: 'Creates a ShippingCompany resource.'
  924. parameters: []
  925. requestBody:
  926. description: 'The new ShippingCompany resource'
  927. content:
  928. application/ld+json:
  929. schema:
  930. $ref: '#/components/schemas/ShippingCompany.jsonld'
  931. required: true
  932. deprecated: false
  933. '/api/shipping_companies/{id}':
  934. get:
  935. operationId: api_shipping_companies_id_get
  936. tags:
  937. - ShippingCompany
  938. responses:
  939. '200':
  940. description: 'ShippingCompany resource'
  941. content:
  942. application/ld+json:
  943. schema:
  944. $ref: '#/components/schemas/ShippingCompany.jsonld'
  945. '403':
  946. description: Forbidden
  947. content:
  948. application/ld+json:
  949. schema:
  950. $ref: '#/components/schemas/Error.jsonld'
  951. application/problem+json:
  952. schema:
  953. $ref: '#/components/schemas/Error'
  954. application/json:
  955. schema:
  956. $ref: '#/components/schemas/Error'
  957. links: { }
  958. '404':
  959. description: 'Not found'
  960. content:
  961. application/ld+json:
  962. schema:
  963. $ref: '#/components/schemas/Error.jsonld'
  964. application/problem+json:
  965. schema:
  966. $ref: '#/components/schemas/Error'
  967. application/json:
  968. schema:
  969. $ref: '#/components/schemas/Error'
  970. links: { }
  971. summary: 'Retrieves a ShippingCompany resource.'
  972. description: 'Retrieves a ShippingCompany resource.'
  973. parameters:
  974. -
  975. name: id
  976. in: path
  977. description: 'ShippingCompany identifier'
  978. required: true
  979. deprecated: false
  980. allowEmptyValue: false
  981. schema:
  982. type: string
  983. style: simple
  984. explode: false
  985. allowReserved: false
  986. deprecated: false
  987. delete:
  988. operationId: api_shipping_companies_id_delete
  989. tags:
  990. - ShippingCompany
  991. responses:
  992. '204':
  993. description: 'ShippingCompany resource deleted'
  994. '403':
  995. description: Forbidden
  996. content:
  997. application/ld+json:
  998. schema:
  999. $ref: '#/components/schemas/Error.jsonld'
  1000. application/problem+json:
  1001. schema:
  1002. $ref: '#/components/schemas/Error'
  1003. application/json:
  1004. schema:
  1005. $ref: '#/components/schemas/Error'
  1006. links: { }
  1007. '404':
  1008. description: 'Not found'
  1009. content:
  1010. application/ld+json:
  1011. schema:
  1012. $ref: '#/components/schemas/Error.jsonld'
  1013. application/problem+json:
  1014. schema:
  1015. $ref: '#/components/schemas/Error'
  1016. application/json:
  1017. schema:
  1018. $ref: '#/components/schemas/Error'
  1019. links: { }
  1020. summary: 'Removes the ShippingCompany resource.'
  1021. description: 'Removes the ShippingCompany resource.'
  1022. parameters:
  1023. -
  1024. name: id
  1025. in: path
  1026. description: 'ShippingCompany identifier'
  1027. required: true
  1028. deprecated: false
  1029. allowEmptyValue: false
  1030. schema:
  1031. type: string
  1032. style: simple
  1033. explode: false
  1034. allowReserved: false
  1035. deprecated: false
  1036. patch:
  1037. operationId: api_shipping_companies_id_patch
  1038. tags:
  1039. - ShippingCompany
  1040. responses:
  1041. '200':
  1042. description: 'ShippingCompany resource updated'
  1043. content:
  1044. application/ld+json:
  1045. schema:
  1046. $ref: '#/components/schemas/ShippingCompany.jsonld'
  1047. links: { }
  1048. '400':
  1049. description: 'Invalid input'
  1050. content:
  1051. application/ld+json:
  1052. schema:
  1053. $ref: '#/components/schemas/Error.jsonld'
  1054. application/problem+json:
  1055. schema:
  1056. $ref: '#/components/schemas/Error'
  1057. application/json:
  1058. schema:
  1059. $ref: '#/components/schemas/Error'
  1060. links: { }
  1061. '422':
  1062. description: 'An error occurred'
  1063. content:
  1064. application/ld+json:
  1065. schema:
  1066. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1067. application/problem+json:
  1068. schema:
  1069. $ref: '#/components/schemas/ConstraintViolation-json'
  1070. application/json:
  1071. schema:
  1072. $ref: '#/components/schemas/ConstraintViolation-json'
  1073. links: { }
  1074. '403':
  1075. description: Forbidden
  1076. content:
  1077. application/ld+json:
  1078. schema:
  1079. $ref: '#/components/schemas/Error.jsonld'
  1080. application/problem+json:
  1081. schema:
  1082. $ref: '#/components/schemas/Error'
  1083. application/json:
  1084. schema:
  1085. $ref: '#/components/schemas/Error'
  1086. links: { }
  1087. '404':
  1088. description: 'Not found'
  1089. content:
  1090. application/ld+json:
  1091. schema:
  1092. $ref: '#/components/schemas/Error.jsonld'
  1093. application/problem+json:
  1094. schema:
  1095. $ref: '#/components/schemas/Error'
  1096. application/json:
  1097. schema:
  1098. $ref: '#/components/schemas/Error'
  1099. links: { }
  1100. summary: 'Updates the ShippingCompany resource.'
  1101. description: 'Updates the ShippingCompany resource.'
  1102. parameters:
  1103. -
  1104. name: id
  1105. in: path
  1106. description: 'ShippingCompany identifier'
  1107. required: true
  1108. deprecated: false
  1109. allowEmptyValue: false
  1110. schema:
  1111. type: string
  1112. style: simple
  1113. explode: false
  1114. allowReserved: false
  1115. requestBody:
  1116. description: 'The updated ShippingCompany resource'
  1117. content:
  1118. application/merge-patch+json:
  1119. schema:
  1120. $ref: '#/components/schemas/ShippingCompany'
  1121. required: true
  1122. deprecated: false
  1123. /api/trips:
  1124. get:
  1125. operationId: api_trips_get_collection
  1126. tags:
  1127. - Trip
  1128. responses:
  1129. '200':
  1130. description: 'Trip collection'
  1131. content:
  1132. application/ld+json:
  1133. schema:
  1134. type: object
  1135. properties:
  1136. member: { type: array, items: { $ref: '#/components/schemas/Trip.jsonld' } }
  1137. totalItems: { type: integer, minimum: 0 }
  1138. view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } }
  1139. search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
  1140. required:
  1141. - member
  1142. '403':
  1143. description: Forbidden
  1144. content:
  1145. application/ld+json:
  1146. schema:
  1147. $ref: '#/components/schemas/Error.jsonld'
  1148. application/problem+json:
  1149. schema:
  1150. $ref: '#/components/schemas/Error'
  1151. application/json:
  1152. schema:
  1153. $ref: '#/components/schemas/Error'
  1154. links: { }
  1155. summary: 'Retrieves the collection of Trip resources.'
  1156. description: 'Retrieves the collection of Trip resources.'
  1157. parameters:
  1158. -
  1159. name: page
  1160. in: query
  1161. description: 'The collection page number'
  1162. required: false
  1163. deprecated: false
  1164. allowEmptyValue: true
  1165. schema:
  1166. type: integer
  1167. default: 1
  1168. style: form
  1169. explode: false
  1170. allowReserved: false
  1171. -
  1172. name: itemsPerPage
  1173. in: query
  1174. description: 'The number of items per page'
  1175. required: false
  1176. deprecated: false
  1177. allowEmptyValue: true
  1178. schema:
  1179. type: integer
  1180. default: 50
  1181. minimum: 0
  1182. maximum: 200
  1183. style: form
  1184. explode: false
  1185. allowReserved: false
  1186. -
  1187. name: id
  1188. in: query
  1189. description: ''
  1190. required: false
  1191. deprecated: false
  1192. allowEmptyValue: false
  1193. schema:
  1194. type: integer
  1195. style: form
  1196. explode: false
  1197. allowReserved: false
  1198. -
  1199. name: custom_json_filter
  1200. in: query
  1201. description: ''
  1202. required: false
  1203. deprecated: false
  1204. allowEmptyValue: false
  1205. schema:
  1206. type: string
  1207. style: form
  1208. explode: false
  1209. allowReserved: false
  1210. -
  1211. name: custom_json_order
  1212. in: query
  1213. description: ''
  1214. required: false
  1215. deprecated: false
  1216. allowEmptyValue: true
  1217. schema:
  1218. type: string
  1219. style: form
  1220. explode: false
  1221. allowReserved: false
  1222. deprecated: false
  1223. post:
  1224. operationId: api_trips_post
  1225. tags:
  1226. - Trip
  1227. responses:
  1228. '201':
  1229. description: 'Trip resource created'
  1230. content:
  1231. application/ld+json:
  1232. schema:
  1233. $ref: '#/components/schemas/Trip.jsonld'
  1234. links: { }
  1235. '400':
  1236. description: 'Invalid input'
  1237. content:
  1238. application/ld+json:
  1239. schema:
  1240. $ref: '#/components/schemas/Error.jsonld'
  1241. application/problem+json:
  1242. schema:
  1243. $ref: '#/components/schemas/Error'
  1244. application/json:
  1245. schema:
  1246. $ref: '#/components/schemas/Error'
  1247. links: { }
  1248. '422':
  1249. description: 'An error occurred'
  1250. content:
  1251. application/ld+json:
  1252. schema:
  1253. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1254. application/problem+json:
  1255. schema:
  1256. $ref: '#/components/schemas/ConstraintViolation-json'
  1257. application/json:
  1258. schema:
  1259. $ref: '#/components/schemas/ConstraintViolation-json'
  1260. links: { }
  1261. '403':
  1262. description: Forbidden
  1263. content:
  1264. application/ld+json:
  1265. schema:
  1266. $ref: '#/components/schemas/Error.jsonld'
  1267. application/problem+json:
  1268. schema:
  1269. $ref: '#/components/schemas/Error'
  1270. application/json:
  1271. schema:
  1272. $ref: '#/components/schemas/Error'
  1273. links: { }
  1274. summary: 'Creates a Trip resource.'
  1275. description: 'Creates a Trip resource.'
  1276. parameters: []
  1277. requestBody:
  1278. description: 'The new Trip resource'
  1279. content:
  1280. application/ld+json:
  1281. schema:
  1282. $ref: '#/components/schemas/Trip.jsonld'
  1283. required: true
  1284. deprecated: false
  1285. '/api/trips/{id}':
  1286. get:
  1287. operationId: api_trips_id_get
  1288. tags:
  1289. - Trip
  1290. responses:
  1291. '200':
  1292. description: 'Trip resource'
  1293. content:
  1294. application/ld+json:
  1295. schema:
  1296. $ref: '#/components/schemas/Trip.jsonld'
  1297. '403':
  1298. description: Forbidden
  1299. content:
  1300. application/ld+json:
  1301. schema:
  1302. $ref: '#/components/schemas/Error.jsonld'
  1303. application/problem+json:
  1304. schema:
  1305. $ref: '#/components/schemas/Error'
  1306. application/json:
  1307. schema:
  1308. $ref: '#/components/schemas/Error'
  1309. links: { }
  1310. '404':
  1311. description: 'Not found'
  1312. content:
  1313. application/ld+json:
  1314. schema:
  1315. $ref: '#/components/schemas/Error.jsonld'
  1316. application/problem+json:
  1317. schema:
  1318. $ref: '#/components/schemas/Error'
  1319. application/json:
  1320. schema:
  1321. $ref: '#/components/schemas/Error'
  1322. links: { }
  1323. summary: 'Retrieves a Trip resource.'
  1324. description: 'Retrieves a Trip resource.'
  1325. parameters:
  1326. -
  1327. name: id
  1328. in: path
  1329. description: 'Trip identifier'
  1330. required: true
  1331. deprecated: false
  1332. allowEmptyValue: false
  1333. schema:
  1334. type: string
  1335. style: simple
  1336. explode: false
  1337. allowReserved: false
  1338. deprecated: false
  1339. delete:
  1340. operationId: api_trips_id_delete
  1341. tags:
  1342. - Trip
  1343. responses:
  1344. '204':
  1345. description: 'Trip resource deleted'
  1346. '403':
  1347. description: Forbidden
  1348. content:
  1349. application/ld+json:
  1350. schema:
  1351. $ref: '#/components/schemas/Error.jsonld'
  1352. application/problem+json:
  1353. schema:
  1354. $ref: '#/components/schemas/Error'
  1355. application/json:
  1356. schema:
  1357. $ref: '#/components/schemas/Error'
  1358. links: { }
  1359. '404':
  1360. description: 'Not found'
  1361. content:
  1362. application/ld+json:
  1363. schema:
  1364. $ref: '#/components/schemas/Error.jsonld'
  1365. application/problem+json:
  1366. schema:
  1367. $ref: '#/components/schemas/Error'
  1368. application/json:
  1369. schema:
  1370. $ref: '#/components/schemas/Error'
  1371. links: { }
  1372. summary: 'Removes the Trip resource.'
  1373. description: 'Removes the Trip resource.'
  1374. parameters:
  1375. -
  1376. name: id
  1377. in: path
  1378. description: 'Trip identifier'
  1379. required: true
  1380. deprecated: false
  1381. allowEmptyValue: false
  1382. schema:
  1383. type: string
  1384. style: simple
  1385. explode: false
  1386. allowReserved: false
  1387. deprecated: false
  1388. patch:
  1389. operationId: api_trips_id_patch
  1390. tags:
  1391. - Trip
  1392. responses:
  1393. '200':
  1394. description: 'Trip resource updated'
  1395. content:
  1396. application/ld+json:
  1397. schema:
  1398. $ref: '#/components/schemas/Trip.jsonld'
  1399. links: { }
  1400. '400':
  1401. description: 'Invalid input'
  1402. content:
  1403. application/ld+json:
  1404. schema:
  1405. $ref: '#/components/schemas/Error.jsonld'
  1406. application/problem+json:
  1407. schema:
  1408. $ref: '#/components/schemas/Error'
  1409. application/json:
  1410. schema:
  1411. $ref: '#/components/schemas/Error'
  1412. links: { }
  1413. '422':
  1414. description: 'An error occurred'
  1415. content:
  1416. application/ld+json:
  1417. schema:
  1418. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1419. application/problem+json:
  1420. schema:
  1421. $ref: '#/components/schemas/ConstraintViolation-json'
  1422. application/json:
  1423. schema:
  1424. $ref: '#/components/schemas/ConstraintViolation-json'
  1425. links: { }
  1426. '403':
  1427. description: Forbidden
  1428. content:
  1429. application/ld+json:
  1430. schema:
  1431. $ref: '#/components/schemas/Error.jsonld'
  1432. application/problem+json:
  1433. schema:
  1434. $ref: '#/components/schemas/Error'
  1435. application/json:
  1436. schema:
  1437. $ref: '#/components/schemas/Error'
  1438. links: { }
  1439. '404':
  1440. description: 'Not found'
  1441. content:
  1442. application/ld+json:
  1443. schema:
  1444. $ref: '#/components/schemas/Error.jsonld'
  1445. application/problem+json:
  1446. schema:
  1447. $ref: '#/components/schemas/Error'
  1448. application/json:
  1449. schema:
  1450. $ref: '#/components/schemas/Error'
  1451. links: { }
  1452. summary: 'Updates the Trip resource.'
  1453. description: 'Updates the Trip resource.'
  1454. parameters:
  1455. -
  1456. name: id
  1457. in: path
  1458. description: 'Trip identifier'
  1459. required: true
  1460. deprecated: false
  1461. allowEmptyValue: false
  1462. schema:
  1463. type: string
  1464. style: simple
  1465. explode: false
  1466. allowReserved: false
  1467. requestBody:
  1468. description: 'The updated Trip resource'
  1469. content:
  1470. application/merge-patch+json:
  1471. schema:
  1472. $ref: '#/components/schemas/Trip'
  1473. required: true
  1474. deprecated: false
  1475. /api/trip_locations:
  1476. get:
  1477. operationId: api_trip_locations_get_collection
  1478. tags:
  1479. - TripLocation
  1480. responses:
  1481. '200':
  1482. description: 'TripLocation collection'
  1483. content:
  1484. application/ld+json:
  1485. schema:
  1486. type: object
  1487. properties:
  1488. member: { type: array, items: { $ref: '#/components/schemas/TripLocation.jsonld' } }
  1489. totalItems: { type: integer, minimum: 0 }
  1490. 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 } }
  1491. 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 } } } } } }
  1492. required:
  1493. - member
  1494. '403':
  1495. description: Forbidden
  1496. content:
  1497. application/ld+json:
  1498. schema:
  1499. $ref: '#/components/schemas/Error.jsonld'
  1500. application/problem+json:
  1501. schema:
  1502. $ref: '#/components/schemas/Error'
  1503. application/json:
  1504. schema:
  1505. $ref: '#/components/schemas/Error'
  1506. links: { }
  1507. summary: 'Retrieves the collection of TripLocation resources.'
  1508. description: 'Retrieves the collection of TripLocation resources.'
  1509. parameters:
  1510. -
  1511. name: page
  1512. in: query
  1513. description: 'The collection page number'
  1514. required: false
  1515. deprecated: false
  1516. allowEmptyValue: true
  1517. schema:
  1518. type: integer
  1519. default: 1
  1520. style: form
  1521. explode: false
  1522. allowReserved: false
  1523. -
  1524. name: itemsPerPage
  1525. in: query
  1526. description: 'The number of items per page'
  1527. required: false
  1528. deprecated: false
  1529. allowEmptyValue: true
  1530. schema:
  1531. type: integer
  1532. default: 50
  1533. minimum: 0
  1534. maximum: 200
  1535. style: form
  1536. explode: false
  1537. allowReserved: false
  1538. -
  1539. name: trip
  1540. in: query
  1541. description: ''
  1542. required: false
  1543. deprecated: false
  1544. allowEmptyValue: false
  1545. schema:
  1546. type: string
  1547. style: form
  1548. explode: false
  1549. allowReserved: false
  1550. -
  1551. name: 'trip[]'
  1552. in: query
  1553. description: ''
  1554. required: false
  1555. deprecated: false
  1556. allowEmptyValue: false
  1557. schema:
  1558. type: array
  1559. items:
  1560. type: string
  1561. style: form
  1562. explode: true
  1563. allowReserved: false
  1564. -
  1565. name: custom_json_filter
  1566. in: query
  1567. description: ''
  1568. required: false
  1569. deprecated: false
  1570. allowEmptyValue: false
  1571. schema:
  1572. type: string
  1573. style: form
  1574. explode: false
  1575. allowReserved: false
  1576. -
  1577. name: custom_json_order
  1578. in: query
  1579. description: ''
  1580. required: false
  1581. deprecated: false
  1582. allowEmptyValue: true
  1583. schema:
  1584. type: string
  1585. style: form
  1586. explode: false
  1587. allowReserved: false
  1588. deprecated: false
  1589. post:
  1590. operationId: api_trip_locations_post
  1591. tags:
  1592. - TripLocation
  1593. responses:
  1594. '201':
  1595. description: 'TripLocation resource created'
  1596. content:
  1597. application/ld+json:
  1598. schema:
  1599. $ref: '#/components/schemas/TripLocation.jsonld'
  1600. links: { }
  1601. '400':
  1602. description: 'Invalid input'
  1603. content:
  1604. application/ld+json:
  1605. schema:
  1606. $ref: '#/components/schemas/Error.jsonld'
  1607. application/problem+json:
  1608. schema:
  1609. $ref: '#/components/schemas/Error'
  1610. application/json:
  1611. schema:
  1612. $ref: '#/components/schemas/Error'
  1613. links: { }
  1614. '422':
  1615. description: 'An error occurred'
  1616. content:
  1617. application/ld+json:
  1618. schema:
  1619. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1620. application/problem+json:
  1621. schema:
  1622. $ref: '#/components/schemas/ConstraintViolation-json'
  1623. application/json:
  1624. schema:
  1625. $ref: '#/components/schemas/ConstraintViolation-json'
  1626. links: { }
  1627. '403':
  1628. description: Forbidden
  1629. content:
  1630. application/ld+json:
  1631. schema:
  1632. $ref: '#/components/schemas/Error.jsonld'
  1633. application/problem+json:
  1634. schema:
  1635. $ref: '#/components/schemas/Error'
  1636. application/json:
  1637. schema:
  1638. $ref: '#/components/schemas/Error'
  1639. links: { }
  1640. summary: 'Creates a TripLocation resource.'
  1641. description: 'Creates a TripLocation resource.'
  1642. parameters: []
  1643. requestBody:
  1644. description: 'The new TripLocation resource'
  1645. content:
  1646. application/ld+json:
  1647. schema:
  1648. $ref: '#/components/schemas/TripLocation.jsonld'
  1649. required: true
  1650. deprecated: false
  1651. '/api/trip_locations/{id}':
  1652. get:
  1653. operationId: api_trip_locations_id_get
  1654. tags:
  1655. - TripLocation
  1656. responses:
  1657. '200':
  1658. description: 'TripLocation resource'
  1659. content:
  1660. application/ld+json:
  1661. schema:
  1662. $ref: '#/components/schemas/TripLocation.jsonld'
  1663. '403':
  1664. description: Forbidden
  1665. content:
  1666. application/ld+json:
  1667. schema:
  1668. $ref: '#/components/schemas/Error.jsonld'
  1669. application/problem+json:
  1670. schema:
  1671. $ref: '#/components/schemas/Error'
  1672. application/json:
  1673. schema:
  1674. $ref: '#/components/schemas/Error'
  1675. links: { }
  1676. '404':
  1677. description: 'Not found'
  1678. content:
  1679. application/ld+json:
  1680. schema:
  1681. $ref: '#/components/schemas/Error.jsonld'
  1682. application/problem+json:
  1683. schema:
  1684. $ref: '#/components/schemas/Error'
  1685. application/json:
  1686. schema:
  1687. $ref: '#/components/schemas/Error'
  1688. links: { }
  1689. summary: 'Retrieves a TripLocation resource.'
  1690. description: 'Retrieves a TripLocation resource.'
  1691. parameters:
  1692. -
  1693. name: id
  1694. in: path
  1695. description: 'TripLocation identifier'
  1696. required: true
  1697. deprecated: false
  1698. allowEmptyValue: false
  1699. schema:
  1700. type: string
  1701. style: simple
  1702. explode: false
  1703. allowReserved: false
  1704. deprecated: false
  1705. delete:
  1706. operationId: api_trip_locations_id_delete
  1707. tags:
  1708. - TripLocation
  1709. responses:
  1710. '204':
  1711. description: 'TripLocation resource deleted'
  1712. '403':
  1713. description: Forbidden
  1714. content:
  1715. application/ld+json:
  1716. schema:
  1717. $ref: '#/components/schemas/Error.jsonld'
  1718. application/problem+json:
  1719. schema:
  1720. $ref: '#/components/schemas/Error'
  1721. application/json:
  1722. schema:
  1723. $ref: '#/components/schemas/Error'
  1724. links: { }
  1725. '404':
  1726. description: 'Not found'
  1727. content:
  1728. application/ld+json:
  1729. schema:
  1730. $ref: '#/components/schemas/Error.jsonld'
  1731. application/problem+json:
  1732. schema:
  1733. $ref: '#/components/schemas/Error'
  1734. application/json:
  1735. schema:
  1736. $ref: '#/components/schemas/Error'
  1737. links: { }
  1738. summary: 'Removes the TripLocation resource.'
  1739. description: 'Removes the TripLocation resource.'
  1740. parameters:
  1741. -
  1742. name: id
  1743. in: path
  1744. description: 'TripLocation identifier'
  1745. required: true
  1746. deprecated: false
  1747. allowEmptyValue: false
  1748. schema:
  1749. type: string
  1750. style: simple
  1751. explode: false
  1752. allowReserved: false
  1753. deprecated: false
  1754. patch:
  1755. operationId: api_trip_locations_id_patch
  1756. tags:
  1757. - TripLocation
  1758. responses:
  1759. '200':
  1760. description: 'TripLocation resource updated'
  1761. content:
  1762. application/ld+json:
  1763. schema:
  1764. $ref: '#/components/schemas/TripLocation.jsonld'
  1765. links: { }
  1766. '400':
  1767. description: 'Invalid input'
  1768. content:
  1769. application/ld+json:
  1770. schema:
  1771. $ref: '#/components/schemas/Error.jsonld'
  1772. application/problem+json:
  1773. schema:
  1774. $ref: '#/components/schemas/Error'
  1775. application/json:
  1776. schema:
  1777. $ref: '#/components/schemas/Error'
  1778. links: { }
  1779. '422':
  1780. description: 'An error occurred'
  1781. content:
  1782. application/ld+json:
  1783. schema:
  1784. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1785. application/problem+json:
  1786. schema:
  1787. $ref: '#/components/schemas/ConstraintViolation-json'
  1788. application/json:
  1789. schema:
  1790. $ref: '#/components/schemas/ConstraintViolation-json'
  1791. links: { }
  1792. '403':
  1793. description: Forbidden
  1794. content:
  1795. application/ld+json:
  1796. schema:
  1797. $ref: '#/components/schemas/Error.jsonld'
  1798. application/problem+json:
  1799. schema:
  1800. $ref: '#/components/schemas/Error'
  1801. application/json:
  1802. schema:
  1803. $ref: '#/components/schemas/Error'
  1804. links: { }
  1805. '404':
  1806. description: 'Not found'
  1807. content:
  1808. application/ld+json:
  1809. schema:
  1810. $ref: '#/components/schemas/Error.jsonld'
  1811. application/problem+json:
  1812. schema:
  1813. $ref: '#/components/schemas/Error'
  1814. application/json:
  1815. schema:
  1816. $ref: '#/components/schemas/Error'
  1817. links: { }
  1818. summary: 'Updates the TripLocation resource.'
  1819. description: 'Updates the TripLocation resource.'
  1820. parameters:
  1821. -
  1822. name: id
  1823. in: path
  1824. description: 'TripLocation identifier'
  1825. required: true
  1826. deprecated: false
  1827. allowEmptyValue: false
  1828. schema:
  1829. type: string
  1830. style: simple
  1831. explode: false
  1832. allowReserved: false
  1833. requestBody:
  1834. description: 'The updated TripLocation resource'
  1835. content:
  1836. application/merge-patch+json:
  1837. schema:
  1838. $ref: '#/components/schemas/TripLocation'
  1839. required: true
  1840. deprecated: false
  1841. /api/users:
  1842. get:
  1843. operationId: api_users_get_collection
  1844. tags:
  1845. - User
  1846. responses:
  1847. '200':
  1848. description: 'User collection'
  1849. content:
  1850. application/ld+json:
  1851. schema:
  1852. type: object
  1853. properties:
  1854. member: { type: array, items: { $ref: '#/components/schemas/User.jsonld' } }
  1855. totalItems: { type: integer, minimum: 0 }
  1856. 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 } }
  1857. 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 } } } } } }
  1858. required:
  1859. - member
  1860. '403':
  1861. description: Forbidden
  1862. content:
  1863. application/ld+json:
  1864. schema:
  1865. $ref: '#/components/schemas/Error.jsonld'
  1866. application/problem+json:
  1867. schema:
  1868. $ref: '#/components/schemas/Error'
  1869. application/json:
  1870. schema:
  1871. $ref: '#/components/schemas/Error'
  1872. links: { }
  1873. summary: 'Retrieves the collection of User resources.'
  1874. description: 'Retrieves the collection of User resources.'
  1875. parameters:
  1876. -
  1877. name: page
  1878. in: query
  1879. description: 'The collection page number'
  1880. required: false
  1881. deprecated: false
  1882. allowEmptyValue: true
  1883. schema:
  1884. type: integer
  1885. default: 1
  1886. style: form
  1887. explode: false
  1888. allowReserved: false
  1889. -
  1890. name: itemsPerPage
  1891. in: query
  1892. description: 'The number of items per page'
  1893. required: false
  1894. deprecated: false
  1895. allowEmptyValue: true
  1896. schema:
  1897. type: integer
  1898. default: 50
  1899. minimum: 0
  1900. maximum: 200
  1901. style: form
  1902. explode: false
  1903. allowReserved: false
  1904. -
  1905. name: firstName
  1906. in: query
  1907. description: ''
  1908. required: false
  1909. deprecated: false
  1910. allowEmptyValue: false
  1911. schema:
  1912. type: string
  1913. style: form
  1914. explode: false
  1915. allowReserved: false
  1916. -
  1917. name: lastName
  1918. in: query
  1919. description: ''
  1920. required: false
  1921. deprecated: false
  1922. allowEmptyValue: false
  1923. schema:
  1924. type: string
  1925. style: form
  1926. explode: false
  1927. allowReserved: false
  1928. -
  1929. name: userNameSearch
  1930. in: query
  1931. description: ''
  1932. required: false
  1933. deprecated: false
  1934. allowEmptyValue: true
  1935. schema:
  1936. type: string
  1937. style: form
  1938. explode: false
  1939. allowReserved: false
  1940. -
  1941. name: custom_json_filter
  1942. in: query
  1943. description: ''
  1944. required: false
  1945. deprecated: false
  1946. allowEmptyValue: false
  1947. schema:
  1948. type: string
  1949. style: form
  1950. explode: false
  1951. allowReserved: false
  1952. -
  1953. name: custom_json_order
  1954. in: query
  1955. description: ''
  1956. required: false
  1957. deprecated: false
  1958. allowEmptyValue: true
  1959. schema:
  1960. type: string
  1961. style: form
  1962. explode: false
  1963. allowReserved: false
  1964. deprecated: false
  1965. post:
  1966. operationId: api_users_post
  1967. tags:
  1968. - User
  1969. responses:
  1970. '201':
  1971. description: 'User resource created'
  1972. content:
  1973. application/ld+json:
  1974. schema:
  1975. $ref: '#/components/schemas/User.jsonld'
  1976. links: { }
  1977. '400':
  1978. description: 'Invalid input'
  1979. content:
  1980. application/ld+json:
  1981. schema:
  1982. $ref: '#/components/schemas/Error.jsonld'
  1983. application/problem+json:
  1984. schema:
  1985. $ref: '#/components/schemas/Error'
  1986. application/json:
  1987. schema:
  1988. $ref: '#/components/schemas/Error'
  1989. links: { }
  1990. '422':
  1991. description: 'An error occurred'
  1992. content:
  1993. application/ld+json:
  1994. schema:
  1995. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1996. application/problem+json:
  1997. schema:
  1998. $ref: '#/components/schemas/ConstraintViolation-json'
  1999. application/json:
  2000. schema:
  2001. $ref: '#/components/schemas/ConstraintViolation-json'
  2002. links: { }
  2003. '403':
  2004. description: Forbidden
  2005. content:
  2006. application/ld+json:
  2007. schema:
  2008. $ref: '#/components/schemas/Error.jsonld'
  2009. application/problem+json:
  2010. schema:
  2011. $ref: '#/components/schemas/Error'
  2012. application/json:
  2013. schema:
  2014. $ref: '#/components/schemas/Error'
  2015. links: { }
  2016. summary: 'Creates a User resource.'
  2017. description: 'Creates a User resource.'
  2018. parameters: []
  2019. requestBody:
  2020. description: 'The new User resource'
  2021. content:
  2022. application/ld+json:
  2023. schema:
  2024. $ref: '#/components/schemas/User.jsonld'
  2025. required: true
  2026. deprecated: false
  2027. '/api/users/{id}':
  2028. get:
  2029. operationId: api_users_id_get
  2030. tags:
  2031. - User
  2032. responses:
  2033. '200':
  2034. description: 'User resource'
  2035. content:
  2036. application/ld+json:
  2037. schema:
  2038. $ref: '#/components/schemas/User.jsonld'
  2039. '403':
  2040. description: Forbidden
  2041. content:
  2042. application/ld+json:
  2043. schema:
  2044. $ref: '#/components/schemas/Error.jsonld'
  2045. application/problem+json:
  2046. schema:
  2047. $ref: '#/components/schemas/Error'
  2048. application/json:
  2049. schema:
  2050. $ref: '#/components/schemas/Error'
  2051. links: { }
  2052. '404':
  2053. description: 'Not found'
  2054. content:
  2055. application/ld+json:
  2056. schema:
  2057. $ref: '#/components/schemas/Error.jsonld'
  2058. application/problem+json:
  2059. schema:
  2060. $ref: '#/components/schemas/Error'
  2061. application/json:
  2062. schema:
  2063. $ref: '#/components/schemas/Error'
  2064. links: { }
  2065. summary: 'Retrieves a User resource.'
  2066. description: 'Retrieves a User resource.'
  2067. parameters:
  2068. -
  2069. name: id
  2070. in: path
  2071. description: 'User identifier'
  2072. required: true
  2073. deprecated: false
  2074. allowEmptyValue: false
  2075. schema:
  2076. type: string
  2077. style: simple
  2078. explode: false
  2079. allowReserved: false
  2080. deprecated: false
  2081. delete:
  2082. operationId: api_users_id_delete
  2083. tags:
  2084. - User
  2085. responses:
  2086. '204':
  2087. description: 'User resource deleted'
  2088. '403':
  2089. description: Forbidden
  2090. content:
  2091. application/ld+json:
  2092. schema:
  2093. $ref: '#/components/schemas/Error.jsonld'
  2094. application/problem+json:
  2095. schema:
  2096. $ref: '#/components/schemas/Error'
  2097. application/json:
  2098. schema:
  2099. $ref: '#/components/schemas/Error'
  2100. links: { }
  2101. '404':
  2102. description: 'Not found'
  2103. content:
  2104. application/ld+json:
  2105. schema:
  2106. $ref: '#/components/schemas/Error.jsonld'
  2107. application/problem+json:
  2108. schema:
  2109. $ref: '#/components/schemas/Error'
  2110. application/json:
  2111. schema:
  2112. $ref: '#/components/schemas/Error'
  2113. links: { }
  2114. summary: 'Removes the User resource.'
  2115. description: 'Removes the User resource.'
  2116. parameters:
  2117. -
  2118. name: id
  2119. in: path
  2120. description: 'User identifier'
  2121. required: true
  2122. deprecated: false
  2123. allowEmptyValue: false
  2124. schema:
  2125. type: string
  2126. style: simple
  2127. explode: false
  2128. allowReserved: false
  2129. deprecated: false
  2130. patch:
  2131. operationId: api_users_id_patch
  2132. tags:
  2133. - User
  2134. responses:
  2135. '200':
  2136. description: 'User resource updated'
  2137. content:
  2138. application/ld+json:
  2139. schema:
  2140. $ref: '#/components/schemas/User.jsonld'
  2141. links: { }
  2142. '400':
  2143. description: 'Invalid input'
  2144. content:
  2145. application/ld+json:
  2146. schema:
  2147. $ref: '#/components/schemas/Error.jsonld'
  2148. application/problem+json:
  2149. schema:
  2150. $ref: '#/components/schemas/Error'
  2151. application/json:
  2152. schema:
  2153. $ref: '#/components/schemas/Error'
  2154. links: { }
  2155. '422':
  2156. description: 'An error occurred'
  2157. content:
  2158. application/ld+json:
  2159. schema:
  2160. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2161. application/problem+json:
  2162. schema:
  2163. $ref: '#/components/schemas/ConstraintViolation-json'
  2164. application/json:
  2165. schema:
  2166. $ref: '#/components/schemas/ConstraintViolation-json'
  2167. links: { }
  2168. '403':
  2169. description: Forbidden
  2170. content:
  2171. application/ld+json:
  2172. schema:
  2173. $ref: '#/components/schemas/Error.jsonld'
  2174. application/problem+json:
  2175. schema:
  2176. $ref: '#/components/schemas/Error'
  2177. application/json:
  2178. schema:
  2179. $ref: '#/components/schemas/Error'
  2180. links: { }
  2181. '404':
  2182. description: 'Not found'
  2183. content:
  2184. application/ld+json:
  2185. schema:
  2186. $ref: '#/components/schemas/Error.jsonld'
  2187. application/problem+json:
  2188. schema:
  2189. $ref: '#/components/schemas/Error'
  2190. application/json:
  2191. schema:
  2192. $ref: '#/components/schemas/Error'
  2193. links: { }
  2194. summary: 'Updates the User resource.'
  2195. description: 'Updates the User resource.'
  2196. parameters:
  2197. -
  2198. name: id
  2199. in: path
  2200. description: 'User identifier'
  2201. required: true
  2202. deprecated: false
  2203. allowEmptyValue: false
  2204. schema:
  2205. type: string
  2206. style: simple
  2207. explode: false
  2208. allowReserved: false
  2209. requestBody:
  2210. description: 'The updated User resource'
  2211. content:
  2212. application/merge-patch+json:
  2213. schema:
  2214. $ref: '#/components/schemas/User'
  2215. required: true
  2216. deprecated: false
  2217. /api/user_trips:
  2218. get:
  2219. operationId: api_user_trips_get_collection
  2220. tags:
  2221. - UserTrip
  2222. responses:
  2223. '200':
  2224. description: 'UserTrip collection'
  2225. content:
  2226. application/ld+json:
  2227. schema:
  2228. type: object
  2229. properties:
  2230. member: { type: array, items: { $ref: '#/components/schemas/UserTrip.jsonld' } }
  2231. totalItems: { type: integer, minimum: 0 }
  2232. 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 } }
  2233. 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 } } } } } }
  2234. required:
  2235. - member
  2236. '403':
  2237. description: Forbidden
  2238. content:
  2239. application/ld+json:
  2240. schema:
  2241. $ref: '#/components/schemas/Error.jsonld'
  2242. application/problem+json:
  2243. schema:
  2244. $ref: '#/components/schemas/Error'
  2245. application/json:
  2246. schema:
  2247. $ref: '#/components/schemas/Error'
  2248. links: { }
  2249. summary: 'Retrieves the collection of UserTrip resources.'
  2250. description: 'Retrieves the collection of UserTrip resources.'
  2251. parameters:
  2252. -
  2253. name: page
  2254. in: query
  2255. description: 'The collection page number'
  2256. required: false
  2257. deprecated: false
  2258. allowEmptyValue: true
  2259. schema:
  2260. type: integer
  2261. default: 1
  2262. style: form
  2263. explode: false
  2264. allowReserved: false
  2265. -
  2266. name: itemsPerPage
  2267. in: query
  2268. description: 'The number of items per page'
  2269. required: false
  2270. deprecated: false
  2271. allowEmptyValue: true
  2272. schema:
  2273. type: integer
  2274. default: 50
  2275. minimum: 0
  2276. maximum: 200
  2277. style: form
  2278. explode: false
  2279. allowReserved: false
  2280. -
  2281. name: trip
  2282. in: query
  2283. description: ''
  2284. required: false
  2285. deprecated: false
  2286. allowEmptyValue: false
  2287. schema:
  2288. type: string
  2289. style: form
  2290. explode: false
  2291. allowReserved: false
  2292. -
  2293. name: 'trip[]'
  2294. in: query
  2295. description: ''
  2296. required: false
  2297. deprecated: false
  2298. allowEmptyValue: false
  2299. schema:
  2300. type: array
  2301. items:
  2302. type: string
  2303. style: form
  2304. explode: true
  2305. allowReserved: false
  2306. -
  2307. name: user
  2308. in: query
  2309. description: ''
  2310. required: false
  2311. deprecated: false
  2312. allowEmptyValue: false
  2313. schema:
  2314. type: string
  2315. style: form
  2316. explode: false
  2317. allowReserved: false
  2318. -
  2319. name: 'user[]'
  2320. in: query
  2321. description: ''
  2322. required: false
  2323. deprecated: false
  2324. allowEmptyValue: false
  2325. schema:
  2326. type: array
  2327. items:
  2328. type: string
  2329. style: form
  2330. explode: true
  2331. allowReserved: false
  2332. -
  2333. name: custom_json_filter
  2334. in: query
  2335. description: ''
  2336. required: false
  2337. deprecated: false
  2338. allowEmptyValue: false
  2339. schema:
  2340. type: string
  2341. style: form
  2342. explode: false
  2343. allowReserved: false
  2344. -
  2345. name: custom_json_order
  2346. in: query
  2347. description: ''
  2348. required: false
  2349. deprecated: false
  2350. allowEmptyValue: true
  2351. schema:
  2352. type: string
  2353. style: form
  2354. explode: false
  2355. allowReserved: false
  2356. deprecated: false
  2357. post:
  2358. operationId: api_user_trips_post
  2359. tags:
  2360. - UserTrip
  2361. responses:
  2362. '201':
  2363. description: 'UserTrip resource created'
  2364. content:
  2365. application/ld+json:
  2366. schema:
  2367. $ref: '#/components/schemas/UserTrip.jsonld'
  2368. links: { }
  2369. '400':
  2370. description: 'Invalid input'
  2371. content:
  2372. application/ld+json:
  2373. schema:
  2374. $ref: '#/components/schemas/Error.jsonld'
  2375. application/problem+json:
  2376. schema:
  2377. $ref: '#/components/schemas/Error'
  2378. application/json:
  2379. schema:
  2380. $ref: '#/components/schemas/Error'
  2381. links: { }
  2382. '422':
  2383. description: 'An error occurred'
  2384. content:
  2385. application/ld+json:
  2386. schema:
  2387. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2388. application/problem+json:
  2389. schema:
  2390. $ref: '#/components/schemas/ConstraintViolation-json'
  2391. application/json:
  2392. schema:
  2393. $ref: '#/components/schemas/ConstraintViolation-json'
  2394. links: { }
  2395. '403':
  2396. description: Forbidden
  2397. content:
  2398. application/ld+json:
  2399. schema:
  2400. $ref: '#/components/schemas/Error.jsonld'
  2401. application/problem+json:
  2402. schema:
  2403. $ref: '#/components/schemas/Error'
  2404. application/json:
  2405. schema:
  2406. $ref: '#/components/schemas/Error'
  2407. links: { }
  2408. summary: 'Creates a UserTrip resource.'
  2409. description: 'Creates a UserTrip resource.'
  2410. parameters: []
  2411. requestBody:
  2412. description: 'The new UserTrip resource'
  2413. content:
  2414. application/ld+json:
  2415. schema:
  2416. $ref: '#/components/schemas/UserTrip.jsonld'
  2417. required: true
  2418. deprecated: false
  2419. '/api/user_trips/{id}':
  2420. get:
  2421. operationId: api_user_trips_id_get
  2422. tags:
  2423. - UserTrip
  2424. responses:
  2425. '200':
  2426. description: 'UserTrip resource'
  2427. content:
  2428. application/ld+json:
  2429. schema:
  2430. $ref: '#/components/schemas/UserTrip.jsonld'
  2431. '403':
  2432. description: Forbidden
  2433. content:
  2434. application/ld+json:
  2435. schema:
  2436. $ref: '#/components/schemas/Error.jsonld'
  2437. application/problem+json:
  2438. schema:
  2439. $ref: '#/components/schemas/Error'
  2440. application/json:
  2441. schema:
  2442. $ref: '#/components/schemas/Error'
  2443. links: { }
  2444. '404':
  2445. description: 'Not found'
  2446. content:
  2447. application/ld+json:
  2448. schema:
  2449. $ref: '#/components/schemas/Error.jsonld'
  2450. application/problem+json:
  2451. schema:
  2452. $ref: '#/components/schemas/Error'
  2453. application/json:
  2454. schema:
  2455. $ref: '#/components/schemas/Error'
  2456. links: { }
  2457. summary: 'Retrieves a UserTrip resource.'
  2458. description: 'Retrieves a UserTrip resource.'
  2459. parameters:
  2460. -
  2461. name: id
  2462. in: path
  2463. description: 'UserTrip identifier'
  2464. required: true
  2465. deprecated: false
  2466. allowEmptyValue: false
  2467. schema:
  2468. type: string
  2469. style: simple
  2470. explode: false
  2471. allowReserved: false
  2472. deprecated: false
  2473. delete:
  2474. operationId: api_user_trips_id_delete
  2475. tags:
  2476. - UserTrip
  2477. responses:
  2478. '204':
  2479. description: 'UserTrip resource deleted'
  2480. '403':
  2481. description: Forbidden
  2482. content:
  2483. application/ld+json:
  2484. schema:
  2485. $ref: '#/components/schemas/Error.jsonld'
  2486. application/problem+json:
  2487. schema:
  2488. $ref: '#/components/schemas/Error'
  2489. application/json:
  2490. schema:
  2491. $ref: '#/components/schemas/Error'
  2492. links: { }
  2493. '404':
  2494. description: 'Not found'
  2495. content:
  2496. application/ld+json:
  2497. schema:
  2498. $ref: '#/components/schemas/Error.jsonld'
  2499. application/problem+json:
  2500. schema:
  2501. $ref: '#/components/schemas/Error'
  2502. application/json:
  2503. schema:
  2504. $ref: '#/components/schemas/Error'
  2505. links: { }
  2506. summary: 'Removes the UserTrip resource.'
  2507. description: 'Removes the UserTrip resource.'
  2508. parameters:
  2509. -
  2510. name: id
  2511. in: path
  2512. description: 'UserTrip identifier'
  2513. required: true
  2514. deprecated: false
  2515. allowEmptyValue: false
  2516. schema:
  2517. type: string
  2518. style: simple
  2519. explode: false
  2520. allowReserved: false
  2521. deprecated: false
  2522. patch:
  2523. operationId: api_user_trips_id_patch
  2524. tags:
  2525. - UserTrip
  2526. responses:
  2527. '200':
  2528. description: 'UserTrip resource updated'
  2529. content:
  2530. application/ld+json:
  2531. schema:
  2532. $ref: '#/components/schemas/UserTrip.jsonld'
  2533. links: { }
  2534. '400':
  2535. description: 'Invalid input'
  2536. content:
  2537. application/ld+json:
  2538. schema:
  2539. $ref: '#/components/schemas/Error.jsonld'
  2540. application/problem+json:
  2541. schema:
  2542. $ref: '#/components/schemas/Error'
  2543. application/json:
  2544. schema:
  2545. $ref: '#/components/schemas/Error'
  2546. links: { }
  2547. '422':
  2548. description: 'An error occurred'
  2549. content:
  2550. application/ld+json:
  2551. schema:
  2552. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2553. application/problem+json:
  2554. schema:
  2555. $ref: '#/components/schemas/ConstraintViolation-json'
  2556. application/json:
  2557. schema:
  2558. $ref: '#/components/schemas/ConstraintViolation-json'
  2559. links: { }
  2560. '403':
  2561. description: Forbidden
  2562. content:
  2563. application/ld+json:
  2564. schema:
  2565. $ref: '#/components/schemas/Error.jsonld'
  2566. application/problem+json:
  2567. schema:
  2568. $ref: '#/components/schemas/Error'
  2569. application/json:
  2570. schema:
  2571. $ref: '#/components/schemas/Error'
  2572. links: { }
  2573. '404':
  2574. description: 'Not found'
  2575. content:
  2576. application/ld+json:
  2577. schema:
  2578. $ref: '#/components/schemas/Error.jsonld'
  2579. application/problem+json:
  2580. schema:
  2581. $ref: '#/components/schemas/Error'
  2582. application/json:
  2583. schema:
  2584. $ref: '#/components/schemas/Error'
  2585. links: { }
  2586. summary: 'Updates the UserTrip resource.'
  2587. description: 'Updates the UserTrip resource.'
  2588. parameters:
  2589. -
  2590. name: id
  2591. in: path
  2592. description: 'UserTrip identifier'
  2593. required: true
  2594. deprecated: false
  2595. allowEmptyValue: false
  2596. schema:
  2597. type: string
  2598. style: simple
  2599. explode: false
  2600. allowReserved: false
  2601. requestBody:
  2602. description: 'The updated UserTrip resource'
  2603. content:
  2604. application/merge-patch+json:
  2605. schema:
  2606. $ref: '#/components/schemas/UserTrip'
  2607. required: true
  2608. deprecated: false
  2609. /api/user_trip_events:
  2610. get:
  2611. operationId: api_user_trip_events_get_collection
  2612. tags:
  2613. - UserTripEvent
  2614. responses:
  2615. '200':
  2616. description: 'UserTripEvent collection'
  2617. content:
  2618. application/ld+json:
  2619. schema:
  2620. type: object
  2621. properties:
  2622. member: { type: array, items: { $ref: '#/components/schemas/UserTripEvent.jsonld' } }
  2623. totalItems: { type: integer, minimum: 0 }
  2624. 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 } }
  2625. 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 } } } } } }
  2626. required:
  2627. - member
  2628. '403':
  2629. description: Forbidden
  2630. content:
  2631. application/ld+json:
  2632. schema:
  2633. $ref: '#/components/schemas/Error.jsonld'
  2634. application/problem+json:
  2635. schema:
  2636. $ref: '#/components/schemas/Error'
  2637. application/json:
  2638. schema:
  2639. $ref: '#/components/schemas/Error'
  2640. links: { }
  2641. summary: 'Retrieves the collection of UserTripEvent resources.'
  2642. description: 'Retrieves the collection of UserTripEvent resources.'
  2643. parameters:
  2644. -
  2645. name: page
  2646. in: query
  2647. description: 'The collection page number'
  2648. required: false
  2649. deprecated: false
  2650. allowEmptyValue: true
  2651. schema:
  2652. type: integer
  2653. default: 1
  2654. style: form
  2655. explode: false
  2656. allowReserved: false
  2657. -
  2658. name: itemsPerPage
  2659. in: query
  2660. description: 'The number of items per page'
  2661. required: false
  2662. deprecated: false
  2663. allowEmptyValue: true
  2664. schema:
  2665. type: integer
  2666. default: 50
  2667. minimum: 0
  2668. maximum: 200
  2669. style: form
  2670. explode: false
  2671. allowReserved: false
  2672. -
  2673. name: userTrip
  2674. in: query
  2675. description: ''
  2676. required: false
  2677. deprecated: false
  2678. allowEmptyValue: false
  2679. schema:
  2680. type: string
  2681. style: form
  2682. explode: false
  2683. allowReserved: false
  2684. -
  2685. name: 'userTrip[]'
  2686. in: query
  2687. description: ''
  2688. required: false
  2689. deprecated: false
  2690. allowEmptyValue: false
  2691. schema:
  2692. type: array
  2693. items:
  2694. type: string
  2695. style: form
  2696. explode: true
  2697. allowReserved: false
  2698. -
  2699. name: tripId
  2700. in: query
  2701. description: 'Filter UserTripEvents by Trip ID'
  2702. required: false
  2703. deprecated: false
  2704. allowEmptyValue: false
  2705. schema:
  2706. type: integer
  2707. style: form
  2708. explode: false
  2709. allowReserved: false
  2710. -
  2711. name: custom_json_filter
  2712. in: query
  2713. description: ''
  2714. required: false
  2715. deprecated: false
  2716. allowEmptyValue: false
  2717. schema:
  2718. type: string
  2719. style: form
  2720. explode: false
  2721. allowReserved: false
  2722. -
  2723. name: custom_json_order
  2724. in: query
  2725. description: ''
  2726. required: false
  2727. deprecated: false
  2728. allowEmptyValue: true
  2729. schema:
  2730. type: string
  2731. style: form
  2732. explode: false
  2733. allowReserved: false
  2734. deprecated: false
  2735. post:
  2736. operationId: api_user_trip_events_post
  2737. tags:
  2738. - UserTripEvent
  2739. responses:
  2740. '201':
  2741. description: 'UserTripEvent resource created'
  2742. content:
  2743. application/ld+json:
  2744. schema:
  2745. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2746. links: { }
  2747. '400':
  2748. description: 'Invalid input'
  2749. content:
  2750. application/ld+json:
  2751. schema:
  2752. $ref: '#/components/schemas/Error.jsonld'
  2753. application/problem+json:
  2754. schema:
  2755. $ref: '#/components/schemas/Error'
  2756. application/json:
  2757. schema:
  2758. $ref: '#/components/schemas/Error'
  2759. links: { }
  2760. '422':
  2761. description: 'An error occurred'
  2762. content:
  2763. application/ld+json:
  2764. schema:
  2765. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2766. application/problem+json:
  2767. schema:
  2768. $ref: '#/components/schemas/ConstraintViolation-json'
  2769. application/json:
  2770. schema:
  2771. $ref: '#/components/schemas/ConstraintViolation-json'
  2772. links: { }
  2773. '403':
  2774. description: Forbidden
  2775. content:
  2776. application/ld+json:
  2777. schema:
  2778. $ref: '#/components/schemas/Error.jsonld'
  2779. application/problem+json:
  2780. schema:
  2781. $ref: '#/components/schemas/Error'
  2782. application/json:
  2783. schema:
  2784. $ref: '#/components/schemas/Error'
  2785. links: { }
  2786. summary: 'Creates a UserTripEvent resource.'
  2787. description: 'Creates a UserTripEvent resource.'
  2788. parameters: []
  2789. requestBody:
  2790. description: 'The new UserTripEvent resource'
  2791. content:
  2792. application/ld+json:
  2793. schema:
  2794. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2795. required: true
  2796. deprecated: false
  2797. '/api/user_trip_events/{id}':
  2798. get:
  2799. operationId: api_user_trip_events_id_get
  2800. tags:
  2801. - UserTripEvent
  2802. responses:
  2803. '200':
  2804. description: 'UserTripEvent resource'
  2805. content:
  2806. application/ld+json:
  2807. schema:
  2808. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2809. '403':
  2810. description: Forbidden
  2811. content:
  2812. application/ld+json:
  2813. schema:
  2814. $ref: '#/components/schemas/Error.jsonld'
  2815. application/problem+json:
  2816. schema:
  2817. $ref: '#/components/schemas/Error'
  2818. application/json:
  2819. schema:
  2820. $ref: '#/components/schemas/Error'
  2821. links: { }
  2822. '404':
  2823. description: 'Not found'
  2824. content:
  2825. application/ld+json:
  2826. schema:
  2827. $ref: '#/components/schemas/Error.jsonld'
  2828. application/problem+json:
  2829. schema:
  2830. $ref: '#/components/schemas/Error'
  2831. application/json:
  2832. schema:
  2833. $ref: '#/components/schemas/Error'
  2834. links: { }
  2835. summary: 'Retrieves a UserTripEvent resource.'
  2836. description: 'Retrieves a UserTripEvent resource.'
  2837. parameters:
  2838. -
  2839. name: id
  2840. in: path
  2841. description: 'UserTripEvent identifier'
  2842. required: true
  2843. deprecated: false
  2844. allowEmptyValue: false
  2845. schema:
  2846. type: string
  2847. style: simple
  2848. explode: false
  2849. allowReserved: false
  2850. deprecated: false
  2851. delete:
  2852. operationId: api_user_trip_events_id_delete
  2853. tags:
  2854. - UserTripEvent
  2855. responses:
  2856. '204':
  2857. description: 'UserTripEvent resource deleted'
  2858. '403':
  2859. description: Forbidden
  2860. content:
  2861. application/ld+json:
  2862. schema:
  2863. $ref: '#/components/schemas/Error.jsonld'
  2864. application/problem+json:
  2865. schema:
  2866. $ref: '#/components/schemas/Error'
  2867. application/json:
  2868. schema:
  2869. $ref: '#/components/schemas/Error'
  2870. links: { }
  2871. '404':
  2872. description: 'Not found'
  2873. content:
  2874. application/ld+json:
  2875. schema:
  2876. $ref: '#/components/schemas/Error.jsonld'
  2877. application/problem+json:
  2878. schema:
  2879. $ref: '#/components/schemas/Error'
  2880. application/json:
  2881. schema:
  2882. $ref: '#/components/schemas/Error'
  2883. links: { }
  2884. summary: 'Removes the UserTripEvent resource.'
  2885. description: 'Removes the UserTripEvent resource.'
  2886. parameters:
  2887. -
  2888. name: id
  2889. in: path
  2890. description: 'UserTripEvent identifier'
  2891. required: true
  2892. deprecated: false
  2893. allowEmptyValue: false
  2894. schema:
  2895. type: string
  2896. style: simple
  2897. explode: false
  2898. allowReserved: false
  2899. deprecated: false
  2900. patch:
  2901. operationId: api_user_trip_events_id_patch
  2902. tags:
  2903. - UserTripEvent
  2904. responses:
  2905. '200':
  2906. description: 'UserTripEvent resource updated'
  2907. content:
  2908. application/ld+json:
  2909. schema:
  2910. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2911. links: { }
  2912. '400':
  2913. description: 'Invalid input'
  2914. content:
  2915. application/ld+json:
  2916. schema:
  2917. $ref: '#/components/schemas/Error.jsonld'
  2918. application/problem+json:
  2919. schema:
  2920. $ref: '#/components/schemas/Error'
  2921. application/json:
  2922. schema:
  2923. $ref: '#/components/schemas/Error'
  2924. links: { }
  2925. '422':
  2926. description: 'An error occurred'
  2927. content:
  2928. application/ld+json:
  2929. schema:
  2930. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2931. application/problem+json:
  2932. schema:
  2933. $ref: '#/components/schemas/ConstraintViolation-json'
  2934. application/json:
  2935. schema:
  2936. $ref: '#/components/schemas/ConstraintViolation-json'
  2937. links: { }
  2938. '403':
  2939. description: Forbidden
  2940. content:
  2941. application/ld+json:
  2942. schema:
  2943. $ref: '#/components/schemas/Error.jsonld'
  2944. application/problem+json:
  2945. schema:
  2946. $ref: '#/components/schemas/Error'
  2947. application/json:
  2948. schema:
  2949. $ref: '#/components/schemas/Error'
  2950. links: { }
  2951. '404':
  2952. description: 'Not found'
  2953. content:
  2954. application/ld+json:
  2955. schema:
  2956. $ref: '#/components/schemas/Error.jsonld'
  2957. application/problem+json:
  2958. schema:
  2959. $ref: '#/components/schemas/Error'
  2960. application/json:
  2961. schema:
  2962. $ref: '#/components/schemas/Error'
  2963. links: { }
  2964. summary: 'Updates the UserTripEvent resource.'
  2965. description: 'Updates the UserTripEvent resource.'
  2966. parameters:
  2967. -
  2968. name: id
  2969. in: path
  2970. description: 'UserTripEvent identifier'
  2971. required: true
  2972. deprecated: false
  2973. allowEmptyValue: false
  2974. schema:
  2975. type: string
  2976. style: simple
  2977. explode: false
  2978. allowReserved: false
  2979. requestBody:
  2980. description: 'The updated UserTripEvent resource'
  2981. content:
  2982. application/merge-patch+json:
  2983. schema:
  2984. $ref: '#/components/schemas/UserTripEvent'
  2985. required: true
  2986. deprecated: false
  2987. /api/user_zones:
  2988. get:
  2989. operationId: api_user_zones_get_collection
  2990. tags:
  2991. - UserZone
  2992. responses:
  2993. '200':
  2994. description: 'UserZone collection'
  2995. content:
  2996. application/ld+json:
  2997. schema:
  2998. type: object
  2999. properties:
  3000. member: { type: array, items: { $ref: '#/components/schemas/UserZone.jsonld' } }
  3001. totalItems: { type: integer, minimum: 0 }
  3002. 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 } }
  3003. 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 } } } } } }
  3004. required:
  3005. - member
  3006. '403':
  3007. description: Forbidden
  3008. content:
  3009. application/ld+json:
  3010. schema:
  3011. $ref: '#/components/schemas/Error.jsonld'
  3012. application/problem+json:
  3013. schema:
  3014. $ref: '#/components/schemas/Error'
  3015. application/json:
  3016. schema:
  3017. $ref: '#/components/schemas/Error'
  3018. links: { }
  3019. summary: 'Retrieves the collection of UserZone resources.'
  3020. description: 'Retrieves the collection of UserZone resources.'
  3021. parameters:
  3022. -
  3023. name: page
  3024. in: query
  3025. description: 'The collection page number'
  3026. required: false
  3027. deprecated: false
  3028. allowEmptyValue: true
  3029. schema:
  3030. type: integer
  3031. default: 1
  3032. style: form
  3033. explode: false
  3034. allowReserved: false
  3035. -
  3036. name: itemsPerPage
  3037. in: query
  3038. description: 'The number of items per page'
  3039. required: false
  3040. deprecated: false
  3041. allowEmptyValue: true
  3042. schema:
  3043. type: integer
  3044. default: 50
  3045. minimum: 0
  3046. maximum: 200
  3047. style: form
  3048. explode: false
  3049. allowReserved: false
  3050. -
  3051. name: user
  3052. in: query
  3053. description: ''
  3054. required: false
  3055. deprecated: false
  3056. allowEmptyValue: false
  3057. schema:
  3058. type: string
  3059. style: form
  3060. explode: false
  3061. allowReserved: false
  3062. -
  3063. name: 'user[]'
  3064. in: query
  3065. description: ''
  3066. required: false
  3067. deprecated: false
  3068. allowEmptyValue: false
  3069. schema:
  3070. type: array
  3071. items:
  3072. type: string
  3073. style: form
  3074. explode: true
  3075. allowReserved: false
  3076. -
  3077. name: zone
  3078. in: query
  3079. description: ''
  3080. required: false
  3081. deprecated: false
  3082. allowEmptyValue: false
  3083. schema:
  3084. type: string
  3085. style: form
  3086. explode: false
  3087. allowReserved: false
  3088. -
  3089. name: 'zone[]'
  3090. in: query
  3091. description: ''
  3092. required: false
  3093. deprecated: false
  3094. allowEmptyValue: false
  3095. schema:
  3096. type: array
  3097. items:
  3098. type: string
  3099. style: form
  3100. explode: true
  3101. allowReserved: false
  3102. -
  3103. name: custom_json_filter
  3104. in: query
  3105. description: ''
  3106. required: false
  3107. deprecated: false
  3108. allowEmptyValue: false
  3109. schema:
  3110. type: string
  3111. style: form
  3112. explode: false
  3113. allowReserved: false
  3114. -
  3115. name: custom_json_order
  3116. in: query
  3117. description: ''
  3118. required: false
  3119. deprecated: false
  3120. allowEmptyValue: true
  3121. schema:
  3122. type: string
  3123. style: form
  3124. explode: false
  3125. allowReserved: false
  3126. deprecated: false
  3127. post:
  3128. operationId: api_user_zones_post
  3129. tags:
  3130. - UserZone
  3131. responses:
  3132. '201':
  3133. description: 'UserZone resource created'
  3134. content:
  3135. application/ld+json:
  3136. schema:
  3137. $ref: '#/components/schemas/UserZone.jsonld'
  3138. links: { }
  3139. '400':
  3140. description: 'Invalid input'
  3141. content:
  3142. application/ld+json:
  3143. schema:
  3144. $ref: '#/components/schemas/Error.jsonld'
  3145. application/problem+json:
  3146. schema:
  3147. $ref: '#/components/schemas/Error'
  3148. application/json:
  3149. schema:
  3150. $ref: '#/components/schemas/Error'
  3151. links: { }
  3152. '422':
  3153. description: 'An error occurred'
  3154. content:
  3155. application/ld+json:
  3156. schema:
  3157. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3158. application/problem+json:
  3159. schema:
  3160. $ref: '#/components/schemas/ConstraintViolation-json'
  3161. application/json:
  3162. schema:
  3163. $ref: '#/components/schemas/ConstraintViolation-json'
  3164. links: { }
  3165. '403':
  3166. description: Forbidden
  3167. content:
  3168. application/ld+json:
  3169. schema:
  3170. $ref: '#/components/schemas/Error.jsonld'
  3171. application/problem+json:
  3172. schema:
  3173. $ref: '#/components/schemas/Error'
  3174. application/json:
  3175. schema:
  3176. $ref: '#/components/schemas/Error'
  3177. links: { }
  3178. summary: 'Creates a UserZone resource.'
  3179. description: 'Creates a UserZone resource.'
  3180. parameters: []
  3181. requestBody:
  3182. description: 'The new UserZone resource'
  3183. content:
  3184. application/ld+json:
  3185. schema:
  3186. $ref: '#/components/schemas/UserZone.jsonld'
  3187. required: true
  3188. deprecated: false
  3189. '/api/user_zones/{id}':
  3190. get:
  3191. operationId: api_user_zones_id_get
  3192. tags:
  3193. - UserZone
  3194. responses:
  3195. '200':
  3196. description: 'UserZone resource'
  3197. content:
  3198. application/ld+json:
  3199. schema:
  3200. $ref: '#/components/schemas/UserZone.jsonld'
  3201. '403':
  3202. description: Forbidden
  3203. content:
  3204. application/ld+json:
  3205. schema:
  3206. $ref: '#/components/schemas/Error.jsonld'
  3207. application/problem+json:
  3208. schema:
  3209. $ref: '#/components/schemas/Error'
  3210. application/json:
  3211. schema:
  3212. $ref: '#/components/schemas/Error'
  3213. links: { }
  3214. '404':
  3215. description: 'Not found'
  3216. content:
  3217. application/ld+json:
  3218. schema:
  3219. $ref: '#/components/schemas/Error.jsonld'
  3220. application/problem+json:
  3221. schema:
  3222. $ref: '#/components/schemas/Error'
  3223. application/json:
  3224. schema:
  3225. $ref: '#/components/schemas/Error'
  3226. links: { }
  3227. summary: 'Retrieves a UserZone resource.'
  3228. description: 'Retrieves a UserZone resource.'
  3229. parameters:
  3230. -
  3231. name: id
  3232. in: path
  3233. description: 'UserZone identifier'
  3234. required: true
  3235. deprecated: false
  3236. allowEmptyValue: false
  3237. schema:
  3238. type: string
  3239. style: simple
  3240. explode: false
  3241. allowReserved: false
  3242. deprecated: false
  3243. delete:
  3244. operationId: api_user_zones_id_delete
  3245. tags:
  3246. - UserZone
  3247. responses:
  3248. '204':
  3249. description: 'UserZone resource deleted'
  3250. '403':
  3251. description: Forbidden
  3252. content:
  3253. application/ld+json:
  3254. schema:
  3255. $ref: '#/components/schemas/Error.jsonld'
  3256. application/problem+json:
  3257. schema:
  3258. $ref: '#/components/schemas/Error'
  3259. application/json:
  3260. schema:
  3261. $ref: '#/components/schemas/Error'
  3262. links: { }
  3263. '404':
  3264. description: 'Not found'
  3265. content:
  3266. application/ld+json:
  3267. schema:
  3268. $ref: '#/components/schemas/Error.jsonld'
  3269. application/problem+json:
  3270. schema:
  3271. $ref: '#/components/schemas/Error'
  3272. application/json:
  3273. schema:
  3274. $ref: '#/components/schemas/Error'
  3275. links: { }
  3276. summary: 'Removes the UserZone resource.'
  3277. description: 'Removes the UserZone resource.'
  3278. parameters:
  3279. -
  3280. name: id
  3281. in: path
  3282. description: 'UserZone identifier'
  3283. required: true
  3284. deprecated: false
  3285. allowEmptyValue: false
  3286. schema:
  3287. type: string
  3288. style: simple
  3289. explode: false
  3290. allowReserved: false
  3291. deprecated: false
  3292. patch:
  3293. operationId: api_user_zones_id_patch
  3294. tags:
  3295. - UserZone
  3296. responses:
  3297. '200':
  3298. description: 'UserZone resource updated'
  3299. content:
  3300. application/ld+json:
  3301. schema:
  3302. $ref: '#/components/schemas/UserZone.jsonld'
  3303. links: { }
  3304. '400':
  3305. description: 'Invalid input'
  3306. content:
  3307. application/ld+json:
  3308. schema:
  3309. $ref: '#/components/schemas/Error.jsonld'
  3310. application/problem+json:
  3311. schema:
  3312. $ref: '#/components/schemas/Error'
  3313. application/json:
  3314. schema:
  3315. $ref: '#/components/schemas/Error'
  3316. links: { }
  3317. '422':
  3318. description: 'An error occurred'
  3319. content:
  3320. application/ld+json:
  3321. schema:
  3322. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3323. application/problem+json:
  3324. schema:
  3325. $ref: '#/components/schemas/ConstraintViolation-json'
  3326. application/json:
  3327. schema:
  3328. $ref: '#/components/schemas/ConstraintViolation-json'
  3329. links: { }
  3330. '403':
  3331. description: Forbidden
  3332. content:
  3333. application/ld+json:
  3334. schema:
  3335. $ref: '#/components/schemas/Error.jsonld'
  3336. application/problem+json:
  3337. schema:
  3338. $ref: '#/components/schemas/Error'
  3339. application/json:
  3340. schema:
  3341. $ref: '#/components/schemas/Error'
  3342. links: { }
  3343. '404':
  3344. description: 'Not found'
  3345. content:
  3346. application/ld+json:
  3347. schema:
  3348. $ref: '#/components/schemas/Error.jsonld'
  3349. application/problem+json:
  3350. schema:
  3351. $ref: '#/components/schemas/Error'
  3352. application/json:
  3353. schema:
  3354. $ref: '#/components/schemas/Error'
  3355. links: { }
  3356. summary: 'Updates the UserZone resource.'
  3357. description: 'Updates the UserZone resource.'
  3358. parameters:
  3359. -
  3360. name: id
  3361. in: path
  3362. description: 'UserZone identifier'
  3363. required: true
  3364. deprecated: false
  3365. allowEmptyValue: false
  3366. schema:
  3367. type: string
  3368. style: simple
  3369. explode: false
  3370. allowReserved: false
  3371. requestBody:
  3372. description: 'The updated UserZone resource'
  3373. content:
  3374. application/merge-patch+json:
  3375. schema:
  3376. $ref: '#/components/schemas/UserZone'
  3377. required: true
  3378. deprecated: false
  3379. /api/vessels:
  3380. get:
  3381. operationId: api_vessels_get_collection
  3382. tags:
  3383. - Vessel
  3384. responses:
  3385. '200':
  3386. description: 'Vessel collection'
  3387. content:
  3388. application/ld+json:
  3389. schema:
  3390. type: object
  3391. properties:
  3392. member: { type: array, items: { $ref: '#/components/schemas/Vessel.jsonld' } }
  3393. totalItems: { type: integer, minimum: 0 }
  3394. 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 } }
  3395. 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 } } } } } }
  3396. required:
  3397. - member
  3398. '403':
  3399. description: Forbidden
  3400. content:
  3401. application/ld+json:
  3402. schema:
  3403. $ref: '#/components/schemas/Error.jsonld'
  3404. application/problem+json:
  3405. schema:
  3406. $ref: '#/components/schemas/Error'
  3407. application/json:
  3408. schema:
  3409. $ref: '#/components/schemas/Error'
  3410. links: { }
  3411. summary: 'Retrieves the collection of Vessel resources.'
  3412. description: 'Retrieves the collection of Vessel resources.'
  3413. parameters:
  3414. -
  3415. name: page
  3416. in: query
  3417. description: 'The collection page number'
  3418. required: false
  3419. deprecated: false
  3420. allowEmptyValue: true
  3421. schema:
  3422. type: integer
  3423. default: 1
  3424. style: form
  3425. explode: false
  3426. allowReserved: false
  3427. -
  3428. name: itemsPerPage
  3429. in: query
  3430. description: 'The number of items per page'
  3431. required: false
  3432. deprecated: false
  3433. allowEmptyValue: true
  3434. schema:
  3435. type: integer
  3436. default: 50
  3437. minimum: 0
  3438. maximum: 200
  3439. style: form
  3440. explode: false
  3441. allowReserved: false
  3442. -
  3443. name: name
  3444. in: query
  3445. description: ''
  3446. required: false
  3447. deprecated: false
  3448. allowEmptyValue: false
  3449. schema:
  3450. type: string
  3451. style: form
  3452. explode: false
  3453. allowReserved: false
  3454. -
  3455. name: custom_json_filter
  3456. in: query
  3457. description: ''
  3458. required: false
  3459. deprecated: false
  3460. allowEmptyValue: false
  3461. schema:
  3462. type: string
  3463. style: form
  3464. explode: false
  3465. allowReserved: false
  3466. -
  3467. name: custom_json_order
  3468. in: query
  3469. description: ''
  3470. required: false
  3471. deprecated: false
  3472. allowEmptyValue: true
  3473. schema:
  3474. type: string
  3475. style: form
  3476. explode: false
  3477. allowReserved: false
  3478. deprecated: false
  3479. post:
  3480. operationId: api_vessels_post
  3481. tags:
  3482. - Vessel
  3483. responses:
  3484. '201':
  3485. description: 'Vessel resource created'
  3486. content:
  3487. application/ld+json:
  3488. schema:
  3489. $ref: '#/components/schemas/Vessel.jsonld'
  3490. links: { }
  3491. '400':
  3492. description: 'Invalid input'
  3493. content:
  3494. application/ld+json:
  3495. schema:
  3496. $ref: '#/components/schemas/Error.jsonld'
  3497. application/problem+json:
  3498. schema:
  3499. $ref: '#/components/schemas/Error'
  3500. application/json:
  3501. schema:
  3502. $ref: '#/components/schemas/Error'
  3503. links: { }
  3504. '422':
  3505. description: 'An error occurred'
  3506. content:
  3507. application/ld+json:
  3508. schema:
  3509. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3510. application/problem+json:
  3511. schema:
  3512. $ref: '#/components/schemas/ConstraintViolation-json'
  3513. application/json:
  3514. schema:
  3515. $ref: '#/components/schemas/ConstraintViolation-json'
  3516. links: { }
  3517. '403':
  3518. description: Forbidden
  3519. content:
  3520. application/ld+json:
  3521. schema:
  3522. $ref: '#/components/schemas/Error.jsonld'
  3523. application/problem+json:
  3524. schema:
  3525. $ref: '#/components/schemas/Error'
  3526. application/json:
  3527. schema:
  3528. $ref: '#/components/schemas/Error'
  3529. links: { }
  3530. summary: 'Creates a Vessel resource.'
  3531. description: 'Creates a Vessel resource.'
  3532. parameters: []
  3533. requestBody:
  3534. description: 'The new Vessel resource'
  3535. content:
  3536. application/ld+json:
  3537. schema:
  3538. $ref: '#/components/schemas/Vessel.jsonld'
  3539. required: true
  3540. deprecated: false
  3541. '/api/vessels/{id}':
  3542. get:
  3543. operationId: api_vessels_id_get
  3544. tags:
  3545. - Vessel
  3546. responses:
  3547. '200':
  3548. description: 'Vessel resource'
  3549. content:
  3550. application/ld+json:
  3551. schema:
  3552. $ref: '#/components/schemas/Vessel.jsonld'
  3553. '403':
  3554. description: Forbidden
  3555. content:
  3556. application/ld+json:
  3557. schema:
  3558. $ref: '#/components/schemas/Error.jsonld'
  3559. application/problem+json:
  3560. schema:
  3561. $ref: '#/components/schemas/Error'
  3562. application/json:
  3563. schema:
  3564. $ref: '#/components/schemas/Error'
  3565. links: { }
  3566. '404':
  3567. description: 'Not found'
  3568. content:
  3569. application/ld+json:
  3570. schema:
  3571. $ref: '#/components/schemas/Error.jsonld'
  3572. application/problem+json:
  3573. schema:
  3574. $ref: '#/components/schemas/Error'
  3575. application/json:
  3576. schema:
  3577. $ref: '#/components/schemas/Error'
  3578. links: { }
  3579. summary: 'Retrieves a Vessel resource.'
  3580. description: 'Retrieves a Vessel resource.'
  3581. parameters:
  3582. -
  3583. name: id
  3584. in: path
  3585. description: 'Vessel identifier'
  3586. required: true
  3587. deprecated: false
  3588. allowEmptyValue: false
  3589. schema:
  3590. type: string
  3591. style: simple
  3592. explode: false
  3593. allowReserved: false
  3594. deprecated: false
  3595. delete:
  3596. operationId: api_vessels_id_delete
  3597. tags:
  3598. - Vessel
  3599. responses:
  3600. '204':
  3601. description: 'Vessel resource deleted'
  3602. '403':
  3603. description: Forbidden
  3604. content:
  3605. application/ld+json:
  3606. schema:
  3607. $ref: '#/components/schemas/Error.jsonld'
  3608. application/problem+json:
  3609. schema:
  3610. $ref: '#/components/schemas/Error'
  3611. application/json:
  3612. schema:
  3613. $ref: '#/components/schemas/Error'
  3614. links: { }
  3615. '404':
  3616. description: 'Not found'
  3617. content:
  3618. application/ld+json:
  3619. schema:
  3620. $ref: '#/components/schemas/Error.jsonld'
  3621. application/problem+json:
  3622. schema:
  3623. $ref: '#/components/schemas/Error'
  3624. application/json:
  3625. schema:
  3626. $ref: '#/components/schemas/Error'
  3627. links: { }
  3628. summary: 'Removes the Vessel resource.'
  3629. description: 'Removes the Vessel resource.'
  3630. parameters:
  3631. -
  3632. name: id
  3633. in: path
  3634. description: 'Vessel identifier'
  3635. required: true
  3636. deprecated: false
  3637. allowEmptyValue: false
  3638. schema:
  3639. type: string
  3640. style: simple
  3641. explode: false
  3642. allowReserved: false
  3643. deprecated: false
  3644. patch:
  3645. operationId: api_vessels_id_patch
  3646. tags:
  3647. - Vessel
  3648. responses:
  3649. '200':
  3650. description: 'Vessel resource updated'
  3651. content:
  3652. application/ld+json:
  3653. schema:
  3654. $ref: '#/components/schemas/Vessel.jsonld'
  3655. links: { }
  3656. '400':
  3657. description: 'Invalid input'
  3658. content:
  3659. application/ld+json:
  3660. schema:
  3661. $ref: '#/components/schemas/Error.jsonld'
  3662. application/problem+json:
  3663. schema:
  3664. $ref: '#/components/schemas/Error'
  3665. application/json:
  3666. schema:
  3667. $ref: '#/components/schemas/Error'
  3668. links: { }
  3669. '422':
  3670. description: 'An error occurred'
  3671. content:
  3672. application/ld+json:
  3673. schema:
  3674. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3675. application/problem+json:
  3676. schema:
  3677. $ref: '#/components/schemas/ConstraintViolation-json'
  3678. application/json:
  3679. schema:
  3680. $ref: '#/components/schemas/ConstraintViolation-json'
  3681. links: { }
  3682. '403':
  3683. description: Forbidden
  3684. content:
  3685. application/ld+json:
  3686. schema:
  3687. $ref: '#/components/schemas/Error.jsonld'
  3688. application/problem+json:
  3689. schema:
  3690. $ref: '#/components/schemas/Error'
  3691. application/json:
  3692. schema:
  3693. $ref: '#/components/schemas/Error'
  3694. links: { }
  3695. '404':
  3696. description: 'Not found'
  3697. content:
  3698. application/ld+json:
  3699. schema:
  3700. $ref: '#/components/schemas/Error.jsonld'
  3701. application/problem+json:
  3702. schema:
  3703. $ref: '#/components/schemas/Error'
  3704. application/json:
  3705. schema:
  3706. $ref: '#/components/schemas/Error'
  3707. links: { }
  3708. summary: 'Updates the Vessel resource.'
  3709. description: 'Updates the Vessel resource.'
  3710. parameters:
  3711. -
  3712. name: id
  3713. in: path
  3714. description: 'Vessel identifier'
  3715. required: true
  3716. deprecated: false
  3717. allowEmptyValue: false
  3718. schema:
  3719. type: string
  3720. style: simple
  3721. explode: false
  3722. allowReserved: false
  3723. requestBody:
  3724. description: 'The updated Vessel resource'
  3725. content:
  3726. application/merge-patch+json:
  3727. schema:
  3728. $ref: '#/components/schemas/Vessel'
  3729. required: true
  3730. deprecated: false
  3731. /api/zones:
  3732. get:
  3733. operationId: api_zones_get_collection
  3734. tags:
  3735. - Zone
  3736. responses:
  3737. '200':
  3738. description: 'Zone collection'
  3739. content:
  3740. application/ld+json:
  3741. schema:
  3742. type: object
  3743. properties:
  3744. member: { type: array, items: { $ref: '#/components/schemas/Zone.jsonld' } }
  3745. totalItems: { type: integer, minimum: 0 }
  3746. 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 } }
  3747. 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 } } } } } }
  3748. required:
  3749. - member
  3750. '403':
  3751. description: Forbidden
  3752. content:
  3753. application/ld+json:
  3754. schema:
  3755. $ref: '#/components/schemas/Error.jsonld'
  3756. application/problem+json:
  3757. schema:
  3758. $ref: '#/components/schemas/Error'
  3759. application/json:
  3760. schema:
  3761. $ref: '#/components/schemas/Error'
  3762. links: { }
  3763. summary: 'Retrieves the collection of Zone resources.'
  3764. description: 'Retrieves the collection of Zone resources.'
  3765. parameters:
  3766. -
  3767. name: page
  3768. in: query
  3769. description: 'The collection page number'
  3770. required: false
  3771. deprecated: false
  3772. allowEmptyValue: true
  3773. schema:
  3774. type: integer
  3775. default: 1
  3776. style: form
  3777. explode: false
  3778. allowReserved: false
  3779. -
  3780. name: itemsPerPage
  3781. in: query
  3782. description: 'The number of items per page'
  3783. required: false
  3784. deprecated: false
  3785. allowEmptyValue: true
  3786. schema:
  3787. type: integer
  3788. default: 50
  3789. minimum: 0
  3790. maximum: 200
  3791. style: form
  3792. explode: false
  3793. allowReserved: false
  3794. -
  3795. name: name
  3796. in: query
  3797. description: ''
  3798. required: false
  3799. deprecated: false
  3800. allowEmptyValue: false
  3801. schema:
  3802. type: string
  3803. style: form
  3804. explode: false
  3805. allowReserved: false
  3806. -
  3807. name: custom_json_filter
  3808. in: query
  3809. description: ''
  3810. required: false
  3811. deprecated: false
  3812. allowEmptyValue: false
  3813. schema:
  3814. type: string
  3815. style: form
  3816. explode: false
  3817. allowReserved: false
  3818. -
  3819. name: custom_json_order
  3820. in: query
  3821. description: ''
  3822. required: false
  3823. deprecated: false
  3824. allowEmptyValue: true
  3825. schema:
  3826. type: string
  3827. style: form
  3828. explode: false
  3829. allowReserved: false
  3830. deprecated: false
  3831. post:
  3832. operationId: api_zones_post
  3833. tags:
  3834. - Zone
  3835. responses:
  3836. '201':
  3837. description: 'Zone resource created'
  3838. content:
  3839. application/ld+json:
  3840. schema:
  3841. $ref: '#/components/schemas/Zone.jsonld'
  3842. links: { }
  3843. '400':
  3844. description: 'Invalid input'
  3845. content:
  3846. application/ld+json:
  3847. schema:
  3848. $ref: '#/components/schemas/Error.jsonld'
  3849. application/problem+json:
  3850. schema:
  3851. $ref: '#/components/schemas/Error'
  3852. application/json:
  3853. schema:
  3854. $ref: '#/components/schemas/Error'
  3855. links: { }
  3856. '422':
  3857. description: 'An error occurred'
  3858. content:
  3859. application/ld+json:
  3860. schema:
  3861. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3862. application/problem+json:
  3863. schema:
  3864. $ref: '#/components/schemas/ConstraintViolation-json'
  3865. application/json:
  3866. schema:
  3867. $ref: '#/components/schemas/ConstraintViolation-json'
  3868. links: { }
  3869. '403':
  3870. description: Forbidden
  3871. content:
  3872. application/ld+json:
  3873. schema:
  3874. $ref: '#/components/schemas/Error.jsonld'
  3875. application/problem+json:
  3876. schema:
  3877. $ref: '#/components/schemas/Error'
  3878. application/json:
  3879. schema:
  3880. $ref: '#/components/schemas/Error'
  3881. links: { }
  3882. summary: 'Creates a Zone resource.'
  3883. description: 'Creates a Zone resource.'
  3884. parameters: []
  3885. requestBody:
  3886. description: 'The new Zone resource'
  3887. content:
  3888. application/ld+json:
  3889. schema:
  3890. $ref: '#/components/schemas/Zone.jsonld'
  3891. required: true
  3892. deprecated: false
  3893. '/api/zones/{id}':
  3894. get:
  3895. operationId: api_zones_id_get
  3896. tags:
  3897. - Zone
  3898. responses:
  3899. '200':
  3900. description: 'Zone resource'
  3901. content:
  3902. application/ld+json:
  3903. schema:
  3904. $ref: '#/components/schemas/Zone.jsonld'
  3905. '403':
  3906. description: Forbidden
  3907. content:
  3908. application/ld+json:
  3909. schema:
  3910. $ref: '#/components/schemas/Error.jsonld'
  3911. application/problem+json:
  3912. schema:
  3913. $ref: '#/components/schemas/Error'
  3914. application/json:
  3915. schema:
  3916. $ref: '#/components/schemas/Error'
  3917. links: { }
  3918. '404':
  3919. description: 'Not found'
  3920. content:
  3921. application/ld+json:
  3922. schema:
  3923. $ref: '#/components/schemas/Error.jsonld'
  3924. application/problem+json:
  3925. schema:
  3926. $ref: '#/components/schemas/Error'
  3927. application/json:
  3928. schema:
  3929. $ref: '#/components/schemas/Error'
  3930. links: { }
  3931. summary: 'Retrieves a Zone resource.'
  3932. description: 'Retrieves a Zone resource.'
  3933. parameters:
  3934. -
  3935. name: id
  3936. in: path
  3937. description: 'Zone identifier'
  3938. required: true
  3939. deprecated: false
  3940. allowEmptyValue: false
  3941. schema:
  3942. type: string
  3943. style: simple
  3944. explode: false
  3945. allowReserved: false
  3946. deprecated: false
  3947. delete:
  3948. operationId: api_zones_id_delete
  3949. tags:
  3950. - Zone
  3951. responses:
  3952. '204':
  3953. description: 'Zone resource deleted'
  3954. '403':
  3955. description: Forbidden
  3956. content:
  3957. application/ld+json:
  3958. schema:
  3959. $ref: '#/components/schemas/Error.jsonld'
  3960. application/problem+json:
  3961. schema:
  3962. $ref: '#/components/schemas/Error'
  3963. application/json:
  3964. schema:
  3965. $ref: '#/components/schemas/Error'
  3966. links: { }
  3967. '404':
  3968. description: 'Not found'
  3969. content:
  3970. application/ld+json:
  3971. schema:
  3972. $ref: '#/components/schemas/Error.jsonld'
  3973. application/problem+json:
  3974. schema:
  3975. $ref: '#/components/schemas/Error'
  3976. application/json:
  3977. schema:
  3978. $ref: '#/components/schemas/Error'
  3979. links: { }
  3980. summary: 'Removes the Zone resource.'
  3981. description: 'Removes the Zone resource.'
  3982. parameters:
  3983. -
  3984. name: id
  3985. in: path
  3986. description: 'Zone identifier'
  3987. required: true
  3988. deprecated: false
  3989. allowEmptyValue: false
  3990. schema:
  3991. type: string
  3992. style: simple
  3993. explode: false
  3994. allowReserved: false
  3995. deprecated: false
  3996. patch:
  3997. operationId: api_zones_id_patch
  3998. tags:
  3999. - Zone
  4000. responses:
  4001. '200':
  4002. description: 'Zone resource updated'
  4003. content:
  4004. application/ld+json:
  4005. schema:
  4006. $ref: '#/components/schemas/Zone.jsonld'
  4007. links: { }
  4008. '400':
  4009. description: 'Invalid input'
  4010. content:
  4011. application/ld+json:
  4012. schema:
  4013. $ref: '#/components/schemas/Error.jsonld'
  4014. application/problem+json:
  4015. schema:
  4016. $ref: '#/components/schemas/Error'
  4017. application/json:
  4018. schema:
  4019. $ref: '#/components/schemas/Error'
  4020. links: { }
  4021. '422':
  4022. description: 'An error occurred'
  4023. content:
  4024. application/ld+json:
  4025. schema:
  4026. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  4027. application/problem+json:
  4028. schema:
  4029. $ref: '#/components/schemas/ConstraintViolation-json'
  4030. application/json:
  4031. schema:
  4032. $ref: '#/components/schemas/ConstraintViolation-json'
  4033. links: { }
  4034. '403':
  4035. description: Forbidden
  4036. content:
  4037. application/ld+json:
  4038. schema:
  4039. $ref: '#/components/schemas/Error.jsonld'
  4040. application/problem+json:
  4041. schema:
  4042. $ref: '#/components/schemas/Error'
  4043. application/json:
  4044. schema:
  4045. $ref: '#/components/schemas/Error'
  4046. links: { }
  4047. '404':
  4048. description: 'Not found'
  4049. content:
  4050. application/ld+json:
  4051. schema:
  4052. $ref: '#/components/schemas/Error.jsonld'
  4053. application/problem+json:
  4054. schema:
  4055. $ref: '#/components/schemas/Error'
  4056. application/json:
  4057. schema:
  4058. $ref: '#/components/schemas/Error'
  4059. links: { }
  4060. summary: 'Updates the Zone resource.'
  4061. description: 'Updates the Zone resource.'
  4062. parameters:
  4063. -
  4064. name: id
  4065. in: path
  4066. description: 'Zone identifier'
  4067. required: true
  4068. deprecated: false
  4069. allowEmptyValue: false
  4070. schema:
  4071. type: string
  4072. style: simple
  4073. explode: false
  4074. allowReserved: false
  4075. requestBody:
  4076. description: 'The updated Zone resource'
  4077. content:
  4078. application/merge-patch+json:
  4079. schema:
  4080. $ref: '#/components/schemas/Zone'
  4081. required: true
  4082. deprecated: false
  4083. components:
  4084. schemas:
  4085. ConstraintViolation-json:
  4086. type: object
  4087. description: 'Unprocessable entity'
  4088. deprecated: false
  4089. properties:
  4090. status:
  4091. default: 422
  4092. example: 422
  4093. type: integer
  4094. violations:
  4095. type: array
  4096. items:
  4097. type: object
  4098. properties:
  4099. propertyPath:
  4100. type: string
  4101. description: 'The property path of the violation'
  4102. message:
  4103. type: string
  4104. description: 'The message associated with the violation'
  4105. detail:
  4106. readOnly: true
  4107. type: string
  4108. type:
  4109. readOnly: true
  4110. type: string
  4111. title:
  4112. readOnly: true
  4113. type:
  4114. - string
  4115. - 'null'
  4116. instance:
  4117. readOnly: true
  4118. type:
  4119. - string
  4120. - 'null'
  4121. ConstraintViolation.jsonld-jsonld:
  4122. type: object
  4123. description: 'Unprocessable entity'
  4124. deprecated: false
  4125. properties:
  4126. '@context':
  4127. readOnly: true
  4128. oneOf:
  4129. -
  4130. type: string
  4131. -
  4132. type: object
  4133. properties:
  4134. '@vocab':
  4135. type: string
  4136. hydra:
  4137. type: string
  4138. enum: ['http://www.w3.org/ns/hydra/core#']
  4139. required:
  4140. - '@vocab'
  4141. - hydra
  4142. additionalProperties: true
  4143. '@id':
  4144. readOnly: true
  4145. type: string
  4146. '@type':
  4147. readOnly: true
  4148. type: string
  4149. status:
  4150. default: 422
  4151. example: 422
  4152. type: integer
  4153. violations:
  4154. type: array
  4155. items:
  4156. type: object
  4157. properties:
  4158. propertyPath:
  4159. type: string
  4160. description: 'The property path of the violation'
  4161. message:
  4162. type: string
  4163. description: 'The message associated with the violation'
  4164. detail:
  4165. readOnly: true
  4166. type: string
  4167. description:
  4168. readOnly: true
  4169. type: string
  4170. type:
  4171. readOnly: true
  4172. type: string
  4173. title:
  4174. readOnly: true
  4175. type:
  4176. - string
  4177. - 'null'
  4178. instance:
  4179. readOnly: true
  4180. type:
  4181. - string
  4182. - 'null'
  4183. Error:
  4184. type: object
  4185. description: 'A representation of common errors.'
  4186. deprecated: false
  4187. properties:
  4188. title:
  4189. readOnly: true
  4190. description: 'A short, human-readable summary of the problem.'
  4191. type:
  4192. - string
  4193. - 'null'
  4194. detail:
  4195. readOnly: true
  4196. description: 'A human-readable explanation specific to this occurrence of the problem.'
  4197. type:
  4198. - string
  4199. - 'null'
  4200. status:
  4201. type: number
  4202. example: 404
  4203. default: 400
  4204. instance:
  4205. readOnly: true
  4206. description: 'A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.'
  4207. type:
  4208. - string
  4209. - 'null'
  4210. type:
  4211. readOnly: true
  4212. description: 'A URI reference that identifies the problem type'
  4213. type: string
  4214. Error.jsonld:
  4215. type: object
  4216. description: 'A representation of common errors.'
  4217. deprecated: false
  4218. properties:
  4219. '@context':
  4220. readOnly: true
  4221. oneOf:
  4222. -
  4223. type: string
  4224. -
  4225. type: object
  4226. properties:
  4227. '@vocab':
  4228. type: string
  4229. hydra:
  4230. type: string
  4231. enum: ['http://www.w3.org/ns/hydra/core#']
  4232. required:
  4233. - '@vocab'
  4234. - hydra
  4235. additionalProperties: true
  4236. '@id':
  4237. readOnly: true
  4238. type: string
  4239. '@type':
  4240. readOnly: true
  4241. type: string
  4242. title:
  4243. readOnly: true
  4244. description: 'A short, human-readable summary of the problem.'
  4245. type:
  4246. - string
  4247. - 'null'
  4248. detail:
  4249. readOnly: true
  4250. description: 'A human-readable explanation specific to this occurrence of the problem.'
  4251. type:
  4252. - string
  4253. - 'null'
  4254. status:
  4255. type: number
  4256. example: 404
  4257. default: 400
  4258. instance:
  4259. readOnly: true
  4260. description: 'A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.'
  4261. type:
  4262. - string
  4263. - 'null'
  4264. type:
  4265. readOnly: true
  4266. description: 'A URI reference that identifies the problem type'
  4267. type: string
  4268. description:
  4269. readOnly: true
  4270. type:
  4271. - string
  4272. - 'null'
  4273. Event.jsonld:
  4274. type: object
  4275. description: ''
  4276. deprecated: false
  4277. properties:
  4278. '@context':
  4279. readOnly: true
  4280. oneOf:
  4281. -
  4282. type: string
  4283. -
  4284. type: object
  4285. properties:
  4286. '@vocab':
  4287. type: string
  4288. hydra:
  4289. type: string
  4290. enum: ['http://www.w3.org/ns/hydra/core#']
  4291. required:
  4292. - '@vocab'
  4293. - hydra
  4294. additionalProperties: true
  4295. '@id':
  4296. readOnly: true
  4297. type: string
  4298. '@type':
  4299. readOnly: true
  4300. type: string
  4301. dbId:
  4302. readOnly: true
  4303. type:
  4304. - integer
  4305. - 'null'
  4306. name:
  4307. type: string
  4308. identifier:
  4309. type: string
  4310. sequence:
  4311. type: integer
  4312. mandatory:
  4313. type: boolean
  4314. createdAt:
  4315. readOnly: true
  4316. type:
  4317. - string
  4318. - 'null'
  4319. format: date-time
  4320. Location:
  4321. type: object
  4322. description: ''
  4323. deprecated: false
  4324. properties:
  4325. dbId:
  4326. readOnly: true
  4327. type:
  4328. - integer
  4329. - 'null'
  4330. zone:
  4331. readOnly: true
  4332. type: string
  4333. format: iri-reference
  4334. example: 'https://example.com/'
  4335. zoneIri:
  4336. type:
  4337. - string
  4338. - 'null'
  4339. format: iri-reference
  4340. example: 'https://example.com/'
  4341. name:
  4342. type: string
  4343. code:
  4344. type: string
  4345. zoneName:
  4346. readOnly: true
  4347. type: string
  4348. isZone:
  4349. type: boolean
  4350. isPlace:
  4351. type: boolean
  4352. isPort:
  4353. type: boolean
  4354. isStartEnd:
  4355. type: boolean
  4356. createdAt:
  4357. readOnly: true
  4358. type:
  4359. - string
  4360. - 'null'
  4361. format: date-time
  4362. required:
  4363. - zoneIri
  4364. - name
  4365. - code
  4366. Location.jsonld:
  4367. type: object
  4368. description: ''
  4369. deprecated: false
  4370. properties:
  4371. '@context':
  4372. readOnly: true
  4373. oneOf:
  4374. -
  4375. type: string
  4376. -
  4377. type: object
  4378. properties:
  4379. '@vocab':
  4380. type: string
  4381. hydra:
  4382. type: string
  4383. enum: ['http://www.w3.org/ns/hydra/core#']
  4384. required:
  4385. - '@vocab'
  4386. - hydra
  4387. additionalProperties: true
  4388. '@id':
  4389. readOnly: true
  4390. type: string
  4391. '@type':
  4392. readOnly: true
  4393. type: string
  4394. dbId:
  4395. readOnly: true
  4396. type:
  4397. - integer
  4398. - 'null'
  4399. zone:
  4400. readOnly: true
  4401. $ref: '#/components/schemas/Zone.jsonld'
  4402. zoneIri:
  4403. type:
  4404. - string
  4405. - 'null'
  4406. format: iri-reference
  4407. example: 'https://example.com/'
  4408. name:
  4409. type: string
  4410. code:
  4411. type: string
  4412. zoneName:
  4413. readOnly: true
  4414. type: string
  4415. isZone:
  4416. type: boolean
  4417. isPlace:
  4418. type: boolean
  4419. isPort:
  4420. type: boolean
  4421. isStartEnd:
  4422. type: boolean
  4423. createdAt:
  4424. readOnly: true
  4425. type:
  4426. - string
  4427. - 'null'
  4428. format: date-time
  4429. required:
  4430. - zoneIri
  4431. - name
  4432. - code
  4433. MediaObject.jsonld:
  4434. type: object
  4435. description: ''
  4436. deprecated: false
  4437. properties:
  4438. '@context':
  4439. readOnly: true
  4440. oneOf:
  4441. -
  4442. type: string
  4443. -
  4444. type: object
  4445. properties:
  4446. '@vocab':
  4447. type: string
  4448. hydra:
  4449. type: string
  4450. enum: ['http://www.w3.org/ns/hydra/core#']
  4451. required:
  4452. - '@vocab'
  4453. - hydra
  4454. additionalProperties: true
  4455. '@id':
  4456. readOnly: true
  4457. type: string
  4458. '@type':
  4459. readOnly: true
  4460. type: string
  4461. dbId:
  4462. readOnly: true
  4463. type:
  4464. - integer
  4465. - 'null'
  4466. contentUrl:
  4467. externalDocs:
  4468. url: 'https://schema.org/contentUrl'
  4469. type:
  4470. - string
  4471. - 'null'
  4472. filePath:
  4473. readOnly: true
  4474. type:
  4475. - string
  4476. - 'null'
  4477. createdAt:
  4478. readOnly: true
  4479. type:
  4480. - string
  4481. - 'null'
  4482. format: date-time
  4483. ShippingCompany:
  4484. type: object
  4485. description: ''
  4486. deprecated: false
  4487. properties:
  4488. dbId:
  4489. readOnly: true
  4490. type:
  4491. - integer
  4492. - 'null'
  4493. name:
  4494. type: string
  4495. code:
  4496. type: string
  4497. createdAt:
  4498. readOnly: true
  4499. type:
  4500. - string
  4501. - 'null'
  4502. format: date-time
  4503. required:
  4504. - name
  4505. - code
  4506. ShippingCompany.jsonld:
  4507. type: object
  4508. description: ''
  4509. deprecated: false
  4510. properties:
  4511. '@context':
  4512. readOnly: true
  4513. oneOf:
  4514. -
  4515. type: string
  4516. -
  4517. type: object
  4518. properties:
  4519. '@vocab':
  4520. type: string
  4521. hydra:
  4522. type: string
  4523. enum: ['http://www.w3.org/ns/hydra/core#']
  4524. required:
  4525. - '@vocab'
  4526. - hydra
  4527. additionalProperties: true
  4528. '@id':
  4529. readOnly: true
  4530. type: string
  4531. '@type':
  4532. readOnly: true
  4533. type: string
  4534. dbId:
  4535. readOnly: true
  4536. type:
  4537. - integer
  4538. - 'null'
  4539. name:
  4540. type: string
  4541. code:
  4542. type: string
  4543. createdAt:
  4544. readOnly: true
  4545. type:
  4546. - string
  4547. - 'null'
  4548. format: date-time
  4549. required:
  4550. - name
  4551. - code
  4552. Trip:
  4553. type: object
  4554. description: ''
  4555. deprecated: false
  4556. properties:
  4557. dbId:
  4558. readOnly: true
  4559. type:
  4560. - integer
  4561. - 'null'
  4562. vessel:
  4563. readOnly: true
  4564. type: string
  4565. format: iri-reference
  4566. example: 'https://example.com/'
  4567. vesselIri:
  4568. type:
  4569. - string
  4570. - 'null'
  4571. format: iri-reference
  4572. example: 'https://example.com/'
  4573. pilotageReference:
  4574. type:
  4575. - string
  4576. - 'null'
  4577. startLocation:
  4578. readOnly: true
  4579. type: string
  4580. format: iri-reference
  4581. example: 'https://example.com/'
  4582. startLocationIri:
  4583. type:
  4584. - string
  4585. - 'null'
  4586. format: iri-reference
  4587. example: 'https://example.com/'
  4588. endLocation:
  4589. readOnly: true
  4590. type: string
  4591. format: iri-reference
  4592. example: 'https://example.com/'
  4593. endLocationIri:
  4594. type:
  4595. - string
  4596. - 'null'
  4597. format: iri-reference
  4598. example: 'https://example.com/'
  4599. startDate:
  4600. type: string
  4601. format: date-time
  4602. endDate:
  4603. type: string
  4604. format: date-time
  4605. note:
  4606. type:
  4607. - string
  4608. - 'null'
  4609. completed:
  4610. type: boolean
  4611. createdAt:
  4612. readOnly: true
  4613. type:
  4614. - string
  4615. - 'null'
  4616. format: date-time
  4617. required:
  4618. - vesselIri
  4619. - startLocationIri
  4620. - endLocationIri
  4621. - startDate
  4622. - endDate
  4623. Trip.jsonld:
  4624. type: object
  4625. description: ''
  4626. deprecated: false
  4627. properties:
  4628. '@context':
  4629. readOnly: true
  4630. oneOf:
  4631. -
  4632. type: string
  4633. -
  4634. type: object
  4635. properties:
  4636. '@vocab':
  4637. type: string
  4638. hydra:
  4639. type: string
  4640. enum: ['http://www.w3.org/ns/hydra/core#']
  4641. required:
  4642. - '@vocab'
  4643. - hydra
  4644. additionalProperties: true
  4645. '@id':
  4646. readOnly: true
  4647. type: string
  4648. '@type':
  4649. readOnly: true
  4650. type: string
  4651. dbId:
  4652. readOnly: true
  4653. type:
  4654. - integer
  4655. - 'null'
  4656. vessel:
  4657. readOnly: true
  4658. $ref: '#/components/schemas/Vessel.jsonld'
  4659. vesselIri:
  4660. type:
  4661. - string
  4662. - 'null'
  4663. format: iri-reference
  4664. example: 'https://example.com/'
  4665. pilotageReference:
  4666. type:
  4667. - string
  4668. - 'null'
  4669. startLocation:
  4670. readOnly: true
  4671. $ref: '#/components/schemas/Location.jsonld'
  4672. startLocationIri:
  4673. type:
  4674. - string
  4675. - 'null'
  4676. format: iri-reference
  4677. example: 'https://example.com/'
  4678. endLocation:
  4679. readOnly: true
  4680. $ref: '#/components/schemas/Location.jsonld'
  4681. endLocationIri:
  4682. type:
  4683. - string
  4684. - 'null'
  4685. format: iri-reference
  4686. example: 'https://example.com/'
  4687. startDate:
  4688. type: string
  4689. format: date-time
  4690. endDate:
  4691. type: string
  4692. format: date-time
  4693. note:
  4694. type:
  4695. - string
  4696. - 'null'
  4697. completed:
  4698. type: boolean
  4699. createdAt:
  4700. readOnly: true
  4701. type:
  4702. - string
  4703. - 'null'
  4704. format: date-time
  4705. required:
  4706. - vesselIri
  4707. - startLocationIri
  4708. - endLocationIri
  4709. - startDate
  4710. - endDate
  4711. TripLocation:
  4712. type: object
  4713. description: ''
  4714. deprecated: false
  4715. properties:
  4716. dbId:
  4717. readOnly: true
  4718. type:
  4719. - integer
  4720. - 'null'
  4721. trip:
  4722. readOnly: true
  4723. type: string
  4724. format: iri-reference
  4725. example: 'https://example.com/'
  4726. tripIri:
  4727. type:
  4728. - string
  4729. - 'null'
  4730. format: iri-reference
  4731. example: 'https://example.com/'
  4732. location:
  4733. readOnly: true
  4734. type: string
  4735. format: iri-reference
  4736. example: 'https://example.com/'
  4737. locationIri:
  4738. type:
  4739. - string
  4740. - 'null'
  4741. format: iri-reference
  4742. example: 'https://example.com/'
  4743. arrivalDateTime:
  4744. type:
  4745. - string
  4746. - 'null'
  4747. format: date-time
  4748. departureDateTime:
  4749. type:
  4750. - string
  4751. - 'null'
  4752. format: date-time
  4753. createdAt:
  4754. readOnly: true
  4755. type:
  4756. - string
  4757. - 'null'
  4758. format: date-time
  4759. required:
  4760. - tripIri
  4761. - locationIri
  4762. TripLocation.jsonld:
  4763. type: object
  4764. description: ''
  4765. deprecated: false
  4766. properties:
  4767. '@context':
  4768. readOnly: true
  4769. oneOf:
  4770. -
  4771. type: string
  4772. -
  4773. type: object
  4774. properties:
  4775. '@vocab':
  4776. type: string
  4777. hydra:
  4778. type: string
  4779. enum: ['http://www.w3.org/ns/hydra/core#']
  4780. required:
  4781. - '@vocab'
  4782. - hydra
  4783. additionalProperties: true
  4784. '@id':
  4785. readOnly: true
  4786. type: string
  4787. '@type':
  4788. readOnly: true
  4789. type: string
  4790. dbId:
  4791. readOnly: true
  4792. type:
  4793. - integer
  4794. - 'null'
  4795. trip:
  4796. readOnly: true
  4797. $ref: '#/components/schemas/Trip.jsonld'
  4798. tripIri:
  4799. type:
  4800. - string
  4801. - 'null'
  4802. format: iri-reference
  4803. example: 'https://example.com/'
  4804. location:
  4805. readOnly: true
  4806. $ref: '#/components/schemas/Location.jsonld'
  4807. locationIri:
  4808. type:
  4809. - string
  4810. - 'null'
  4811. format: iri-reference
  4812. example: 'https://example.com/'
  4813. arrivalDateTime:
  4814. type:
  4815. - string
  4816. - 'null'
  4817. format: date-time
  4818. departureDateTime:
  4819. type:
  4820. - string
  4821. - 'null'
  4822. format: date-time
  4823. createdAt:
  4824. readOnly: true
  4825. type:
  4826. - string
  4827. - 'null'
  4828. format: date-time
  4829. required:
  4830. - tripIri
  4831. - locationIri
  4832. User:
  4833. type: object
  4834. description: ''
  4835. deprecated: false
  4836. properties:
  4837. dbId:
  4838. readOnly: true
  4839. type:
  4840. - integer
  4841. - 'null'
  4842. email:
  4843. format: email
  4844. externalDocs:
  4845. url: 'https://schema.org/email'
  4846. type: string
  4847. firstName:
  4848. type: string
  4849. referenceId:
  4850. type: string
  4851. lastName:
  4852. type: string
  4853. image:
  4854. readOnly: true
  4855. type: string
  4856. format: iri-reference
  4857. example: 'https://example.com/'
  4858. imageIri:
  4859. type:
  4860. - string
  4861. - 'null'
  4862. format: iri-reference
  4863. example: 'https://example.com/'
  4864. imageUrl:
  4865. readOnly: true
  4866. type:
  4867. - string
  4868. - 'null'
  4869. fullName:
  4870. readOnly: true
  4871. type:
  4872. - string
  4873. - 'null'
  4874. password:
  4875. writeOnly: true
  4876. description: 'The plaintext password when being set or changed.'
  4877. type:
  4878. - string
  4879. - 'null'
  4880. isAdmin:
  4881. type: boolean
  4882. active:
  4883. type: boolean
  4884. isPilot:
  4885. type: boolean
  4886. roles:
  4887. readOnly: true
  4888. type: array
  4889. items:
  4890. type: string
  4891. createdAt:
  4892. readOnly: true
  4893. type:
  4894. - string
  4895. - 'null'
  4896. format: date-time
  4897. required:
  4898. - email
  4899. - firstName
  4900. - referenceId
  4901. - lastName
  4902. - isAdmin
  4903. - active
  4904. - isPilot
  4905. User.jsonld:
  4906. type: object
  4907. description: ''
  4908. deprecated: false
  4909. properties:
  4910. '@context':
  4911. readOnly: true
  4912. oneOf:
  4913. -
  4914. type: string
  4915. -
  4916. type: object
  4917. properties:
  4918. '@vocab':
  4919. type: string
  4920. hydra:
  4921. type: string
  4922. enum: ['http://www.w3.org/ns/hydra/core#']
  4923. required:
  4924. - '@vocab'
  4925. - hydra
  4926. additionalProperties: true
  4927. '@id':
  4928. readOnly: true
  4929. type: string
  4930. '@type':
  4931. readOnly: true
  4932. type: string
  4933. dbId:
  4934. readOnly: true
  4935. type:
  4936. - integer
  4937. - 'null'
  4938. email:
  4939. format: email
  4940. externalDocs:
  4941. url: 'https://schema.org/email'
  4942. type: string
  4943. firstName:
  4944. type: string
  4945. referenceId:
  4946. type: string
  4947. lastName:
  4948. type: string
  4949. image:
  4950. readOnly: true
  4951. $ref: '#/components/schemas/MediaObject.jsonld'
  4952. imageIri:
  4953. type:
  4954. - string
  4955. - 'null'
  4956. format: iri-reference
  4957. example: 'https://example.com/'
  4958. imageUrl:
  4959. readOnly: true
  4960. type:
  4961. - string
  4962. - 'null'
  4963. fullName:
  4964. readOnly: true
  4965. type:
  4966. - string
  4967. - 'null'
  4968. password:
  4969. writeOnly: true
  4970. description: 'The plaintext password when being set or changed.'
  4971. type:
  4972. - string
  4973. - 'null'
  4974. isAdmin:
  4975. type: boolean
  4976. active:
  4977. type: boolean
  4978. isPilot:
  4979. type: boolean
  4980. roles:
  4981. readOnly: true
  4982. type: array
  4983. items:
  4984. type: string
  4985. createdAt:
  4986. readOnly: true
  4987. type:
  4988. - string
  4989. - 'null'
  4990. format: date-time
  4991. required:
  4992. - email
  4993. - firstName
  4994. - referenceId
  4995. - lastName
  4996. - isAdmin
  4997. - active
  4998. - isPilot
  4999. UserTrip:
  5000. type: object
  5001. description: ''
  5002. deprecated: false
  5003. properties:
  5004. dbId:
  5005. readOnly: true
  5006. type:
  5007. - integer
  5008. - 'null'
  5009. trip:
  5010. readOnly: true
  5011. type: string
  5012. format: iri-reference
  5013. example: 'https://example.com/'
  5014. tripIri:
  5015. type:
  5016. - string
  5017. - 'null'
  5018. format: iri-reference
  5019. example: 'https://example.com/'
  5020. user:
  5021. readOnly: true
  5022. type: string
  5023. format: iri-reference
  5024. example: 'https://example.com/'
  5025. userIri:
  5026. type:
  5027. - string
  5028. - 'null'
  5029. format: iri-reference
  5030. example: 'https://example.com/'
  5031. captainName:
  5032. type:
  5033. - string
  5034. - 'null'
  5035. completed:
  5036. type: boolean
  5037. approved:
  5038. type: boolean
  5039. signature:
  5040. readOnly: true
  5041. type: string
  5042. format: iri-reference
  5043. example: 'https://example.com/'
  5044. signatureIri:
  5045. type:
  5046. - string
  5047. - 'null'
  5048. format: iri-reference
  5049. example: 'https://example.com/'
  5050. signatureUrl:
  5051. readOnly: true
  5052. type:
  5053. - string
  5054. - 'null'
  5055. completedDate:
  5056. type:
  5057. - string
  5058. - 'null'
  5059. format: date-time
  5060. createdAt:
  5061. readOnly: true
  5062. type:
  5063. - string
  5064. - 'null'
  5065. format: date-time
  5066. required:
  5067. - tripIri
  5068. - userIri
  5069. - completed
  5070. - approved
  5071. UserTrip.jsonld:
  5072. type: object
  5073. description: ''
  5074. deprecated: false
  5075. properties:
  5076. '@context':
  5077. readOnly: true
  5078. oneOf:
  5079. -
  5080. type: string
  5081. -
  5082. type: object
  5083. properties:
  5084. '@vocab':
  5085. type: string
  5086. hydra:
  5087. type: string
  5088. enum: ['http://www.w3.org/ns/hydra/core#']
  5089. required:
  5090. - '@vocab'
  5091. - hydra
  5092. additionalProperties: true
  5093. '@id':
  5094. readOnly: true
  5095. type: string
  5096. '@type':
  5097. readOnly: true
  5098. type: string
  5099. dbId:
  5100. readOnly: true
  5101. type:
  5102. - integer
  5103. - 'null'
  5104. trip:
  5105. readOnly: true
  5106. $ref: '#/components/schemas/Trip.jsonld'
  5107. tripIri:
  5108. type:
  5109. - string
  5110. - 'null'
  5111. format: iri-reference
  5112. example: 'https://example.com/'
  5113. user:
  5114. readOnly: true
  5115. $ref: '#/components/schemas/User.jsonld'
  5116. userIri:
  5117. type:
  5118. - string
  5119. - 'null'
  5120. format: iri-reference
  5121. example: 'https://example.com/'
  5122. captainName:
  5123. type:
  5124. - string
  5125. - 'null'
  5126. completed:
  5127. type: boolean
  5128. approved:
  5129. type: boolean
  5130. signature:
  5131. readOnly: true
  5132. $ref: '#/components/schemas/MediaObject.jsonld'
  5133. signatureIri:
  5134. type:
  5135. - string
  5136. - 'null'
  5137. format: iri-reference
  5138. example: 'https://example.com/'
  5139. signatureUrl:
  5140. readOnly: true
  5141. type:
  5142. - string
  5143. - 'null'
  5144. completedDate:
  5145. type:
  5146. - string
  5147. - 'null'
  5148. format: date-time
  5149. createdAt:
  5150. readOnly: true
  5151. type:
  5152. - string
  5153. - 'null'
  5154. format: date-time
  5155. required:
  5156. - tripIri
  5157. - userIri
  5158. - completed
  5159. - approved
  5160. UserTripEvent:
  5161. type: object
  5162. description: ''
  5163. deprecated: false
  5164. properties:
  5165. dbId:
  5166. readOnly: true
  5167. type:
  5168. - integer
  5169. - 'null'
  5170. userTrip:
  5171. readOnly: true
  5172. $ref: '#/components/schemas/UserTrip'
  5173. userTripIri:
  5174. type:
  5175. - string
  5176. - 'null'
  5177. format: iri-reference
  5178. example: 'https://example.com/'
  5179. event:
  5180. readOnly: true
  5181. type: string
  5182. format: iri-reference
  5183. example: 'https://example.com/'
  5184. eventIri:
  5185. type:
  5186. - string
  5187. - 'null'
  5188. format: iri-reference
  5189. example: 'https://example.com/'
  5190. location:
  5191. readOnly: true
  5192. type: string
  5193. format: iri-reference
  5194. example: 'https://example.com/'
  5195. locationIri:
  5196. type:
  5197. - string
  5198. - 'null'
  5199. format: iri-reference
  5200. example: 'https://example.com/'
  5201. user:
  5202. readOnly: true
  5203. type: string
  5204. format: iri-reference
  5205. example: 'https://example.com/'
  5206. date:
  5207. type: string
  5208. format: date-time
  5209. note:
  5210. type:
  5211. - string
  5212. - 'null'
  5213. createdAt:
  5214. readOnly: true
  5215. type:
  5216. - string
  5217. - 'null'
  5218. format: date-time
  5219. required:
  5220. - userTripIri
  5221. - eventIri
  5222. - locationIri
  5223. - date
  5224. UserTripEvent.jsonld:
  5225. type: object
  5226. description: ''
  5227. deprecated: false
  5228. properties:
  5229. '@context':
  5230. readOnly: true
  5231. oneOf:
  5232. -
  5233. type: string
  5234. -
  5235. type: object
  5236. properties:
  5237. '@vocab':
  5238. type: string
  5239. hydra:
  5240. type: string
  5241. enum: ['http://www.w3.org/ns/hydra/core#']
  5242. required:
  5243. - '@vocab'
  5244. - hydra
  5245. additionalProperties: true
  5246. '@id':
  5247. readOnly: true
  5248. type: string
  5249. '@type':
  5250. readOnly: true
  5251. type: string
  5252. dbId:
  5253. readOnly: true
  5254. type:
  5255. - integer
  5256. - 'null'
  5257. userTrip:
  5258. readOnly: true
  5259. $ref: '#/components/schemas/UserTrip.jsonld'
  5260. userTripIri:
  5261. type:
  5262. - string
  5263. - 'null'
  5264. format: iri-reference
  5265. example: 'https://example.com/'
  5266. event:
  5267. readOnly: true
  5268. $ref: '#/components/schemas/Event.jsonld'
  5269. eventIri:
  5270. type:
  5271. - string
  5272. - 'null'
  5273. format: iri-reference
  5274. example: 'https://example.com/'
  5275. location:
  5276. readOnly: true
  5277. $ref: '#/components/schemas/Location.jsonld'
  5278. locationIri:
  5279. type:
  5280. - string
  5281. - 'null'
  5282. format: iri-reference
  5283. example: 'https://example.com/'
  5284. user:
  5285. readOnly: true
  5286. $ref: '#/components/schemas/User.jsonld'
  5287. date:
  5288. type: string
  5289. format: date-time
  5290. note:
  5291. type:
  5292. - string
  5293. - 'null'
  5294. createdAt:
  5295. readOnly: true
  5296. type:
  5297. - string
  5298. - 'null'
  5299. format: date-time
  5300. required:
  5301. - userTripIri
  5302. - eventIri
  5303. - locationIri
  5304. - date
  5305. UserZone:
  5306. type: object
  5307. description: ''
  5308. deprecated: false
  5309. properties:
  5310. dbId:
  5311. readOnly: true
  5312. type:
  5313. - integer
  5314. - 'null'
  5315. user:
  5316. readOnly: true
  5317. type: string
  5318. format: iri-reference
  5319. example: 'https://example.com/'
  5320. userIri:
  5321. type:
  5322. - string
  5323. - 'null'
  5324. format: iri-reference
  5325. example: 'https://example.com/'
  5326. zone:
  5327. readOnly: true
  5328. type: string
  5329. format: iri-reference
  5330. example: 'https://example.com/'
  5331. zoneIri:
  5332. type:
  5333. - string
  5334. - 'null'
  5335. format: iri-reference
  5336. example: 'https://example.com/'
  5337. UserZone.jsonld:
  5338. type: object
  5339. description: ''
  5340. deprecated: false
  5341. properties:
  5342. '@context':
  5343. readOnly: true
  5344. oneOf:
  5345. -
  5346. type: string
  5347. -
  5348. type: object
  5349. properties:
  5350. '@vocab':
  5351. type: string
  5352. hydra:
  5353. type: string
  5354. enum: ['http://www.w3.org/ns/hydra/core#']
  5355. required:
  5356. - '@vocab'
  5357. - hydra
  5358. additionalProperties: true
  5359. '@id':
  5360. readOnly: true
  5361. type: string
  5362. '@type':
  5363. readOnly: true
  5364. type: string
  5365. dbId:
  5366. readOnly: true
  5367. type:
  5368. - integer
  5369. - 'null'
  5370. user:
  5371. readOnly: true
  5372. $ref: '#/components/schemas/User.jsonld'
  5373. userIri:
  5374. type:
  5375. - string
  5376. - 'null'
  5377. format: iri-reference
  5378. example: 'https://example.com/'
  5379. zone:
  5380. readOnly: true
  5381. $ref: '#/components/schemas/Zone.jsonld'
  5382. zoneIri:
  5383. type:
  5384. - string
  5385. - 'null'
  5386. format: iri-reference
  5387. example: 'https://example.com/'
  5388. Vessel:
  5389. type: object
  5390. description: ''
  5391. deprecated: false
  5392. properties:
  5393. dbId:
  5394. readOnly: true
  5395. type:
  5396. - integer
  5397. - 'null'
  5398. name:
  5399. type: string
  5400. code:
  5401. type: string
  5402. company:
  5403. readOnly: true
  5404. type: string
  5405. format: iri-reference
  5406. example: 'https://example.com/'
  5407. companyIri:
  5408. type:
  5409. - string
  5410. - 'null'
  5411. format: iri-reference
  5412. example: 'https://example.com/'
  5413. length:
  5414. type:
  5415. - number
  5416. - 'null'
  5417. breadth:
  5418. type:
  5419. - number
  5420. - 'null'
  5421. draft:
  5422. type:
  5423. - number
  5424. - 'null'
  5425. grossTonnage:
  5426. type:
  5427. - number
  5428. - 'null'
  5429. imoNo:
  5430. type:
  5431. - string
  5432. - 'null'
  5433. callSign:
  5434. type:
  5435. - string
  5436. - 'null'
  5437. createdAt:
  5438. readOnly: true
  5439. type:
  5440. - string
  5441. - 'null'
  5442. format: date-time
  5443. required:
  5444. - name
  5445. - code
  5446. - companyIri
  5447. Vessel.jsonld:
  5448. type: object
  5449. description: ''
  5450. deprecated: false
  5451. properties:
  5452. '@context':
  5453. readOnly: true
  5454. oneOf:
  5455. -
  5456. type: string
  5457. -
  5458. type: object
  5459. properties:
  5460. '@vocab':
  5461. type: string
  5462. hydra:
  5463. type: string
  5464. enum: ['http://www.w3.org/ns/hydra/core#']
  5465. required:
  5466. - '@vocab'
  5467. - hydra
  5468. additionalProperties: true
  5469. '@id':
  5470. readOnly: true
  5471. type: string
  5472. '@type':
  5473. readOnly: true
  5474. type: string
  5475. dbId:
  5476. readOnly: true
  5477. type:
  5478. - integer
  5479. - 'null'
  5480. name:
  5481. type: string
  5482. code:
  5483. type: string
  5484. company:
  5485. readOnly: true
  5486. $ref: '#/components/schemas/ShippingCompany.jsonld'
  5487. companyIri:
  5488. type:
  5489. - string
  5490. - 'null'
  5491. format: iri-reference
  5492. example: 'https://example.com/'
  5493. length:
  5494. type:
  5495. - number
  5496. - 'null'
  5497. breadth:
  5498. type:
  5499. - number
  5500. - 'null'
  5501. draft:
  5502. type:
  5503. - number
  5504. - 'null'
  5505. grossTonnage:
  5506. type:
  5507. - number
  5508. - 'null'
  5509. imoNo:
  5510. type:
  5511. - string
  5512. - 'null'
  5513. callSign:
  5514. type:
  5515. - string
  5516. - 'null'
  5517. createdAt:
  5518. readOnly: true
  5519. type:
  5520. - string
  5521. - 'null'
  5522. format: date-time
  5523. required:
  5524. - name
  5525. - code
  5526. - companyIri
  5527. Zone:
  5528. type: object
  5529. description: ''
  5530. deprecated: false
  5531. properties:
  5532. dbId:
  5533. readOnly: true
  5534. type:
  5535. - integer
  5536. - 'null'
  5537. name:
  5538. type: string
  5539. createdAt:
  5540. readOnly: true
  5541. type:
  5542. - string
  5543. - 'null'
  5544. format: date-time
  5545. required:
  5546. - name
  5547. Zone.jsonld:
  5548. type: object
  5549. description: ''
  5550. deprecated: false
  5551. properties:
  5552. '@context':
  5553. readOnly: true
  5554. oneOf:
  5555. -
  5556. type: string
  5557. -
  5558. type: object
  5559. properties:
  5560. '@vocab':
  5561. type: string
  5562. hydra:
  5563. type: string
  5564. enum: ['http://www.w3.org/ns/hydra/core#']
  5565. required:
  5566. - '@vocab'
  5567. - hydra
  5568. additionalProperties: true
  5569. '@id':
  5570. readOnly: true
  5571. type: string
  5572. '@type':
  5573. readOnly: true
  5574. type: string
  5575. dbId:
  5576. readOnly: true
  5577. type:
  5578. - integer
  5579. - 'null'
  5580. name:
  5581. type: string
  5582. createdAt:
  5583. readOnly: true
  5584. type:
  5585. - string
  5586. - 'null'
  5587. format: date-time
  5588. required:
  5589. - name
  5590. Credentials:
  5591. type: object
  5592. properties:
  5593. email:
  5594. type: string
  5595. example: user@example.com
  5596. password:
  5597. type: string
  5598. example: password123
  5599. AuthResponse:
  5600. type: object
  5601. properties:
  5602. '@id':
  5603. type: string
  5604. example: /api/users/1
  5605. dbId:
  5606. type: integer
  5607. example: 1
  5608. token:
  5609. type: string
  5610. example: JWT_TOKEN
  5611. responses: { }
  5612. parameters: { }
  5613. examples: { }
  5614. requestBodies: { }
  5615. headers: { }
  5616. securitySchemes:
  5617. JWT:
  5618. type: http
  5619. scheme: bearer
  5620. bearerFormat: JWT
  5621. security:
  5622. -
  5623. JWT: []
  5624. tags:
  5625. -
  5626. name: Event
  5627. -
  5628. name: Location
  5629. -
  5630. name: MediaObject
  5631. -
  5632. name: ShippingCompany
  5633. -
  5634. name: Trip
  5635. -
  5636. name: TripLocation
  5637. -
  5638. name: User
  5639. -
  5640. name: UserTrip
  5641. -
  5642. name: UserTripEvent
  5643. -
  5644. name: UserZone
  5645. -
  5646. name: Vessel
  5647. -
  5648. name: Zone
  5649. webhooks: { }