您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符
 
 
 
 
 

5096 行
147 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: name
  251. in: query
  252. description: ''
  253. required: false
  254. deprecated: false
  255. allowEmptyValue: false
  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_order
  1942. in: query
  1943. description: ''
  1944. required: false
  1945. deprecated: false
  1946. allowEmptyValue: true
  1947. schema:
  1948. type: string
  1949. style: form
  1950. explode: false
  1951. allowReserved: false
  1952. deprecated: false
  1953. post:
  1954. operationId: api_users_post
  1955. tags:
  1956. - User
  1957. responses:
  1958. '201':
  1959. description: 'User resource created'
  1960. content:
  1961. application/ld+json:
  1962. schema:
  1963. $ref: '#/components/schemas/User.jsonld'
  1964. links: { }
  1965. '400':
  1966. description: 'Invalid input'
  1967. content:
  1968. application/ld+json:
  1969. schema:
  1970. $ref: '#/components/schemas/Error.jsonld'
  1971. application/problem+json:
  1972. schema:
  1973. $ref: '#/components/schemas/Error'
  1974. application/json:
  1975. schema:
  1976. $ref: '#/components/schemas/Error'
  1977. links: { }
  1978. '422':
  1979. description: 'An error occurred'
  1980. content:
  1981. application/ld+json:
  1982. schema:
  1983. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  1984. application/problem+json:
  1985. schema:
  1986. $ref: '#/components/schemas/ConstraintViolation-json'
  1987. application/json:
  1988. schema:
  1989. $ref: '#/components/schemas/ConstraintViolation-json'
  1990. links: { }
  1991. '403':
  1992. description: Forbidden
  1993. content:
  1994. application/ld+json:
  1995. schema:
  1996. $ref: '#/components/schemas/Error.jsonld'
  1997. application/problem+json:
  1998. schema:
  1999. $ref: '#/components/schemas/Error'
  2000. application/json:
  2001. schema:
  2002. $ref: '#/components/schemas/Error'
  2003. links: { }
  2004. summary: 'Creates a User resource.'
  2005. description: 'Creates a User resource.'
  2006. parameters: []
  2007. requestBody:
  2008. description: 'The new User resource'
  2009. content:
  2010. application/ld+json:
  2011. schema:
  2012. $ref: '#/components/schemas/User.jsonld'
  2013. required: true
  2014. deprecated: false
  2015. '/api/users/{id}':
  2016. get:
  2017. operationId: api_users_id_get
  2018. tags:
  2019. - User
  2020. responses:
  2021. '200':
  2022. description: 'User resource'
  2023. content:
  2024. application/ld+json:
  2025. schema:
  2026. $ref: '#/components/schemas/User.jsonld'
  2027. '403':
  2028. description: Forbidden
  2029. content:
  2030. application/ld+json:
  2031. schema:
  2032. $ref: '#/components/schemas/Error.jsonld'
  2033. application/problem+json:
  2034. schema:
  2035. $ref: '#/components/schemas/Error'
  2036. application/json:
  2037. schema:
  2038. $ref: '#/components/schemas/Error'
  2039. links: { }
  2040. '404':
  2041. description: 'Not found'
  2042. content:
  2043. application/ld+json:
  2044. schema:
  2045. $ref: '#/components/schemas/Error.jsonld'
  2046. application/problem+json:
  2047. schema:
  2048. $ref: '#/components/schemas/Error'
  2049. application/json:
  2050. schema:
  2051. $ref: '#/components/schemas/Error'
  2052. links: { }
  2053. summary: 'Retrieves a User resource.'
  2054. description: 'Retrieves a User resource.'
  2055. parameters:
  2056. -
  2057. name: id
  2058. in: path
  2059. description: 'User identifier'
  2060. required: true
  2061. deprecated: false
  2062. allowEmptyValue: false
  2063. schema:
  2064. type: string
  2065. style: simple
  2066. explode: false
  2067. allowReserved: false
  2068. deprecated: false
  2069. delete:
  2070. operationId: api_users_id_delete
  2071. tags:
  2072. - User
  2073. responses:
  2074. '204':
  2075. description: 'User resource deleted'
  2076. '403':
  2077. description: Forbidden
  2078. content:
  2079. application/ld+json:
  2080. schema:
  2081. $ref: '#/components/schemas/Error.jsonld'
  2082. application/problem+json:
  2083. schema:
  2084. $ref: '#/components/schemas/Error'
  2085. application/json:
  2086. schema:
  2087. $ref: '#/components/schemas/Error'
  2088. links: { }
  2089. '404':
  2090. description: 'Not found'
  2091. content:
  2092. application/ld+json:
  2093. schema:
  2094. $ref: '#/components/schemas/Error.jsonld'
  2095. application/problem+json:
  2096. schema:
  2097. $ref: '#/components/schemas/Error'
  2098. application/json:
  2099. schema:
  2100. $ref: '#/components/schemas/Error'
  2101. links: { }
  2102. summary: 'Removes the User resource.'
  2103. description: 'Removes the User resource.'
  2104. parameters:
  2105. -
  2106. name: id
  2107. in: path
  2108. description: 'User identifier'
  2109. required: true
  2110. deprecated: false
  2111. allowEmptyValue: false
  2112. schema:
  2113. type: string
  2114. style: simple
  2115. explode: false
  2116. allowReserved: false
  2117. deprecated: false
  2118. patch:
  2119. operationId: api_users_id_patch
  2120. tags:
  2121. - User
  2122. responses:
  2123. '200':
  2124. description: 'User resource updated'
  2125. content:
  2126. application/ld+json:
  2127. schema:
  2128. $ref: '#/components/schemas/User.jsonld'
  2129. links: { }
  2130. '400':
  2131. description: 'Invalid input'
  2132. content:
  2133. application/ld+json:
  2134. schema:
  2135. $ref: '#/components/schemas/Error.jsonld'
  2136. application/problem+json:
  2137. schema:
  2138. $ref: '#/components/schemas/Error'
  2139. application/json:
  2140. schema:
  2141. $ref: '#/components/schemas/Error'
  2142. links: { }
  2143. '422':
  2144. description: 'An error occurred'
  2145. content:
  2146. application/ld+json:
  2147. schema:
  2148. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2149. application/problem+json:
  2150. schema:
  2151. $ref: '#/components/schemas/ConstraintViolation-json'
  2152. application/json:
  2153. schema:
  2154. $ref: '#/components/schemas/ConstraintViolation-json'
  2155. links: { }
  2156. '403':
  2157. description: Forbidden
  2158. content:
  2159. application/ld+json:
  2160. schema:
  2161. $ref: '#/components/schemas/Error.jsonld'
  2162. application/problem+json:
  2163. schema:
  2164. $ref: '#/components/schemas/Error'
  2165. application/json:
  2166. schema:
  2167. $ref: '#/components/schemas/Error'
  2168. links: { }
  2169. '404':
  2170. description: 'Not found'
  2171. content:
  2172. application/ld+json:
  2173. schema:
  2174. $ref: '#/components/schemas/Error.jsonld'
  2175. application/problem+json:
  2176. schema:
  2177. $ref: '#/components/schemas/Error'
  2178. application/json:
  2179. schema:
  2180. $ref: '#/components/schemas/Error'
  2181. links: { }
  2182. summary: 'Updates the User resource.'
  2183. description: 'Updates the User resource.'
  2184. parameters:
  2185. -
  2186. name: id
  2187. in: path
  2188. description: 'User identifier'
  2189. required: true
  2190. deprecated: false
  2191. allowEmptyValue: false
  2192. schema:
  2193. type: string
  2194. style: simple
  2195. explode: false
  2196. allowReserved: false
  2197. requestBody:
  2198. description: 'The updated User resource'
  2199. content:
  2200. application/merge-patch+json:
  2201. schema:
  2202. $ref: '#/components/schemas/User'
  2203. required: true
  2204. deprecated: false
  2205. /api/user_trips:
  2206. get:
  2207. operationId: api_user_trips_get_collection
  2208. tags:
  2209. - UserTrip
  2210. responses:
  2211. '200':
  2212. description: 'UserTrip collection'
  2213. content:
  2214. application/ld+json:
  2215. schema:
  2216. type: object
  2217. properties:
  2218. member: { type: array, items: { $ref: '#/components/schemas/UserTrip.jsonld' } }
  2219. totalItems: { type: integer, minimum: 0 }
  2220. 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 } }
  2221. 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 } } } } } }
  2222. required:
  2223. - member
  2224. '403':
  2225. description: Forbidden
  2226. content:
  2227. application/ld+json:
  2228. schema:
  2229. $ref: '#/components/schemas/Error.jsonld'
  2230. application/problem+json:
  2231. schema:
  2232. $ref: '#/components/schemas/Error'
  2233. application/json:
  2234. schema:
  2235. $ref: '#/components/schemas/Error'
  2236. links: { }
  2237. summary: 'Retrieves the collection of UserTrip resources.'
  2238. description: 'Retrieves the collection of UserTrip resources.'
  2239. parameters:
  2240. -
  2241. name: page
  2242. in: query
  2243. description: 'The collection page number'
  2244. required: false
  2245. deprecated: false
  2246. allowEmptyValue: true
  2247. schema:
  2248. type: integer
  2249. default: 1
  2250. style: form
  2251. explode: false
  2252. allowReserved: false
  2253. -
  2254. name: itemsPerPage
  2255. in: query
  2256. description: 'The number of items per page'
  2257. required: false
  2258. deprecated: false
  2259. allowEmptyValue: true
  2260. schema:
  2261. type: integer
  2262. default: 50
  2263. minimum: 0
  2264. maximum: 200
  2265. style: form
  2266. explode: false
  2267. allowReserved: false
  2268. -
  2269. name: trip
  2270. in: query
  2271. description: ''
  2272. required: false
  2273. deprecated: false
  2274. allowEmptyValue: false
  2275. schema:
  2276. type: string
  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: array
  2289. items:
  2290. type: string
  2291. style: form
  2292. explode: true
  2293. allowReserved: false
  2294. -
  2295. name: user
  2296. in: query
  2297. description: ''
  2298. required: false
  2299. deprecated: false
  2300. allowEmptyValue: false
  2301. schema:
  2302. type: string
  2303. style: form
  2304. explode: false
  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: array
  2315. items:
  2316. type: string
  2317. style: form
  2318. explode: true
  2319. allowReserved: false
  2320. -
  2321. name: custom_json_filter
  2322. in: query
  2323. description: ''
  2324. required: false
  2325. deprecated: false
  2326. allowEmptyValue: false
  2327. schema:
  2328. type: string
  2329. style: form
  2330. explode: false
  2331. allowReserved: false
  2332. -
  2333. name: custom_json_order
  2334. in: query
  2335. description: ''
  2336. required: false
  2337. deprecated: false
  2338. allowEmptyValue: true
  2339. schema:
  2340. type: string
  2341. style: form
  2342. explode: false
  2343. allowReserved: false
  2344. deprecated: false
  2345. post:
  2346. operationId: api_user_trips_post
  2347. tags:
  2348. - UserTrip
  2349. responses:
  2350. '201':
  2351. description: 'UserTrip resource created'
  2352. content:
  2353. application/ld+json:
  2354. schema:
  2355. $ref: '#/components/schemas/UserTrip.jsonld'
  2356. links: { }
  2357. '400':
  2358. description: 'Invalid input'
  2359. content:
  2360. application/ld+json:
  2361. schema:
  2362. $ref: '#/components/schemas/Error.jsonld'
  2363. application/problem+json:
  2364. schema:
  2365. $ref: '#/components/schemas/Error'
  2366. application/json:
  2367. schema:
  2368. $ref: '#/components/schemas/Error'
  2369. links: { }
  2370. '422':
  2371. description: 'An error occurred'
  2372. content:
  2373. application/ld+json:
  2374. schema:
  2375. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2376. application/problem+json:
  2377. schema:
  2378. $ref: '#/components/schemas/ConstraintViolation-json'
  2379. application/json:
  2380. schema:
  2381. $ref: '#/components/schemas/ConstraintViolation-json'
  2382. links: { }
  2383. '403':
  2384. description: Forbidden
  2385. content:
  2386. application/ld+json:
  2387. schema:
  2388. $ref: '#/components/schemas/Error.jsonld'
  2389. application/problem+json:
  2390. schema:
  2391. $ref: '#/components/schemas/Error'
  2392. application/json:
  2393. schema:
  2394. $ref: '#/components/schemas/Error'
  2395. links: { }
  2396. summary: 'Creates a UserTrip resource.'
  2397. description: 'Creates a UserTrip resource.'
  2398. parameters: []
  2399. requestBody:
  2400. description: 'The new UserTrip resource'
  2401. content:
  2402. application/ld+json:
  2403. schema:
  2404. $ref: '#/components/schemas/UserTrip.jsonld'
  2405. required: true
  2406. deprecated: false
  2407. '/api/user_trips/{id}':
  2408. get:
  2409. operationId: api_user_trips_id_get
  2410. tags:
  2411. - UserTrip
  2412. responses:
  2413. '200':
  2414. description: 'UserTrip resource'
  2415. content:
  2416. application/ld+json:
  2417. schema:
  2418. $ref: '#/components/schemas/UserTrip.jsonld'
  2419. '403':
  2420. description: Forbidden
  2421. content:
  2422. application/ld+json:
  2423. schema:
  2424. $ref: '#/components/schemas/Error.jsonld'
  2425. application/problem+json:
  2426. schema:
  2427. $ref: '#/components/schemas/Error'
  2428. application/json:
  2429. schema:
  2430. $ref: '#/components/schemas/Error'
  2431. links: { }
  2432. '404':
  2433. description: 'Not found'
  2434. content:
  2435. application/ld+json:
  2436. schema:
  2437. $ref: '#/components/schemas/Error.jsonld'
  2438. application/problem+json:
  2439. schema:
  2440. $ref: '#/components/schemas/Error'
  2441. application/json:
  2442. schema:
  2443. $ref: '#/components/schemas/Error'
  2444. links: { }
  2445. summary: 'Retrieves a UserTrip resource.'
  2446. description: 'Retrieves a UserTrip resource.'
  2447. parameters:
  2448. -
  2449. name: id
  2450. in: path
  2451. description: 'UserTrip identifier'
  2452. required: true
  2453. deprecated: false
  2454. allowEmptyValue: false
  2455. schema:
  2456. type: string
  2457. style: simple
  2458. explode: false
  2459. allowReserved: false
  2460. deprecated: false
  2461. delete:
  2462. operationId: api_user_trips_id_delete
  2463. tags:
  2464. - UserTrip
  2465. responses:
  2466. '204':
  2467. description: 'UserTrip resource deleted'
  2468. '403':
  2469. description: Forbidden
  2470. content:
  2471. application/ld+json:
  2472. schema:
  2473. $ref: '#/components/schemas/Error.jsonld'
  2474. application/problem+json:
  2475. schema:
  2476. $ref: '#/components/schemas/Error'
  2477. application/json:
  2478. schema:
  2479. $ref: '#/components/schemas/Error'
  2480. links: { }
  2481. '404':
  2482. description: 'Not found'
  2483. content:
  2484. application/ld+json:
  2485. schema:
  2486. $ref: '#/components/schemas/Error.jsonld'
  2487. application/problem+json:
  2488. schema:
  2489. $ref: '#/components/schemas/Error'
  2490. application/json:
  2491. schema:
  2492. $ref: '#/components/schemas/Error'
  2493. links: { }
  2494. summary: 'Removes the UserTrip resource.'
  2495. description: 'Removes the UserTrip resource.'
  2496. parameters:
  2497. -
  2498. name: id
  2499. in: path
  2500. description: 'UserTrip identifier'
  2501. required: true
  2502. deprecated: false
  2503. allowEmptyValue: false
  2504. schema:
  2505. type: string
  2506. style: simple
  2507. explode: false
  2508. allowReserved: false
  2509. deprecated: false
  2510. patch:
  2511. operationId: api_user_trips_id_patch
  2512. tags:
  2513. - UserTrip
  2514. responses:
  2515. '200':
  2516. description: 'UserTrip resource updated'
  2517. content:
  2518. application/ld+json:
  2519. schema:
  2520. $ref: '#/components/schemas/UserTrip.jsonld'
  2521. links: { }
  2522. '400':
  2523. description: 'Invalid input'
  2524. content:
  2525. application/ld+json:
  2526. schema:
  2527. $ref: '#/components/schemas/Error.jsonld'
  2528. application/problem+json:
  2529. schema:
  2530. $ref: '#/components/schemas/Error'
  2531. application/json:
  2532. schema:
  2533. $ref: '#/components/schemas/Error'
  2534. links: { }
  2535. '422':
  2536. description: 'An error occurred'
  2537. content:
  2538. application/ld+json:
  2539. schema:
  2540. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2541. application/problem+json:
  2542. schema:
  2543. $ref: '#/components/schemas/ConstraintViolation-json'
  2544. application/json:
  2545. schema:
  2546. $ref: '#/components/schemas/ConstraintViolation-json'
  2547. links: { }
  2548. '403':
  2549. description: Forbidden
  2550. content:
  2551. application/ld+json:
  2552. schema:
  2553. $ref: '#/components/schemas/Error.jsonld'
  2554. application/problem+json:
  2555. schema:
  2556. $ref: '#/components/schemas/Error'
  2557. application/json:
  2558. schema:
  2559. $ref: '#/components/schemas/Error'
  2560. links: { }
  2561. '404':
  2562. description: 'Not found'
  2563. content:
  2564. application/ld+json:
  2565. schema:
  2566. $ref: '#/components/schemas/Error.jsonld'
  2567. application/problem+json:
  2568. schema:
  2569. $ref: '#/components/schemas/Error'
  2570. application/json:
  2571. schema:
  2572. $ref: '#/components/schemas/Error'
  2573. links: { }
  2574. summary: 'Updates the UserTrip resource.'
  2575. description: 'Updates the UserTrip resource.'
  2576. parameters:
  2577. -
  2578. name: id
  2579. in: path
  2580. description: 'UserTrip identifier'
  2581. required: true
  2582. deprecated: false
  2583. allowEmptyValue: false
  2584. schema:
  2585. type: string
  2586. style: simple
  2587. explode: false
  2588. allowReserved: false
  2589. requestBody:
  2590. description: 'The updated UserTrip resource'
  2591. content:
  2592. application/merge-patch+json:
  2593. schema:
  2594. $ref: '#/components/schemas/UserTrip'
  2595. required: true
  2596. deprecated: false
  2597. /api/user_trip_events:
  2598. get:
  2599. operationId: api_user_trip_events_get_collection
  2600. tags:
  2601. - UserTripEvent
  2602. responses:
  2603. '200':
  2604. description: 'UserTripEvent collection'
  2605. content:
  2606. application/ld+json:
  2607. schema:
  2608. type: object
  2609. properties:
  2610. member: { type: array, items: { $ref: '#/components/schemas/UserTripEvent.jsonld' } }
  2611. totalItems: { type: integer, minimum: 0 }
  2612. 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 } }
  2613. 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 } } } } } }
  2614. required:
  2615. - member
  2616. '403':
  2617. description: Forbidden
  2618. content:
  2619. application/ld+json:
  2620. schema:
  2621. $ref: '#/components/schemas/Error.jsonld'
  2622. application/problem+json:
  2623. schema:
  2624. $ref: '#/components/schemas/Error'
  2625. application/json:
  2626. schema:
  2627. $ref: '#/components/schemas/Error'
  2628. links: { }
  2629. summary: 'Retrieves the collection of UserTripEvent resources.'
  2630. description: 'Retrieves the collection of UserTripEvent resources.'
  2631. parameters:
  2632. -
  2633. name: page
  2634. in: query
  2635. description: 'The collection page number'
  2636. required: false
  2637. deprecated: false
  2638. allowEmptyValue: true
  2639. schema:
  2640. type: integer
  2641. default: 1
  2642. style: form
  2643. explode: false
  2644. allowReserved: false
  2645. -
  2646. name: itemsPerPage
  2647. in: query
  2648. description: 'The number of items per page'
  2649. required: false
  2650. deprecated: false
  2651. allowEmptyValue: true
  2652. schema:
  2653. type: integer
  2654. default: 50
  2655. minimum: 0
  2656. maximum: 200
  2657. style: form
  2658. explode: false
  2659. allowReserved: false
  2660. -
  2661. name: userTrip
  2662. in: query
  2663. description: ''
  2664. required: false
  2665. deprecated: false
  2666. allowEmptyValue: false
  2667. schema:
  2668. type: string
  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: array
  2681. items:
  2682. type: string
  2683. style: form
  2684. explode: true
  2685. allowReserved: false
  2686. -
  2687. name: tripId
  2688. in: query
  2689. description: 'Filter UserTripEvents by Trip ID'
  2690. required: false
  2691. deprecated: false
  2692. allowEmptyValue: false
  2693. schema:
  2694. type: integer
  2695. style: form
  2696. explode: false
  2697. allowReserved: false
  2698. -
  2699. name: custom_json_filter
  2700. in: query
  2701. description: ''
  2702. required: false
  2703. deprecated: false
  2704. allowEmptyValue: false
  2705. schema:
  2706. type: string
  2707. style: form
  2708. explode: false
  2709. allowReserved: false
  2710. -
  2711. name: custom_json_order
  2712. in: query
  2713. description: ''
  2714. required: false
  2715. deprecated: false
  2716. allowEmptyValue: true
  2717. schema:
  2718. type: string
  2719. style: form
  2720. explode: false
  2721. allowReserved: false
  2722. deprecated: false
  2723. post:
  2724. operationId: api_user_trip_events_post
  2725. tags:
  2726. - UserTripEvent
  2727. responses:
  2728. '201':
  2729. description: 'UserTripEvent resource created'
  2730. content:
  2731. application/ld+json:
  2732. schema:
  2733. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2734. links: { }
  2735. '400':
  2736. description: 'Invalid input'
  2737. content:
  2738. application/ld+json:
  2739. schema:
  2740. $ref: '#/components/schemas/Error.jsonld'
  2741. application/problem+json:
  2742. schema:
  2743. $ref: '#/components/schemas/Error'
  2744. application/json:
  2745. schema:
  2746. $ref: '#/components/schemas/Error'
  2747. links: { }
  2748. '422':
  2749. description: 'An error occurred'
  2750. content:
  2751. application/ld+json:
  2752. schema:
  2753. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2754. application/problem+json:
  2755. schema:
  2756. $ref: '#/components/schemas/ConstraintViolation-json'
  2757. application/json:
  2758. schema:
  2759. $ref: '#/components/schemas/ConstraintViolation-json'
  2760. links: { }
  2761. '403':
  2762. description: Forbidden
  2763. content:
  2764. application/ld+json:
  2765. schema:
  2766. $ref: '#/components/schemas/Error.jsonld'
  2767. application/problem+json:
  2768. schema:
  2769. $ref: '#/components/schemas/Error'
  2770. application/json:
  2771. schema:
  2772. $ref: '#/components/schemas/Error'
  2773. links: { }
  2774. summary: 'Creates a UserTripEvent resource.'
  2775. description: 'Creates a UserTripEvent resource.'
  2776. parameters: []
  2777. requestBody:
  2778. description: 'The new UserTripEvent resource'
  2779. content:
  2780. application/ld+json:
  2781. schema:
  2782. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2783. required: true
  2784. deprecated: false
  2785. '/api/user_trip_events/{id}':
  2786. get:
  2787. operationId: api_user_trip_events_id_get
  2788. tags:
  2789. - UserTripEvent
  2790. responses:
  2791. '200':
  2792. description: 'UserTripEvent resource'
  2793. content:
  2794. application/ld+json:
  2795. schema:
  2796. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2797. '403':
  2798. description: Forbidden
  2799. content:
  2800. application/ld+json:
  2801. schema:
  2802. $ref: '#/components/schemas/Error.jsonld'
  2803. application/problem+json:
  2804. schema:
  2805. $ref: '#/components/schemas/Error'
  2806. application/json:
  2807. schema:
  2808. $ref: '#/components/schemas/Error'
  2809. links: { }
  2810. '404':
  2811. description: 'Not found'
  2812. content:
  2813. application/ld+json:
  2814. schema:
  2815. $ref: '#/components/schemas/Error.jsonld'
  2816. application/problem+json:
  2817. schema:
  2818. $ref: '#/components/schemas/Error'
  2819. application/json:
  2820. schema:
  2821. $ref: '#/components/schemas/Error'
  2822. links: { }
  2823. summary: 'Retrieves a UserTripEvent resource.'
  2824. description: 'Retrieves a UserTripEvent resource.'
  2825. parameters:
  2826. -
  2827. name: id
  2828. in: path
  2829. description: 'UserTripEvent identifier'
  2830. required: true
  2831. deprecated: false
  2832. allowEmptyValue: false
  2833. schema:
  2834. type: string
  2835. style: simple
  2836. explode: false
  2837. allowReserved: false
  2838. deprecated: false
  2839. delete:
  2840. operationId: api_user_trip_events_id_delete
  2841. tags:
  2842. - UserTripEvent
  2843. responses:
  2844. '204':
  2845. description: 'UserTripEvent resource deleted'
  2846. '403':
  2847. description: Forbidden
  2848. content:
  2849. application/ld+json:
  2850. schema:
  2851. $ref: '#/components/schemas/Error.jsonld'
  2852. application/problem+json:
  2853. schema:
  2854. $ref: '#/components/schemas/Error'
  2855. application/json:
  2856. schema:
  2857. $ref: '#/components/schemas/Error'
  2858. links: { }
  2859. '404':
  2860. description: 'Not found'
  2861. content:
  2862. application/ld+json:
  2863. schema:
  2864. $ref: '#/components/schemas/Error.jsonld'
  2865. application/problem+json:
  2866. schema:
  2867. $ref: '#/components/schemas/Error'
  2868. application/json:
  2869. schema:
  2870. $ref: '#/components/schemas/Error'
  2871. links: { }
  2872. summary: 'Removes the UserTripEvent resource.'
  2873. description: 'Removes the UserTripEvent resource.'
  2874. parameters:
  2875. -
  2876. name: id
  2877. in: path
  2878. description: 'UserTripEvent identifier'
  2879. required: true
  2880. deprecated: false
  2881. allowEmptyValue: false
  2882. schema:
  2883. type: string
  2884. style: simple
  2885. explode: false
  2886. allowReserved: false
  2887. deprecated: false
  2888. patch:
  2889. operationId: api_user_trip_events_id_patch
  2890. tags:
  2891. - UserTripEvent
  2892. responses:
  2893. '200':
  2894. description: 'UserTripEvent resource updated'
  2895. content:
  2896. application/ld+json:
  2897. schema:
  2898. $ref: '#/components/schemas/UserTripEvent.jsonld'
  2899. links: { }
  2900. '400':
  2901. description: 'Invalid input'
  2902. content:
  2903. application/ld+json:
  2904. schema:
  2905. $ref: '#/components/schemas/Error.jsonld'
  2906. application/problem+json:
  2907. schema:
  2908. $ref: '#/components/schemas/Error'
  2909. application/json:
  2910. schema:
  2911. $ref: '#/components/schemas/Error'
  2912. links: { }
  2913. '422':
  2914. description: 'An error occurred'
  2915. content:
  2916. application/ld+json:
  2917. schema:
  2918. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  2919. application/problem+json:
  2920. schema:
  2921. $ref: '#/components/schemas/ConstraintViolation-json'
  2922. application/json:
  2923. schema:
  2924. $ref: '#/components/schemas/ConstraintViolation-json'
  2925. links: { }
  2926. '403':
  2927. description: Forbidden
  2928. content:
  2929. application/ld+json:
  2930. schema:
  2931. $ref: '#/components/schemas/Error.jsonld'
  2932. application/problem+json:
  2933. schema:
  2934. $ref: '#/components/schemas/Error'
  2935. application/json:
  2936. schema:
  2937. $ref: '#/components/schemas/Error'
  2938. links: { }
  2939. '404':
  2940. description: 'Not found'
  2941. content:
  2942. application/ld+json:
  2943. schema:
  2944. $ref: '#/components/schemas/Error.jsonld'
  2945. application/problem+json:
  2946. schema:
  2947. $ref: '#/components/schemas/Error'
  2948. application/json:
  2949. schema:
  2950. $ref: '#/components/schemas/Error'
  2951. links: { }
  2952. summary: 'Updates the UserTripEvent resource.'
  2953. description: 'Updates the UserTripEvent resource.'
  2954. parameters:
  2955. -
  2956. name: id
  2957. in: path
  2958. description: 'UserTripEvent identifier'
  2959. required: true
  2960. deprecated: false
  2961. allowEmptyValue: false
  2962. schema:
  2963. type: string
  2964. style: simple
  2965. explode: false
  2966. allowReserved: false
  2967. requestBody:
  2968. description: 'The updated UserTripEvent resource'
  2969. content:
  2970. application/merge-patch+json:
  2971. schema:
  2972. $ref: '#/components/schemas/UserTripEvent'
  2973. required: true
  2974. deprecated: false
  2975. /api/vessels:
  2976. get:
  2977. operationId: api_vessels_get_collection
  2978. tags:
  2979. - Vessel
  2980. responses:
  2981. '200':
  2982. description: 'Vessel collection'
  2983. content:
  2984. application/ld+json:
  2985. schema:
  2986. type: object
  2987. properties:
  2988. member: { type: array, items: { $ref: '#/components/schemas/Vessel.jsonld' } }
  2989. totalItems: { type: integer, minimum: 0 }
  2990. 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 } }
  2991. 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 } } } } } }
  2992. required:
  2993. - member
  2994. '403':
  2995. description: Forbidden
  2996. content:
  2997. application/ld+json:
  2998. schema:
  2999. $ref: '#/components/schemas/Error.jsonld'
  3000. application/problem+json:
  3001. schema:
  3002. $ref: '#/components/schemas/Error'
  3003. application/json:
  3004. schema:
  3005. $ref: '#/components/schemas/Error'
  3006. links: { }
  3007. summary: 'Retrieves the collection of Vessel resources.'
  3008. description: 'Retrieves the collection of Vessel resources.'
  3009. parameters:
  3010. -
  3011. name: page
  3012. in: query
  3013. description: 'The collection page number'
  3014. required: false
  3015. deprecated: false
  3016. allowEmptyValue: true
  3017. schema:
  3018. type: integer
  3019. default: 1
  3020. style: form
  3021. explode: false
  3022. allowReserved: false
  3023. -
  3024. name: itemsPerPage
  3025. in: query
  3026. description: 'The number of items per page'
  3027. required: false
  3028. deprecated: false
  3029. allowEmptyValue: true
  3030. schema:
  3031. type: integer
  3032. default: 50
  3033. minimum: 0
  3034. maximum: 200
  3035. style: form
  3036. explode: false
  3037. allowReserved: false
  3038. -
  3039. name: name
  3040. in: query
  3041. description: ''
  3042. required: false
  3043. deprecated: false
  3044. allowEmptyValue: false
  3045. schema:
  3046. type: string
  3047. style: form
  3048. explode: false
  3049. allowReserved: false
  3050. -
  3051. name: custom_json_filter
  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: custom_json_order
  3064. in: query
  3065. description: ''
  3066. required: false
  3067. deprecated: false
  3068. allowEmptyValue: true
  3069. schema:
  3070. type: string
  3071. style: form
  3072. explode: false
  3073. allowReserved: false
  3074. deprecated: false
  3075. post:
  3076. operationId: api_vessels_post
  3077. tags:
  3078. - Vessel
  3079. responses:
  3080. '201':
  3081. description: 'Vessel resource created'
  3082. content:
  3083. application/ld+json:
  3084. schema:
  3085. $ref: '#/components/schemas/Vessel.jsonld'
  3086. links: { }
  3087. '400':
  3088. description: 'Invalid input'
  3089. content:
  3090. application/ld+json:
  3091. schema:
  3092. $ref: '#/components/schemas/Error.jsonld'
  3093. application/problem+json:
  3094. schema:
  3095. $ref: '#/components/schemas/Error'
  3096. application/json:
  3097. schema:
  3098. $ref: '#/components/schemas/Error'
  3099. links: { }
  3100. '422':
  3101. description: 'An error occurred'
  3102. content:
  3103. application/ld+json:
  3104. schema:
  3105. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3106. application/problem+json:
  3107. schema:
  3108. $ref: '#/components/schemas/ConstraintViolation-json'
  3109. application/json:
  3110. schema:
  3111. $ref: '#/components/schemas/ConstraintViolation-json'
  3112. links: { }
  3113. '403':
  3114. description: Forbidden
  3115. content:
  3116. application/ld+json:
  3117. schema:
  3118. $ref: '#/components/schemas/Error.jsonld'
  3119. application/problem+json:
  3120. schema:
  3121. $ref: '#/components/schemas/Error'
  3122. application/json:
  3123. schema:
  3124. $ref: '#/components/schemas/Error'
  3125. links: { }
  3126. summary: 'Creates a Vessel resource.'
  3127. description: 'Creates a Vessel resource.'
  3128. parameters: []
  3129. requestBody:
  3130. description: 'The new Vessel resource'
  3131. content:
  3132. application/ld+json:
  3133. schema:
  3134. $ref: '#/components/schemas/Vessel.jsonld'
  3135. required: true
  3136. deprecated: false
  3137. '/api/vessels/{id}':
  3138. get:
  3139. operationId: api_vessels_id_get
  3140. tags:
  3141. - Vessel
  3142. responses:
  3143. '200':
  3144. description: 'Vessel resource'
  3145. content:
  3146. application/ld+json:
  3147. schema:
  3148. $ref: '#/components/schemas/Vessel.jsonld'
  3149. '403':
  3150. description: Forbidden
  3151. content:
  3152. application/ld+json:
  3153. schema:
  3154. $ref: '#/components/schemas/Error.jsonld'
  3155. application/problem+json:
  3156. schema:
  3157. $ref: '#/components/schemas/Error'
  3158. application/json:
  3159. schema:
  3160. $ref: '#/components/schemas/Error'
  3161. links: { }
  3162. '404':
  3163. description: 'Not found'
  3164. content:
  3165. application/ld+json:
  3166. schema:
  3167. $ref: '#/components/schemas/Error.jsonld'
  3168. application/problem+json:
  3169. schema:
  3170. $ref: '#/components/schemas/Error'
  3171. application/json:
  3172. schema:
  3173. $ref: '#/components/schemas/Error'
  3174. links: { }
  3175. summary: 'Retrieves a Vessel resource.'
  3176. description: 'Retrieves a Vessel resource.'
  3177. parameters:
  3178. -
  3179. name: id
  3180. in: path
  3181. description: 'Vessel identifier'
  3182. required: true
  3183. deprecated: false
  3184. allowEmptyValue: false
  3185. schema:
  3186. type: string
  3187. style: simple
  3188. explode: false
  3189. allowReserved: false
  3190. deprecated: false
  3191. delete:
  3192. operationId: api_vessels_id_delete
  3193. tags:
  3194. - Vessel
  3195. responses:
  3196. '204':
  3197. description: 'Vessel resource deleted'
  3198. '403':
  3199. description: Forbidden
  3200. content:
  3201. application/ld+json:
  3202. schema:
  3203. $ref: '#/components/schemas/Error.jsonld'
  3204. application/problem+json:
  3205. schema:
  3206. $ref: '#/components/schemas/Error'
  3207. application/json:
  3208. schema:
  3209. $ref: '#/components/schemas/Error'
  3210. links: { }
  3211. '404':
  3212. description: 'Not found'
  3213. content:
  3214. application/ld+json:
  3215. schema:
  3216. $ref: '#/components/schemas/Error.jsonld'
  3217. application/problem+json:
  3218. schema:
  3219. $ref: '#/components/schemas/Error'
  3220. application/json:
  3221. schema:
  3222. $ref: '#/components/schemas/Error'
  3223. links: { }
  3224. summary: 'Removes the Vessel resource.'
  3225. description: 'Removes the Vessel resource.'
  3226. parameters:
  3227. -
  3228. name: id
  3229. in: path
  3230. description: 'Vessel identifier'
  3231. required: true
  3232. deprecated: false
  3233. allowEmptyValue: false
  3234. schema:
  3235. type: string
  3236. style: simple
  3237. explode: false
  3238. allowReserved: false
  3239. deprecated: false
  3240. patch:
  3241. operationId: api_vessels_id_patch
  3242. tags:
  3243. - Vessel
  3244. responses:
  3245. '200':
  3246. description: 'Vessel resource updated'
  3247. content:
  3248. application/ld+json:
  3249. schema:
  3250. $ref: '#/components/schemas/Vessel.jsonld'
  3251. links: { }
  3252. '400':
  3253. description: 'Invalid input'
  3254. content:
  3255. application/ld+json:
  3256. schema:
  3257. $ref: '#/components/schemas/Error.jsonld'
  3258. application/problem+json:
  3259. schema:
  3260. $ref: '#/components/schemas/Error'
  3261. application/json:
  3262. schema:
  3263. $ref: '#/components/schemas/Error'
  3264. links: { }
  3265. '422':
  3266. description: 'An error occurred'
  3267. content:
  3268. application/ld+json:
  3269. schema:
  3270. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3271. application/problem+json:
  3272. schema:
  3273. $ref: '#/components/schemas/ConstraintViolation-json'
  3274. application/json:
  3275. schema:
  3276. $ref: '#/components/schemas/ConstraintViolation-json'
  3277. links: { }
  3278. '403':
  3279. description: Forbidden
  3280. content:
  3281. application/ld+json:
  3282. schema:
  3283. $ref: '#/components/schemas/Error.jsonld'
  3284. application/problem+json:
  3285. schema:
  3286. $ref: '#/components/schemas/Error'
  3287. application/json:
  3288. schema:
  3289. $ref: '#/components/schemas/Error'
  3290. links: { }
  3291. '404':
  3292. description: 'Not found'
  3293. content:
  3294. application/ld+json:
  3295. schema:
  3296. $ref: '#/components/schemas/Error.jsonld'
  3297. application/problem+json:
  3298. schema:
  3299. $ref: '#/components/schemas/Error'
  3300. application/json:
  3301. schema:
  3302. $ref: '#/components/schemas/Error'
  3303. links: { }
  3304. summary: 'Updates the Vessel resource.'
  3305. description: 'Updates the Vessel resource.'
  3306. parameters:
  3307. -
  3308. name: id
  3309. in: path
  3310. description: 'Vessel identifier'
  3311. required: true
  3312. deprecated: false
  3313. allowEmptyValue: false
  3314. schema:
  3315. type: string
  3316. style: simple
  3317. explode: false
  3318. allowReserved: false
  3319. requestBody:
  3320. description: 'The updated Vessel resource'
  3321. content:
  3322. application/merge-patch+json:
  3323. schema:
  3324. $ref: '#/components/schemas/Vessel'
  3325. required: true
  3326. deprecated: false
  3327. /api/zones:
  3328. get:
  3329. operationId: api_zones_get_collection
  3330. tags:
  3331. - Zone
  3332. responses:
  3333. '200':
  3334. description: 'Zone collection'
  3335. content:
  3336. application/ld+json:
  3337. schema:
  3338. type: object
  3339. properties:
  3340. member: { type: array, items: { $ref: '#/components/schemas/Zone.jsonld' } }
  3341. totalItems: { type: integer, minimum: 0 }
  3342. 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 } }
  3343. 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 } } } } } }
  3344. required:
  3345. - member
  3346. '403':
  3347. description: Forbidden
  3348. content:
  3349. application/ld+json:
  3350. schema:
  3351. $ref: '#/components/schemas/Error.jsonld'
  3352. application/problem+json:
  3353. schema:
  3354. $ref: '#/components/schemas/Error'
  3355. application/json:
  3356. schema:
  3357. $ref: '#/components/schemas/Error'
  3358. links: { }
  3359. summary: 'Retrieves the collection of Zone resources.'
  3360. description: 'Retrieves the collection of Zone resources.'
  3361. parameters:
  3362. -
  3363. name: page
  3364. in: query
  3365. description: 'The collection page number'
  3366. required: false
  3367. deprecated: false
  3368. allowEmptyValue: true
  3369. schema:
  3370. type: integer
  3371. default: 1
  3372. style: form
  3373. explode: false
  3374. allowReserved: false
  3375. -
  3376. name: itemsPerPage
  3377. in: query
  3378. description: 'The number of items per page'
  3379. required: false
  3380. deprecated: false
  3381. allowEmptyValue: true
  3382. schema:
  3383. type: integer
  3384. default: 50
  3385. minimum: 0
  3386. maximum: 200
  3387. style: form
  3388. explode: false
  3389. allowReserved: false
  3390. -
  3391. name: name
  3392. in: query
  3393. description: ''
  3394. required: false
  3395. deprecated: false
  3396. allowEmptyValue: false
  3397. schema:
  3398. type: string
  3399. style: form
  3400. explode: false
  3401. allowReserved: false
  3402. -
  3403. name: custom_json_filter
  3404. in: query
  3405. description: ''
  3406. required: false
  3407. deprecated: false
  3408. allowEmptyValue: false
  3409. schema:
  3410. type: string
  3411. style: form
  3412. explode: false
  3413. allowReserved: false
  3414. -
  3415. name: custom_json_order
  3416. in: query
  3417. description: ''
  3418. required: false
  3419. deprecated: false
  3420. allowEmptyValue: true
  3421. schema:
  3422. type: string
  3423. style: form
  3424. explode: false
  3425. allowReserved: false
  3426. deprecated: false
  3427. post:
  3428. operationId: api_zones_post
  3429. tags:
  3430. - Zone
  3431. responses:
  3432. '201':
  3433. description: 'Zone resource created'
  3434. content:
  3435. application/ld+json:
  3436. schema:
  3437. $ref: '#/components/schemas/Zone.jsonld'
  3438. links: { }
  3439. '400':
  3440. description: 'Invalid input'
  3441. content:
  3442. application/ld+json:
  3443. schema:
  3444. $ref: '#/components/schemas/Error.jsonld'
  3445. application/problem+json:
  3446. schema:
  3447. $ref: '#/components/schemas/Error'
  3448. application/json:
  3449. schema:
  3450. $ref: '#/components/schemas/Error'
  3451. links: { }
  3452. '422':
  3453. description: 'An error occurred'
  3454. content:
  3455. application/ld+json:
  3456. schema:
  3457. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3458. application/problem+json:
  3459. schema:
  3460. $ref: '#/components/schemas/ConstraintViolation-json'
  3461. application/json:
  3462. schema:
  3463. $ref: '#/components/schemas/ConstraintViolation-json'
  3464. links: { }
  3465. '403':
  3466. description: Forbidden
  3467. content:
  3468. application/ld+json:
  3469. schema:
  3470. $ref: '#/components/schemas/Error.jsonld'
  3471. application/problem+json:
  3472. schema:
  3473. $ref: '#/components/schemas/Error'
  3474. application/json:
  3475. schema:
  3476. $ref: '#/components/schemas/Error'
  3477. links: { }
  3478. summary: 'Creates a Zone resource.'
  3479. description: 'Creates a Zone resource.'
  3480. parameters: []
  3481. requestBody:
  3482. description: 'The new Zone resource'
  3483. content:
  3484. application/ld+json:
  3485. schema:
  3486. $ref: '#/components/schemas/Zone.jsonld'
  3487. required: true
  3488. deprecated: false
  3489. '/api/zones/{id}':
  3490. get:
  3491. operationId: api_zones_id_get
  3492. tags:
  3493. - Zone
  3494. responses:
  3495. '200':
  3496. description: 'Zone resource'
  3497. content:
  3498. application/ld+json:
  3499. schema:
  3500. $ref: '#/components/schemas/Zone.jsonld'
  3501. '403':
  3502. description: Forbidden
  3503. content:
  3504. application/ld+json:
  3505. schema:
  3506. $ref: '#/components/schemas/Error.jsonld'
  3507. application/problem+json:
  3508. schema:
  3509. $ref: '#/components/schemas/Error'
  3510. application/json:
  3511. schema:
  3512. $ref: '#/components/schemas/Error'
  3513. links: { }
  3514. '404':
  3515. description: 'Not found'
  3516. content:
  3517. application/ld+json:
  3518. schema:
  3519. $ref: '#/components/schemas/Error.jsonld'
  3520. application/problem+json:
  3521. schema:
  3522. $ref: '#/components/schemas/Error'
  3523. application/json:
  3524. schema:
  3525. $ref: '#/components/schemas/Error'
  3526. links: { }
  3527. summary: 'Retrieves a Zone resource.'
  3528. description: 'Retrieves a Zone resource.'
  3529. parameters:
  3530. -
  3531. name: id
  3532. in: path
  3533. description: 'Zone identifier'
  3534. required: true
  3535. deprecated: false
  3536. allowEmptyValue: false
  3537. schema:
  3538. type: string
  3539. style: simple
  3540. explode: false
  3541. allowReserved: false
  3542. deprecated: false
  3543. delete:
  3544. operationId: api_zones_id_delete
  3545. tags:
  3546. - Zone
  3547. responses:
  3548. '204':
  3549. description: 'Zone resource deleted'
  3550. '403':
  3551. description: Forbidden
  3552. content:
  3553. application/ld+json:
  3554. schema:
  3555. $ref: '#/components/schemas/Error.jsonld'
  3556. application/problem+json:
  3557. schema:
  3558. $ref: '#/components/schemas/Error'
  3559. application/json:
  3560. schema:
  3561. $ref: '#/components/schemas/Error'
  3562. links: { }
  3563. '404':
  3564. description: 'Not found'
  3565. content:
  3566. application/ld+json:
  3567. schema:
  3568. $ref: '#/components/schemas/Error.jsonld'
  3569. application/problem+json:
  3570. schema:
  3571. $ref: '#/components/schemas/Error'
  3572. application/json:
  3573. schema:
  3574. $ref: '#/components/schemas/Error'
  3575. links: { }
  3576. summary: 'Removes the Zone resource.'
  3577. description: 'Removes the Zone resource.'
  3578. parameters:
  3579. -
  3580. name: id
  3581. in: path
  3582. description: 'Zone identifier'
  3583. required: true
  3584. deprecated: false
  3585. allowEmptyValue: false
  3586. schema:
  3587. type: string
  3588. style: simple
  3589. explode: false
  3590. allowReserved: false
  3591. deprecated: false
  3592. patch:
  3593. operationId: api_zones_id_patch
  3594. tags:
  3595. - Zone
  3596. responses:
  3597. '200':
  3598. description: 'Zone resource updated'
  3599. content:
  3600. application/ld+json:
  3601. schema:
  3602. $ref: '#/components/schemas/Zone.jsonld'
  3603. links: { }
  3604. '400':
  3605. description: 'Invalid input'
  3606. content:
  3607. application/ld+json:
  3608. schema:
  3609. $ref: '#/components/schemas/Error.jsonld'
  3610. application/problem+json:
  3611. schema:
  3612. $ref: '#/components/schemas/Error'
  3613. application/json:
  3614. schema:
  3615. $ref: '#/components/schemas/Error'
  3616. links: { }
  3617. '422':
  3618. description: 'An error occurred'
  3619. content:
  3620. application/ld+json:
  3621. schema:
  3622. $ref: '#/components/schemas/ConstraintViolation.jsonld-jsonld'
  3623. application/problem+json:
  3624. schema:
  3625. $ref: '#/components/schemas/ConstraintViolation-json'
  3626. application/json:
  3627. schema:
  3628. $ref: '#/components/schemas/ConstraintViolation-json'
  3629. links: { }
  3630. '403':
  3631. description: Forbidden
  3632. content:
  3633. application/ld+json:
  3634. schema:
  3635. $ref: '#/components/schemas/Error.jsonld'
  3636. application/problem+json:
  3637. schema:
  3638. $ref: '#/components/schemas/Error'
  3639. application/json:
  3640. schema:
  3641. $ref: '#/components/schemas/Error'
  3642. links: { }
  3643. '404':
  3644. description: 'Not found'
  3645. content:
  3646. application/ld+json:
  3647. schema:
  3648. $ref: '#/components/schemas/Error.jsonld'
  3649. application/problem+json:
  3650. schema:
  3651. $ref: '#/components/schemas/Error'
  3652. application/json:
  3653. schema:
  3654. $ref: '#/components/schemas/Error'
  3655. links: { }
  3656. summary: 'Updates the Zone resource.'
  3657. description: 'Updates the Zone resource.'
  3658. parameters:
  3659. -
  3660. name: id
  3661. in: path
  3662. description: 'Zone identifier'
  3663. required: true
  3664. deprecated: false
  3665. allowEmptyValue: false
  3666. schema:
  3667. type: string
  3668. style: simple
  3669. explode: false
  3670. allowReserved: false
  3671. requestBody:
  3672. description: 'The updated Zone resource'
  3673. content:
  3674. application/merge-patch+json:
  3675. schema:
  3676. $ref: '#/components/schemas/Zone'
  3677. required: true
  3678. deprecated: false
  3679. components:
  3680. schemas:
  3681. ConstraintViolation-json:
  3682. type: object
  3683. description: 'Unprocessable entity'
  3684. deprecated: false
  3685. properties:
  3686. status:
  3687. default: 422
  3688. example: 422
  3689. type: integer
  3690. violations:
  3691. type: array
  3692. items:
  3693. type: object
  3694. properties:
  3695. propertyPath:
  3696. type: string
  3697. description: 'The property path of the violation'
  3698. message:
  3699. type: string
  3700. description: 'The message associated with the violation'
  3701. detail:
  3702. readOnly: true
  3703. type: string
  3704. type:
  3705. readOnly: true
  3706. type: string
  3707. title:
  3708. readOnly: true
  3709. type:
  3710. - string
  3711. - 'null'
  3712. instance:
  3713. readOnly: true
  3714. type:
  3715. - string
  3716. - 'null'
  3717. ConstraintViolation.jsonld-jsonld:
  3718. type: object
  3719. description: 'Unprocessable entity'
  3720. deprecated: false
  3721. properties:
  3722. '@context':
  3723. readOnly: true
  3724. oneOf:
  3725. -
  3726. type: string
  3727. -
  3728. type: object
  3729. properties:
  3730. '@vocab':
  3731. type: string
  3732. hydra:
  3733. type: string
  3734. enum: ['http://www.w3.org/ns/hydra/core#']
  3735. required:
  3736. - '@vocab'
  3737. - hydra
  3738. additionalProperties: true
  3739. '@id':
  3740. readOnly: true
  3741. type: string
  3742. '@type':
  3743. readOnly: true
  3744. type: string
  3745. status:
  3746. default: 422
  3747. example: 422
  3748. type: integer
  3749. violations:
  3750. type: array
  3751. items:
  3752. type: object
  3753. properties:
  3754. propertyPath:
  3755. type: string
  3756. description: 'The property path of the violation'
  3757. message:
  3758. type: string
  3759. description: 'The message associated with the violation'
  3760. detail:
  3761. readOnly: true
  3762. type: string
  3763. description:
  3764. readOnly: true
  3765. type: string
  3766. type:
  3767. readOnly: true
  3768. type: string
  3769. title:
  3770. readOnly: true
  3771. type:
  3772. - string
  3773. - 'null'
  3774. instance:
  3775. readOnly: true
  3776. type:
  3777. - string
  3778. - 'null'
  3779. Error:
  3780. type: object
  3781. description: 'A representation of common errors.'
  3782. deprecated: false
  3783. properties:
  3784. title:
  3785. readOnly: true
  3786. description: 'A short, human-readable summary of the problem.'
  3787. type:
  3788. - string
  3789. - 'null'
  3790. detail:
  3791. readOnly: true
  3792. description: 'A human-readable explanation specific to this occurrence of the problem.'
  3793. type:
  3794. - string
  3795. - 'null'
  3796. status:
  3797. type: number
  3798. example: 404
  3799. default: 400
  3800. instance:
  3801. readOnly: true
  3802. description: 'A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.'
  3803. type:
  3804. - string
  3805. - 'null'
  3806. type:
  3807. readOnly: true
  3808. description: 'A URI reference that identifies the problem type'
  3809. type: string
  3810. Error.jsonld:
  3811. type: object
  3812. description: 'A representation of common errors.'
  3813. deprecated: false
  3814. properties:
  3815. '@context':
  3816. readOnly: true
  3817. oneOf:
  3818. -
  3819. type: string
  3820. -
  3821. type: object
  3822. properties:
  3823. '@vocab':
  3824. type: string
  3825. hydra:
  3826. type: string
  3827. enum: ['http://www.w3.org/ns/hydra/core#']
  3828. required:
  3829. - '@vocab'
  3830. - hydra
  3831. additionalProperties: true
  3832. '@id':
  3833. readOnly: true
  3834. type: string
  3835. '@type':
  3836. readOnly: true
  3837. type: string
  3838. title:
  3839. readOnly: true
  3840. description: 'A short, human-readable summary of the problem.'
  3841. type:
  3842. - string
  3843. - 'null'
  3844. detail:
  3845. readOnly: true
  3846. description: 'A human-readable explanation specific to this occurrence of the problem.'
  3847. type:
  3848. - string
  3849. - 'null'
  3850. status:
  3851. type: number
  3852. example: 404
  3853. default: 400
  3854. instance:
  3855. readOnly: true
  3856. description: 'A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.'
  3857. type:
  3858. - string
  3859. - 'null'
  3860. type:
  3861. readOnly: true
  3862. description: 'A URI reference that identifies the problem type'
  3863. type: string
  3864. description:
  3865. readOnly: true
  3866. type:
  3867. - string
  3868. - 'null'
  3869. Event.jsonld:
  3870. type: object
  3871. description: ''
  3872. deprecated: false
  3873. properties:
  3874. '@context':
  3875. readOnly: true
  3876. oneOf:
  3877. -
  3878. type: string
  3879. -
  3880. type: object
  3881. properties:
  3882. '@vocab':
  3883. type: string
  3884. hydra:
  3885. type: string
  3886. enum: ['http://www.w3.org/ns/hydra/core#']
  3887. required:
  3888. - '@vocab'
  3889. - hydra
  3890. additionalProperties: true
  3891. '@id':
  3892. readOnly: true
  3893. type: string
  3894. '@type':
  3895. readOnly: true
  3896. type: string
  3897. dbId:
  3898. readOnly: true
  3899. type:
  3900. - integer
  3901. - 'null'
  3902. name:
  3903. type: string
  3904. identifier:
  3905. type: string
  3906. sequence:
  3907. type: integer
  3908. mandatory:
  3909. type: boolean
  3910. createdAt:
  3911. readOnly: true
  3912. type:
  3913. - string
  3914. - 'null'
  3915. format: date-time
  3916. Location:
  3917. type: object
  3918. description: ''
  3919. deprecated: false
  3920. properties:
  3921. dbId:
  3922. readOnly: true
  3923. type:
  3924. - integer
  3925. - 'null'
  3926. zone:
  3927. readOnly: true
  3928. type: string
  3929. format: iri-reference
  3930. example: 'https://example.com/'
  3931. zoneIri:
  3932. type:
  3933. - string
  3934. - 'null'
  3935. format: iri-reference
  3936. example: 'https://example.com/'
  3937. name:
  3938. type: string
  3939. code:
  3940. type: string
  3941. zoneName:
  3942. readOnly: true
  3943. type: string
  3944. isZone:
  3945. type: boolean
  3946. isPlace:
  3947. type: boolean
  3948. isPort:
  3949. type: boolean
  3950. createdAt:
  3951. readOnly: true
  3952. type:
  3953. - string
  3954. - 'null'
  3955. format: date-time
  3956. required:
  3957. - zoneIri
  3958. - name
  3959. - code
  3960. Location.jsonld:
  3961. type: object
  3962. description: ''
  3963. deprecated: false
  3964. properties:
  3965. '@context':
  3966. readOnly: true
  3967. oneOf:
  3968. -
  3969. type: string
  3970. -
  3971. type: object
  3972. properties:
  3973. '@vocab':
  3974. type: string
  3975. hydra:
  3976. type: string
  3977. enum: ['http://www.w3.org/ns/hydra/core#']
  3978. required:
  3979. - '@vocab'
  3980. - hydra
  3981. additionalProperties: true
  3982. '@id':
  3983. readOnly: true
  3984. type: string
  3985. '@type':
  3986. readOnly: true
  3987. type: string
  3988. dbId:
  3989. readOnly: true
  3990. type:
  3991. - integer
  3992. - 'null'
  3993. zone:
  3994. readOnly: true
  3995. $ref: '#/components/schemas/Zone.jsonld'
  3996. zoneIri:
  3997. type:
  3998. - string
  3999. - 'null'
  4000. format: iri-reference
  4001. example: 'https://example.com/'
  4002. name:
  4003. type: string
  4004. code:
  4005. type: string
  4006. zoneName:
  4007. readOnly: true
  4008. type: string
  4009. isZone:
  4010. type: boolean
  4011. isPlace:
  4012. type: boolean
  4013. isPort:
  4014. type: boolean
  4015. createdAt:
  4016. readOnly: true
  4017. type:
  4018. - string
  4019. - 'null'
  4020. format: date-time
  4021. required:
  4022. - zoneIri
  4023. - name
  4024. - code
  4025. MediaObject.jsonld:
  4026. type: object
  4027. description: ''
  4028. deprecated: false
  4029. properties:
  4030. '@context':
  4031. readOnly: true
  4032. oneOf:
  4033. -
  4034. type: string
  4035. -
  4036. type: object
  4037. properties:
  4038. '@vocab':
  4039. type: string
  4040. hydra:
  4041. type: string
  4042. enum: ['http://www.w3.org/ns/hydra/core#']
  4043. required:
  4044. - '@vocab'
  4045. - hydra
  4046. additionalProperties: true
  4047. '@id':
  4048. readOnly: true
  4049. type: string
  4050. '@type':
  4051. readOnly: true
  4052. type: string
  4053. dbId:
  4054. readOnly: true
  4055. type:
  4056. - integer
  4057. - 'null'
  4058. contentUrl:
  4059. externalDocs:
  4060. url: 'https://schema.org/contentUrl'
  4061. type:
  4062. - string
  4063. - 'null'
  4064. filePath:
  4065. readOnly: true
  4066. type:
  4067. - string
  4068. - 'null'
  4069. createdAt:
  4070. readOnly: true
  4071. type:
  4072. - string
  4073. - 'null'
  4074. format: date-time
  4075. ShippingCompany:
  4076. type: object
  4077. description: ''
  4078. deprecated: false
  4079. properties:
  4080. dbId:
  4081. readOnly: true
  4082. type:
  4083. - integer
  4084. - 'null'
  4085. name:
  4086. type: string
  4087. code:
  4088. type: string
  4089. createdAt:
  4090. readOnly: true
  4091. type:
  4092. - string
  4093. - 'null'
  4094. format: date-time
  4095. required:
  4096. - name
  4097. - code
  4098. ShippingCompany.jsonld:
  4099. type: object
  4100. description: ''
  4101. deprecated: false
  4102. properties:
  4103. '@context':
  4104. readOnly: true
  4105. oneOf:
  4106. -
  4107. type: string
  4108. -
  4109. type: object
  4110. properties:
  4111. '@vocab':
  4112. type: string
  4113. hydra:
  4114. type: string
  4115. enum: ['http://www.w3.org/ns/hydra/core#']
  4116. required:
  4117. - '@vocab'
  4118. - hydra
  4119. additionalProperties: true
  4120. '@id':
  4121. readOnly: true
  4122. type: string
  4123. '@type':
  4124. readOnly: true
  4125. type: string
  4126. dbId:
  4127. readOnly: true
  4128. type:
  4129. - integer
  4130. - 'null'
  4131. name:
  4132. type: string
  4133. code:
  4134. type: string
  4135. createdAt:
  4136. readOnly: true
  4137. type:
  4138. - string
  4139. - 'null'
  4140. format: date-time
  4141. required:
  4142. - name
  4143. - code
  4144. Trip:
  4145. type: object
  4146. description: ''
  4147. deprecated: false
  4148. properties:
  4149. dbId:
  4150. readOnly: true
  4151. type:
  4152. - integer
  4153. - 'null'
  4154. vessel:
  4155. readOnly: true
  4156. type: string
  4157. format: iri-reference
  4158. example: 'https://example.com/'
  4159. vesselIri:
  4160. type:
  4161. - string
  4162. - 'null'
  4163. format: iri-reference
  4164. example: 'https://example.com/'
  4165. pilotageReference:
  4166. readOnly: true
  4167. type:
  4168. - string
  4169. - 'null'
  4170. customerReference:
  4171. type:
  4172. - string
  4173. - 'null'
  4174. captainName:
  4175. type:
  4176. - string
  4177. - 'null'
  4178. startLocation:
  4179. readOnly: true
  4180. type: string
  4181. format: iri-reference
  4182. example: 'https://example.com/'
  4183. startLocationIri:
  4184. type:
  4185. - string
  4186. - 'null'
  4187. format: iri-reference
  4188. example: 'https://example.com/'
  4189. endLocation:
  4190. readOnly: true
  4191. type: string
  4192. format: iri-reference
  4193. example: 'https://example.com/'
  4194. endLocationIri:
  4195. type:
  4196. - string
  4197. - 'null'
  4198. format: iri-reference
  4199. example: 'https://example.com/'
  4200. startDate:
  4201. type: string
  4202. format: date-time
  4203. endDate:
  4204. type: string
  4205. format: date-time
  4206. note:
  4207. type:
  4208. - string
  4209. - 'null'
  4210. createdAt:
  4211. readOnly: true
  4212. type:
  4213. - string
  4214. - 'null'
  4215. format: date-time
  4216. required:
  4217. - vesselIri
  4218. - startLocationIri
  4219. - endLocationIri
  4220. - startDate
  4221. - endDate
  4222. Trip.jsonld:
  4223. type: object
  4224. description: ''
  4225. deprecated: false
  4226. properties:
  4227. '@context':
  4228. readOnly: true
  4229. oneOf:
  4230. -
  4231. type: string
  4232. -
  4233. type: object
  4234. properties:
  4235. '@vocab':
  4236. type: string
  4237. hydra:
  4238. type: string
  4239. enum: ['http://www.w3.org/ns/hydra/core#']
  4240. required:
  4241. - '@vocab'
  4242. - hydra
  4243. additionalProperties: true
  4244. '@id':
  4245. readOnly: true
  4246. type: string
  4247. '@type':
  4248. readOnly: true
  4249. type: string
  4250. dbId:
  4251. readOnly: true
  4252. type:
  4253. - integer
  4254. - 'null'
  4255. vessel:
  4256. readOnly: true
  4257. $ref: '#/components/schemas/Vessel.jsonld'
  4258. vesselIri:
  4259. type:
  4260. - string
  4261. - 'null'
  4262. format: iri-reference
  4263. example: 'https://example.com/'
  4264. pilotageReference:
  4265. readOnly: true
  4266. type:
  4267. - string
  4268. - 'null'
  4269. customerReference:
  4270. type:
  4271. - string
  4272. - 'null'
  4273. captainName:
  4274. type:
  4275. - string
  4276. - 'null'
  4277. startLocation:
  4278. readOnly: true
  4279. $ref: '#/components/schemas/Location.jsonld'
  4280. startLocationIri:
  4281. type:
  4282. - string
  4283. - 'null'
  4284. format: iri-reference
  4285. example: 'https://example.com/'
  4286. endLocation:
  4287. readOnly: true
  4288. $ref: '#/components/schemas/Location.jsonld'
  4289. endLocationIri:
  4290. type:
  4291. - string
  4292. - 'null'
  4293. format: iri-reference
  4294. example: 'https://example.com/'
  4295. startDate:
  4296. type: string
  4297. format: date-time
  4298. endDate:
  4299. type: string
  4300. format: date-time
  4301. note:
  4302. type:
  4303. - string
  4304. - 'null'
  4305. createdAt:
  4306. readOnly: true
  4307. type:
  4308. - string
  4309. - 'null'
  4310. format: date-time
  4311. required:
  4312. - vesselIri
  4313. - startLocationIri
  4314. - endLocationIri
  4315. - startDate
  4316. - endDate
  4317. TripLocation:
  4318. type: object
  4319. description: ''
  4320. deprecated: false
  4321. properties:
  4322. dbId:
  4323. readOnly: true
  4324. type:
  4325. - integer
  4326. - 'null'
  4327. trip:
  4328. $ref: '#/components/schemas/Trip'
  4329. tripIri:
  4330. type:
  4331. - string
  4332. - 'null'
  4333. format: iri-reference
  4334. example: 'https://example.com/'
  4335. location:
  4336. $ref: '#/components/schemas/Location'
  4337. locationIri:
  4338. type:
  4339. - string
  4340. - 'null'
  4341. format: iri-reference
  4342. example: 'https://example.com/'
  4343. isArrival:
  4344. type: boolean
  4345. date:
  4346. type: string
  4347. format: date-time
  4348. createdAt:
  4349. readOnly: true
  4350. type:
  4351. - string
  4352. - 'null'
  4353. format: date-time
  4354. required:
  4355. - tripIri
  4356. - locationIri
  4357. - date
  4358. TripLocation.jsonld:
  4359. type: object
  4360. description: ''
  4361. deprecated: false
  4362. properties:
  4363. '@context':
  4364. readOnly: true
  4365. oneOf:
  4366. -
  4367. type: string
  4368. -
  4369. type: object
  4370. properties:
  4371. '@vocab':
  4372. type: string
  4373. hydra:
  4374. type: string
  4375. enum: ['http://www.w3.org/ns/hydra/core#']
  4376. required:
  4377. - '@vocab'
  4378. - hydra
  4379. additionalProperties: true
  4380. '@id':
  4381. readOnly: true
  4382. type: string
  4383. '@type':
  4384. readOnly: true
  4385. type: string
  4386. dbId:
  4387. readOnly: true
  4388. type:
  4389. - integer
  4390. - 'null'
  4391. trip:
  4392. $ref: '#/components/schemas/Trip.jsonld'
  4393. tripIri:
  4394. type:
  4395. - string
  4396. - 'null'
  4397. format: iri-reference
  4398. example: 'https://example.com/'
  4399. location:
  4400. $ref: '#/components/schemas/Location.jsonld'
  4401. locationIri:
  4402. type:
  4403. - string
  4404. - 'null'
  4405. format: iri-reference
  4406. example: 'https://example.com/'
  4407. isArrival:
  4408. type: boolean
  4409. date:
  4410. type: string
  4411. format: date-time
  4412. createdAt:
  4413. readOnly: true
  4414. type:
  4415. - string
  4416. - 'null'
  4417. format: date-time
  4418. required:
  4419. - tripIri
  4420. - locationIri
  4421. - date
  4422. User:
  4423. type: object
  4424. description: ''
  4425. deprecated: false
  4426. properties:
  4427. dbId:
  4428. readOnly: true
  4429. type:
  4430. - integer
  4431. - 'null'
  4432. email:
  4433. format: email
  4434. externalDocs:
  4435. url: 'https://schema.org/email'
  4436. type: string
  4437. firstName:
  4438. type: string
  4439. referenceId:
  4440. type: string
  4441. lastName:
  4442. type: string
  4443. image:
  4444. readOnly: true
  4445. type: string
  4446. format: iri-reference
  4447. example: 'https://example.com/'
  4448. imageIri:
  4449. type:
  4450. - string
  4451. - 'null'
  4452. format: iri-reference
  4453. example: 'https://example.com/'
  4454. imageUrl:
  4455. readOnly: true
  4456. type:
  4457. - string
  4458. - 'null'
  4459. fullName:
  4460. readOnly: true
  4461. type:
  4462. - string
  4463. - 'null'
  4464. password:
  4465. writeOnly: true
  4466. description: 'The plaintext password when being set or changed.'
  4467. type:
  4468. - string
  4469. - 'null'
  4470. isAdmin:
  4471. type: boolean
  4472. active:
  4473. type: boolean
  4474. roles:
  4475. readOnly: true
  4476. type: array
  4477. items:
  4478. type: string
  4479. createdAt:
  4480. readOnly: true
  4481. type:
  4482. - string
  4483. - 'null'
  4484. format: date-time
  4485. required:
  4486. - email
  4487. - firstName
  4488. - referenceId
  4489. - lastName
  4490. - isAdmin
  4491. - active
  4492. User.jsonld:
  4493. type: object
  4494. description: ''
  4495. deprecated: false
  4496. properties:
  4497. '@context':
  4498. readOnly: true
  4499. oneOf:
  4500. -
  4501. type: string
  4502. -
  4503. type: object
  4504. properties:
  4505. '@vocab':
  4506. type: string
  4507. hydra:
  4508. type: string
  4509. enum: ['http://www.w3.org/ns/hydra/core#']
  4510. required:
  4511. - '@vocab'
  4512. - hydra
  4513. additionalProperties: true
  4514. '@id':
  4515. readOnly: true
  4516. type: string
  4517. '@type':
  4518. readOnly: true
  4519. type: string
  4520. dbId:
  4521. readOnly: true
  4522. type:
  4523. - integer
  4524. - 'null'
  4525. email:
  4526. format: email
  4527. externalDocs:
  4528. url: 'https://schema.org/email'
  4529. type: string
  4530. firstName:
  4531. type: string
  4532. referenceId:
  4533. type: string
  4534. lastName:
  4535. type: string
  4536. image:
  4537. readOnly: true
  4538. $ref: '#/components/schemas/MediaObject.jsonld'
  4539. imageIri:
  4540. type:
  4541. - string
  4542. - 'null'
  4543. format: iri-reference
  4544. example: 'https://example.com/'
  4545. imageUrl:
  4546. readOnly: true
  4547. type:
  4548. - string
  4549. - 'null'
  4550. fullName:
  4551. readOnly: true
  4552. type:
  4553. - string
  4554. - 'null'
  4555. password:
  4556. writeOnly: true
  4557. description: 'The plaintext password when being set or changed.'
  4558. type:
  4559. - string
  4560. - 'null'
  4561. isAdmin:
  4562. type: boolean
  4563. active:
  4564. type: boolean
  4565. roles:
  4566. readOnly: true
  4567. type: array
  4568. items:
  4569. type: string
  4570. createdAt:
  4571. readOnly: true
  4572. type:
  4573. - string
  4574. - 'null'
  4575. format: date-time
  4576. required:
  4577. - email
  4578. - firstName
  4579. - referenceId
  4580. - lastName
  4581. - isAdmin
  4582. - active
  4583. UserTrip:
  4584. type: object
  4585. description: ''
  4586. deprecated: false
  4587. properties:
  4588. dbId:
  4589. readOnly: true
  4590. type:
  4591. - integer
  4592. - 'null'
  4593. trip:
  4594. readOnly: true
  4595. type: string
  4596. format: iri-reference
  4597. example: 'https://example.com/'
  4598. tripIri:
  4599. type:
  4600. - string
  4601. - 'null'
  4602. format: iri-reference
  4603. example: 'https://example.com/'
  4604. user:
  4605. readOnly: true
  4606. type: string
  4607. format: iri-reference
  4608. example: 'https://example.com/'
  4609. userIri:
  4610. type:
  4611. - string
  4612. - 'null'
  4613. format: iri-reference
  4614. example: 'https://example.com/'
  4615. captainName:
  4616. type:
  4617. - string
  4618. - 'null'
  4619. completed:
  4620. type: boolean
  4621. signature:
  4622. readOnly: true
  4623. type: string
  4624. format: iri-reference
  4625. example: 'https://example.com/'
  4626. signatureIri:
  4627. type:
  4628. - string
  4629. - 'null'
  4630. format: iri-reference
  4631. example: 'https://example.com/'
  4632. signatureUrl:
  4633. readOnly: true
  4634. type:
  4635. - string
  4636. - 'null'
  4637. completedDate:
  4638. type:
  4639. - string
  4640. - 'null'
  4641. format: date-time
  4642. createdAt:
  4643. readOnly: true
  4644. type:
  4645. - string
  4646. - 'null'
  4647. format: date-time
  4648. required:
  4649. - tripIri
  4650. - userIri
  4651. - completed
  4652. UserTrip.jsonld:
  4653. type: object
  4654. description: ''
  4655. deprecated: false
  4656. properties:
  4657. '@context':
  4658. readOnly: true
  4659. oneOf:
  4660. -
  4661. type: string
  4662. -
  4663. type: object
  4664. properties:
  4665. '@vocab':
  4666. type: string
  4667. hydra:
  4668. type: string
  4669. enum: ['http://www.w3.org/ns/hydra/core#']
  4670. required:
  4671. - '@vocab'
  4672. - hydra
  4673. additionalProperties: true
  4674. '@id':
  4675. readOnly: true
  4676. type: string
  4677. '@type':
  4678. readOnly: true
  4679. type: string
  4680. dbId:
  4681. readOnly: true
  4682. type:
  4683. - integer
  4684. - 'null'
  4685. trip:
  4686. readOnly: true
  4687. $ref: '#/components/schemas/Trip.jsonld'
  4688. tripIri:
  4689. type:
  4690. - string
  4691. - 'null'
  4692. format: iri-reference
  4693. example: 'https://example.com/'
  4694. user:
  4695. readOnly: true
  4696. $ref: '#/components/schemas/User.jsonld'
  4697. userIri:
  4698. type:
  4699. - string
  4700. - 'null'
  4701. format: iri-reference
  4702. example: 'https://example.com/'
  4703. captainName:
  4704. type:
  4705. - string
  4706. - 'null'
  4707. completed:
  4708. type: boolean
  4709. signature:
  4710. readOnly: true
  4711. $ref: '#/components/schemas/MediaObject.jsonld'
  4712. signatureIri:
  4713. type:
  4714. - string
  4715. - 'null'
  4716. format: iri-reference
  4717. example: 'https://example.com/'
  4718. signatureUrl:
  4719. readOnly: true
  4720. type:
  4721. - string
  4722. - 'null'
  4723. completedDate:
  4724. type:
  4725. - string
  4726. - 'null'
  4727. format: date-time
  4728. createdAt:
  4729. readOnly: true
  4730. type:
  4731. - string
  4732. - 'null'
  4733. format: date-time
  4734. required:
  4735. - tripIri
  4736. - userIri
  4737. - completed
  4738. UserTripEvent:
  4739. type: object
  4740. description: ''
  4741. deprecated: false
  4742. properties:
  4743. dbId:
  4744. readOnly: true
  4745. type:
  4746. - integer
  4747. - 'null'
  4748. userTrip:
  4749. readOnly: true
  4750. $ref: '#/components/schemas/UserTrip'
  4751. userTripIri:
  4752. type:
  4753. - string
  4754. - 'null'
  4755. format: iri-reference
  4756. example: 'https://example.com/'
  4757. event:
  4758. readOnly: true
  4759. type: string
  4760. format: iri-reference
  4761. example: 'https://example.com/'
  4762. eventIri:
  4763. type:
  4764. - string
  4765. - 'null'
  4766. format: iri-reference
  4767. example: 'https://example.com/'
  4768. location:
  4769. readOnly: true
  4770. type: string
  4771. format: iri-reference
  4772. example: 'https://example.com/'
  4773. locationIri:
  4774. type:
  4775. - string
  4776. - 'null'
  4777. format: iri-reference
  4778. example: 'https://example.com/'
  4779. user:
  4780. readOnly: true
  4781. type: string
  4782. format: iri-reference
  4783. example: 'https://example.com/'
  4784. date:
  4785. type: string
  4786. format: date-time
  4787. note:
  4788. type:
  4789. - string
  4790. - 'null'
  4791. createdAt:
  4792. readOnly: true
  4793. type:
  4794. - string
  4795. - 'null'
  4796. format: date-time
  4797. required:
  4798. - userTripIri
  4799. - eventIri
  4800. - locationIri
  4801. - date
  4802. UserTripEvent.jsonld:
  4803. type: object
  4804. description: ''
  4805. deprecated: false
  4806. properties:
  4807. '@context':
  4808. readOnly: true
  4809. oneOf:
  4810. -
  4811. type: string
  4812. -
  4813. type: object
  4814. properties:
  4815. '@vocab':
  4816. type: string
  4817. hydra:
  4818. type: string
  4819. enum: ['http://www.w3.org/ns/hydra/core#']
  4820. required:
  4821. - '@vocab'
  4822. - hydra
  4823. additionalProperties: true
  4824. '@id':
  4825. readOnly: true
  4826. type: string
  4827. '@type':
  4828. readOnly: true
  4829. type: string
  4830. dbId:
  4831. readOnly: true
  4832. type:
  4833. - integer
  4834. - 'null'
  4835. userTrip:
  4836. readOnly: true
  4837. $ref: '#/components/schemas/UserTrip.jsonld'
  4838. userTripIri:
  4839. type:
  4840. - string
  4841. - 'null'
  4842. format: iri-reference
  4843. example: 'https://example.com/'
  4844. event:
  4845. readOnly: true
  4846. $ref: '#/components/schemas/Event.jsonld'
  4847. eventIri:
  4848. type:
  4849. - string
  4850. - 'null'
  4851. format: iri-reference
  4852. example: 'https://example.com/'
  4853. location:
  4854. readOnly: true
  4855. $ref: '#/components/schemas/Location.jsonld'
  4856. locationIri:
  4857. type:
  4858. - string
  4859. - 'null'
  4860. format: iri-reference
  4861. example: 'https://example.com/'
  4862. user:
  4863. readOnly: true
  4864. $ref: '#/components/schemas/User.jsonld'
  4865. date:
  4866. type: string
  4867. format: date-time
  4868. note:
  4869. type:
  4870. - string
  4871. - 'null'
  4872. createdAt:
  4873. readOnly: true
  4874. type:
  4875. - string
  4876. - 'null'
  4877. format: date-time
  4878. required:
  4879. - userTripIri
  4880. - eventIri
  4881. - locationIri
  4882. - date
  4883. Vessel:
  4884. type: object
  4885. description: ''
  4886. deprecated: false
  4887. properties:
  4888. dbId:
  4889. readOnly: true
  4890. type:
  4891. - integer
  4892. - 'null'
  4893. name:
  4894. type: string
  4895. code:
  4896. type: string
  4897. company:
  4898. readOnly: true
  4899. type: string
  4900. format: iri-reference
  4901. example: 'https://example.com/'
  4902. companyIri:
  4903. type:
  4904. - string
  4905. - 'null'
  4906. format: iri-reference
  4907. example: 'https://example.com/'
  4908. createdAt:
  4909. readOnly: true
  4910. type:
  4911. - string
  4912. - 'null'
  4913. format: date-time
  4914. required:
  4915. - name
  4916. - code
  4917. - companyIri
  4918. Vessel.jsonld:
  4919. type: object
  4920. description: ''
  4921. deprecated: false
  4922. properties:
  4923. '@context':
  4924. readOnly: true
  4925. oneOf:
  4926. -
  4927. type: string
  4928. -
  4929. type: object
  4930. properties:
  4931. '@vocab':
  4932. type: string
  4933. hydra:
  4934. type: string
  4935. enum: ['http://www.w3.org/ns/hydra/core#']
  4936. required:
  4937. - '@vocab'
  4938. - hydra
  4939. additionalProperties: true
  4940. '@id':
  4941. readOnly: true
  4942. type: string
  4943. '@type':
  4944. readOnly: true
  4945. type: string
  4946. dbId:
  4947. readOnly: true
  4948. type:
  4949. - integer
  4950. - 'null'
  4951. name:
  4952. type: string
  4953. code:
  4954. type: string
  4955. company:
  4956. readOnly: true
  4957. $ref: '#/components/schemas/ShippingCompany.jsonld'
  4958. companyIri:
  4959. type:
  4960. - string
  4961. - 'null'
  4962. format: iri-reference
  4963. example: 'https://example.com/'
  4964. createdAt:
  4965. readOnly: true
  4966. type:
  4967. - string
  4968. - 'null'
  4969. format: date-time
  4970. required:
  4971. - name
  4972. - code
  4973. - companyIri
  4974. Zone:
  4975. type: object
  4976. description: ''
  4977. deprecated: false
  4978. properties:
  4979. dbId:
  4980. readOnly: true
  4981. type:
  4982. - integer
  4983. - 'null'
  4984. name:
  4985. type: string
  4986. createdAt:
  4987. readOnly: true
  4988. type:
  4989. - string
  4990. - 'null'
  4991. format: date-time
  4992. required:
  4993. - name
  4994. Zone.jsonld:
  4995. type: object
  4996. description: ''
  4997. deprecated: false
  4998. properties:
  4999. '@context':
  5000. readOnly: true
  5001. oneOf:
  5002. -
  5003. type: string
  5004. -
  5005. type: object
  5006. properties:
  5007. '@vocab':
  5008. type: string
  5009. hydra:
  5010. type: string
  5011. enum: ['http://www.w3.org/ns/hydra/core#']
  5012. required:
  5013. - '@vocab'
  5014. - hydra
  5015. additionalProperties: true
  5016. '@id':
  5017. readOnly: true
  5018. type: string
  5019. '@type':
  5020. readOnly: true
  5021. type: string
  5022. dbId:
  5023. readOnly: true
  5024. type:
  5025. - integer
  5026. - 'null'
  5027. name:
  5028. type: string
  5029. createdAt:
  5030. readOnly: true
  5031. type:
  5032. - string
  5033. - 'null'
  5034. format: date-time
  5035. required:
  5036. - name
  5037. Credentials:
  5038. type: object
  5039. properties:
  5040. email:
  5041. type: string
  5042. example: user@example.com
  5043. password:
  5044. type: string
  5045. example: password123
  5046. AuthResponse:
  5047. type: object
  5048. properties:
  5049. '@id':
  5050. type: string
  5051. example: /api/users/1
  5052. dbId:
  5053. type: integer
  5054. example: 1
  5055. token:
  5056. type: string
  5057. example: JWT_TOKEN
  5058. responses: { }
  5059. parameters: { }
  5060. examples: { }
  5061. requestBodies: { }
  5062. headers: { }
  5063. securitySchemes:
  5064. JWT:
  5065. type: http
  5066. scheme: bearer
  5067. bearerFormat: JWT
  5068. security:
  5069. -
  5070. JWT: []
  5071. tags:
  5072. -
  5073. name: Event
  5074. -
  5075. name: Location
  5076. -
  5077. name: MediaObject
  5078. -
  5079. name: ShippingCompany
  5080. -
  5081. name: Trip
  5082. -
  5083. name: TripLocation
  5084. -
  5085. name: User
  5086. -
  5087. name: UserTrip
  5088. -
  5089. name: UserTripEvent
  5090. -
  5091. name: Vessel
  5092. -
  5093. name: Zone
  5094. webhooks: { }