peridot/.api-linter.yaml

41 lines
1.7 KiB
YAML

- included_paths:
- "**/*.proto"
disabled_rules:
# Since we don't care about resource annotations, we don't care about
# resource-annotation-presence.
- "core::0131::request-name-reference"
- "core::0135::request-name-reference"
# We should be able to make X_id fields required for CreateX RPCs.
- "core::0133::request-required-fields"
# Resource annotations are not required for our use case.
- "core::0123::resource-annotation"
# Field behavior defaults to OPTIONAL, so we don't want to require it.
# Required fields MUST be explicitly marked as such though.
- "core::0203::field-behavior-required"
# The proto package does not strictly match, but modeled in a way that makes
# sense for this monorepo. We prepend "peridot." and don't include the "proto"
# directory.
- "core::0191::proto-package"
# We don't follow the parent/child pattern for our services.
- "core::0133::method-signature"
- "core::0133::http-uri-parent"
- "core::0132::request-parent-required"
- "core::0133::request-parent-required"
# We want to allow certain POST methods to set body to something other than "*".
# Useful for non-JSON payloads.
- "core::0136::http-body"
# I don't really understand this requirement but looks like Google has a special
# use case when it comes to user provided IDs.
- "core::0133::request-id-field"
# We don't require update mask support
- "core::0134::request-mask-required"
- included_paths:
- "third_party/**/*.proto"
- "vendor/**/*.proto"
- "node_modules/**/*.proto"
- "bazel-bin/**/*.proto"
- "bazel-peridot/**/*.proto"
- "bazel-out/**/*.proto"
disabled_rules:
- all