Update Go docs #862
Merged
Update Go docs #862
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
|
No New Or Fixed Issues Found |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #862 +/- ##
=======================================
Coverage 57.92% 57.92%
=======================================
Files 193 193
Lines 13120 13120
=======================================
Hits 7600 7600
Misses 5520 5520 ☔ View full report in Codecov by Sentry. |
mzieniukbw
previously approved these changes
Jul 15, 2024
| @@ -52,25 +52,25 @@ err := bitwardenClient.AccessTokenLogin(accessToken, &statePath) | |||
| #### Create a Project | |||
|
|
|||
| ```go | |||
| project, err := client.Projects().Create("organization_id", "project_name") | |||
| project, err := bitwardenClient.Projects().Create("organization_id", "project_name") | |||
| ``` | |||
|
|
|||
| #### List Projects | |||
There was a problem hiding this comment.
⛏️ Should we add Get Project (by id) ?
There was a problem hiding this comment.
Great catch! Added in 2ec353f.
| @@ -80,34 +80,34 @@ project, err := client.Projects().Delete([]string{"project_id_1", "project_id_2" | |||
| #### Create a Secret | |||
|
|
|||
| ```go | |||
| secret, err := client.Secrets().Create("key", "value", "note", "organization_id", []string{"project_id"}) | |||
| secret, err := bitwardenClient.Secrets().Create("key", "value", "note", "organization_id", []string{"project_id"}) | |||
| ``` | |||
|
|
|||
| #### List Secrets | |||
There was a problem hiding this comment.
⛏️ Should we add Get Secrets (by id) and Get (multiple) Secrets By Ids ?
There was a problem hiding this comment.
Added in 47f059e.
mzieniukbw
approved these changes
Jul 16, 2024
coltonhurst
approved these changes
Jul 17, 2024
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.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/SM-1265
📔 Objective
Correct a syntax error and use consistent and descriptive
bitwardenClientvariable name.⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes