https://github.com/wasmcloud/interfaces

wasmCloud API interfaces: smithy IDLs and shared libraries
https://github.com/wasmcloud/interfaces

api codegen idl schema smithy smithy-models

Last synced: 5 days ago
JSON representation

wasmCloud API interfaces: smithy IDLs and shared libraries

• Host: GitHub
• URL: https://github.com/wasmcloud/interfaces
• Owner: wasmCloud
• License: apache-2.0
• Created: 2021-07-22T20:30:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-25T03:54:07.000Z (12 months ago)
• Last Synced: 2024-04-27T13:42:39.495Z (8 months ago)
• Topics: api, codegen, idl, schema, smithy, smithy-models
• Language: CSS
• Homepage: https://wasmcloud.github.io/interfaces/
• Size: 969 KB
• Stars: 34
• Watchers: 4
• Forks: 23
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
> [!IMPORTANT]

> The interfaces in this repo are defined in Smithy and used for RPC between actors and providers on the [stable ABI](https://wasmcloud.com/docs/hosts/abis/wasmbus/). For new providers and component actors, interfaces are defined using [WIT](https://github.com/WebAssembly/component-model/blob/main/design/mvp/WIT.md), and codegen for providers is accomplished via the [wasmcloud-provider-wit-bindgen macro](https://github.com/wasmCloud/wasmCloud/tree/main/crates/provider-wit-bindgen). Note that support for WIT is considered **experimental** at this time.

# wasmCloud API Interfaces

This repository contains the wasmCloud contract interface definitions (defined in the _Smithy_ IDL) for those interfaces that are defined and supported by the wasmCloud team. These interfaces are definitely not the _only_ interfaces available, as teams and companies can create their own private or bespoke interfaces as desired.

## Smithy IDLs and Shared Libraries

Each interface is defined in a file with the `.smithy` extension. If

the folder contains a `codegen.toml` file,

a library and/or html documentation can be

automatically generated from the `.smithy` file.

More information on code

generation and the `codegen.toml` files is in the [weld

crate](https://github.com/wasmcloud/weld)

The `docs` folder in this repository is published to github pages at

[Wasmcloud Interfaces](https://wasmcloud.github.io/interfaces/), and

contains copies of the interfaces available for direct download, and

html generated documentation.

For more information on Smithy, see

- [Smithy](https://awslabs.github.io/smithy/index.html) A language for

  defining services and SDKs

- [IDL specification](https://awslabs.github.io/smithy/1.0/spec/core/idl.html)

For more on wasmcloud, see

- [wasmCloud](https://wasmcloud.com)