Skip to content

Commit 2f6c1de

Browse files
committed
review code formatting
1 parent c961b3b commit 2f6c1de

File tree

2,697 files changed

+7311
-6842
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,697 files changed

+7311
-6842
lines changed

CHANGELOG.md

Lines changed: 135 additions & 46 deletions
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,6 @@ individual is representing the project or its community.
3535

3636
This Code of Conduct is adapted from the
3737
[Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at
38-
[contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/) and [spring-boot
38+
[contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/)
39+
and [spring-boot
3940
Contributor Code of Conduct](https://github.com/spring-projects/spring-boot/blob/master/CODE_OF_CONDUCT.adoc)

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
[![Known Vulnerabilities](https://snyk.io/test/github/springdoc/springdoc-openapi.git/badge.svg)](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
55
[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/springdoc)](https://stackoverflow.com/questions/tagged/springdoc?tab=Votes)
66

7-
IMPORTANT: ``springdoc-openapi v1.8.0`` is the latest Open Source release supporting Spring Boot 2.x and 1.x.
7+
IMPORTANT: ``springdoc-openapi v1.8.0`` is the latest Open Source release supporting
8+
Spring Boot 2.x and 1.x.
89

9-
An extended support for [*springdoc-openapi v1*](https://springdoc.org/v1)
10-
project is now available for organizations that need support beyond 2023.
10+
An extended support for [*springdoc-openapi v1*](https://springdoc.org/v1)
11+
project is now available for organizations that need support beyond 2023.
1112

12-
For more details, feel free to reach out: [[email protected]](mailto:[email protected])
13+
For more details, feel free to reach
14+
1315

14-
``springdoc-openapi`` is on [Open Collective](https://opencollective.com/springdoc). If you ❤️ this project consider becoming a [sponsor](https://github.com/sponsors/springdoc).
16+
``springdoc-openapi`` is on [Open Collective](https://opencollective.com/springdoc). If
17+
you ❤️ this project consider becoming a [sponsor](https://github.com/sponsors/springdoc).
1518

1619
This project is sponsored by
1720

@@ -82,9 +85,11 @@ The following video introduces the Library:
8285

8386
* [https://youtu.be/utRxyPfFlDw](https://youtu.be/utRxyPfFlDw)
8487

85-
For *spring-boot v3* support, make sure you use [springdoc-openapi v2](https://springdoc.org/)
88+
For *spring-boot v3* support, make sure you
89+
use [springdoc-openapi v2](https://springdoc.org/)
8690

87-
This is a community-based project, not maintained by the Spring Framework Contributors (Pivotal)
91+
This is a community-based project, not maintained by the Spring Framework Contributors (
92+
Pivotal)
8893

8994
# **Getting Started**
9095

@@ -105,6 +110,7 @@ This is a community-based project, not maintained by the Spring Framework Contri
105110
additional configuration is needed):
106111

107112
Maven
113+
108114
```xml
109115
<dependency>
110116
<groupId>org.springdoc</groupId>
@@ -114,6 +120,7 @@ Maven
114120
```
115121

116122
Gradle
123+
117124
```groovy
118125
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:latest'
119126
```
@@ -157,6 +164,7 @@ springdoc.swagger-ui.path=/swagger-ui.html
157164
is needed)
158165

159166
Maven
167+
160168
```xml
161169
<dependency>
162170
<groupId>org.springdoc</groupId>
@@ -166,6 +174,7 @@ Maven
166174
```
167175

168176
Gradle
177+
169178
```groovy
170179
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:latest'
171180
```
@@ -208,6 +217,7 @@ and `@SecurityScheme` annotations within a Spring managed bean.
208217
is needed)
209218

210219
Maven
220+
211221
```xml
212222
<dependency>
213223
<groupId>org.springdoc</groupId>
@@ -217,6 +227,7 @@ Maven
217227
```
218228

219229
Gradle
230+
220231
```groovy
221232
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:latest'
222233
```

SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Supported Versions
44

5-
| Version | Supported |
6-
| ------- | ------------------ |
7-
| latest-stable | :white_check_mark: |
5+
| Version | Supported |
6+
|---------------|--------------------|
7+
| latest-stable | :white_check_mark: |
88

99
## Reporting a Vulnerability
1010

pom.xml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xmlns="http://maven.apache.org/POM/4.0.0"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24
<modelVersion>4.0.0</modelVersion>
35
<groupId>org.springdoc</groupId>
46
<artifactId>springdoc-openapi</artifactId>
@@ -59,7 +61,8 @@
5961
<jjwt.version>0.9.1</jjwt.version>
6062
<therapi-runtime-javadoc.version>0.15.0</therapi-runtime-javadoc.version>
6163
<spring-cloud-function.version>4.2.2</spring-cloud-function.version>
62-
<spring-security-oauth2-authorization-server.version>1.4.3</spring-security-oauth2-authorization-server.version>
64+
<spring-security-oauth2-authorization-server.version>1.4.3
65+
</spring-security-oauth2-authorization-server.version>
6366
</properties>
6467

6568
<dependencyManagement>
@@ -117,7 +120,8 @@
117120
<goal>copy-resources</goal>
118121
</goals>
119122
<configuration>
120-
<outputDirectory>${basedir}/target/classes/META-INF</outputDirectory>
123+
<outputDirectory>${basedir}/target/classes/META-INF
124+
</outputDirectory>
121125
<resources>
122126
<resource>
123127
<directory>${basedir}/..</directory>

springdoc-openapi-bom/pom.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xmlns="http://maven.apache.org/POM/4.0.0"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24
<modelVersion>4.0.0</modelVersion>
35
<parent>
46
<groupId>org.springdoc</groupId>
57
<artifactId>springdoc-openapi</artifactId>
68
<version>2.8.10-SNAPSHOT</version>
79
</parent>
810
<artifactId>springdoc-openapi-bom</artifactId>
11+
<name>${project.artifactId}</name>
912
<packaging>pom</packaging>
1013
<dependencyManagement>
1114
<dependencies>
@@ -69,4 +72,4 @@
6972
</plugins>
7073
</build>
7174

72-
</project>
75+
</project>

springdoc-openapi-starter-common/pom.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xmlns="http://maven.apache.org/POM/4.0.0"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24
<modelVersion>4.0.0</modelVersion>
35
<parent>
46
<groupId>org.springdoc</groupId>
57
<artifactId>springdoc-openapi</artifactId>
68
<version>2.8.10-SNAPSHOT</version>
79
</parent>
810
<artifactId>springdoc-openapi-starter-common</artifactId>
11+
<name>${project.artifactId}</name>
912
<dependencies>
1013
<dependency>
1114
<groupId>org.springframework.boot</groupId>
@@ -159,4 +162,4 @@
159162
</plugins>
160163
</build>
161164

162-
</project>
165+
</project>

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* * * *
2222
* * *
2323
* *
24-
*
24+
*
2525
*/
2626

2727
package org.springdoc.api;
@@ -178,6 +178,11 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
178178
*/
179179
protected final SpringDocProviders springDocProviders;
180180

181+
/**
182+
* The Spring doc customizers.
183+
*/
184+
protected final SpringDocCustomizers springDocCustomizers;
185+
181186
/**
182187
* The open api builder object factory.
183188
*/
@@ -203,16 +208,6 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
203208
*/
204209
private final AntPathMatcher antPathMatcher = new AntPathMatcher();
205210

206-
/**
207-
* The Open api builder.
208-
*/
209-
protected OpenAPIService openAPIService;
210-
211-
/**
212-
* The Spring doc customizers.
213-
*/
214-
protected final SpringDocCustomizers springDocCustomizers;
215-
216211
/**
217212
* The Reentrant lock.
218213
*/
@@ -223,6 +218,11 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
223218
*/
224219
private final Pattern pathPattern = Pattern.compile("\\{(.*?)}");
225220

221+
/**
222+
* The Open api builder.
223+
*/
224+
protected OpenAPIService openAPIService;
225+
226226

227227
/**
228228
* Instantiates a new Abstract open api resource.
@@ -426,8 +426,8 @@ private Locale selectLocale(Locale inputLocale) {
426426
List<String> allowedLocales = springDocConfigProperties.getAllowedLocales();
427427
if (!CollectionUtils.isEmpty(allowedLocales)) {
428428
Locale bestMatchingAllowedLocale = Locale.lookup(
429-
Locale.LanguageRange.parse(inputLocale.toLanguageTag()),
430-
allowedLocales.stream().map(Locale::forLanguageTag).toList()
429+
Locale.LanguageRange.parse(inputLocale.toLanguageTag()),
430+
allowedLocales.stream().map(Locale::forLanguageTag).toList()
431431
);
432432

433433
return bestMatchingAllowedLocale == null ? Locale.forLanguageTag(allowedLocales.get(0)) : bestMatchingAllowedLocale;
@@ -524,7 +524,7 @@ private void trimIndentOperation(Operation operation) {
524524
*/
525525
protected void calculateWebhooks(OpenAPI calculatedOpenAPI, Locale locale) {
526526
Webhooks[] webhooksAttr = openAPIService.getWebhooks();
527-
if(ArrayUtils.isEmpty(webhooksAttr))
527+
if (ArrayUtils.isEmpty(webhooksAttr))
528528
return;
529529
var webhooks = Arrays.stream(webhooksAttr).map(Webhooks::value).flatMap(Arrays::stream).toArray(Webhook[]::new);
530530
Arrays.stream(webhooks).forEach(webhook -> {
@@ -659,7 +659,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
659659
operationPath = operationPath.replace("{" + pathParam + "}", "{" + newPathParam + "}");
660660
}
661661
}
662-
662+
663663
PathItem pathItemObject = buildPathItem(requestMethod, operation, operationPath, paths);
664664
paths.addPathItem(operationPath, pathItemObject);
665665
}

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/ErrorMessage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* * * *
2222
* * *
2323
* *
24-
*
24+
*
2525
*/
2626

2727
package org.springdoc.api;

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/OpenApiResourceNotFoundException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* * * *
2222
* * *
2323
* *
24-
*
24+
*
2525
*/
2626

2727
package org.springdoc.api;

0 commit comments

Comments
 (0)