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

Redis statestore field redisPassword incorrectly marked as required in docs #4193

Closed
jake-engelberg opened this issue Jun 11, 2024 · 3 comments · Fixed by #4298
Closed

Redis statestore field redisPassword incorrectly marked as required in docs #4193

jake-engelberg opened this issue Jun 11, 2024 · 3 comments · Fixed by #4298
Assignees

Comments

@jake-engelberg
Copy link

jake-engelberg commented Jun 11, 2024

EDIT (contrib maintainer): The contrib repo metadata was correct. The docs are wrong. The docs instead need updating.

Expected Behavior

redisPassword should be a required field in the statestore .yaml as per the docs:
https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-redis-pubsub/
Screenshot 2024-06-11 at 4 28 15 PM

Actual Behavior

redisPassword is incorrectly set as required: false.
https://github.com/dapr/components-contrib/blob/787b23d5d0a3486fc14255f26b36cf365c9bd2bf/state/redis/metadata.yaml#L24-L29

Steps to Reproduce the Problem

N/A

Release Note

RELEASE NOTE: FIX Redis statestore field redisPassword now correctly marked as required.

@berndverst
Copy link
Member

The docs are incorrect and the metadata file is actually correct. I'll transfer this issue to the docs repo and you can then update the docs there instead.

Thanks!

@berndverst berndverst transferred this issue from dapr/components-contrib Jun 11, 2024
@berndverst berndverst changed the title Redis statestore field redisPassword not marked as required Redis statestore field redisPassword incorrectly marked as required in docs Jun 11, 2024
@hhunter-ms
Copy link
Collaborator

@jake-engelberg @berndverst it looks like the docs are already updated to show redisPassword as a required field in all Redis component specs.

@hhunter-ms hhunter-ms self-assigned this Jul 30, 2024
@hhunter-ms
Copy link
Collaborator

@jake-engelberg @berndverst it looks like the docs are already updated to show redisPassword as a required field in all Redis component specs.

ope, just realized what we're asking for. I'll update the docs to show as not required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants