Skip to content

Commit 0e5aa19

Browse files
authored
docs: inconsistent RFC links in documentation (#836)
There are some invalid links in the documentation, which can result in the user writing this PR and forgetting what they were working on in the first place.
1 parent 2b393b6 commit 0e5aa19

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

introspection_request_handler.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import (
1717
)
1818

1919
// NewIntrospectionRequest initiates token introspection as defined in
20-
// https://tools.ietf.org/search/rfc7662#section-2.1
20+
// https://tools.ietf.org/html/rfc7662#section-2.1
2121
//
2222
// The protected resource calls the introspection endpoint using an HTTP
2323
// POST [RFC7231] request with parameters sent as

introspection_response_writer.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
)
1414

1515
// WriteIntrospectionError responds with token metadata discovered by token introspection as defined in
16-
// https://tools.ietf.org/search/rfc7662#section-2.2
16+
// https://tools.ietf.org/html/rfc7662#section-2.2
1717
//
1818
// If the protected resource uses OAuth 2.0 client credentials to
1919
// authenticate to the introspection endpoint and its credentials are
@@ -53,7 +53,7 @@ func (f *Fosite) WriteIntrospectionError(ctx context.Context, rw http.ResponseWr
5353
}
5454

5555
// WriteIntrospectionResponse responds with an error if token introspection failed as defined in
56-
// https://tools.ietf.org/search/rfc7662#section-2.3
56+
// https://tools.ietf.org/html/rfc7662#section-2.3
5757
//
5858
// The server responds with a JSON object [RFC7159] in "application/
5959
// json" format with the following top-level members.

oauth2.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -176,15 +176,15 @@ type OAuth2Provider interface {
176176
IntrospectToken(ctx context.Context, token string, tokenUse TokenUse, session Session, scope ...string) (TokenUse, AccessRequester, error)
177177

178178
// NewIntrospectionRequest initiates token introspection as defined in
179-
// https://tools.ietf.org/search/rfc7662#section-2.1
179+
// https://tools.ietf.org/html/rfc7662#section-2.1
180180
NewIntrospectionRequest(ctx context.Context, r *http.Request, session Session) (IntrospectionResponder, error)
181181

182182
// WriteIntrospectionError responds with an error if token introspection failed as defined in
183-
// https://tools.ietf.org/search/rfc7662#section-2.3
183+
// https://tools.ietf.org/html/rfc7662#section-2.3
184184
WriteIntrospectionError(ctx context.Context, rw http.ResponseWriter, err error)
185185

186186
// WriteIntrospectionResponse responds with token metadata discovered by token introspection as defined in
187-
// https://tools.ietf.org/search/rfc7662#section-2.2
187+
// https://tools.ietf.org/html/rfc7662#section-2.2
188188
WriteIntrospectionResponse(ctx context.Context, rw http.ResponseWriter, r IntrospectionResponder)
189189

190190
// NewPushedAuthorizeRequest validates the request and produces an AuthorizeRequester object that can be stored
@@ -202,7 +202,7 @@ type OAuth2Provider interface {
202202

203203
// IntrospectionResponder is the response object that will be returned when token introspection was successful,
204204
// for example when the client is allowed to perform token introspection. Refer to
205-
// https://tools.ietf.org/search/rfc7662#section-2.2 for more details.
205+
// https://tools.ietf.org/html/rfc7662#section-2.2 for more details.
206206
type IntrospectionResponder interface {
207207
// IsActive returns true if the introspected token is active and false otherwise.
208208
IsActive() bool

0 commit comments

Comments
 (0)