github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
62f273d508
containerd/api
History
Bryant Biggs 42eee8bf05 fix: Add containerd to the message type reference 
Signed-off-by: Bryant Biggs <bryantbiggs@gmail.com>
2023-09-20 16:32:05 -04:00
..
events Add sandbox events protos 2023-05-30 13:54:35 -07:00
runtime fix: Add containerd to the message type reference 2023-09-20 16:32:05 -04:00
services Sandbox: Add annotations to CreateSandbox surface 2023-08-12 01:39:29 -07:00
types platforms: move ToProto, FromProto to api/types 2023-09-13 16:44:52 +02: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 Sandbox: Add annotations to CreateSandbox surface 2023-08-12 01:39:29 -07:00
Protobuild.toml Cleanup protobuild config 2023-03-22 13:28:41 +08: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.