Skip to content

Commit

Permalink
Updates usage & readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Aleksander Lorenc committed Jan 19, 2020
1 parent b9c026d commit 8e639ed
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ pip install aws-openapi-lint
`$ aws-openapi-lint path/to/spec.yml`

```
usage: aws-openapi-lint / main.py [-h] [--treat-errors-as-warnings]
[--warning-threshold WARNING_THRESHOLD]
lint_file
usage: aws-openapi-lint [-h] [--treat-errors-as-warnings]
[--warning-threshold WARNING_THRESHOLD]
lint_file
Process some integers.
Lint OpenAPI specifications based on AWS API Gateway.
positional arguments:
lint_file Specify path to the openapi schema file.
Expand Down
2 changes: 1 addition & 1 deletion aws_openapi_lint/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def print_no_violations():


def parse_arguments():
parser = argparse.ArgumentParser(description='Process some integers.')
parser = argparse.ArgumentParser(description='Lint OpenAPI specifications based on AWS API Gateway.')
parser.add_argument('lint_file', help='Specify path to the openapi schema file.')
parser.add_argument('--treat-errors-as-warnings', action='store_const', const=True, default=False,
help='Treats errors as warnings (exit code will be 0 unless warning threshold is specified')
Expand Down

0 comments on commit 8e639ed

Please sign in to comment.