github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
09cf2a629b
containerd/api
History
Stefan Berger c6703d4c76 Add missing annotations map to Descriptor for gRPC transfer 
Add the annotations map to the gRPC Descriptor message.

Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
Signed-off-by: Brandon Lum <lumjjb@gmail.com>
Signed-off-by: Harshal Patil <harshal.patil@in.ibm.com>
2019-02-27 10:41:17 -05:00
..
events protobuf: remove generated google/rpc files 2018-04-05 14:36:32 -07:00
services fix: typo omitted -> ommitted 2018-09-20 10:30:30 +08:00
types Add missing annotations map to Descriptor for gRPC transfer 2019-02-27 10:41:17 -05: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 Add missing annotations map to Descriptor for gRPC transfer 2019-02-27 10:41:17 -05: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.