You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,11 +44,11 @@ To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.3 -p postman
44
44
Options:
45
45
46
46
```
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
49
49
--indent -i File indentation in spaces. Default: 2
50
50
--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
52
52
--validationWarn -w Warn about validation errors only. Will write the OpenAPI file if generation is successful. Default: false
53
53
```
54
54
@@ -133,7 +133,7 @@ Options:
133
133
134
134
### Configuration
135
135
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.
137
137
138
138
The `custom` section of your `serverless.yml` can be configured as below:
139
139
@@ -975,7 +975,7 @@ We use the plugin [JSON Schema $Ref Parser](https://apitools.dev/json-schema-ref
975
975
}
976
976
```
977
977
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.
979
979
980
980
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.
0 commit comments