DOC: Add an example of adding a user_password credential #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds an example of how to set a new credential of type user_password, with a given user property, to the examples if the credentials command. It shows that type and user need to be defined as properties, and entry of the secret is interactive. While it was probably clear from the other examples and command description, now it's explicit.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #103 +/- ##
===========================================
- Coverage 94.50% 53.07% -41.44%
===========================================
Files 32 16 -16
Lines 2966 1611 -1355
===========================================
- Hits 2803 855 -1948
- Misses 163 756 +593 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds an example of how to set a new credential of type user_password, with a given user property, to the examples in the
credentials command. For some reason, I always had to think twice before adding a new user_password credentials based on the existing docs (maybe it's just me). I thought this usage could have an explicit example.
The added example shows that type and user need to be defined as properties, and entry of the secret is interactive. While it was probably clear from the other examples and command description, now it's explicit. Also, it is the first example where more than one property is being given.