Skip to content

Fix issues in mixin examples #2518

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

Merged
kstich merged 1 commit into from
Feb 14, 2025
Merged

Fix issues in mixin examples #2518

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
44 changes: 32 additions & 12 deletions docs/source-2.0/spec/mixins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,22 +492,32 @@ example, in the following model:

.. code-block:: smithy

operation OperationA {}
operation OperationA {
input: OperationAInput
output: OperationAOutput
}

structure OperationAInput {}
structure OperationAOutput {}

@mixin
service A {
version: "A"
operations: [OperationA]
}

operation OperationB {}
operation OperationB {
input: OperationBInput
}

structure OperationBInput {}

@mixin
service B with [A] {
version: "B"
rename: {
"smithy.example#OperationA": "OperA"
"smithy.example#OperationB": "OperB"
"smithy.example#OperationAInput": "OperationARequest"
"smithy.example#OperationAOutput": "OperationAResult"
}
operations: [OperationB]
}
Expand All @@ -517,8 +527,8 @@ example, in the following model:
service C with [B] {
version: "C"
rename: {
"smithy.example#OperationA": "OpA"
"smithy.example#OperationC": "OpC"
"smithy.example#OperationAOutput": "OperationAResponse"
"smithy.example#OperationBInput": "OperationBRequest"
}
operations: [OperationC]
}
Expand All @@ -527,18 +537,28 @@ The flattened equivalent of ``C`` with no mixins is:

.. code-block:: smithy

operation OperationA {}
operation OperationA {
input: OperationAInput
output: OperationAOutput
}

structure OperationAInput {}
structure OperationAOutput {}

operation OperationB {
input: OperationBInput
}

operation OperationB {}
structure OperationBInput {}

operation OperationC {}

service C {
version: "C"
rename: {
"smithy.example#OperationA": "OpA"
"smithy.example#OperationB": "OperB"
"smithy.example#OperationC": "OpC"
"smithy.example#OperationAInput": "OperationARequest"
"smithy.example#OperationAOutput": "OperationAResponse"
"smithy.example#OperationBInput": "OperationBRequest"
}
operations: [OperationA, OperationB, OperationC]
}
Expand Down Expand Up @@ -588,7 +608,7 @@ Operation shapes with the :ref:`mixin-trait` MAY define errors.
output := {
name: String
}
error: [NotFoundError]
errors: [NotFoundError]
}

@error("client")
Expand Down
Loading