docs(sdks): fix stale SDK versions and Go import path - #80
Open
lakhansamani wants to merge 1 commit into
Open
Conversation
- authorizer-go example imported the pre-/v2 path while the same page documents `go get .../v2`; Go silently resolves it to an untagged pseudo-version of the old module, so the example runs against a different SDK than the one installed - admin.md claimed the generated proto types live under `internal/` and are unimportable externally; they moved to the public authorizer-proto-go module in authorizer-go#23 - getting-started and the v1-to-v2 guide still pinned authorizer-js@^3.0.0-rc.1 / authorizer-react@^2.0.0-rc.1; js is at 3.3.0 and react v2 has been stable since 2.0.0 - introduction listed authorizer-react v2.1.0, which was never published - `pip install authorizer-py` resolves to 0.2.0, which predates server 2.4.0: no skip_mfa_setup, and paginated admin queries still send the renamed PaginatedRequest type. Use --pre until 0.3.0 is stable - Flutter docs pointed readers at a placeholder repo for "usage instructions"; introduction linked a community fork that 404s
✅ Deploy Preview for authorizerdev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Audit of SDK versions and install/import instructions across the docs ahead of the 2.4.0 stable release. Every version claim below was checked against the registry.
Go SDK
docs/sdks/authorizer-go/example.mdimportedgithub.com/authorizerdev/authorizer-gowhileindex.mdon the same sidebar tells you togo get github.com/authorizerdev/authorizer-go/v2. This does not fail loudly — Go resolves the bare path to an untagged pseudo-version of the pre-/v2module and adds it alongside v2:So the reader ends up with two copies of the SDK in one build and the example running against the old API. The corrected import builds clean against the published
v2.2.0-rc.4.docs/sdks/authorizer-go/admin.mdtold readers the generatedauthorizerv1package "lives underinternal/" and can only be imported from within the SDK module. That stopped being true in authorizerdev/authorizer-go#23 — the types now come from the publicgithub.com/authorizerdev/authorizer-proto-gomodule (v0.2.0-rc.0, pulled in transitively).internal/no longer exists in the repo.index.mdpkg.go.dev link now points at the/v2path.npm version pins
docs/getting-started/index.mdanddocs/migration/v1-to-v2.mdstill pinned release-candidate versions from the v2 beta period:@authorizerdev/authorizer-js@^3.0.0-rc.1latest=3.3.0^3.3.0@authorizerdev/authorizer-react@^2.0.0-rc.1latest=2.0.7,rc=2.2.0-rc.6^2.0.0docs/introduction.mdalso listed authorizer-react as v2.1.0 — that version was never published; npm goes2.0.7→2.2.0-rc.0.Python SDK
pip install authorizer-pyresolves to0.2.0(the current PyPIlatest), which predates server 2.4.0:0.2.0has noskip_mfa_setup— verified absent at the0.2.0tag0.2.0_queries.pysendsquery adminUsers($data: PaginatedRequest); 2.4.0 renamed that input toPaginationRequest, whichmainnow usesPyPI has
0.3.0rc3published. Install commands now use--pre, with a callout explaining why, until 0.3.0 goes stable.Flutter
docs/sdks/authorizer-flutter/index.mdpointed readers at authorizerdev/authorizer-flutter-sdk for "source code and usage instructions" — that repo contains only LICENSE, NOTICE and README. There is noauthorizerpackage on pub.dev either. The page now says so and points at the REST/GraphQL APIs, which any Dart HTTP client can call.docs/introduction.mdlinked Flutter tonickolasgomez/authorizer-flutter-sdk, which 404s.Out of scope
No SDK package versions were bumped and nothing was published.
versioned_docs/version-1.x/is left untouched — it documents the v1 line.Verification
npm run buildpasses with no new broken-link warnings.