add doc

Author: jba

internal/oauthex/auth_meta.go

@@ -15,10 +15,12 @@ import (
 )
 
 // AuthServerMeta represents the metadata for an OAuth 2.0 authorization server,
-// as defined in RFC 8414 (https://tools.ietf.org/html/rfc8414).
+// as defined in [RFC 8414].
 //
 // Not supported:
 // - signed metadata
+//
+// [RFC 8414]: https://tools.ietf.org/html/rfc8414)
 type AuthServerMeta struct {
 	// GENERATED BY GEMINI 2.5.
 
@@ -112,6 +114,15 @@ var wellKnownPaths = []string{
 	"/.well-known/openid-configuration",
 }
 
+// GetAuthServerMeta issues a GET request to retrieve authorization server metadata
+// from an OAuth authorization server with the given issuerURL.
+//
+// It follows [RFC 8414]:
+//   - The well-known paths specified there are inserted into the URL's path, one at time.
+//     The first to succeed is used.
+//   - The Issuer field is checked against issuerURL.
+//
+// [RFC 8414]: https://tools.ietf.org/html/rfc8414
 func GetAuthServerMeta(ctx context.Context, issuerURL string, c *http.Client) (*AuthServerMeta, error) {
 	var errs []error
 	for _, p := range wellKnownPaths {