containerd/api
2017-08-08 21:59:28 -04:00
..
services Merge pull request #1276 from dmcgowan/snapshot-labels 2017-08-08 21:59:28 -04:00
types api: cleanup protobuf imports 2017-08-04 12:57:43 -07:00
next.pb.txt api: generate merged descriptors when building protobufs 2017-08-04 16:50:28 -07:00
README.md api: generate merged descriptors when building protobufs 2017-08-04 16:50:28 -07:00

This directory contains the GRPC API definitions for contaienrd.

All defined services and messages have been aggregated into *.pb.txt descriptors files in this directory. Definitions present here are considered frozen after the release.

At release time, the current next.pb.txt file will be moved into place to freeze the API changes for the minor version. For example, when 1.0.0 is released, next.pb.txt should be moved to 1.0.txt. Notice that we leave off the patch number, since the API will be completely locked down for a given patch series.

We may find that by default, protobuf descriptors are too noisy to lock down API changes. In that case, we may filter out certain fields in the descriptors, possibly regenerating for old versions.

This process is similar to the process used to ensure backwards compatibility in Go.