From 498b70bae1a3a66b51bb42404a4e35f668e819ec Mon Sep 17 00:00:00 2001
From: David Sharnoff <dsharnoff@singlestore.com>
Date: Mon, 4 Jul 2022 00:20:29 -0700
Subject: [PATCH] chore: add some docs to NewOpenIDProvider() (#191)

* add some docs to NewOpenIDProvider()

* typo
---
 pkg/op/op.go | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/pkg/op/op.go b/pkg/op/op.go
index 0d3bc76..5b8567a 100644
--- a/pkg/op/op.go
+++ b/pkg/op/op.go
@@ -117,6 +117,23 @@ type endpoints struct {
 	JwksURI            Endpoint
 }
 
+//NewOpenIDProvider creates a provider. The provider provides (with HttpHandler())
+//a http.Router that handles a suite of endpoints (some paths can be overridden):
+//  /healthz
+//  /ready
+//  /.well-known/openid-configuration
+//  /oauth/token
+//  /oauth/introspect
+//  /callback
+//  /authorize
+//  /userinfo
+//  /revoke
+//  /end_session
+//  /keys
+//This does not include login. Login is handled with a redirect that includes the
+//request ID. The redirect for logins is specified per-client by Client.LoginURL().
+//Successful logins should mark the request as authorized and redirect back to to
+//op.AuthCallbackURL(provider) which is probably /callback.
 func NewOpenIDProvider(ctx context.Context, config *Config, storage Storage, opOpts ...Option) (OpenIDProvider, error) {
 	err := ValidateIssuer(config.Issuer)
 	if err != nil {