This repository contains the service definitions and code generated stubs for Cofide's APIs.

This repository uses the Buf CLI to help generate and manage Cofide's Protocol buffer (protobuf) definitions and schemas. To install the CLI, use the following instructions. For convenience, a set of useful commands have been added to the Justfile in the project root. If you haven't got just, you can follow these instructions to install it.

Some of the key commands include:

• just fmt - Formats the protobuf definitions
• just lint - Lints the protobuf definitions in accordance with best practices
• just proto-gen - Generates the code stubs from the protobuf definitions using the defined plugins (specified in buf.gen.yaml)

The .proto files are in the proto directory, and the generated stubs for Go are in the gen/proto/go directory.

The service definitions in this repository are not currently guaranteed to be backward compatible over time, and have been versioned as v1alhpa1 to indicate this. As the Cofide product matures, we will move to v1 and guarantee backward compatibility from that point.