Add comprehensive README documentation#9
Open
lightcap wants to merge 4 commits into
Open
Conversation
lightcap
force-pushed
the
worktree-docs-readme
branch
from
7d2e43d to
5d72d69
Compare
Model structure and content after the official 1Password SDKs (JS, Python, Go). Covers both authentication methods, usage examples for all API surfaces (secrets, items, files, shares, vaults, groups, environments), feature flags, error handling, and supported functionality checklist.
Fix non-compiling code examples: - Use explicit field initialization instead of ..Default::default() (ItemField and ItemCreateParams do not implement Default) - Use Option wrappers where the actual types require them Fix install instructions to use git dependency since the crate is not published to crates.io (publish = false). Add coverage for previously undocumented public API methods: - Secrets::validate_secret_reference - Batch operations: create_all, get_all, delete_all - File operations: delete, replace_document - Vault operations: get, get_overview, update, update_group_permissions Add MIT LICENSE file (referenced in Cargo.toml but was missing).
Replace println! calls that print .len() of secrets and passwords with simple success messages, consistent with the examples fix in PR #11.
- Point installation URL to lightcap/onepassword-sdk-rust (actual repo) - Add ItemsFilesApi import to file management snippet - Add ItemsSharesApi import to sharing snippet
lightcap
force-pushed
the
worktree-docs-readme
branch
from
f1e7a07 to
89d31a8
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a full README.md modeled after the official 1Password SDKs (JS, Python, Go).
Covers:
wasmanddesktop)SdkErrorvariantsTest plan
Note
Low Risk
Documentation-only addition plus an MIT
LICENSE; no runtime code paths or behavior are changed.Overview
Adds a comprehensive
README.mdwith setup/authentication instructions and end-to-end usage examples across the SDK surface (secrets, items, files, shares, vaults, groups, environments), plus feature-flag and error-handling notes.Introduces an MIT
LICENSEfile and links the README’s license section to it.Reviewed by Cursor Bugbot for commit 89d31a8. Bugbot is set up for automated code reviews on this repo. Configure here.