gogatekeeper / gatekeeper

An OpenID / Proxy service
https://gogatekeeper.github.io/gatekeeper/
Apache License 2.0
253 stars 43 forks source link

docs: Allowed Query Params for Authentication #460

Closed heissonwillen closed 1 month ago

heissonwillen commented 1 month ago

Fix documentation for "Allowed Query Params for Authentication"

Summary

The documentation for allowed query parameters is misleading right now, as it states you should use a yaml list to specify the query parameters you could use. By following the current documentation, GGK simply breaks.

Also, looks like there are leftovers from conflict resolving on the _index.md file currently.

More context here: https://github.com/gogatekeeper/gatekeeper/issues/452#issuecomment-2092443577

Type

Why?

Requirements

How to try it?

Documentation

Additional Information

Checklist:

heissonwillen commented 1 month ago

@p53 could you take a look?

I'll be happy to address any comments and help to improve somewhere else if needed! :)

p53 commented 1 month ago

oh thanks! didn't probably save during rebase