Skip to content

Commit

Permalink
chore(repo): fix documentation typos
Browse files Browse the repository at this point in the history
  • Loading branch information
frankkilcommins authored and frantuma committed Oct 17, 2024
1 parent 327873b commit d02d406
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,4 +271,4 @@ When code is generated from this project, it shall be considered **AS IS** and o

## Thank You

💚💚💚 We'd like to give a big shout our to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, [authoring templates](./docs/template-creators.md), or crafting useful [content](./docs/public-content.md) for others to benefit from. 💚💚💚
💚💚💚 We'd like to give a big shout out to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, [authoring templates](./docs/template-creators.md), or crafting useful [content](./docs/public-content.md) for others to benefit from. 💚💚💚
4 changes: 3 additions & 1 deletion docs/generators-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ and `config.json` contains the following as an example:
```

Supported config options can be different per language. Running `config-help -l {lang}` will show available options.
**These options are applied via configuration file (e.g. config.json) or by passing them with `java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}`**. (If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it)
**These options are applied via configuration file (e.g. config.json) or by passing them with `java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}`**.

> If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it.
```sh
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java
Expand Down
4 changes: 2 additions & 2 deletions docs/generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \
-o output/myLibrary -n myClientCodegen -p com.my.company.codegen
```

This will write, in the folder `output/myLibrary`, all the files you need to get started, including a `README.md. Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic.
This will write, in the folder `output/myLibrary`, all the files you need to get started, including a `README.md`. Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic.

You would then compile your library in the `output/myLibrary` folder with `mvn package` and execute the codegen like such:

Expand Down Expand Up @@ -51,7 +51,7 @@ to the code generator like this:
-i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json
```

Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane.
Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane ✈️.

## Ignore file format

Expand Down
12 changes: 3 additions & 9 deletions docs/versioning.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Versioning
# Versioning

Both 2.X and 3.X version lines of Swagger Codegen are available and are independently maintained.

**NOTE:** version 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids.

### Swagger Codegen 2.X
## Swagger Codegen 2.X

|||
|----|-----|
Expand All @@ -24,7 +24,7 @@ dependency example:
</dependency>
```

### Swagger Codegen 3.X ([`3.0.0` branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0))
## Swagger Codegen 3.X

|||
|----|-----|
Expand All @@ -43,9 +43,3 @@ dependency example:
<version>3.0.61</version>
</dependency>
```


(for main ReadMe)
[Online generator of version 3.X](https://github.com/swagger-api/swagger-codegen/tree/3.0.0#online-generators) supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications.


2 changes: 1 addition & 1 deletion docs/workflow-integration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Worklfow Integrations
# Workflow Integrations

## Maven Integration

Expand Down

0 comments on commit d02d406

Please sign in to comment.