Skip to content

Commit

Permalink
Corrected some typo's
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim committed Apr 5, 2021
1 parent 0dcaed4 commit 70898b6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "asyncapi-format",
"version": "1.0.1",
"description": "Format a AsyncAPI document by ordering and filtering fields.",
"version": "1.0.2",
"description": "Format an AsyncAPI document by ordering and filtering fields.",
"keywords": [
"asyncapi",
"format",
Expand Down
10 changes: 5 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Format an AsyncAPI document by ordering and filtering fields.

The asyncapi-format CLI can load an OpenAPI file, sorts the AsyncAPI fields by ordering them in a hierarchical order,
The asyncapi-format CLI can load an AsyncAPI file, sorts the AsyncAPI fields by ordering them in a hierarchical order,
and can output the file with clean indenting, to either JSON or YAML.

Next to the ordering, the CLI provides additional options to filter fields & parts of the AsyncAPI document based on
Expand Down Expand Up @@ -230,7 +230,7 @@ components:
payload:
$ref: "#/components/schemas/lightMeasuredPayload"
tags:
- metadata
- measure
```

Expand Down Expand Up @@ -281,10 +281,10 @@ channels:
$ asyncapi-format asyncapi.json -o asyncapi-formatted.json
```

-Format a AsyncAPI document with the default sorting and saves it as a new YAML file
- Format a AsyncAPI document with the default sorting and saves it as a new YAML file

```shell
$ asyncapi-format asyncapi.yaml -o asyncapi.yaml
$ asyncapi-format asyncapi.yaml -o asyncapi-formatted.yaml
```

- Format a AsyncAPI document with the default sorting and output it as JSON to STDOUT
Expand Down Expand Up @@ -318,7 +318,7 @@ rename action.

## CLI filter usage

- Format a AsyncAPI document by filtering fields, default sorting and saves it as a new file
- Format an AsyncAPI document by filtering fields, default sorting and saves it as a new file

When you want to strip certain flags, tags, operations, operationID's, you can pass a `filterFile` which contains the
specific values for the flags, tags, operations, operationID's.
Expand Down

0 comments on commit 70898b6

Please sign in to comment.