magda-io / magda

A federated, open-source data catalog for all your big data and small data
https://magda.io
Apache License 2.0
505 stars 92 forks source link

Gateway Chart should support an extra "additionalRoutes" field #3438

Closed t83714 closed 1 year ago

t83714 commented 1 year ago

Gateway Chart should support an extra "additionalRoutes" field

At this moment, users can config gateway API routes via the routes field. However, once the user set the routes fields, he will have to list all API routes including system API routes. Although this allow users to disable system routes, we should also provide a shortcut to users so he don't have to list all system API routes. The "additionalRoutes" field is proposed for this propose.

Without additionalRoutes field, the user will have to config his own API by:

routes:
  my-own-api:
    to: http://my-service/
  search:
        to: http://search-api/v0
        auth: true
  ...
  ... all other system API routes

With additionalRoutes field, the user can simply config his own API by:

additionalRoutes:
  my-own-api:
    to: http://my-service/
t83714 commented 1 year ago

closed via PR: https://github.com/magda-io/magda/pull/3441