Skip to content

Commit

Permalink
2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@anttiviljami
anttiviljami committed Dec 13, 2023
1 parent b4378e3 commit 2b82985
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 30 deletions.
41 changes: 15 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand All @@ -89,7 +88,7 @@ EXAMPLES
$ openapi auth --security BasicAuth --username admin --password password
```

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

## `openapi call [DEFINITION]`

Expand All @@ -111,7 +110,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand Down Expand Up @@ -139,7 +137,7 @@ EXAMPLES
$ openapi call -o createPet -d '{ "name": "Garfield" }'
```

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

## `openapi help [COMMANDS]`

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

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

## `openapi init`

Expand All @@ -210,7 +208,6 @@ USAGE
FLAGS
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-S, --server=http://localhost:9000... override servers definition
-T, --title=<value> [default: My API] The title for the API
-d, --description=<value> Description for the API
Expand All @@ -231,7 +228,7 @@ EXAMPLES
$ openapi init --title 'My API' > openapi.yml
```

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

## `openapi load DEFINITION`

Expand All @@ -258,7 +255,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.0.2/src/commands/load.ts)_
_See code: [src/commands/load.ts](https://github.com/openapistack/openapicmd/blob/v2.1.0/src/commands/load.ts)_

## `openapi mock [DEFINITION]`

Expand All @@ -277,7 +274,6 @@ FLAGS
descriptions from definition
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-U, --swagger-ui=docs Swagger UI endpoint
Expand All @@ -295,7 +291,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.0.2/src/commands/mock.ts)_
_See code: [src/commands/mock.ts](https://github.com/openapistack/openapicmd/blob/v2.1.0/src/commands/mock.ts)_

## `openapi read [DEFINITION]`

Expand All @@ -316,7 +312,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand All @@ -335,7 +330,7 @@ EXAMPLES
$ openapi read ./openapi.yml -f json > openapi.json
```

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

## `openapi redoc [DEFINITION]`

Expand All @@ -355,7 +350,6 @@ FLAGS
descriptions from definition
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-h, --help Show CLI help.
Expand All @@ -373,7 +367,7 @@ EXAMPLES
$ openapi redoc ./openapi.yml --bundle outDir
```

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

## `openapi swagger-editor [DEFINITION]`

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

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

## `openapi swagger-ui [DEFINITION]`

Expand All @@ -422,7 +416,6 @@ FLAGS
descriptions from definition
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-h, --help Show CLI help.
Expand Down Expand Up @@ -450,7 +443,7 @@ EXAMPLES
$ openapi swagger-ui ./openapi.yml --bundle outDir
```

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

## `openapi swagger2openapi [DEFINITION]`

Expand All @@ -471,7 +464,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand All @@ -488,7 +480,7 @@ EXAMPLES
$ openapi swagger2openapi --yaml ./swagger.json > openapi.yml
```

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

## `openapi test`

Expand All @@ -506,7 +498,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand All @@ -529,7 +520,7 @@ EXAMPLES
$ openapi test -o getPets
```

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

## `openapi test add [DEFINITION]`

Expand All @@ -551,7 +542,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand Down Expand Up @@ -579,7 +569,7 @@ EXAMPLES
$ openapi test add -o getPet --checks all
```

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

## `openapi typegen [DEFINITION]`

Expand All @@ -600,7 +590,6 @@ FLAGS
-D, --dereference resolve $ref pointers
-H, --header=<value>... add request headers when calling remote urls
-I, --inject={"info":{"version":"1.0.0"}}... inject JSON to definition with deep merge
-E, --exclude-ext=x-internal Specify an openapi extension to exclude parts of the spec
-R, --root=/ override API root path
-S, --server=http://localhost:9000... override servers definition
-V, --validate validate against openapi schema
Expand All @@ -613,7 +602,7 @@ EXAMPLES
$ openapi typegen ./openapi.yml > openapi.d.ts
```

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

## `openapi unload`

Expand All @@ -633,7 +622,7 @@ EXAMPLES
$ openapi unload
```

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

## Sponsors
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file

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

4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "openapicmd",
"description": "OpenAPI Command Line Tool",
"version": "2.0.2",
"version": "2.1.0",
"author": "Viljami Kuosmanen <[email protected]>",
"bin": {
"openapi": "./bin/run.js"
Expand Down Expand Up @@ -113,4 +113,4 @@
"version": "oclif readme && git add README.md"
},
"types": "lib/index.d.ts"
}
}

0 comments on commit 2b82985

Please sign in to comment.