github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
ac72483e87
containerd/api
History
Maksym Pavlenko 1c1d8fb057 Update OCI spec tests for generic platform 
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2023-01-11 13:03:59 -08:00
..
events Regenerate protos with updated protoc-gen-go 2022-07-28 16:59:30 +00:00
runtime Update OCI spec tests for generic platform 2023-01-11 13:03:59 -08:00
services Update sandbox API to return target platform 2023-01-11 13:03:59 -08:00
types Cleanup code comments and lint fixes 2022-11-30 16:02:09 -08: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 Update sandbox API to return target platform 2023-01-11 13:03:59 -08:00
Protobuild.toml Remove gogo from .proto files 2022-04-27 20:27:55 +00: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.