Skip to content

Commit ecda4e0

Browse files
author
Steve Riesenberg
committed
Polish section id prefixes in docs
See #736 (comment) Issue gh-667 Issue gh-668 Issue gh-545
1 parent 14cedd7 commit ecda4e0

File tree

3 files changed

+28
-28
lines changed

3 files changed

+28
-28
lines changed

docs/src/docs/asciidoc/getting-help.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[[getting-help]]
22
= Getting Help
33

4-
[[getting-help-community]]
4+
[[community]]
55
== Community
66

77
Welcome to the https://docs.spring.io/spring-security/reference/community.html[Spring Security Community].
88
Spring Authorization Server is an open source project led by the Spring Security team.
99
If you need help with Spring Authorization Server, we are here to help.
1010

11-
[[getting-help-resources]]
11+
[[resources]]
1212
== Resources
1313

1414
The following are some of the best ways to get help:

docs/src/docs/asciidoc/guides/how-to-jpa.adoc

+24-24
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
:docs-dir: ..
55
:examples-dir: ../examples
66

7-
[[jpa-getting-started]]
7+
[[getting-started]]
88
== Getting Started
99

1010
This guide shows how to implement the xref:{docs-dir}/core-model-components.adoc#core-model-components[core services] of xref:{docs-dir}/index.adoc#top[Spring Authorization Server] with JPA.
1111
The purpose of this guide is to provide a starting point for implementing these services yourself, with the intention that you can make modifications to suit your needs.
1212

13-
[[jpa-define-data-model]]
13+
[[define-data-model]]
1414
== Define the data model
1515

1616
This guide provides a starting point for the data model and uses the simplest possible structure and data types.
@@ -20,7 +20,7 @@ NOTE: Except for token, state, metadata, settings, and claims values, we use the
2020
In reality, the length and even type of columns you use may need to be customized.
2121
You are encouraged to experiment and test before deploying to production.
2222

23-
[[jpa-client-schema]]
23+
[[client-schema]]
2424
=== Client Schema
2525

2626
The xref:{docs-dir}/core-model-components.adoc#registered-client[`RegisteredClient`] domain object contains a few multi-valued fields and some settings fields that require storing arbitrary key/value data.
@@ -32,7 +32,7 @@ The following listing shows the `client` schema.
3232
include::{examples-dir}/src/main/resources/oauth2-registered-client-schema.sql[]
3333
----
3434

35-
[[jpa-authorization-schema]]
35+
[[authorization-schema]]
3636
=== Authorization Schema
3737

3838
The xref:{docs-dir}/core-model-components.adoc#oauth2-authorization[`OAuth2Authorization`] domain object is more complex and contains several multi-valued fields as well as numerous arbitrarily long token values, metadata, settings and claims values.
@@ -49,7 +49,7 @@ The following listing shows the `authorization` schema.
4949
include::{examples-dir}/src/main/resources/oauth2-authorization-schema.sql[]
5050
----
5151

52-
[[jpa-authorization-consent-schema]]
52+
[[authorization-consent-schema]]
5353
=== Authorization Consent Schema
5454

5555
The xref:{docs-dir}/core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object is the simplest to model and contains only a single multi-valued field in addition to a composite key.
@@ -61,15 +61,15 @@ The following listing shows the `authorizationConsent` schema.
6161
include::{examples-dir}/src/main/resources/oauth2-authorization-consent-schema.sql[]
6262
----
6363

64-
[[jpa-create-jpa-entities]]
64+
[[create-jpa-entities]]
6565
== Create JPA entities
6666

6767
The preceding schema examples provide a reference for the structure of the entities we need to create.
6868

6969
NOTE: The following entities are minimally annotated and are just examples.
7070
They allow the schema to be created dynamically and therefore do not require the above sql scripts to be executed manually.
7171

72-
[[jpa-client-entity]]
72+
[[client-entity]]
7373
=== Client Entity
7474

7575
The following listing shows the `Client` entity, which is used to persist information mapped from the xref:{docs-dir}/core-model-components.adoc#registered-client[`RegisteredClient`] domain object.
@@ -80,7 +80,7 @@ The following listing shows the `Client` entity, which is used to persist inform
8080
include::{examples-dir}/src/main/java/sample/jpa/Client.java[tag=class]
8181
----
8282

83-
[[jpa-authorization-entity]]
83+
[[authorization-entity]]
8484
=== Authorization Entity
8585

8686
The following listing shows the `Authorization` entity, which is used to persist information mapped from the xref:{docs-dir}/core-model-components.adoc#oauth2-authorization[`OAuth2Authorization`] domain object.
@@ -91,7 +91,7 @@ The following listing shows the `Authorization` entity, which is used to persist
9191
include::{examples-dir}/src/main/java/sample/jpa/Authorization.java[tag=class]
9292
----
9393

94-
[[jpa-authorization-consent-entity]]
94+
[[authorization-consent-entity]]
9595
=== Authorization Consent Entity
9696

9797
The following listing shows the `AuthorizationConsent` entity, which is used to persist information mapped from the xref:{docs-dir}/core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object.
@@ -102,26 +102,26 @@ The following listing shows the `AuthorizationConsent` entity, which is used to
102102
include::{examples-dir}/src/main/java/sample/jpa/AuthorizationConsent.java[tag=class]
103103
----
104104

105-
[[jpa-create-spring-data-repositories]]
105+
[[create-spring-data-repositories]]
106106
== Create Spring Data repositories
107107

108108
By closely examining the interfaces of each core service and reviewing the `Jdbc` implementations, we can derive a minimal set of queries needed for supporting a JPA version of each interface.
109109

110-
[[jpa-client-repository]]
110+
[[client-repository]]
111111
=== Client Repository
112112

113-
The following listing shows the `ClientRepository`, which is able to find a <<jpa-client-entity,`Client`>> by the `id` and `clientId` fields.
113+
The following listing shows the `ClientRepository`, which is able to find a <<client-entity,`Client`>> by the `id` and `clientId` fields.
114114

115115
.Client Repository
116116
[source,java]
117117
----
118118
include::{examples-dir}/src/main/java/sample/jpa/ClientRepository.java[tag=class]
119119
----
120120

121-
[[jpa-authorization-repository]]
121+
[[authorization-repository]]
122122
=== Authorization Repository
123123

124-
The following listing shows the `AuthorizationRepository`, which is able to find an <<jpa-authorization-entity,`Authorization`>> by the `id` field as well as the `state`, `authorizationCodeValue`, `accessTokenValue` and `refreshTokenValue` token fields.
124+
The following listing shows the `AuthorizationRepository`, which is able to find an <<authorization-entity,`Authorization`>> by the `id` field as well as the `state`, `authorizationCodeValue`, `accessTokenValue` and `refreshTokenValue` token fields.
125125
It also allows querying a combination of token fields.
126126

127127
.Authorization Repository
@@ -130,52 +130,52 @@ It also allows querying a combination of token fields.
130130
include::{examples-dir}/src/main/java/sample/jpa/AuthorizationRepository.java[tag=class]
131131
----
132132

133-
[[jpa-authorization-consent-repository]]
133+
[[authorization-consent-repository]]
134134
=== Authorization Consent Repository
135135

136-
The following listing shows the `AuthorizationConsentRepository`, which is able to find and delete an <<jpa-authorization-consent-entity,`AuthorizationConsent`>> by the `registeredClientId` and `principalName` fields that form a composite primary key.
136+
The following listing shows the `AuthorizationConsentRepository`, which is able to find and delete an <<authorization-consent-entity,`AuthorizationConsent`>> by the `registeredClientId` and `principalName` fields that form a composite primary key.
137137

138138
.Authorization Consent Repository
139139
[source,java]
140140
----
141141
include::{examples-dir}/src/main/java/sample/jpa/AuthorizationConsentRepository.java[tag=class]
142142
----
143143

144-
[[jpa-implement-core-services]]
144+
[[implement-core-services]]
145145
== Implement core services
146146

147-
With the above <<jpa-create-jpa-entities,entities>> and <<jpa-create-spring-data-repositories,repositories>>, we can begin implementing the core services.
147+
With the above <<create-jpa-entities,entities>> and <<create-spring-data-repositories,repositories>>, we can begin implementing the core services.
148148
By reviewing the `Jdbc` implementations, we can derive a minimal set of internal utilities for converting to and from string values for enumerations and reading and writing JSON data for attributes, settings, metadata and claims fields.
149149

150150
CAUTION: Keep in mind that writing JSON data to text columns with a fixed length has proven problematic with the `Jdbc` implementations.
151151
While these examples continue to do so, you may need to split these fields out into a separate table or data store that supports arbitrarily long data values.
152152

153-
[[jpa-registered-client-repository]]
153+
[[registered-client-repository]]
154154
=== Registered Client Repository
155155

156-
The following listing shows the `JpaRegisteredClientRepository`, which uses a <<jpa-client-repository,`ClientRepository`>> for persisting a <<jpa-client-entity,`Client`>> and maps to and from the xref:{docs-dir}/core-model-components.adoc#registered-client[`RegisteredClient`] domain object.
156+
The following listing shows the `JpaRegisteredClientRepository`, which uses a <<client-repository,`ClientRepository`>> for persisting a <<client-entity,`Client`>> and maps to and from the xref:{docs-dir}/core-model-components.adoc#registered-client[`RegisteredClient`] domain object.
157157

158158
.`RegisteredClientRepository` Implementation
159159
[source,java]
160160
----
161161
include::{examples-dir}/src/main/java/sample/jpa/JpaRegisteredClientRepository.java[tag=class]
162162
----
163163

164-
[[jpa-authorization-service]]
164+
[[authorization-service]]
165165
=== Authorization Service
166166

167-
The following listing shows the `JpaOAuth2AuthorizationService`, which uses an <<jpa-authorization-repository,`AuthorizationRepository`>> for persisting an <<jpa-authorization-entity,`Authorization`>> and maps to and from the xref:{docs-dir}/core-model-components.adoc#oauth2-authorization[`OAuth2Authorization`] domain object.
167+
The following listing shows the `JpaOAuth2AuthorizationService`, which uses an <<authorization-repository,`AuthorizationRepository`>> for persisting an <<authorization-entity,`Authorization`>> and maps to and from the xref:{docs-dir}/core-model-components.adoc#oauth2-authorization[`OAuth2Authorization`] domain object.
168168

169169
.`OAuth2AuthorizationService` Implementation
170170
[source,java]
171171
----
172172
include::{examples-dir}/src/main/java/sample/jpa/JpaOAuth2AuthorizationService.java[tag=class]
173173
----
174174

175-
[[jpa-authorization-consent-service]]
175+
[[authorization-consent-service]]
176176
=== Authorization Consent Service
177177

178-
The following listing shows the `JpaOAuth2AuthorizationConsentService`, which uses an <<jpa-authorization-consent-repository,`AuthorizationConsentRepository`>> for persisting an <<jpa-authorization-consent-entity,`AuthorizationConsent`>> and maps to and from the xref:{docs-dir}/core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object.
178+
The following listing shows the `JpaOAuth2AuthorizationConsentService`, which uses an <<authorization-consent-repository,`AuthorizationConsentRepository`>> for persisting an <<authorization-consent-entity,`AuthorizationConsent`>> and maps to and from the xref:{docs-dir}/core-model-components.adoc#oauth2-authorization-consent[`OAuth2AuthorizationConsent`] domain object.
179179

180180
.`OAuth2AuthorizationConsentService` Implementation
181181
[source,java]

docs/src/docs/asciidoc/overview.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55

66
This site contains reference documentation and how-to guides for Spring Authorization Server.
77

8-
[[overview-introducing-spring-authorization-server]]
8+
[[introducing-spring-authorization-server]]
99
== Introducing Spring Authorization Server
1010

1111
Spring Authorization Server is a framework that provides implementations of the https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-05[OAuth 2.1] and https://openid.net/specs/openid-connect-core-1_0.html[OpenID Connect 1.0] specifications and other related specifications.
1212
It is built on top of https://spring.io/projects/spring-security[Spring Security] to provide a secure, light-weight, and customizable foundation for building OpenID Connect 1.0 Identity Providers and OAuth2 Authorization Server products.
1313

14-
[[overview-feature-list]]
14+
[[feature-list]]
1515
== Feature List
1616

1717
Spring Authorization Server supports the following features:

0 commit comments

Comments
 (0)