Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for header and cookie unifier are wrong #623

Closed
3 tasks done
dadrus opened this issue May 12, 2023 · 0 comments · Fixed by #626
Closed
3 tasks done

Documentation for header and cookie unifier are wrong #623

dadrus opened this issue May 12, 2023 · 0 comments · Fixed by #626
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@dadrus
Copy link
Owner

dadrus commented May 12, 2023

Preflight checklist

  • I agree to follow this project's Code of Conduct.
  • I have read and am following this repository's Contribution Guidelines."
  • I could not find a solution in the existing issues, docs, nor discussions.

Describe the bug

The documentation sais, the header unifier configuration looks as follows:

id: foo
type: header
config:
  headers:
    - X-User-ID: {{ quote .Subject.ID }}
    - X-User-Email: {{ quote .Subject.Attributes["email"] }}

but the headers property is a map, so the proper configuration would be

id: foo
type: header
config:
  headers:
    # note the absence of "-"
    X-User-ID: {{ quote .Subject.ID }}
    X-User-Email: {{ quote .Subject.Attributes["email"] }}

Same issue applies to the documentation of the cookie unifier. In addition the example uses header as type and not cookie

How can the bug be reproduced

Just take a look in the docs

Relevant log output

No response

Relevant configuration

No response

Version

v0.7.0-alpha

On which operating system are you observing this issue?

None

In which environment are you deploying?

None

Additional Context

No response

@dadrus dadrus added bug Something isn't working documentation Improvements or additions to documentation labels May 12, 2023
@dadrus dadrus closed this as completed May 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant