dapr / docs

Dapr user documentation, used to build docs.dapr.io

Home Page:https://docs.dapr.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Redis statestore field redisPassword incorrectly marked as required in docs

jake-engelberg opened this issue · comments

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.

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!

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

@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.