Skip to content

Commit 5bd587c

Browse files
keetonianpraneetap
authored andcommitted
docs: document the OpenApiVersion property (#1189)
1 parent 4fa5d6a commit 5bd587c

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

versions/2016-10-31.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,7 @@ AccessLogSetting | [CloudFormation AccessLogSetting property](https://docs.aws.a
233233
CanarySetting | [CloudFormation CanarySetting property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) | Configure a Canary Setting to a Stage of a regular deployment. This value is passed through to Cloudformation, so any value supported by `CanarySetting` is supported here.
234234
TracingEnabled | `boolean` | Indicates whether active tracing with X-Ray is enabled for the stage.
235235
Models | `List of JSON or YAML objects` | JSON schemas that describes the models to be used by API methods.
236+
OpenApiVersion | `string` | Version of OpenApi to use. This can either be `'2.0'` for the swagger spec or one of the OpenApi 3.0 versions, like `'3.0.1'`. Setting this property to any valid value will also remove the stage `Stage` that SAM creates.
236237

237238
##### Return values
238239

0 commit comments

Comments
 (0)