Skip to content

Commit

Permalink
start on README, disable test on other languages for now
Browse files Browse the repository at this point in the history
  • Loading branch information
robin-aws committed Oct 25, 2024
1 parent b12249b commit 47250ff
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 0 deletions.
20 changes: 20 additions & 0 deletions TestModels/SQSExtended/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# SQSExtended

This project serves as an example of a common pattern:
using `smithy-dafny` to build a thick client library for a remote service,
such as an AWS service.
The single source implementation is in Dafny,
but `smithy-dafny` transforms this into a full library with an idiomatic API
in multiple other common programming languages,
such as Java, Rust and Python.
This transformation is known as "polymorphing".

The language-agnostic API of the library is
[defined in Smithy here](Model/sqsextended.smithy).
This looks very similar to a remote service definition,
with a few extra traits used to specify that this is a "local service".


# Building your own Polymorph library

We hope to provide a `smithy init` template for this soon.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ class DotnetTestModels extends TestModelTest {
DISABLED_TESTS.add("SimpleTypes/SimpleByte");
DISABLED_TESTS.add("SimpleTypes/SimpleFloat");
DISABLED_TESTS.add("SimpleTypes/SimpleShort");
DISABLED_TESTS.add("SQSExtended");
// V2 Models are not yet supported in Net.
DISABLED_TESTS.add("aws-sdks/ddbv2");
DISABLED_TESTS.add("aws-sdks/kmsv2");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ class PythonTestModels extends TestModelTest {
DISABLED_TESTS.add("SimpleTypes/SimpleFloat");
DISABLED_TESTS.add("SimpleTypes/SimpleShort");
DISABLED_TESTS.add("SimpleTypes/SimpleTimestamp");
DISABLED_TESTS.add("SQSExtended");
DISABLED_TESTS.add("aws-sdks/ddb-lite");
DISABLED_TESTS.add("aws-sdks/glue");
DISABLED_TESTS.add("aws-sdks/lakeformation");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ class RustTestModels extends TestModelTest {
DISABLED_TESTS.add("SimpleTypes/SimpleByte");
DISABLED_TESTS.add("SimpleTypes/SimpleFloat");
DISABLED_TESTS.add("SimpleTypes/SimpleShort");
DISABLED_TESTS.add("SQSExtended");
DISABLED_TESTS.add("aws-sdks/glue");
DISABLED_TESTS.add("aws-sdks/lakeformation");
DISABLED_TESTS.add("aws-sdks/sqs");
Expand Down

0 comments on commit 47250ff

Please sign in to comment.