cofide-api-sdk

README

Cofide API SDK

This repository contains the service definitions and code generated stubs for Cofide's APIs, used for open source projects (e.g. cofidectl) and the Cofide product.

Services and messages are defined using Protocol Buffers (protobuf).

Prerequisites

This repository uses the Buf CLI to help generate and manage Cofide's protobuf definitions and schemas. The following tools must be available in order to generate code stubs.

• Go 1.22.6 toolchain
• protobuf version 3 compiler
• Go gRPC and protobuf build tools.
• Buf CLI
• Just

Getting started

For convenience, a set of useful commands have been added to the Justfile in the project root. 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.

Stability

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