github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
2d11f5e6d5
containerd/api
History
Sebastiaan van Stijn 2d11f5e6d5
Regenerate protobufs 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-04-03 23:41:15 +02:00
..
events Regenerate protobufs 2019-04-03 23:41:15 +02:00
services Regenerate protobufs 2019-04-03 23:41:15 +02:00
types Regenerate protobufs 2019-04-03 23:41:15 +02:00
1.0.pb.txt api: lock down 1.0 API descriptors 2017-12-05 13:17:08 -08:00
1.1.pb.txt api: update API capture for 1.1 release 2018-04-06 13:52:10 -07:00
1.2.pb.txt Prepare 1.2 release 2018-10-24 16:14:46 -07:00
next.pb.txt Merge pull request #3000 from stefanberger/descriptor_annotations.pr 2019-03-22 14:05:44 -04: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.