github.com/gravitational/teleport/api@v0.0.0-20240507183017-3110591cbafc/proto/buf.yaml (about)

     1  version: v1
     2  deps:
     3    # gogo/protobuf v1.3.2, keep in sync with build.assets/Makefile.
     4    - buf.build/gogo/protobuf:b03c65ea87cdc3521ede29f62fe3ce239267c1bc
     5    - buf.build/googleapis/googleapis:beb34b4050abfcfff72ff5cc6a28f0afa4043ce0
     6  lint:
     7    use:
     8      - DEFAULT
     9      - PACKAGE_NO_IMPORT_CYCLE
    10      - UNARY_RPC
    11      # Top-level types require comments.
    12      - COMMENT_ENUM
    13      - COMMENT_MESSAGE
    14      - COMMENT_RPC
    15      - COMMENT_SERVICE
    16    except:
    17      # Allow Google API-style responses (CreateFoo returns Foo).
    18      # See https://cloud.google.com/apis/design/standard_methods.
    19      - RPC_REQUEST_RESPONSE_UNIQUE
    20      - RPC_RESPONSE_STANDARD_NAME
    21    ignore:
    22      - teleport/legacy/client/proto/authservice.proto
    23      - teleport/legacy/client/proto/certs.proto
    24      - teleport/legacy/client/proto/event.proto
    25      - teleport/legacy/client/proto/proxyservice.proto
    26      - teleport/legacy/types/events/events.proto
    27      - teleport/legacy/types/events/athena.proto
    28      - teleport/legacy/types/types.proto
    29      - teleport/legacy/types/wrappers/wrappers.proto
    30    ignore_only:
    31      # Allow package/directory mismatch for legacy protos.
    32      FIELD_LOWER_SNAKE_CASE:
    33        - teleport/legacy/types/device.proto
    34      # Allow package/directory mismatch for legacy protos.
    35      PACKAGE_DIRECTORY_MATCH:
    36        - teleport/legacy/client/proto/joinservice.proto
    37        - teleport/legacy/types/device.proto
    38        - teleport/legacy/types/webauthn/webauthn.proto
    39      # Allow non-versioned packages for legacy protos.
    40      PACKAGE_VERSION_SUFFIX:
    41        - teleport/legacy/client/proto/joinservice.proto
    42        - teleport/legacy/types/device.proto
    43        - teleport/legacy/types/webauthn/webauthn.proto
    44      # Allow only certain services to use streaming RPCs.
    45      #
    46      # We should avoid streaming RPCs until we have a compelling reason to use them (e.g. the
    47      # implementation needs 1-N messages or the server cannot dial directly to the client).
    48      #
    49      # Check out the links below. If you still have questions or doubts, reach out to @codingllama.
    50      #
    51      # https://docs.buf.build/lint/rules#unary_rpc
    52      # https://github.com/gravitational/teleport/pull/16043#issuecomment-1235728212
    53      # https://github.com/twitchtv/twirp/issues/70#issuecomment-470367807
    54      UNARY_RPC:
    55        - teleport/devicetrust/v1/devicetrust_service.proto
    56        - teleport/legacy/client/proto/joinservice.proto
    57        - teleport/transport/v1/transport_service.proto
    58        - teleport/auditlog/v1/auditlog.proto
    59  breaking:
    60    use:
    61      - WIRE_JSON
    62      - ENUM_VALUE_NO_DELETE
    63    ignore_only:
    64      RESERVED_ENUM_NO_DELETE:
    65        - teleport/legacy/types/types.proto