search

kubeshop / kusk-gateway

Kusk-gateway is an OpenAPI-driven API Gateway for Kubernetes
https://kubeshop.github.io/kusk-gateway/
MIT License
264 stars 21 forks source link

Rename `scheme: basic` to `scheme: custom-upstream` #716

Open aabedraba opened 2 years ago

aabedraba commented 2 years ago

And rename auth-upstream to upstream

FROM 

x-kusk:
  scheme: basic
  auth-upstream:
    hostname: upstream.default
    port: 80

TO

x-kusk:
  scheme: custom-upstream
  upstream:
    hostname: upstream.default
    port: 80
mbana commented 2 years ago

And rename auth-upstream to upstream

FROM

x-kusk:
  scheme: basic
  auth-upstream:
    hostname: upstream.default
    port: 80

TO

x-kusk:
  scheme: custom-upstream
  upstream:
    hostname: upstream.default
    port: 80

Personally, I think we should just rename it to basic to make it more intuitive.

Was this changed already discussed amongst the team?

aabedraba commented 2 years ago

Personally, I think we should just rename it to basic to make it more intuitive.

I believe calling it basic is unintuitive for the user.

If it were to be basic I think this pattern would be best: 

x-kusk:
  auth:
     scheme: basic
     basic:
       username: USER
       password: PASSWORD

Custom upstream reflects the flexibility that you can not only do basic, but also any header basic authentication, including:

And calling that basic... is too basic :P IMO.