Skip to content

Commit a3b0a47

Browse files
committed
Fix minor typos
1 parent 7d8eacc commit a3b0a47

File tree

279 files changed

+861
-861
lines changed

Some content is hidden

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

279 files changed

+861
-861
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0, 3.1 (beta support)
141141

142142
For old releases, please refer to the [**Release**](https://github.com/OpenAPITools/openapi-generator/releases) page.
143143

144-
For decomissioned generators/libraries/frameworks, please refer to [the "Decommission" label](https://github.com/OpenAPITools/openapi-generator/issues?q=label%3ADecommission+is%3Amerged+) in the pull request page.
144+
For decommissioned generators/libraries/frameworks, please refer to [the "Decommission" label](https://github.com/OpenAPITools/openapi-generator/issues?q=label%3ADecommission+is%3Amerged+) in the pull request page.
145145

146146
## [1.2 - Artifacts on Maven Central](#table-of-contents)
147147

bin/utils/test_file_list.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/ClientTest.java"
1111
sha256: 325fdd5d7e2c97790c0fb44f712ab7b2ba022d7e1a5b0056f47b07f342682b6d
1212
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/JSONTest.java"
13-
sha256: e673d9928c8eb848262d0116fe0d28db832e128671a810a7c966d06d90cb9b63
13+
sha256: 44aef898ae3f5ac75e3847aa24a8eca259eb922be920162df0b725a6b751a6ca
1414
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/api/PetApiTest.java"
1515
sha256: 0d64cdc11809a7b5b952ccdad2bd91bd0045b3894d6fabf3e368fa0be12b8217
1616
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/model/PetTest.java"

docs/3.0.0-release-note.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_label: "Release Notes: 3.0.0"
1010
* e58dc2c77 Fix COPY in Dockerfile (#64)
1111
* 9d7feaaeb Fix online generator (docker push) (#58)
1212
* 9247cd01e Changes for Docker
13-
* 64037ee59 update docker-related files to ues jdk8
13+
* 64037ee59 update docker-related files to use jdk8
1414

1515
* ## Plug-ins
1616
* b6b8c0db8 \[gradle-plugin] Initial implementation (#162)

docs/customization.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ Upon first code generation, you may also pass the CLI option `--ignore-file-over
266266

267267
Editor support for `.openapi-generator-ignore` files is available in IntelliJ via the [.ignore plugin](https://plugins.jetbrains.com/plugin/7495--ignore).
268268

269-
One may want to pre-populate `.openapi-generator-ignore` with a list of entries during the code generation process and the global/general option `openapiGeneatorIgnoreList` (e.g. --openapi-generator-ignore-list in CLI) can do exactly that. For example,
269+
One may want to pre-populate `.openapi-generator-ignore` with a list of entries during the code generation process and the global/general option `openapiGeneratorIgnoreList` (e.g. --openapi-generator-ignore-list in CLI) can do exactly that. For example,
270270
```
271271
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g spring -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/spring --additional-properties useTags=true --openapi-generator-ignore-list "README.md,pom.xml,docs/*.md,src/main/java/org/openapitools/model/*"
272272
```
@@ -434,9 +434,9 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat
434434
```
435435
will rename SOLD to UNAVAILABLE instead.
436436

437-
Not all generators support thess features yet. Please give it a try to confirm the behaviour and open an issue (ticket) to let us know which generators you would like to have this feature enabled and we'll prioritize accordingly. We also welcome PRs to add these features to generators. Related PRs for reference: #16209, #16234 (modelNameMappings), #16194, #16206 (nameMappings, parameterNameMappings), #17108 (enumNameMappings).
437+
Not all generators support these features yet. Please give it a try to confirm the behaviour and open an issue (ticket) to let us know which generators you would like to have this feature enabled and we'll prioritize accordingly. We also welcome PRs to add these features to generators. Related PRs for reference: #16209, #16234 (modelNameMappings), #16194, #16206 (nameMappings, parameterNameMappings), #17108 (enumNameMappings).
438438

439-
NOTE: some generators use `baseName` (original name obtained direclty from OpenAPI spec, e.g. `shipping-date`) mustache tag in the templates so the mapping feature won't work.
439+
NOTE: some generators use `baseName` (original name obtained directly from OpenAPI spec, e.g. `shipping-date`) mustache tag in the templates so the mapping feature won't work.
440440

441441
To map `operationId` (used in method naming) to something else, use `operationIdNameMappings` option, e.g.
442442

@@ -480,7 +480,7 @@ paths:
480480
481481
## Inline Schema Naming
482482
483-
Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the `title` field or the `inlineSchemaNameMapping` option. For exmaple, run the following,
483+
Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the `title` field or the `inlineSchemaNameMapping` option. For example, run the following,
484484

485485
```
486486
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml -o /tmp/java3/ --skip-validate-spec --inline-schema-name-mappings inline_object_2=SomethingMapped,inline_object_4=nothing_new
@@ -503,7 +503,7 @@ Another useful option is `inlineSchemaOptions`, which allows you to customize ho
503503
- `ARRAY_ITEM_SUFFIX` sets the array item suffix
504504
- `MAP_ITEM_SUFFIX` set the map item suffix
505505
- `SKIP_SCHEMA_REUSE=true` is a special value to skip reusing inline schemas during refactoring
506-
- `REFACTOR_ALLOF_INLINE_SCHEMAS=true` will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schmeas by default)
506+
- `REFACTOR_ALLOF_INLINE_SCHEMAS=true` will restore the 6.x (or below) behaviour to refactor allOf inline schemas into $ref. (v7.0.0 will skip the refactoring of these allOf inline schemas by default)
507507
- `RESOLVE_INLINE_ENUMS=true` will refactor inline enum definitions into $ref
508508
509509
## OpenAPI Normalizer
@@ -524,7 +524,7 @@ Example:
524524
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/allOf_extension_parent.yaml -o /tmp/java-okhttp/ --openapi-normalizer REF_AS_PARENT_IN_ALLOF=true
525525
```
526526
527-
- `REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY`: when set to `true`, oneOf/anyOf schema with only required properies only in a schema with properties will be removed. [(example)](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml)
527+
- `REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY`: when set to `true`, oneOf/anyOf schema with only required properties only in a schema with properties will be removed. [(example)](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml)
528528
529529
Example:
530530
```

docs/generators/swift5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
5555
|useCustomDateWithoutTime|Uses a custom type to decode and encode dates without time information to support OpenAPIs date format (default: false)| |false|
5656
|useJsonEncodable|Make models conform to JSONEncodable protocol (default: true)| |true|
5757
|useSPMFileStructure|Use SPM file structure and set the source path to Sources/{{projectName}} (default: false).| |null|
58-
|validatable|Make validation rules and validator for model properies (default: true)| |true|
58+
|validatable|Make validation rules and validator for model properties (default: true)| |true|
5959

6060
## IMPORT MAPPING
6161

modules/openapi-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,7 @@ public void execute() throws MojoExecutionException {
865865
}
866866

867867
// Apply Parameter Name Mappings
868-
if (parameterNameMappings != null && (configOptions == null || !configOptions.containsKey("paramter-name-mappings"))) {
868+
if (parameterNameMappings != null && (configOptions == null || !configOptions.containsKey("parameter-name-mappings"))) {
869869
applyParameterNameMappingsKvpList(parameterNameMappings, configurator);
870870
}
871871

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1924,9 +1924,9 @@ public String toInstantiationType(Schema schema) {
19241924
if (ModelUtils.isMapSchema(schema)) {
19251925
Schema additionalProperties = ModelUtils.getAdditionalProperties(schema);
19261926
String inner = getSchemaType(additionalProperties);
1927-
String mapInstantion = instantiationTypes.get("map");
1928-
if (mapInstantion != null) {
1929-
return mapInstantion + "<String, " + inner + ">";
1927+
String mapInstantiation = instantiationTypes.get("map");
1928+
if (mapInstantiation != null) {
1929+
return mapInstantiation + "<String, " + inner + ">";
19301930
}
19311931
return inner;
19321932
} else if (ModelUtils.isArraySchema(schema)) {
@@ -2199,7 +2199,7 @@ public String toDefaultValueWithParam(String name, Schema schema) {
21992199
* @return string presentation of the default value of the property
22002200
*/
22012201
public String toDefaultValue(CodegenProperty codegenProperty, Schema schema) {
2202-
// use toDefaultValue(schema) if generator has not overriden this method
2202+
// use toDefaultValue(schema) if generator has not overridden this method
22032203
return toDefaultValue(schema);
22042204
}
22052205

@@ -3131,7 +3131,7 @@ protected void setAddProps(Schema schema, IJsonSchemaValidationProperties proper
31313131
// if we are trying to set additionalProperties on an empty schema stop recursing
31323132
return;
31333133
}
3134-
// Note: This flag is set to true if additioanl properties
3134+
// Note: This flag is set to true if additional properties
31353135
// is set (any type, free form object, boolean true, string, etc).
31363136
// The variable name may be renamed later to avoid confusion.
31373137
boolean additionalPropertiesIsAnyType = false;
@@ -3154,7 +3154,7 @@ protected void setAddProps(Schema schema, IJsonSchemaValidationProperties proper
31543154
additionalPropertiesIsAnyType = true;
31553155
}
31563156
} else {
3157-
// if additioanl properties is set (e.g. free form object, any type, string, etc)
3157+
// if additional properties is set (e.g. free form object, any type, string, etc)
31583158
addPropProp = fromProperty(getAdditionalPropertiesName(), (Schema) schema.getAdditionalProperties(), false);
31593159
additionalPropertiesIsAnyType = true;
31603160
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,7 @@ private void flattenResponses(String modelName, Operation operation) {
591591
* breed:
592592
* type: string
593593
*
594-
* @param key a unique name ofr the composed schema.
594+
* @param key a unique name for the composed schema.
595595
* @param children the list of nested schemas within a composed schema (allOf, anyOf, oneOf).
596596
* @param skipAllOfInlineSchemas true if allOf inline schemas need to be skipped.
597597
*/

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,7 @@ private Schema normalizeOneOf(Schema schema, Set<Schema> visitedSchemas) {
650650
if (!(item instanceof Schema)) {
651651
throw new RuntimeException("Error! oneOf schema is not of the type Schema: " + item);
652652
}
653-
// normalize oenOf sub schemas one by one
653+
// normalize oneOf sub schemas one by one
654654
normalizeSchema((Schema) item, visitedSchemas);
655655
}
656656
// process rules here
@@ -691,7 +691,7 @@ private Schema normalizeComplexComposedSchema(Schema schema, Set<Schema> visited
691691
}
692692

693693
// ===================== a list of rules =====================
694-
// all rules (fuctions) start with the word "process"
694+
// all rules (functions) start with the word "process"
695695

696696
/**
697697
* Child schemas in `allOf` is considered a parent if it's a `$ref` (instead of inline schema).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@ private boolean startsWithTwoUppercaseLetters(String name) {
926926

927927
@Override
928928
public String toParamName(String name) {
929-
// obtain the name from paramterNameMapping directly if provided
929+
// obtain the name from parameterNameMapping directly if provided
930930
if (parameterNameMapping.containsKey(name)) {
931931
return parameterNameMapping.get(name);
932932
}

0 commit comments

Comments
 (0)