Files
teleport/proto/buf.yaml
T
Edoardo Spadolini 571477fe5a protobuf changes in preparation for buf breaking (#26792)
* Use WIRE_JSON in buf breaking

* Add some field reservations for backwards compat
2023-05-26 13:53:07 +00:00

48 lines
1.5 KiB
YAML

version: v1
lint:
use:
- DEFAULT
- PACKAGE_NO_IMPORT_CYCLE
- UNARY_RPC
# Top-level types require comments.
- COMMENT_ENUM
- COMMENT_MESSAGE
- COMMENT_RPC
- COMMENT_SERVICE
except:
# Allow Google API-style responses (CreateFoo returns Foo).
# See https://cloud.google.com/apis/design/standard_methods.
- RPC_REQUEST_RESPONSE_UNIQUE
- RPC_RESPONSE_STANDARD_NAME
ignore:
# "legacy" lib protos.
- teleport/lib/multiplexer/test/ping.proto
- teleport/lib/web/envelope.proto
ignore_only:
# Allow only certain services to use streaming RPCs.
#
# We should avoid streaming RPCs until we have a compelling reason to use them (e.g. the
# implementation needs 1-N messages or the server cannot dial directly to the client).
#
# Check out the links below. If you still have questions or doubts, reach out to @codingllama.
#
# https://docs.buf.build/lint/rules#unary_rpc
# https://github.com/gravitational/teleport/pull/16043#issuecomment-1235728212
# https://github.com/twitchtv/twirp/issues/70#issuecomment-470367807
UNARY_RPC:
- teleport/lib/teleterm/v1/service.proto
# TODO(ravicious): Fix protos and re-enable lib/teleterm lint rules below.
RPC_REQUEST_STANDARD_NAME:
- teleport/lib/teleterm
# TODO(espadolini): Fix protos and re-enable prehog lint rules below.
COMMENT_MESSAGE:
- teleport/lib/teleterm
- prehog
COMMENT_RPC:
- prehog
COMMENT_SERVICE:
- prehog
breaking:
use:
- WIRE_JSON