Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 25e4375

Browse files
naXa777naXa777
committed
correct spelling, fix typos
(issue springfox#1896)
1 parent 271f2c0 commit 25e4375

46 files changed

Lines changed: 114 additions & 118 deletions

File tree

Some content is hidden

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

‎.github/CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ code reviewer can focus on reviewing what has actually changed, without having t
3030
context as to what the thought processes is or how you arrived at the final solution
3131
- If you encounter significant cleanup required mid-way through your work try to isolate that as a separate commit.
3232
This is not to say ever single minute cleanup needs to be in its own commit, just the large chunks of cleanup.
33-
- Finally clean up all the merge commits by rebaseing against the source repo often.
33+
- Finally clean up all the merge commits by rebasing against the source repo often.
3434

3535
Along the lines of the _agile manifesto_:
3636

‎docs/asciidoc/common-problems.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ spring services can serve it up.
1919

2020
A. Thanks to https://github.com/chrishuttonch[@chrishuttonch] for describing the solution to https://github.com/springfox/springfox/issues/867[this issue]
2121

22-
TIP: I switched on the excludeFieldsWithoutExposeAnnotation() which meant that none of the objects would produce any data. To get around this I created several serialisers for the following classes:
22+
TIP: I switched on the excludeFieldsWithoutExposeAnnotation() which meant that none of the objects would produce any data. To get around this I created several serializers for the following classes:
2323

2424
[source,java]
2525
----
@@ -72,7 +72,7 @@ public class MyWebAutoConfiguration extends WebMvcConfigurerAdapter {
7272
}
7373
----
7474

75-
[[q5]]*Q. How do we use Java 8 types esply. LocalDateTime?*
75+
[[q5]]*Q. How do we use Java 8 types easily. LocalDateTime?*
7676

7777
A. The easiest way to to configure dates is via `Docket#directModelSubstitute(LocalDateTime.class, String.class)`. If
7878
these are ISO 8601 dates that conform to a string format i.e. `yyyy-MM-dd'T'HH:mm'Z'`. However you won't have any format or validation info.

‎docs/asciidoc/current-documentation.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ library always has a configured ObjectMapper that is customized to serialize swa
5858

5959
In order to do this implement the ```ApplicationListener<ObjectMapperConfigured>``` interface. The event has a handle
6060
to the ObjectMapper that was configured. Configuring application specific ObjectMapper customizations in this
61-
applicaiton event handler guarantees that application specific customizations will be applied to each and every
61+
application event handler guarantees that application specific customizations will be applied to each and every
6262
ObjectMapper that is in play.
6363

6464
If you encounter a NullPointerException during application startup like https://github.com/springfox/springfox/issues/635[this issue]. Its because most likely the ```WebMvcConfigurerAdapter``` isn't working.
@@ -299,7 +299,7 @@ public Model getAllThePets() {
299299

300300
===== Customizing the value of _operationId_
301301

302-
In the event you wish to overide the default `operationId` which Springfox renders, you may do so by providing the
302+
In the event you wish to override the default `operationId` which Springfox renders, you may do so by providing the
303303
`nickname` element in an `@ApiOperation` annotation.
304304

305305
====== Given this annotated method ...

‎docs/asciidoc/extensibility.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ include::../../springfox-spring-config/src/main/java/springfox/springconfig/Vers
9393
<2> Check if the https://github.com/springfox/springfox/blob/master/springfox-spring-config/src/main/java/springfox/springconfig/VersionApi.java[VersionApi]
9494
is applied to the parameter.
9595
<3> Build the parameter with the necessary information using the builder methods.
96-
<4> Return true if we want this plugin to apply to all documenation types.
96+
<4> Return true if we want this plugin to apply to all documentation types.
9797

9898
==== Example ApiListingScannerPlugin
9999

@@ -108,7 +108,7 @@ include::../../swagger-contract-tests/src/main/java/springfox/test/contract/swag
108108
<1> Add a list of custom ``ApiDescription``s
109109
<2> Add a list of ``Operation``s for each description
110110
<3> NOTE: the code generated names are not guaranteed to be unique. For these custom endpoints it is the
111-
resposibility of the service author to ensure.
111+
responsibility of the service author to ensure.
112112
<4> NOTE: It is important to also ensure we pass in a model reference even for primitive types
113113

114114
== Additional extensibility options

‎docs/asciidoc/legacy-documentation.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ By default, when using Springfox in Swagger 2.0 mode, the value of `operationID`
280280
```
281281

282282
===== Customizing the value of `operationId`
283-
In the event you wish to overide the default `operationId` which Springfox renders, you may do so by providing the `nickname` element in an `@ApiOperation` annotation.
283+
In the event you wish to override the default `operationId` which Springfox renders, you may do so by providing the `nickname` element in an `@ApiOperation` annotation.
284284

285285
====== Given this annotated method ...
286286

‎gradle/publishing.gradle‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@ if (!isSnapshot()) {
162162
// mavenCentralSync {
163163
// sync = true //Optional (true by default). Determines whether to sync the version to Maven Central.
164164
// user = 'userToken' //OSS user token
165-
// password = 'paasword' //OSS user password
166-
// close = '1' //Optional property. By default the staging repository is closed and artifacts are released to Maven Central. You can optionally turn this behaviour off (by puting 0 as value) and release the version manually.
165+
// password = 'password' //OSS user password
166+
// close = '1' //Optional property. By default the staging repository is closed and artifacts are released to Maven Central. You can optionally turn this behaviour off (by putting 0 as value) and release the version manually.
167167
// }
168168
// }
169169
}

‎gradle/wrapper/gradle-wrapper.properties‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
#Fri Apr 28 05:37:48 CDT 2017
1+
#Sun Jul 02 12:52:46 MSK 2017
22
distributionBase=GRADLE_USER_HOME
33
distributionPath=wrapper/dists
44
zipStoreBase=GRADLE_USER_HOME
55
zipStorePath=wrapper/dists
6-
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-bin.zip
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-all.zip

‎springfox-bean-validators/src/test/groovy/springfox/bean/validators/plugins/schema/ModelPropertyNotNullAnnotationPluginSpec.groovy‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ import com.fasterxml.jackson.databind.ObjectMapper
2323
import com.fasterxml.jackson.databind.type.TypeFactory
2424
import spock.lang.Specification
2525
import spock.lang.Unroll
26-
import springfox.bean.validators.plugins.models.NullablityTestModel
27-
import springfox.bean.validators.plugins.schema.NotNullAnnotationPlugin
26+
import springfox.bean.validators.plugins.models.NullabilityTestModel
2827
import springfox.documentation.builders.ModelPropertyBuilder
2928
import springfox.documentation.spi.DocumentationType
3029
import springfox.documentation.spi.schema.contexts.ModelPropertyContext
@@ -41,7 +40,7 @@ class ModelPropertyNotNullAnnotationPluginSpec extends Specification {
4140
def "@NotNull annotations are reflected in the model properties that are AnnotatedElements"() {
4241
given:
4342
def sut = new NotNullAnnotationPlugin()
44-
def element = NullablityTestModel.getDeclaredField(propertyName)
43+
def element = NullabilityTestModel.getDeclaredField(propertyName)
4544
def context = new ModelPropertyContext(
4645
new ModelPropertyBuilder(),
4746
element,
@@ -87,7 +86,7 @@ class ModelPropertyNotNullAnnotationPluginSpec extends Specification {
8786
def mapper = new ObjectMapper()
8887
mapper
8988
.serializationConfig
90-
.introspect(TypeFactory.defaultInstance().constructType(NullablityTestModel))
89+
.introspect(TypeFactory.defaultInstance().constructType(NullabilityTestModel))
9190
.findProperties()
9291
.find { p -> property.equals(p.name) };
9392
}

springfox-bean-validators/src/test/java/springfox/bean/validators/plugins/models/NullablityTestModel.java renamed to springfox-bean-validators/src/test/java/springfox/bean/validators/plugins/models/NullabilityTestModel.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
import javax.validation.constraints.NotNull;
2222

23-
public class NullablityTestModel {
23+
public class NullabilityTestModel {
2424
@NotNull
2525
private String notNullString;
2626
private String string;

‎springfox-core/src/main/java/springfox/documentation/builders/ApiListingBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public ApiListingBuilder protocols(Set<String> protocols) {
172172
}
173173

174174
/**
175-
* Updates the references to the security definitiosn
175+
* Updates the references to the security definitions
176176
*
177177
* @param securityReferences - security definition references
178178
* @return this

0 commit comments

Comments
 (0)