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

Update secret token examples in data-plane-aws-s3 README #491

Open
ronjaquensel opened this issue Nov 26, 2024 · 0 comments · May be fixed by #493
Open

Update secret token examples in data-plane-aws-s3 README #491

ronjaquensel opened this issue Nov 26, 2024 · 0 comments · May be fixed by #493
Assignees
Labels
documentation Improvements or additions to documentation triage all new issues awaiting classification

Comments

@ronjaquensel
Copy link
Contributor

Feature Request

The README of the data-plane-aws-s3 module describes the 2 types of SecretToken supported by the data plane, but the JSON examples are incomplete. They miss the required field "edctype": "dataspaceconnector:secrettoken". In addition, the JSON example for the AwsTemporarySecretToken only lists the fields sessionToken and expiration, but not the also required fields accessKeyId and secretAccessKey (even though this is detailed in the text preceding the example). Further, a quick note could be added that the expiration is expected to be a unix timestamp, not any other date format.

Which Areas Would Be Affected?

README

Why Is the Feature Desired?

To avoid confusion/errors when strictly following the README.

Solution Proposal

Add the above-mentioned details to the README.

@ronjaquensel ronjaquensel added the documentation Improvements or additions to documentation label Nov 26, 2024
@ronjaquensel ronjaquensel self-assigned this Nov 26, 2024
@github-actions github-actions bot added the triage all new issues awaiting classification label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation triage all new issues awaiting classification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant