Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix smithy-build.json version numbers #1918

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Fix smithy-build.json version numbers #1918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 59 additions & 29 deletions docs/source-2.0/guides/converting-to-openapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ that builds an OpenAPI specification from a service for the
:name: open-api-smithy-build-json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down Expand Up @@ -181,9 +181,10 @@ service (``string``)
For example, ``example.weather#Weather``.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather"
Expand Down Expand Up @@ -211,9 +212,10 @@ protocol (``string``)
service provider found on the classpath.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -235,6 +237,7 @@ version (``string``)
``3.1.0`` will use JSON schema version ``draft2020-12`` for model schemas.

.. code-block:: json
:caption: smithy-build.json

{
"version": "1.0",
Expand All @@ -254,9 +257,10 @@ tags (``boolean``)
model to the OpenAPI model.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -273,9 +277,10 @@ supportedTags (``[string]``)
``true`` in order to have an effect.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -293,9 +298,10 @@ defaultBlobFormat (``string``)
See `OpenAPI Data types`_ for more information.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -314,9 +320,10 @@ externalDocs (``[string]``)
"Reference", and "Guide".

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -335,9 +342,10 @@ keepUnusedComponents (``boolean``)
removed from the created specification.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -353,9 +361,10 @@ jsonContentType (``string``)
JSON-based protocols.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -372,9 +381,10 @@ forbidGreedyLabels (``boolean``)
"/{foo+}".

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -392,9 +402,10 @@ removeGreedyParameterSuffix (``boolean``)
If enabled, the parameter name will instead be "foo".

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -416,9 +427,10 @@ onHttpPrefixHeaders (``string``)
* WARN: The header is omitted from the OpenAPI model and a warning is logged.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -434,9 +446,10 @@ ignoreUnsupportedTraits (``boolean``)
``endpoint`` and ``hostLabel`` are encountered.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down Expand Up @@ -468,9 +481,10 @@ substitutions (``Map<String, any>``)
change.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -497,9 +511,10 @@ jsonAdd (``Map<String, Node>``)
result as needed.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -525,9 +540,10 @@ useIntegerType (``boolean``)
"number".

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -545,9 +561,10 @@ disableIntegerFormat (``boolean``)
configuration setting.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down Expand Up @@ -614,6 +631,7 @@ onErrorStatusConflict (``String``)
By default, this setting is set to ``oneOf``.

.. code-block:: json
:caption: smithy-build.json

{
"version": "1.0",
Expand Down Expand Up @@ -651,9 +669,10 @@ useJsonName (``boolean``)
automatically set to ``true`` depending on the protocol being converted.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -671,9 +690,10 @@ defaultTimestampFormat (``string``)
"epoch-seconds", or "http-date".

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -696,9 +716,10 @@ unionStrategy (``string``)
structure.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -723,9 +744,10 @@ mapStrategy (``string``)
is applied.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -741,9 +763,10 @@ schemaDocumentExtensions (``Map<String, any>``)
Any existing value is overwritten.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -764,9 +787,10 @@ disableFeatures (``[string]``)
generated OpenAPI model.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -787,9 +811,10 @@ supportNonNumericFloats (``boolean``)
By default, these non-numeric values are not supported.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down Expand Up @@ -838,9 +863,10 @@ disableDefaultValues (``boolean``)
Set to true to disable adding default values.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down Expand Up @@ -921,9 +947,10 @@ disableIntEnums (``boolean``)
Set to true to disable setting the ``enum`` property for intEnum shapes.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down Expand Up @@ -1164,9 +1191,10 @@ apiGatewayType (``string``)
is inadvertently placed on the classpath by a dependency.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -1180,9 +1208,10 @@ disableCloudFormationSubstitution (``boolean``)
into CloudFormation intrinsic functions.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand All @@ -1201,9 +1230,10 @@ additionalAllowedCorsHeaders (``[string]``)
headers will be omitted.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"openapi": {
"service": "example.weather#Weather",
Expand Down
3 changes: 2 additions & 1 deletion docs/source-2.0/guides/generating-cloudformation-resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,9 +492,10 @@ useIntegerType (``boolean``)
By default, these shape types are converted with a type of ``number``.

.. code-block:: json
:caption: smithy-build.json

{
"version": "2.0",
"version": "1.0",
"plugins": {
"cloudformation": {
"service": "smithy.example#Queues",
Expand Down