github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
a91b05d99c
containerd/api
History
Abel Feng de38490ed6 sandbox: merge address and protocol to one url 
Signed-off-by: Abel Feng <fshb1988@gmail.com>
2024-04-30 15:28:00 +08:00
..
events refactor: move plugin/fieldpath to api/types/ 2024-01-26 00:24:08 +05:30
runtime Update go module to github.com/containerd/containerd/v2 2023-10-29 20:52:21 -07:00
services sandbox: merge address and protocol to one url 2024-04-30 15:28:00 +08:00
types Transfer: Registry: Enable plain HTTP 2024-04-03 10:46:10 +09: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: merge address and protocol to one url 2024-04-30 15:28:00 +08:00
Protobuild.toml Update protobuild to build ttrpc services 2024-02-21 14:22:25 -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.