@@ -1606,128 +1606,145 @@ dependency on ``software.amazon.smithy:smithy-aws-apigateway-openapi``.
16061606 Amazon API Gateway configuration settings
16071607=========================================
16081608
1609+ .. _generate-openapi-apigateway-setting-apiGatewayDefault :
1610+
16091611apiGatewayDefaults (``string ``)
1610- Sets recommended default configuration settings and allows for those defaults
1611- to be disabled.
1612+ -------------------------------
16121613
1613- This setting can be set to one of the following:
1614+ Sets recommended default configuration settings and allows for those defaults
1615+ to be disabled.
16141616
1615- * ``2023-08-11 `` Set the defaults described below.
1616- * ``DISABLED `` Disables setting defaults.
1617+ This setting can be set to one of the following:
16171618
1618- The ``2023-08-11 `` version sets the following configuration settings:
1619+ * ``2023-08-11 `` Set the defaults described below.
1620+ * ``DISABLED `` Disables setting defaults.
16191621
1620- * :ref: `alphanumericOnlyRefs <generate-openapi-jsonschema-setting-alphanumericOnlyRefs >`: ``true ``
1621- * :ref: `disableDefaultValues <generate-openapi-setting-disableDefaultValues >`: ``true ``
1622- * :ref: `disableIntegerFormat <generate-openapi-setting-disableIntegerFormat >`: ``true ``
1623- * :ref: `disableFeatures <generate-openapi-jsonschema-setting-disableFeatures >`: ``["default"] ``
1622+ The ``2023-08-11 `` version sets the following configuration settings:
16241623
1625- .. important ::
1624+ * :ref: `alphanumericOnlyRefs <generate-openapi-jsonschema-setting-alphanumericOnlyRefs >`: ``true ``
1625+ * :ref: `disableDefaultValues <generate-openapi-setting-disableDefaultValues >`: ``true ``
1626+ * :ref: `disableIntegerFormat <generate-openapi-setting-disableIntegerFormat >`: ``true ``
1627+ * :ref: `disableFeatures <generate-openapi-jsonschema-setting-disableFeatures >`: ``["default"] ``
16261628
1627- This setting should be set explicitly to one of the allowed values.
1628- If omitted, it will default to ``2023-08-11 ``.
1629+ .. important ::
16291630
1630- .. code-block :: json
1631- :caption: smithy-build.json
1631+ This setting should be set explicitly to one of the allowed values.
1632+ If omitted, it will default to `` 2023-08-11 ``.
16321633
1633- {
1634- "version" : " 1.0" ,
1635- "plugins" : {
1636- "openapi" : {
1637- "service" : " example.weather#Weather" ,
1638- "apiGatewayDefaults" : " 2023-08-11"
1639- }
1634+ .. code-block :: json
1635+ :caption: smithy-build.json
1636+
1637+ {
1638+ "version" : " 1.0" ,
1639+ "plugins" : {
1640+ "openapi" : {
1641+ "service" : " example.weather#Weather" ,
1642+ "apiGatewayDefaults" : " 2023-08-11"
16401643 }
16411644 }
1645+ }
1646+
1647+ .. _generate-openapi-apigateway-setting-apiGatewayType :
16421648
16431649apiGatewayType (``string ``)
1644- Defines the type of API Gateway to define in the generated OpenAPI model.
1645- This setting influences which API Gateway specific plugins apply
1646- to the generated OpenAPI model.
1650+ ---------------------------
16471651
1648- This setting can be set to one of the following:
1652+ Defines the type of API Gateway to define in the generated OpenAPI model.
1653+ This setting influences which API Gateway specific plugins apply
1654+ to the generated OpenAPI model.
16491655
1650- * ``REST ``: Generates a `REST API `_. This is the default setting if not
1651- configured.
1652- * ``HTTP ``: Generates an `HTTP API `_.
1653- * ``DISABLED ``: Disables all API Gateway modifications made to the
1654- OpenAPI model. This is useful if ``software.amazon.smithy:smithy-aws-apigateway-openapi ``
1655- is inadvertently placed on the classpath by a dependency.
1656+ This setting can be set to one of the following:
16561657
1657- .. code-block :: json
1658- :caption: smithy-build.json
1658+ * ``REST ``: Generates a `REST API `_. This is the default setting if not
1659+ configured.
1660+ * ``HTTP ``: Generates an `HTTP API `_.
1661+ * ``DISABLED ``: Disables all API Gateway modifications made to the
1662+ OpenAPI model. This is useful if ``software.amazon.smithy:smithy-aws-apigateway-openapi ``
1663+ is inadvertently placed on the classpath by a dependency.
16591664
1660- {
1661- "version" : " 1.0" ,
1662- "plugins" : {
1663- "openapi" : {
1664- "service" : " example.weather#Weather" ,
1665- "apiGatewayType" : " REST"
1666- }
1665+ .. code-block :: json
1666+ :caption: smithy-build.json
1667+
1668+ {
1669+ "version" : " 1.0" ,
1670+ "plugins" : {
1671+ "openapi" : {
1672+ "service" : " example.weather#Weather" ,
1673+ "apiGatewayType" : " REST"
16671674 }
16681675 }
1676+ }
1677+
1678+ .. _generate-openapi-apigateway-setting-disableCloudFormationSubstitution :
16691679
16701680disableCloudFormationSubstitution (``boolean ``)
1671- Disables automatically converting ``${} `` templates in specific properties
1672- into CloudFormation intrinsic functions.
1681+ -----------------------------------------------
16731682
1674- .. code-block :: json
1675- :caption: smithy-build.json
1683+ Disables automatically converting `` ${} `` templates in specific properties
1684+ into CloudFormation intrinsic functions.
16761685
1677- {
1678- "version" : " 1.0" ,
1679- "plugins" : {
1680- "openapi" : {
1681- "service" : " example.weather#Weather" ,
1682- "disableCloudFormationSubstitution" : true
1683- }
1686+ .. code-block :: json
1687+ :caption: smithy-build.json
1688+
1689+ {
1690+ "version" : " 1.0" ,
1691+ "plugins" : {
1692+ "openapi" : {
1693+ "service" : " example.weather#Weather" ,
1694+ "disableCloudFormationSubstitution" : true
16841695 }
16851696 }
1697+ }
16861698
1687- .. seealso :: :ref:`openapi-cfn-substitutions`
1699+ .. seealso :: :ref:`openapi-cfn-substitutions`
16881700
1701+ .. _generate-openapi-apigateway-setting-additionalAllowedCorsHeaders :
16891702
16901703additionalAllowedCorsHeaders (``[string] ``)
1691- Sets additional allowed CORS headers on the preflight requests. If this
1692- option is not set, the default ``amz-sdk-invocation-id `` and ``amz-sdk-request ``
1693- headers will be added. By setting this option to an empty array, those default
1694- headers will be omitted.
1704+ -------------------------------------------
16951705
1696- .. code-block :: json
1697- :caption: smithy-build.json
1706+ Sets additional allowed CORS headers on the preflight requests. If this
1707+ option is not set, the default ``amz-sdk-invocation-id `` and ``amz-sdk-request ``
1708+ headers will be added. By setting this option to an empty array, those default
1709+ headers will be omitted.
16981710
1699- {
1700- "version" : " 1.0" ,
1701- "plugins" : {
1702- "openapi" : {
1703- "service" : " example.weather#Weather" ,
1704- "additionalAllowedCorsHeaders" : [" foo-header" , " bar-header" ]
1705- }
1711+ .. code-block :: json
1712+ :caption: smithy-build.json
1713+
1714+ {
1715+ "version" : " 1.0" ,
1716+ "plugins" : {
1717+ "openapi" : {
1718+ "service" : " example.weather#Weather" ,
1719+ "additionalAllowedCorsHeaders" : [" foo-header" , " bar-header" ]
17061720 }
17071721 }
1722+ }
17081723
17091724
17101725 .. _generate-openapi-apigateway-setting-syncCorsPreflightIntegration :
17111726
17121727syncCorsPreflightIntegration (``boolean ``)
1713- Set to true to sync CORS preflight integration request templates with all possible content-types
1714- from other methods within the same path resource.
1728+ ------------------------------------------
17151729
1716- .. code-block :: json
1717- :caption: smithy-build.json
1730+ Set to true to sync CORS preflight integration request templates with all possible content-types
1731+ from other methods within the same path resource.
17181732
1719- {
1720- "version" : " 1.0" ,
1721- "plugins" : {
1722- "openapi" : {
1723- "service" : " example.weather#Weather" ,
1724- "syncCorsPreflightIntegration" : true
1725- }
1733+ .. code-block :: json
1734+ :caption: smithy-build.json
1735+
1736+ {
1737+ "version" : " 1.0" ,
1738+ "plugins" : {
1739+ "openapi" : {
1740+ "service" : " example.weather#Weather" ,
1741+ "syncCorsPreflightIntegration" : true
17261742 }
17271743 }
1744+ }
17281745
1729- With this enabled, the `integration's passthroughBehavior `_ for CORS preflight integration
1730- will be set to ``never ``.
1746+ With this enabled, the `integration's passthroughBehavior `_ for CORS preflight integration
1747+ will be set to ``never ``.
17311748
17321749Binary types
17331750============
0 commit comments