xref: /aosp_15_r20/external/grpc-grpc-java/xds/third_party/envoy/src/main/proto/envoy/annotations/deprecation.proto (revision e07d83d3ffcef9ecfc9f7f475418ec639ff0e5fe)
1syntax = "proto3";
2
3package envoy.annotations;
4option go_package = "github.com/envoyproxy/go-control-plane/envoy/annotations";
5
6import "google/protobuf/descriptor.proto";
7
8// [#protodoc-title: Deprecation]
9// Adds annotations for deprecated fields and enums to allow tagging proto
10// fields as fatal by default and the minor version on which the field was
11// deprecated. One Envoy release after deprecation, deprecated fields will be
12// disallowed by default, a state which is reversible with
13// :ref:`runtime overrides <config_runtime_deprecation>`.
14
15// Magic number in this file derived from top 28bit of SHA256 digest of
16// "envoy.annotation.disallowed_by_default" and "envoy.annotation.deprecated_at_minor_version"
17extend google.protobuf.FieldOptions {
18  bool disallowed_by_default = 189503207;
19
20  // The API major and minor version on which the field was deprecated
21  // (e.g., "3.5" for major version 3 and minor version 5).
22  string deprecated_at_minor_version = 157299826;
23}
24
25// Magic number in this file derived from top 28bit of SHA256 digest of
26// "envoy.annotation.disallowed_by_default_enum" and
27// "envoy.annotation.deprecated_at_minor_version_eum"
28extend google.protobuf.EnumValueOptions {
29  bool disallowed_by_default_enum = 70100853;
30
31  // The API major and minor version on which the enum value was deprecated
32  // (e.g., "3.5" for major version 3 and minor version 5).
33  string deprecated_at_minor_version_enum = 181198657;
34}
35