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

Add set to list doc section #1346

Merged
merged 3 commits into from
Aug 12, 2022
Merged

Add set to list doc section #1346

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea7c017
Add set to list doc section
srchase Aug 11, 2022
871d7dc
Fix syntax highlighting
srchase Aug 11, 2022
9cac283
Update docs/source-2.0/guides/migrating-idl-1-to-2.rst
srchase Aug 12, 2022
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
34 changes: 33 additions & 1 deletion docs/source-2.0/guides/migrating-idl-1-to-2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,38 @@ Needs to be updated to:
}


Convert set shapes to list shapes
=================================

The set shape was deprecated for IDL 2.0. Each set shape must be replaced by a
list shape with the :ref:`uniqueItems-trait`.

For example, the following set:

.. code-block:: smithy

$version "1.0"

namespace smithy.example

set StringSet {
member: String
}

Needs to be updated to:

.. code-block:: smithy

$version "2"

namespace smithy.example

@uniqueItems
list StringSet {
member: String
}


Add the default trait to streaming blobs
========================================

Expand Down Expand Up @@ -209,7 +241,7 @@ needed to model an operation. For example, the following model:

can be updated to:

.. code-block::
.. code-block:: smithy

$version: "2"

Expand Down