Skip to content

Commit

Permalink
v2.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
anttiviljami committed Sep 10, 2024
1 parent bb60640 commit 046b9ff
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 19 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ EXAMPLES
$ openapi auth --security BasicAuth --username admin --password password
```

_See code: [src/commands/auth.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/auth.ts)_
_See code: [src/commands/auth.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/auth.ts)_

## `openapi call [DEFINITION]`

Expand Down Expand Up @@ -149,7 +149,7 @@ EXAMPLES
$ openapi call -o createPet -d '{ "name": "Garfield" }'
```

_See code: [src/commands/call.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/call.ts)_
_See code: [src/commands/call.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/call.ts)_

## `openapi help [COMMAND]`

Expand Down Expand Up @@ -213,7 +213,7 @@ EXAMPLES
$ openapi info ./openapi.yml
```

_See code: [src/commands/info.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/info.ts)_
_See code: [src/commands/info.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/info.ts)_

## `openapi init`

Expand Down Expand Up @@ -246,7 +246,7 @@ EXAMPLES
$ openapi init --title 'My API' > openapi.yml
```

_See code: [src/commands/init.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/init.ts)_
_See code: [src/commands/init.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/init.ts)_

## `openapi load DEFINITION`

Expand All @@ -273,7 +273,7 @@ EXAMPLES
$ openapi load https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
```

_See code: [src/commands/load.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/load.ts)_
_See code: [src/commands/load.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/load.ts)_

## `openapi mock [DEFINITION]`

Expand Down Expand Up @@ -312,7 +312,7 @@ EXAMPLES
$ openapi mock https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
```

_See code: [src/commands/mock.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/mock.ts)_
_See code: [src/commands/mock.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/mock.ts)_

## `openapi read [DEFINITION]`

Expand Down Expand Up @@ -357,7 +357,7 @@ EXAMPLES
$ openapi read ./openapi.yml -f json > openapi.json
```

_See code: [src/commands/read.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/read.ts)_
_See code: [src/commands/read.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/read.ts)_

## `openapi redoc [DEFINITION]`

Expand Down Expand Up @@ -397,7 +397,7 @@ EXAMPLES
$ openapi redoc ./openapi.yml --bundle outDir
```

_See code: [src/commands/redoc.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/redoc.ts)_
_See code: [src/commands/redoc.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/redoc.ts)_

## `openapi swagger-editor [DEFINITION]`

Expand Down Expand Up @@ -425,7 +425,7 @@ EXAMPLES
$ openapi swagger-editor ./openapi.yml
```

_See code: [src/commands/swagger-editor.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/swagger-editor.ts)_
_See code: [src/commands/swagger-editor.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/swagger-editor.ts)_

## `openapi swagger-ui [DEFINITION]`

Expand Down Expand Up @@ -476,7 +476,7 @@ EXAMPLES
$ openapi swagger-ui ./openapi.yml --bundle outDir
```

_See code: [src/commands/swagger-ui.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/swagger-ui.ts)_
_See code: [src/commands/swagger-ui.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/swagger-ui.ts)_

## `openapi swagger2openapi [DEFINITION]`

Expand Down Expand Up @@ -519,7 +519,7 @@ EXAMPLES
$ openapi swagger2openapi --yaml ./swagger.json > openapi.yml
```

_See code: [src/commands/swagger2openapi.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/swagger2openapi.ts)_
_See code: [src/commands/swagger2openapi.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/swagger2openapi.ts)_

## `openapi test`

Expand Down Expand Up @@ -565,7 +565,7 @@ EXAMPLES
$ openapi test -o getPets
```

_See code: [src/commands/test/index.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/test/index.ts)_
_See code: [src/commands/test/index.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/test/index.ts)_

## `openapi test add [DEFINITION]`

Expand Down Expand Up @@ -620,7 +620,7 @@ EXAMPLES
$ openapi test add -o getPet --checks all
```

_See code: [src/commands/test/add.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/test/add.ts)_
_See code: [src/commands/test/add.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/test/add.ts)_

## `openapi typegen [DEFINITION]`

Expand All @@ -630,7 +630,7 @@ Generate types from openapi definition
USAGE
$ openapi typegen [DEFINITION] [-h] [-D] [-B] [-R /] [-H <value>...] [-V] [-S http://localhost:9000...] [-I
{"info":{"version":"1.0.0"}}...] [-E x-internal] [-C default|all|openapi_client_axios|openapi_backend] [-U] [-b
<value>] [-A]
<value>] [--client] [--backend] [-A]
ARGUMENTS
DEFINITION input definition file
Expand All @@ -655,6 +655,8 @@ FLAGS
-b, --banner=<value> include a banner comment at the top of the generated
file
-h, --help Show CLI help.
--backend Generate types for openapi-backend
--client Generate types for openapi-client-axios (default)
DESCRIPTION
Generate types from openapi definition
Expand All @@ -663,7 +665,7 @@ EXAMPLES
$ openapi typegen ./openapi.yml > openapi.d.ts
```

_See code: [src/commands/typegen.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/typegen.ts)_
_See code: [src/commands/typegen.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/typegen.ts)_

## `openapi unload`

Expand All @@ -683,7 +685,7 @@ EXAMPLES
$ openapi unload
```

_See code: [src/commands/unload.ts](https://github.com/openapistack/openapicmd/blob/v2.5.2/src/commands/unload.ts)_
_See code: [src/commands/unload.ts](https://github.com/openapistack/openapicmd/blob/v2.6.0/src/commands/unload.ts)_
<!-- commandsstop -->

## Commercial support
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "openapicmd",
"description": "OpenAPI Command Line Tool",
"version": "2.6.0-beta.3",
"version": "2.6.0",
"author": "Viljami Kuosmanen <[email protected]>",
"bin": {
"openapi": "./bin/run.js"
Expand Down

0 comments on commit 046b9ff

Please sign in to comment.