Skip to content

Commit 6c11076

Browse files
chore(docs): update based on Codegen-3.0.68 release (#389)
* chore(docs): update based on 3.0.68 codegen release
1 parent c886759 commit 6c11076

File tree

7 files changed

+37
-14
lines changed

7 files changed

+37
-14
lines changed

src/content/docs/open-source-tools/Swagger Codegen/Codegen v3/about.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
7171

7272
Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes
7373
-------------------------- |--------------| -------------------------- | -----
74-
[3.0.67](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.67) (**current stable**) | 2025-01-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.67](https://github.com/swagger-api/swagger-codegen/tree/v3.0.67)
74+
[3.0.68](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.68) (**current stable**) | 2025-03-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.68](https://github.com/swagger-api/swagger-codegen/tree/v3.0.68)
7575
[2.4.44](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.44) (**current stable**) | 2024-12-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.44](https://github.com/swagger-api/swagger-codegen/tree/v2.4.44)
7676

7777
💁 Here's also an overview of what's coming around the corner:
7878

7979
Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes
8080
-------------------------- |--------------| -------------------------- | -----
81-
3.0.68-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.68-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release
81+
3.0.69-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.69-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release
8282
2.4.45-SNAPSHOT (current master, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/swagger-codegen-cli/2.4.45-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0 | Minor release
8383

8484
For detailed breakdown of all versions, please see the [full compatibility listing](../compatibility).
@@ -113,7 +113,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
113113
java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i http://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client
114114
```
115115

116-
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.66/swagger-codegen-cli-3.0.66.jar).
116+
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.68/swagger-codegen-cli-3.0.68.jar).
117117

118118
To get a list of **general** options available, please run:
119119

src/content/docs/open-source-tools/Swagger Codegen/Codegen v3/compatibility.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ The Swagger Codegen project has the following compatibilities with the OpenAPI S
1010

1111
Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes
1212
-------------------------- |--------------| -------------------------- | -----
13-
3.0.68-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.68-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release
14-
[3.0.67](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.67) (**current stable**) | 2025-01-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.67](https://github.com/swagger-api/swagger-codegen/tree/v3.0.67)
13+
3.0.69-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.69-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release
14+
[3.0.68](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.68) (**current stable**) | 2025-03-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.68](https://github.com/swagger-api/swagger-codegen/tree/v3.0.68)
15+
[3.0.67](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.67) | 2025-01-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.67](https://github.com/swagger-api/swagger-codegen/tree/v3.0.67)
1516
[3.0.66](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.66) | 2024-12-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.66](https://github.com/swagger-api/swagger-codegen/tree/v3.0.66)
1617
[3.0.65](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.65) | 2024-12-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.65](https://github.com/swagger-api/swagger-codegen/tree/v3.0.65)
1718
[3.0.64](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.64) | 2024-11-07 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.64](https://github.com/swagger-api/swagger-codegen/tree/v3.0.64)

src/content/docs/open-source-tools/Swagger Codegen/Codegen v3/prerequisites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ sidebar:
99
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
1010

1111
```sh
12-
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.67/swagger-codegen-cli-3.0.67.jar -O swagger-codegen-cli.jar
12+
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.68/swagger-codegen-cli-3.0.68.jar -O swagger-codegen-cli.jar
1313

1414
java -jar swagger-codegen-cli.jar --help
1515
```
1616

1717
For Windows users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+). For example:
1818

1919
```powershell
20-
Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.67/swagger-codegen-cli-3.0.67.jar
20+
Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.68/swagger-codegen-cli-3.0.68.jar
2121
```
2222

2323
On a Mac, it's even easier with `brew`:

src/content/docs/open-source-tools/Swagger UI/Development/scripts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Script name | Description
1616
`lint` | Report ESLint style errors and warnings.
1717
`lint-errors` | Report ESLint style errors, without warnings.
1818
`lint-fix` | Attempt to fix style errors automatically.
19+
`lint-styles` | Report Stylelint style errors and warnings.
20+
`lint-styles-fix` | Attempt to fix Stylelint errors and warnings automatically.
1921
`watch` | Rebuild the core files in `/dist` when the source code changes. Useful for `npm link` with Swagger Editor.
2022

2123
### Building

src/content/docs/open-source-tools/Swagger UI/Development/setting-up.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,24 @@ sidebar:
66
---
77

88

9-
Swagger UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
9+
SwaggerUI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
1010

1111
### Prerequisites
1212

1313
- git, any version
14-
- **Node.js >=20.3.0** and **npm >=9.6.7** are the minimum required versions that this repo runs on, but we always recommend using the latest version of Node.js.
14+
- **Node.js >=22.11.0** and **npm >=10.9.0** are the minimum required versions that this repo runs on, but we always recommend using the latest version of Node.js.
15+
16+
1517

1618
### Steps
1719

1820
1. `git clone https://github.com/swagger-api/swagger-ui.git`
1921
2. `cd swagger-ui`
2022
3. `npm install`
21-
4. `npm run dev`
22-
5. Wait a bit
23-
6. Open http://localhost:3200/
23+
4. `npx husky init` (optional)
24+
5. `npm run dev`
25+
6. Wait a bit
26+
7. Open http://localhost:3200/
2427

2528
### Using your own local api definition with local dev build
2629

src/content/docs/open-source-tools/Swagger UI/Usage/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ Set the value to the literal object value you'd like, taking care to escape char
377377
Example:
378378

379379
```sh
380-
SPEC="{ \"openapi\": \"3.0.0\" }"
380+
SPEC="{ \"openapi\": \"3.0.4\" }"
381381
```
382382

383383
### Docker-Compose

src/content/docs/open-source-tools/Swagger UI/Usage/installation.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,23 @@ We publish three modules to npm: **`swagger-ui`**, **`swagger-ui-dist`** and **`
1616
such as Webpack, Browserify, and Rollup. Its main file exports Swagger UI's main function,
1717
and the module also includes a namespaced stylesheet at `swagger-ui/dist/swagger-ui.css`. Here's an example:
1818

19+
### Installation
20+
21+
You can now install SwaggerUI packages using `npm`:
22+
23+
```sh
24+
$ npm install swagger-ui
25+
````
26+
27+
```sh
28+
$ npm install swagger-ui-react
29+
````
30+
31+
```sh
32+
$ npm install swagger-ui-dist
33+
````
34+
35+
1936
```javascript
2037
import SwaggerUI from 'swagger-ui'
2138
// or use require if you prefer
@@ -68,7 +85,7 @@ const ui = SwaggerUIBundle({
6885
6986
### Docker
7087
71-
You can pull a pre-built docker image of the swagger-ui directly from Docker Hub:
88+
You can pull a pre-built docker image of the swagger-ui directly from **docker.swagger.io**:
7289
7390
```sh
7491
docker pull docker.swagger.io/swaggerapi/swagger-ui

0 commit comments

Comments
 (0)