Alloy: Relocation of smithy4s.api#*

[lewisjkl]

Hey @jona7o and any others who may be involved with building tooling off of smithy4s!

We wanted to give you all a heads up that we have just open-sourced a new repository: disneystreaming/alloy.

What is Alloy?

This repository is going to be the new home of smithy4s.api#simpleRestJson (now called alloy#simpleRestJson and it's associated shapes. It is also the home of an alloy#grpc protocol and some other proto-related shapes. Going forward, this is where we will put our oss Smithy protocols as well as other shapes which lend themselves to reuse across projects. All Alloy shapes will be published to maven central and used by our projects, such as smithy4s, from there.

Why Alloy?

The reason for this change is that having a common spot to place smithy shapes makes it easier to build smithy-based tooling that works well together. As an example, we have another library we will be open sourcing (hopefully next week) called smithy-translate.

Smithy-translate uses Alloy as well and contains functionality for converting openapi specs to smithy models, json schema to smithy models, and smithy models to protobuf files. Having shapes such as alloy#untagged accessible in smithy-translate allows us to output Smithy models that will Just Work ™️ with smithy4s.

More to come on smithy-translate, but wanted to mention it here since it is part of the motivation for moving in this direction.

Migration

The migration for smithy4s to use alloy is mostly trivial. It is mainly just updating imports to be alloy.x instead of smithy4s.api.x. We are hoping to be able to release a new version of smithy4s sometime in the next week or two that will incorporate these changes. Here is a link to the PR that I've been prepping for smithy4s to move over to use Alloy.

I hope the migration will be smooth on your end as well with the play integration you've built. If you anticipate any issues, please let us know.

Final Notes

Anyway, happy to chat about this more if you have any questions. Alloy is out in the open, but I am running into a slight issue with getting it published out to Maven Central. It might be tomorrow when it is actually published, but you can publish it locally in the meantime (mill __.publishLocal) if you want.

Thanks!