-
Notifications
You must be signed in to change notification settings - Fork 0
/
.api-linter.yaml
91 lines (75 loc) · 3.22 KB
/
.api-linter.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
- included_paths:
- '**/*.proto'
disabled_rules:
# Comments are sometimes so trivial, we'd rather omit them
- 'core::0192::has-comments'
# protoc enforces the Java package name already, no need to explicitly specify it
- 'core::0191::java-package'
# Since we have multiple files for Java, this is not required
- 'core::0191::java-outer-classname'
# We don't need pagination just yet, so we'd rather not overcomplicate this
- 'core::0158::request-page-size-field'
- 'core::0158::response-next-page-token-field'
- 'core::0158::request-page-token-field'
# We'd rather specify a relation that an entity has to another entity
# rather than a hierarchy as Google requires here
- 'core::0132::request-parent-required'
- 'core::0133::request-parent-required'
# Google APIs specific, seems to be focused on mapping gRPC to REST
- 'core::0123::resource-annotation'
- 'core::0131::method-signature'
- 'core::0131::request-name-reference'
- 'core::0133::method-signature'
- 'core::0133::response-message-name'
- 'core::0134::method-signature'
- 'core::0134::request-unknown-fields'
- 'core::0134::response-message-name'
- 'core::0134::request-resource-required'
- 'core::0135::request-name-reference'
- 'core::0135::response-message-name'
- 'core::0135::method-signature'
- 'core::0135::request-unknown-fields'
- 'core::0135::request-name-required'
# We don't need gRPC to REST transcoding yet, so we disable it for now
- 'core::0127::http-annotation'
# We choose to wrap all our entities in a response object,
# as we do not always return the requested entity, but a Tree view
# on the entity
- 'core::0131::response-message-name'
# Get RPCs do not always have a name as a unique identifier
- 'core::0131::request-unknown-fields'
- 'core::0131::request-name-required'
- 'core::0132::request-unknown-fields'
- 'core::0133::request-unknown-fields'
# Temporarily disabled
- 'core::0133::request-resource-behavior'
# Disable HTTP URI rules, as we do not have HTTP REST annotations on Proto messages yet
- 'core::0133::http-uri-parent'
# We don't require an id field to be set for creates, as it's often generated
- 'core::0133::request-id-field'
# We would like to provide more information regarding pagination in list responses as well
- 'core::0132::response-unknown-fields'
- included_paths:
- '**/consent_levels_*.proto'
disabled_rules:
# The unique identifier for consent levels is the level
- 'core::0135::request-unknown-fields'
- 'core::0135::request-name-required'
- included_paths:
- '**/credentials_*.proto'
disabled_rules:
# The unique identifier for consent levels is the level
- 'core::0133::request-unknown-fields'
- 'core::0135::request-name-required'
- 'core::0135::request-unknown-fields'
- included_paths:
- '**/entities_*.proto'
disabled_rules:
# The unique identifier for consent levels is the level
- 'core::0122::name-suffix'
- 'core::0203::required'
- included_paths:
- '**/account_*.proto'
disabled_rules:
# Disable synonyms for RPC names, as we want to use Set instead of Update
- 'core::0134::synonyms'