Skip to content

Commit f45c3e5

Browse files
committed
Change to Description to match 3.0.4 and 3.1.1 spec changes
1 parent 0b43bbb commit f45c3e5

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.3 -p postman
4444
Options:
4545

4646
```
47-
--output -o What filename the OpenAPI documentation should output under. Default: openapi.json
48-
--format -f Whether to output the OpenAPI documentation as json or yaml. Default: json
47+
--output -o What filename the OpenAPI Description should output under. Default: openapi.json
48+
--format -f Whether to output the OpenAPI Description as json or yaml. Default: json
4949
--indent -i File indentation in spaces. Default: 2
5050
--openApiVersion -a OpenAPI version to generate for. Default: 3.0.0
51-
--postmanCollection -p Will generate a postman collection (from the generated openAPI documentation), in json only, if passed in. Default postman.json
51+
--postmanCollection -p Will generate a postman collection (from the generated OpenAPI Description), in json only, if passed in. Default postman.json
5252
--validationWarn -w Warn about validation errors only. Will write the OpenAPI file if generation is successful. Default: false
5353
```
5454

@@ -133,7 +133,7 @@ Options:
133133

134134
### Configuration
135135

136-
To configure this plugin to generate valid OpenAPI documentation there are two places you'll need to modify in your `serverless.yml` file, the `custom` variables section and the `http/httpApi` event section for each given function in your service.
136+
To configure this plugin to generate a valid OpenAPI Description, there are two places you'll need to modify in your `serverless.yml` file, the `custom` variables section and the `http/httpApi` event section for each given function in your service.
137137

138138
The `custom` section of your `serverless.yml` can be configured as below:
139139

@@ -975,7 +975,7 @@ We use the plugin [JSON Schema $Ref Parser](https://apitools.dev/json-schema-ref
975975
}
976976
```
977977

978-
Where the definition "link" refers to a schema held in a directory that the resolver does not know about, we will not be able to fully resolve the schema which will likely cause errors in validation of the openAPI 3.0.X specification.
978+
Where the definition "link" refers to a schema held in a directory that the resolver does not know about, we will not be able to fully resolve the schema which will likely cause errors in validation of the OpenAPI 3.0.X Description.
979979

980980
Because of the dependency we use to parse externally linked schemas, we can supply our own options to resolve schemas that are more difficult than a straight forward example.
981981

0 commit comments

Comments
 (0)