1Password / onepassword-sdk-go

https://developer.1password.com/docs/sdks/
MIT License
40 stars 3 forks source link

Document supported functionality in the README #118

Closed SimonBarendse closed 1 month ago

SimonBarendse commented 1 month ago

Make clear upfront what is and isn't yet supported in the README, and invite folks to contribute their desires by upvoting or filing issues.

I've changed the phrasing from "limitations" to a more roadmap-like todo list, to be more forward looking and bring across our intentions to continue expanding these SDKs across more use cases. I want it to be inviting to brainstorm or request additional use cases, and prevent these coming across as out of scope and SDKs not being suitable for these use cases.

Where there's existing issues already filed for functionality we don't support yet, I've included a link to the issue, so it's easier for folks to upvote this request if they need it too. We may even want to seed the issue tracker with issues for the other functionality, to make it even easier to indicate desire for these too. Before we do so, we may want to look into creating a central (core) repository first though, to track these, so that we're not duplicating issues for the same functionality across all repositories for the different languages, adding overhead to managing these issues and seeing demand across languages.

Where there's current alternatives available for programmatic access, I've listed these alternatives for easier discovery (e.g. Events API).

SimonBarendse commented 1 month ago

Thanks Lucy, this looks even better now! 😍 Agree that talking about the supported fields specifically is more accurate than the item templates these fields exist on, updated to reflect that.

After this is merged, do you want me to open matching updates to the Python and SDK repos?

Sure, thanks for offering! One caveat for now to consider when creating these, is as I mentioned in the PR description, we currently track issues for adding functionality separately in each languages repo, so for now we'll need to check for which issues exist separately on those repos to link the right tickets instead of the ones we link here in the Go repo.