This repository contains interface definitions of public dictyBase API that supports gRPC protocols. These definitions can be used with open source tools generate client libraries, documentation and other artifacts.

dictyBase APIs are typically deployed as API services that are hosted under different DNS names. It uses Protocol Buffers version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. It can be accessed through gRPC.

In general, every API has its own directory with matching proto packages. The dictybase folder contains reusable definitions.

This project has been designed to be automated by GitHub Actions. To make changes, create a new branch and push your changes. This will automatically create a pull request then run buf lint to verify your changes. If everything is fine, merge it to the master branch and it will generate updated Go code and open a PR in the go-genproto repository where it will need to be manually reviewed.

Note: if making any updates to the buf.gen.yaml file, you need to run buf beta mod update to update the lock file.