Skip to content

Conversation

@developerkunal
Copy link
Contributor

🔧 Changes

Updated the Go backend API quickstart documentation to reference the new 01-Quickstart-Go-API sample repository and bumped the go-jwt-middleware library version to v3.0.0.

What changed:

  • Updated GitHub sample links from 01-Authorization-RS256 to 01-Quickstart-Go-API in English documentation
  • Updated go-jwt-middleware version from v2.3.0 to v3.0.0 in libraries.mdx (released Jan 20, 2026)
  • Updated sample download links in SDK libraries page

Why:

  • The new sample repository provides a cleaner, simplified structure that better matches the documentation
  • v3.0.0 release includes breaking changes and requires Go 1.24+ for generics support

Files modified:

  • main/docs/quickstart/backend/golang/index.mdx
  • main/docs/quickstart/backend/golang/interactive.mdx
  • main/docs/libraries.mdx
  • main/snippets/sdks/SdkLibraries.mdx

📚 References

🔬 Testing

Verified:

  • ✅ All GitHub links resolve correctly to the new sample repository
  • ✅ New sample repository structure matches documentation code snippets
  • ✅ Documentation builds successfully with mint dev --port 3333
  • ✅ Version badge displays v3.0.0 in libraries page

�� Checklist

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

Copilot AI review requested due to automatic review settings January 20, 2026 14:01
@github-actions
Copy link

github-actions bot commented Jan 20, 2026

Summary

Status Count
🔍 Total 160
✅ Successful 134
⏳ Timeouts 0
🔀 Redirected 10
👻 Excluded 11
❓ Unknown 0
🚫 Errors 5
⛔ Unsupported 0

Errors per input

Errors in main/docs/libraries.mdx

Errors in main/docs/quickstart/backend/golang/03-troubleshooting.mdx

Errors in main/docs/quickstart/backend/golang/index.mdx

  • [ERROR] https://quickstarts/api | Network error: Connection failed. Check network connectivity and firewall settings

Redirects per input

Redirects in main/docs/libraries.mdx

Redirects in main/docs/quickstart/backend/golang/02-using.mdx

Redirects in main/docs/quickstart/backend/golang/03-troubleshooting.mdx

Redirects in main/docs/quickstart/backend/golang/index.mdx

Redirects in main/snippets/sdks/SdkLibraries.mdx

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request updates the Go backend API quickstart documentation to reference the new 01-Quickstart-Go-API sample repository and upgrades the go-jwt-middleware library from v2.3.0 to v3.0.0. The update includes comprehensive rewrites of the documentation to reflect v3's new features, including generics-based type-safe claims handling and a simplified options pattern API.

Changes:

  • Updated sample repository links from 01-Authorization-RS256 to 01-Quickstart-Go-API
  • Upgraded go-jwt-middleware from v2.3.0 to v3.0.0 with breaking changes
  • Rewrote quickstart documentation with expanded step-by-step guidance, troubleshooting tips, and best practices

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
main/docs/libraries.mdx Updated library version to v3.0.0, release date to Jan 20, 2026, and sample repository link
main/snippets/sdks/SdkLibraries.mdx Updated sample repository link to new location
main/snippets/quickstart/backend/golang/validator.go.mdx New snippet showing v3 validator setup with JWKS caching and options pattern
main/snippets/quickstart/backend/golang/middleware.go.mdx New snippet for HTTP middleware configuration with error handling
main/snippets/quickstart/backend/golang/main.go.mdx Completely rewritten main server with graceful shutdown and production timeouts
main/snippets/quickstart/backend/golang/handlers.go.mdx New handlers demonstrating public, private, and scoped endpoint patterns
main/snippets/quickstart/backend/golang/config.go.mdx New configuration loader for Auth0 environment variables
main/snippets/quickstart/backend/golang/claims.go.mdx New custom claims implementation with scope validation
main/docs/quickstart/backend/golang/interactive.mdx Major rewrite with expanded tutorial format, prerequisites, and troubleshooting
main/docs/quickstart/backend/golang/index.mdx Major rewrite with comprehensive step-by-step guide and advanced topics
main/docs/quickstart/backend/golang/_index.mdx Deleted file (content consolidated into other files)
main/docs/quickstart/backend/golang/03-troubleshooting.mdx Enhanced with v3-specific troubleshooting scenarios and solutions
main/docs/quickstart/backend/golang/02-using.mdx Updated port numbers (3010→8080), improved formatting, removed deprecated examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Modernize documentation with go-jwt-middleware latest version
- Add comprehensive tutorial with 11 steps (index.mdx) and 10 steps (interactive.mdx)
- Introduce modern UI components (Cards, Accordions, Steps, Tips, Warnings)
- Add config package pattern for centralized environment variable management
- Separate CustomClaims into dedicated claims.go file for better organization
- Add useful Validate() method with optional scope validation
- Update all endpoints to /api/private-scoped (was /api/scoped)
- Add WithValidateOnOptions(false) for CORS preflight handling
- Remove invalid issuer error from troubleshooting (code handles trailing slash automatically)
- Update all code snippets to match auth0-golang-api-samples repository structure
- Add new snippet files: claims.go.mdx, config.go.mdx, handlers.go.mdx, middleware.go.mdx, validator.go.mdx
- Update 02-using.mdx with correct port (8080) and endpoint URLs
- Fix troubleshooting guide numbering after removing invalid issuer section
- Remove orphaned _index.mdx file
- Remove write:messages permission (only read:messages is used)
@developerkunal developerkunal merged commit 2343d39 into main Jan 21, 2026
5 checks passed
@developerkunal developerkunal deleted the golang-backend-api-docs-update branch January 21, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants