github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
83c80388b2
containerd/api
History
Derek McGowan fcb7bd6997
Remove api go submodule 
Signed-off-by: Derek McGowan <derek@mcg.dev>
2022-01-18 14:48:33 -08:00
..
events Update gogo/protobuf to v1.3.2 2021-01-28 12:57:50 +00:00
services Add runtime path in CreateTaskRequest 2021-11-04 07:33:11 -07:00
types Introduce a new go module - containerd/api for use in standalone clients 2021-07-27 07:34:59 -04:00
1.0.pb.txt Remove the executable bit for api/*.txt files 2020-02-19 16:32:52 +07:00
1.1.pb.txt Remove the executable bit for api/*.txt files 2020-02-19 16:32:52 +07:00
1.2.pb.txt Remove the executable bit for api/*.txt files 2020-02-19 16:32:52 +07:00
doc.go Introduce a new go module - containerd/api for use in standalone clients 2021-07-27 07:34:59 -04:00
next.pb.txt Add runtime path in CreateTaskRequest 2021-11-04 07:33:11 -07:00
Protobuild.toml Introduce a new go module - containerd/api for use in standalone clients 2021-07-27 07:34:59 -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.