Skip to content

Commit

Permalink
Release v1.4.0 (#1224)
Browse files Browse the repository at this point in the history
  • Loading branch information
lfportal authored Jan 22, 2021
1 parent a32bb61 commit b34605f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 10 deletions.
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ console.log(openApi);

## `spot checksum SPOT_CONTRACT`

Generate a checksum for a Spot contract

```
USAGE
$ spot checksum SPOT_CONTRACT
Expand All @@ -167,10 +169,12 @@ EXAMPLE
$ spot checksum api.ts
```

_See code: [build/cli/src/commands/checksum.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/checksum.js)_
_See code: [build/cli/src/commands/checksum.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/checksum.js)_

## `spot docs SPOT_CONTRACT`

Preview Spot contract as OpenAPI3 documentation. The documentation server will start on http://localhost:8080.

```
USAGE
$ spot docs SPOT_CONTRACT
Expand All @@ -186,10 +190,12 @@ EXAMPLE
$ spot docs api.ts
```

_See code: [build/cli/src/commands/docs.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/docs.js)_
_See code: [build/cli/src/commands/docs.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/docs.js)_

## `spot generate`

Runs a generator on an API. Used to produce client libraries, server boilerplates and well-known API contract formats such as OpenAPI.

```
USAGE
$ spot generate
Expand All @@ -205,10 +211,12 @@ EXAMPLE
$ spot generate --contract api.ts --language yaml --generator openapi3 --out output/
```

_See code: [build/cli/src/commands/generate.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/generate.js)_
_See code: [build/cli/src/commands/generate.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/generate.js)_

## `spot help [COMMAND]`

display help for spot

```
USAGE
$ spot help [COMMAND]
Expand All @@ -220,10 +228,12 @@ OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_

## `spot init`

Generates the boilerplate for an API.

```
USAGE
$ spot init
Expand All @@ -239,10 +249,12 @@ EXAMPLE
- package.json
```

_See code: [build/cli/src/commands/init.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/init.js)_
_See code: [build/cli/src/commands/init.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/init.js)_

## `spot lint SPOT_CONTRACT`

Lint a Spot contract

```
USAGE
$ spot lint SPOT_CONTRACT
Expand All @@ -257,10 +269,12 @@ EXAMPLE
$ spot lint api.ts
```

_See code: [build/cli/src/commands/lint.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/lint.js)_
_See code: [build/cli/src/commands/lint.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/lint.js)_

## `spot mock SPOT_CONTRACT`

Run a mock server based on a Spot contract

```
USAGE
$ spot mock SPOT_CONTRACT
Expand All @@ -280,10 +294,12 @@ EXAMPLE
$ spot mock api.ts
```

_See code: [build/cli/src/commands/mock.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/mock.js)_
_See code: [build/cli/src/commands/mock.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/mock.js)_

## `spot validate SPOT_CONTRACT`

Validate a Spot contract

```
USAGE
$ spot validate SPOT_CONTRACT
Expand All @@ -298,10 +314,12 @@ EXAMPLE
$ spot validate api.ts
```

_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/validate.js)_
_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/validate.js)_

## `spot validation-server SPOT_CONTRACT`

Start the spot contract validation server

```
USAGE
$ spot validation-server SPOT_CONTRACT
Expand All @@ -317,5 +335,5 @@ EXAMPLE
$ spot validation-server api.ts
```

_See code: [build/cli/src/commands/validation-server.js](https://github.com/airtasker/spot/blob/v1.3.0/build/cli/src/commands/validation-server.js)_
_See code: [build/cli/src/commands/validation-server.js](https://github.com/airtasker/spot/blob/v1.4.0/build/cli/src/commands/validation-server.js)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@airtasker/spot",
"version": "1.3.0",
"version": "1.4.0",
"author": "Francois Wouts, Leslie Fung",
"bin": {
"spot": "./bin/run"
Expand Down

0 comments on commit b34605f

Please sign in to comment.