No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 
 
 
 

2806 líneas
78 KiB

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