Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix another batch of spelling typos #13915

Merged
merged 3 commits into from
Nov 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/samples-java-client-jdk11.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- samples/client/petstore/java/resttemplate
- samples/client/petstore/java/resttemplate-withXml
- samples/client/petstore/java/webclient
- samples/client/petstore/java/webclient-nulable-arrays
- samples/client/petstore/java/webclient-nullable-arrays
- samples/client/petstore/java/vertx
- samples/client/petstore/java/jersey2-java8-localdatetime
- samples/client/petstore/java/resteasy
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/samples-kotlin-client.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Samples Kotlin cilent
name: Samples Kotlin client

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .gitpod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
## customise it to your individual needs - from themes to extensions, you
## have full control.
##
## The easiest way to try out Gitpod is install the browser extenion:
## The easiest way to try out Gitpod is install the browser extension:
## 'https://www.gitpod.io/docs/browser-extension' or by prefixing
## 'https://gitpod.io#' to the source control URL of any project.
##
Expand Down
2 changes: 1 addition & 1 deletion bin/configs/aspnetcore-6.0-project4Models.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ additionalProperties:
packageGuid: '{3C799344-F285-4669-8FD5-7ED9B795D5C5}'
aspnetCoreVersion: "6.0"
userSecretsGuid: 'cb87e868-8646-48ef-9bb6-344b537d0d37'
useSeperateModelProject: true
useSeparateModelProject: true
2 changes: 1 addition & 1 deletion bin/configs/java-camel-petstore-new.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ additionalProperties:
library: "spring-boot"
withXml: true
jackson: true
camelUseDefaultValidationtErrorProcessor: true
camelUseDefaultValidationErrorProcessor: true
camelRestClientRequestValidation: true
camelSecurityDefinitions: true
2 changes: 1 addition & 1 deletion bin/configs/java-webclient-nullable-array.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
generatorName: java
outputDir: samples/client/petstore/java/webclient-nulable-arrays
outputDir: samples/client/petstore/java/webclient-nullable-arrays
library: webclient
inputSpec: modules/openapi-generator/src/test/resources/3_0/schema-with-nullable-arrays.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
Expand Down
2 changes: 1 addition & 1 deletion bin/configs/swift5-deprecated.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
generatorName: swift5
outputDir: samples/client/petstore/swift5/deprecated
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-depreacted-fields.yaml
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-deprecated-fields.yaml
templateDir: modules/openapi-generator/src/main/resources/swift5
generateAliasAsModel: true
additionalProperties:
Expand Down
4 changes: 2 additions & 2 deletions bin/utils/test_file_list.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
# csharp-netcore test files and image for upload
- filename: "samples/client/petstore/csharp-netcore/OpenAPIClient/src/Org.OpenAPITools.Test/JSONComposedSchemaTests.cs"
sha256: aaa596db60531417994533b0e7962eca21dcaf8fa3aea1e2e3cb8b1b216cb89f
sha256: 054adb6efaff70f492e471cb3e4d628d22cda814906808fd3fcce36ce710b7ee
- filename: "samples/client/petstore/csharp-netcore/OpenAPIClient/src/Org.OpenAPITools.Test/Api/PetApiTests.cs"
sha256: dae985015ba461297927d544a78267f2def35e07c3f14ca66468fd61e1fd1c26
sha256: ff6a5fccd4c026d85fe7232911cda445f5065dcefd03abe258e19af5b28d05c5
- filename: "samples/client/petstore/csharp-netcore/OpenAPIClient/src/Org.OpenAPITools.Test/linux-logo.png"
sha256: 0a67c32728197e942b13bdda064b73793f12f5c795f1e5cf35a3adf69c973230
# java okhttp gson test files
Expand Down
6 changes: 3 additions & 3 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The above configuration will do the following:
* 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`.
* Because `api.mustache` is the same mustache filename as used in your target generator (`kotlin` in this example), we support the following:
- 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.
- 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.
- 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.
- 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.
* 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).

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

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.

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

```sh
# generate only models
Expand Down Expand Up @@ -397,7 +397,7 @@ or

## Schema Mapping

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
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
```sh
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
```
Expand Down
2 changes: 1 addition & 1 deletion docs/generators/aspnetcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|useDefaultRouting|Use default routing for the ASP.NET Core version.| |true|
|useFrameworkReference|Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.| |false|
|useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
|useSeperateModelProject|Create a seperate project for models| |false|
|useSeparateModelProject|Create a separate project for models| |false|
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |true|

## IMPORT MAPPING
Expand Down
2 changes: 1 addition & 1 deletion docs/generators/java-camel.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|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|
|camelRestComponent|name of the Camel component to use as the REST consumer| |servlet|
|camelSecurityDefinitions|generate camel security definitions| |true|
|camelUseDefaultValidationtErrorProcessor|generate default validation error processor| |true|
|camelUseDefaultValidationErrorProcessor|generate default validation error processor| |true|
|camelValidationErrorProcessor|validation error processor bean name| |validationErrorProcessor|
|configPackage|configuration package for generated code| |org.openapitools.configuration|
|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|
Expand Down
2 changes: 1 addition & 1 deletion docs/generators/wsdl-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|soapPath|basepath of the soap services| |null|
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|useSpecifiedOperationId|wheather to use autogenerated operationId's (default) or those specified in openapi spec| |null|
|useSpecifiedOperationId|whether to use autogenerated operationId's (default) or those specified in openapi spec| |null|

## IMPORT MAPPING

Expand Down
4 changes: 2 additions & 2 deletions docs/migration-from-swagger-codegen.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,10 @@ The metadata folder (to store the `VERSION` file for example) is now called `.op

If you use a generator without specifying each parameter, you might see some differences in the generated code.
As example the default package name used in the generated code has changed.
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`.
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`.
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`.

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).
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).


## New fully qualified name for the classes
Expand Down
2 changes: 1 addition & 1 deletion docs/migration-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Projects relying on generated code might need to be adapted.
==== Validate spec on generation by default

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/new-generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ outputFolder = "generated-code" + File.separator + "common-mark";

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.

> When joining paths, always use `File.seperator`
> When joining paths, always use `File.separator`

```java
modelTemplateFiles.put("model.mustache", ".zz");
Expand Down
2 changes: 1 addition & 1 deletion docs/online.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ curl -H "Content-type: application/json" \
http://localhost:8080/api/gen/clients/python
```

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

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/roadmap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Short term are focused on improving contributor and user productivity (part of t
> Feature set, well-defined API (code and templates), and extensibility improvements.

* API
** 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.
** 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.
* Feature set (potential generators to add; not an exhaustive list)
** Azure functions (node.js, server)
** Finagle HTTP Client (Scala, client)
Expand Down
4 changes: 2 additions & 2 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Short term are focused on improving contributor and user productivity (part of t
* Automated release stability
* General
* OAS3.0 features support: anyOf, oneOf, callbacks, etc
* 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.
* 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.
* Code clean up
* centralize build scripts
* organize samples/bin scripts according to new generator names
Expand All @@ -43,7 +43,7 @@ Short term are focused on improving contributor and user productivity (part of t
> Feature set, well-defined API (code and templates), and extensibility improvements.

### API
* 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.
* 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.
* Feature set (potential generators to add; not an exhaustive list)
* Azure functions (node.js, server)
* Finagle HTTP Client (Scala, client)
Expand Down
2 changes: 1 addition & 1 deletion docs/templating.md
Original file line number Diff line number Diff line change
Expand Up @@ -845,7 +845,7 @@ The following are vendor extensions supported by OpenAPI Generator. The list may

#### Enum

`x-enum-varnames` can be used to have an other enum name for the corresponding value.
`x-enum-varnames` can be used to have another enum name for the corresponding value.
This is used to define names of the enum items.

`x-enum-descriptions` can be used to provide an individual description for each value.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ supportsES6: true
```

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`.
The name of the file should be `config.yml` or `config.yaml` (in our example it will be `config.yaml`.
The name of the file should be `config.yml` or `config.yaml` (in our example it will be `config.yaml`).

```bash
openapi-generator-cli generate -i petstore.yaml -g typescript-fetch -o out \
Expand Down
4 changes: 2 additions & 2 deletions modules/openapi-generator-maven-plugin/examples/camel.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@
<camelDataformatProperties>json.out.disableFeatures=WRITE_DATES_AS_TIMESTAMPS</camelDataformatProperties>
<withXml>true</withXml>
<jackson>true</jackson>
<camelUseDefaultValidationtErrorProcessor>true</camelUseDefaultValidationtErrorProcessor>
<camelUseDefaultValidationErrorProcessor>true</camelUseDefaultValidationErrorProcessor>
<!--
Define bean validation error processor
<camelUseDefaultValidationtErrorProcessor>false</camelUseDefaultValidationtErrorProcessor>
<camelUseDefaultValidationErrorProcessor>false</camelUseDefaultValidationErrorProcessor>
<camelValidationErrorProcessor>errorProcessorBeanName</camelValidationErrorProcessor>
-->
<camelRestClientRequestValidation>true</camelRestClientRequestValidation>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
- "store"
summary: "Find purchase order by ID"
description: "For valid response try integer IDs with value <= 5 or > 10. Other\
\ values will generated exceptions"
\ values will generate exceptions"
operationId: "getOrderById"
produces:
- "application/xml"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
- "store"
summary: "Find purchase order by ID"
description: "For valid response try integer IDs with value <= 5 or > 10. Other\
\ values will generated exceptions"
\ values will generate exceptions"
operationId: "getOrderById"
produces:
- "application/xml"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ paths:
summary: Find purchase order by ID
description: >-
For valid response try integer IDs with value <= 5 or > 10. Other values
will generated exceptions
will generate exceptions
operationId: getOrderById
parameters:
- name: orderId
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ paths:
summary: Find purchase order by ID
description: >-
For valid response try integer IDs with value <= 5 or > 10. Other values
will generated exceptions
will generate exceptions
operationId: getOrderById
parameters:
- name: orderId
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2761,7 +2761,7 @@ protected String toTestCaseName(String specTestCaseName) {

/**
* A method that allows generators to pre-process test example payloads
* This can be useful if one needs to change how values like null in string are represnted
* This can be useful if one needs to change how values like null in string are represented
* @param data the test data payload
* @return the updated test data payload
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ private void gatherInlineModels(Schema schema, String modelPrefix) {
} else {
// allOf is just one or more types only so do not generate the inline allOf model
if (m.getAllOf().size() == 1) {
// handle earlier in this function when looping through properites
// handle earlier in this function when looping through properties
} else if (m.getAllOf().size() > 1) {
LOGGER.warn("allOf schema `{}` containing multiple types (not model) is not supported at the moment.", schema.getName());
} else {
Expand Down Expand Up @@ -892,7 +892,7 @@ private void copyVendorExtensions(Schema source, Schema target) {
*
* @param name name of the inline schema
* @param schema inilne schema
* @return the actual model name (based on inlineSchemaNameMapping if provied)
* @return the actual model name (based on inlineSchemaNameMapping if provided)
*/
private String addSchemas(String name, Schema schema) {
//check inlineSchemaNameMapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ public String toModelName(String name) {

name = toGenericName(name);

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