Skip to content

Commit 9f1fa0e

Browse files
authored
Fix another batch of spelling typos (#13915)
* Fix typos * Remove repeated words * Minor grammar fixes
1 parent 3dc8403 commit 9f1fa0e

File tree

1,449 files changed

+2576
-2581
lines changed

Some content is hidden

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

1,449 files changed

+2576
-2581
lines changed

.github/workflows/samples-java-client-jdk11.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
- samples/client/petstore/java/resttemplate
3737
- samples/client/petstore/java/resttemplate-withXml
3838
- samples/client/petstore/java/webclient
39-
- samples/client/petstore/java/webclient-nulable-arrays
39+
- samples/client/petstore/java/webclient-nullable-arrays
4040
- samples/client/petstore/java/vertx
4141
- samples/client/petstore/java/jersey2-java8-localdatetime
4242
- samples/client/petstore/java/resteasy

.github/workflows/samples-kotlin-client.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Samples Kotlin cilent
1+
name: Samples Kotlin client
22

33
on:
44
push:

.gitpod.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
## customise it to your individual needs - from themes to extensions, you
1313
## have full control.
1414
##
15-
## The easiest way to try out Gitpod is install the browser extenion:
15+
## The easiest way to try out Gitpod is install the browser extension:
1616
## 'https://www.gitpod.io/docs/browser-extension' or by prefixing
1717
## 'https://gitpod.io#' to the source control URL of any project.
1818
##

bin/configs/aspnetcore-6.0-project4Models.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ additionalProperties:
66
packageGuid: '{3C799344-F285-4669-8FD5-7ED9B795D5C5}'
77
aspnetCoreVersion: "6.0"
88
userSecretsGuid: 'cb87e868-8646-48ef-9bb6-344b537d0d37'
9-
useSeperateModelProject: true
9+
useSeparateModelProject: true

bin/configs/java-camel-petstore-new.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ additionalProperties:
1212
library: "spring-boot"
1313
withXml: true
1414
jackson: true
15-
camelUseDefaultValidationtErrorProcessor: true
15+
camelUseDefaultValidationErrorProcessor: true
1616
camelRestClientRequestValidation: true
1717
camelSecurityDefinitions: true

bin/configs/java-webclient-nullable-array.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
generatorName: java
2-
outputDir: samples/client/petstore/java/webclient-nulable-arrays
2+
outputDir: samples/client/petstore/java/webclient-nullable-arrays
33
library: webclient
44
inputSpec: modules/openapi-generator/src/test/resources/3_0/schema-with-nullable-arrays.yaml
55
templateDir: modules/openapi-generator/src/main/resources/Java

bin/configs/swift5-deprecated.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
generatorName: swift5
22
outputDir: samples/client/petstore/swift5/deprecated
3-
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-depreacted-fields.yaml
3+
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-deprecated-fields.yaml
44
templateDir: modules/openapi-generator/src/main/resources/swift5
55
generateAliasAsModel: true
66
additionalProperties:

bin/utils/test_file_list.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
# csharp-netcore test files and image for upload
33
- filename: "samples/client/petstore/csharp-netcore/OpenAPIClient/src/Org.OpenAPITools.Test/JSONComposedSchemaTests.cs"
4-
sha256: aaa596db60531417994533b0e7962eca21dcaf8fa3aea1e2e3cb8b1b216cb89f
4+
sha256: 054adb6efaff70f492e471cb3e4d628d22cda814906808fd3fcce36ce710b7ee
55
- filename: "samples/client/petstore/csharp-netcore/OpenAPIClient/src/Org.OpenAPITools.Test/Api/PetApiTests.cs"
6-
sha256: dae985015ba461297927d544a78267f2def35e07c3f14ca66468fd61e1fd1c26
6+
sha256: ff6a5fccd4c026d85fe7232911cda445f5065dcefd03abe258e19af5b28d05c5
77
- filename: "samples/client/petstore/csharp-netcore/OpenAPIClient/src/Org.OpenAPITools.Test/linux-logo.png"
88
sha256: 0a67c32728197e942b13bdda064b73793f12f5c795f1e5cf35a3adf69c973230
99
# java okhttp gson test files

docs/customization.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The above configuration will do the following:
5656
* Compile a user-provided `my_custom_templates/api_interfaces.mustache` following our usual API template compilation logic. That is, one file will be created per API; APIs are generated defined according to tags in your spec documentation. The destination filename of `Interface.kt` will act as a suffix for the filename. So, a tag of `Equipment` will output a corresponding `EquipmentInterface.kt`.
5757
* Because `api.mustache` is the same mustache filename as used in your target generator (`kotlin` in this example), we support the following:
5858
- The destination filename provides a suffix for the generated output. APIs generate per tag in your specification. So, a tag of `Equipment` will output a corresponding `EquipmentImpl.kt`. This option will be used whether `api.mustache` targets a user customized template or a built-in template.
59-
- The built-in template will be used if you haven't provided an customized template. The kotlin generator defines the suffix as simply `.kt`, so this scenario would modify only the generated file suffixes according to the previous bullet point.
59+
- The built-in template will be used if you haven't provided a customized template. The kotlin generator defines the suffix as simply `.kt`, so this scenario would modify only the generated file suffixes according to the previous bullet point.
6060
- Your `api.mustache` will be used if it exists in your custom template directory. For generators with library options, such as `jvm-okhttp3` in the kotlin generator, your file must exist in the same relative location as the embedded template. For kotlin using the `jvm-okhttp3` library option, this file would need to be located at `my_custom_templates/libraries/jvm-okhttp/api.mustache`. See [templating](./templating.md) for more details.
6161
* Compile `my_custom_templates/other/check.mustache` with the supporting files bundle, and output to `scripts/check.sh` in your output directory. Note that we don't currently support setting file flags on output, so scripts such as these will either have to be sourced rather than executed, or have file flags set separately after generation (external to our tooling).
6262

@@ -169,7 +169,7 @@ If you publish your artifact to a distant maven repository, do not forget to add
169169

170170
You may not want to generate *all* models in your project. Likewise, you may want just one or two apis to be written. If that's the case, you can use system properties or [global properties](./global-properties.md) to control the output.
171171

172-
The default is generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated:
172+
The default is to generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated:
173173

174174
```sh
175175
# generate only models
@@ -397,7 +397,7 @@ or
397397
398398
## Schema Mapping
399399
400-
One can map the schema to someting else (e.g. external objects/models outside of the package) using the `schemaMappings` option, e.g. in CLI
400+
One can map the schema to something else (e.g. external objects/models outside of the package) using the `schemaMappings` option, e.g. in CLI
401401
```sh
402402
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/type-alias.yaml -o /tmp/java2/ --schema-mapping TypeAlias=foo.bar.TypeAlias
403403
```

docs/generators/aspnetcore.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5151
|useDefaultRouting|Use default routing for the ASP.NET Core version.| |true|
5252
|useFrameworkReference|Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.| |false|
5353
|useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
54-
|useSeperateModelProject|Create a seperate project for models| |false|
54+
|useSeparateModelProject|Create a separate project for models| |false|
5555
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |true|
5656

5757
## IMPORT MAPPING

docs/generators/java-camel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3838
|camelRestClientRequestValidation|enable validation of the client request to check whether the Content-Type and Accept headers from the client is supported by the Rest-DSL configuration| |false|
3939
|camelRestComponent|name of the Camel component to use as the REST consumer| |servlet|
4040
|camelSecurityDefinitions|generate camel security definitions| |true|
41-
|camelUseDefaultValidationtErrorProcessor|generate default validation error processor| |true|
41+
|camelUseDefaultValidationErrorProcessor|generate default validation error processor| |true|
4242
|camelValidationErrorProcessor|validation error processor bean name| |validationErrorProcessor|
4343
|configPackage|configuration package for generated code| |org.openapitools.configuration|
4444
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+)</dd></dl>|java8|

docs/generators/wsdl-schema.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
3030
|soapPath|basepath of the soap services| |null|
3131
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
3232
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
33-
|useSpecifiedOperationId|wheather to use autogenerated operationId's (default) or those specified in openapi spec| |null|
33+
|useSpecifiedOperationId|whether to use autogenerated operationId's (default) or those specified in openapi spec| |null|
3434

3535
## IMPORT MAPPING
3636

docs/migration-from-swagger-codegen.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,10 @@ The metadata folder (to store the `VERSION` file for example) is now called `.op
173173

174174
If you use a generator without specifying each parameter, you might see some differences in the generated code.
175175
As example the default package name used in the generated code has changed.
176-
You need to have a look at the specific value, depending of your target language, but often `Swagger` îs replaced by `OpenAPITools` and `io.swagger` is replaced by `org.openapitools`.
176+
You need to have a look at the specific value, depending on your target language, but often `Swagger` îs replaced by `OpenAPITools` and `io.swagger` is replaced by `org.openapitools`.
177177
Concretely if you did not specify anything when you are generating java code, a file `org/openapitools/api/PetApi.java` might be generated instead of `io/swagger/api/PetApi.java`.
178178

179-
If this is a problem for you, you need to explicitly set the the parameter value in order to match with the `swagger-codgen` default value (`apiPackage` == `io.swagger` in the previous example with the java generator).
179+
If this is a problem for you, you need to explicitly set the parameter value in order to match with the `swagger-codegen` default value (`apiPackage` == `io.swagger` in the previous example with the java generator).
180180

181181

182182
## New fully qualified name for the classes

docs/migration-guide.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Projects relying on generated code might need to be adapted.
4949
==== Validate spec on generation by default
5050

5151
The default is to validate the spec during generation. If the spec has errors,
52-
they will appear as errors or warnings to the user. This prevent generation of the project.
52+
they will appear as errors or warnings to the user. This prevents generation of the project.
5353

5454
If you want to switch back to the `3.1.x` behavior you can use:
5555

docs/new-generator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ outputFolder = "generated-code" + File.separator + "common-mark";
119119

120120
This is the default output location. This will be `generated-code/common-mark` on non-Windows machines and `generated-code\common-mark` on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.
121121

122-
> When joining paths, always use `File.seperator`
122+
> When joining paths, always use `File.separator`
123123
124124
```java
125125
modelTemplateFiles.put("model.mustache", ".zz");

docs/online.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ curl -H "Content-type: application/json" \
125125
http://localhost:8080/api/gen/clients/python
126126
```
127127

128-
Instead of using `openAPIUrl` with an URL to the OpenAPI spec, one can include the spec in the JSON payload with `spec`:
128+
Instead of using `openAPIUrl` with a URL to the OpenAPI spec, one can include the spec in the JSON payload with `spec`:
129129

130130
```json
131131
{

docs/roadmap.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Short term are focused on improving contributor and user productivity (part of t
3737
> Feature set, well-defined API (code and templates), and extensibility improvements.
3838

3939
* API
40-
** Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
40+
** Typed representation of the model bound to our templates. As it is, everything is treated as an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
4141
* Feature set (potential generators to add; not an exhaustive list)
4242
** Azure functions (node.js, server)
4343
** Finagle HTTP Client (Scala, client)

docs/roadmap.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Short term are focused on improving contributor and user productivity (part of t
2727
* Automated release stability
2828
* General
2929
* OAS3.0 features support: anyOf, oneOf, callbacks, etc
30-
* Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name). This would allow us to make prioritization decisions based on statistics.
30+
* Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name. This would allow us to make prioritization decisions based on statistics.
3131
* Code clean up
3232
* centralize build scripts
3333
* organize samples/bin scripts according to new generator names
@@ -43,7 +43,7 @@ Short term are focused on improving contributor and user productivity (part of t
4343
> Feature set, well-defined API (code and templates), and extensibility improvements.
4444
4545
### API
46-
* Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
46+
* Typed representation of the model bound to our templates. As it is, everything is treated as an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
4747
* Feature set (potential generators to add; not an exhaustive list)
4848
* Azure functions (node.js, server)
4949
* Finagle HTTP Client (Scala, client)

docs/templating.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -845,7 +845,7 @@ The following are vendor extensions supported by OpenAPI Generator. The list may
845845
846846
#### Enum
847847
848-
`x-enum-varnames` can be used to have an other enum name for the corresponding value.
848+
`x-enum-varnames` can be used to have another enum name for the corresponding value.
849849
This is used to define names of the enum items.
850850
851851
`x-enum-descriptions` can be used to provide an individual description for each value.

docs/usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,7 @@ supportsES6: true
629629
```
630630
631631
The settings are passed exactly the same as for `config.json`. The most important part is the file extension. Supported values are `yml` or `yaml`.
632-
The name of the file should be `config.yml` or `config.yaml` (in our example it will be `config.yaml`.
632+
The name of the file should be `config.yml` or `config.yaml` (in our example it will be `config.yaml`).
633633

634634
```bash
635635
openapi-generator-cli generate -i petstore.yaml -g typescript-fetch -o out \

modules/openapi-generator-maven-plugin/examples/camel.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
<camelDataformatProperties>json.out.disableFeatures=WRITE_DATES_AS_TIMESTAMPS</camelDataformatProperties>
4343
<withXml>true</withXml>
4444
<jackson>true</jackson>
45-
<camelUseDefaultValidationtErrorProcessor>true</camelUseDefaultValidationtErrorProcessor>
45+
<camelUseDefaultValidationErrorProcessor>true</camelUseDefaultValidationErrorProcessor>
4646
<!--
4747
Define bean validation error processor
48-
<camelUseDefaultValidationtErrorProcessor>false</camelUseDefaultValidationtErrorProcessor>
48+
<camelUseDefaultValidationErrorProcessor>false</camelUseDefaultValidationErrorProcessor>
4949
<camelValidationErrorProcessor>errorProcessorBeanName</camelValidationErrorProcessor>
5050
-->
5151
<camelRestClientRequestValidation>true</camelRestClientRequestValidation>

modules/openapi-generator-maven-plugin/examples/multi-module/sample-schema/src/main/resources/openapi.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ paths:
335335
- "store"
336336
summary: "Find purchase order by ID"
337337
description: "For valid response try integer IDs with value <= 5 or > 10. Other\
338-
\ values will generated exceptions"
338+
\ values will generate exceptions"
339339
operationId: "getOrderById"
340340
produces:
341341
- "application/xml"

modules/openapi-generator-maven-plugin/examples/swagger.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ paths:
335335
- "store"
336336
summary: "Find purchase order by ID"
337337
description: "For valid response try integer IDs with value <= 5 or > 10. Other\
338-
\ values will generated exceptions"
338+
\ values will generate exceptions"
339339
operationId: "getOrderById"
340340
produces:
341341
- "application/xml"

modules/openapi-generator-maven-plugin/src/test/resources/default/petstore.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ paths:
334334
summary: Find purchase order by ID
335335
description: >-
336336
For valid response try integer IDs with value <= 5 or > 10. Other values
337-
will generated exceptions
337+
will generate exceptions
338338
operationId: getOrderById
339339
parameters:
340340
- name: orderId

modules/openapi-generator-maven-plugin/src/test/resources/petstore-on-classpath.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ paths:
334334
summary: Find purchase order by ID
335335
description: >-
336336
For valid response try integer IDs with value <= 5 or > 10. Other values
337-
will generated exceptions
337+
will generate exceptions
338338
operationId: getOrderById
339339
parameters:
340340
- name: orderId

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -2761,7 +2761,7 @@ protected String toTestCaseName(String specTestCaseName) {
27612761

27622762
/**
27632763
* A method that allows generators to pre-process test example payloads
2764-
* This can be useful if one needs to change how values like null in string are represnted
2764+
* This can be useful if one needs to change how values like null in string are represented
27652765
* @param data the test data payload
27662766
* @return the updated test data payload
27672767
*/

modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ private void gatherInlineModels(Schema schema, String modelPrefix) {
340340
} else {
341341
// allOf is just one or more types only so do not generate the inline allOf model
342342
if (m.getAllOf().size() == 1) {
343-
// handle earlier in this function when looping through properites
343+
// handle earlier in this function when looping through properties
344344
} else if (m.getAllOf().size() > 1) {
345345
LOGGER.warn("allOf schema `{}` containing multiple types (not model) is not supported at the moment.", schema.getName());
346346
} else {
@@ -892,7 +892,7 @@ private void copyVendorExtensions(Schema source, Schema target) {
892892
*
893893
* @param name name of the inline schema
894894
* @param schema inilne schema
895-
* @return the actual model name (based on inlineSchemaNameMapping if provied)
895+
* @return the actual model name (based on inlineSchemaNameMapping if provided)
896896
*/
897897
private String addSchemas(String name, Schema schema) {
898898
//check inlineSchemaNameMapping

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ public String toModelName(String name) {
476476

477477
name = toGenericName(name);
478478

479-
// add prefix and/or suffix only if name does not start wth \ (e.g. \DateTime)
479+
// add prefix and/or suffix only if name does not start with \ (e.g. \DateTime)
480480
if (!name.matches("^\\\\.*")) {
481481
if (!StringUtils.isEmpty(modelNamePrefix)) {
482482
name = modelNamePrefix + "_" + name;

0 commit comments

Comments
 (0)