wgtwoapis

README

Working Group Two APIs

This repository contains the public APIs of Working Group Two.

Working Group Two's APIs uses gRPC backed by Protocol Buffers. This repository contains both the .proto files that can be used to generate clients and documentation, in addition to ready made Maven packages to simplify integration.

Contents:

• Java/Maven
• Protobuf FileDescriptorSet release
• Go release
• NPM package

Documentation

See https://docs.wgtwo.com

Setup required to release/deploy from local machine:

See our internal wiki for the required local tooling/setup for releasing to the maven central repository.

Languages

Java/Maven

The Java artifacts are released to maven central. We use semver, where major version corresponds to the version set as part of the protobuf package.

Go

Generated go code is included in this repo, next to their corresponding .proto files

Node.js

Note: This is currently experimental, so changes may occur.

We are publishing our .proto files to the Buf Schema Registry at buf.build/wgtwo/wgtwoapis.

This includes npm support.

Other languages

Buf Schema Registry offers support for:

• Go
• Node.js
• Maven
• Swift

We are not currently publishing artifacts for other languages, so please reach out if you have any needs.

However, gRPC has support for a variety of languages as displayed ingRPC's documentation. Any of these may be used by using our protobuf files directly by syncing them from this repository.

That is, e.g. using the dotnet-grpc cli for .NET.