github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
8ae20a135a
containerd/api
History
Stephen J Day 8ae20a135a
api: update protobuf descriptors 
Because we merged the PR that added the API descriptors and modified the
API at the same time. This updates the protobufs to be consistent.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-08-17 14:22:14 -07:00
..
services Add support for content labels on commit 2017-08-11 14:15:20 -07:00
types api: cleanup protobuf imports 2017-08-04 12:57:43 -07:00
next.pb.txt api: update protobuf descriptors 2017-08-17 14:22:14 -07:00
README.md Minor typo fix. 2017-08-10 06:23:21 +00:00

README.md

This directory contains the GRPC API definitions for containerd.

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.