33 |
34 |
35 |
42 |
--------------------------------------------------------------------------------
/internal/version.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 | package internal
15 |
16 | // Version is the current tagged release of the library.
17 | const Version = "1.69.2"
18 |
--------------------------------------------------------------------------------
/lint/response.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package lint
16 |
17 | // Response describes the result returned by a rule.
18 | type Response struct {
19 | FilePath string `json:"file_path" yaml:"file_path"`
20 | Problems []Problem `json:"problems" yaml:"problems"`
21 | }
22 |
--------------------------------------------------------------------------------
/lint/rule_aliases.go:
--------------------------------------------------------------------------------
1 | package lint
2 |
3 | // aliasMap stores legacy names for some rules.
4 | // At Google, we inject rule-alias mapping into this map.
5 | // Example:
6 | // We will compile an addition file -- "google_rule_aliases.go".
7 | // ````````````````````````````````````````````````````````````
8 | // package lint
9 | //
10 | // func init() {
11 | // aliasMap["core::0140::lower-snake"] = "naming-format"
12 | // aliasMap["core::0140::enum-names::abbreviations"] = "abbreviations"
13 | // }
14 | //
15 | // ````````````````````````````````````````````````````````````
16 | var aliasMap = map[string]string{}
17 |
--------------------------------------------------------------------------------
/locations/descriptor_locations.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package locations
16 |
17 | import (
18 | "github.com/jhump/protoreflect/desc"
19 | dpb "google.golang.org/protobuf/types/descriptorpb"
20 | )
21 |
22 | // DescriptorName returns the precise location for a descriptor's name.
23 | //
24 | // This works for any descriptor, regardless of type (message, field, etc.).
25 | func DescriptorName(d desc.Descriptor) *dpb.SourceCodeInfo_Location {
26 | // All descriptors seem to have `string name = 1`, so this conveniently works.
27 | return pathLocation(d, 1)
28 | }
29 |
--------------------------------------------------------------------------------
/locations/message_locations.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package locations
16 |
17 | import (
18 | "github.com/jhump/protoreflect/desc"
19 | apb "google.golang.org/genproto/googleapis/api/annotations"
20 | dpb "google.golang.org/protobuf/types/descriptorpb"
21 | )
22 |
23 | // MessageResource returns the precise location of the `google.api.resource`
24 | // annotation.
25 | func MessageResource(m *desc.MessageDescriptor) *dpb.SourceCodeInfo_Location {
26 | return pathLocation(m, 7, int(apb.E_Resource.TypeDescriptor().Number())) // MessageDescriptor.options == 7
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0121/aip0121.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0121 contains rules defined in https://aip.dev/121.
16 | package aip0121
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules accepts a register function and registers each of
23 | // this AIP's rules to it.
24 | func AddRules(r lint.RuleRegistry) error {
25 | return r.Register(
26 | 121,
27 | resourceMustSupportGet,
28 | resourceMustSupportList,
29 | noMutableCycles,
30 | )
31 | }
32 |
--------------------------------------------------------------------------------
/rules/aip0121/aip0121_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0121 contains rules defined in https://aip.dev/121.
16 | package aip0121
17 |
18 | import (
19 | "testing"
20 |
21 | "github.com/googleapis/api-linter/lint"
22 | )
23 |
24 | func TestAddRules(t *testing.T) {
25 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
26 | t.Errorf("AddRules got an error: %v", err)
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/rules/aip0122/aip0122.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0122 contains rules defined in https://aip.dev/122.
16 | package aip0122
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules accepts a register function and registers each of
23 | // this AIP's rules to it.
24 | func AddRules(r lint.RuleRegistry) error {
25 | return r.Register(
26 | 122,
27 | resourceCollectionIdentifiers,
28 | httpURICase,
29 | nameSuffix,
30 | noSelfLinks,
31 | resourceReferenceType,
32 | resourceIdOutputOnly,
33 | embeddedResource,
34 | )
35 | }
36 |
--------------------------------------------------------------------------------
/rules/aip0122/api0122_test.go:
--------------------------------------------------------------------------------
1 | package aip0122
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0124/aip0124_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0124
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0126/aip0126.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0126 contains rules defined in https://aip.dev/126.
16 | package aip0126
17 |
18 | import "github.com/googleapis/api-linter/lint"
19 |
20 | // AddRules adds all of the AIP-126 rules to the provided registry.
21 | func AddRules(r lint.RuleRegistry) error {
22 | return r.Register(
23 | 126,
24 | enumValueUpperSnakeCase,
25 | unspecified,
26 | )
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0126/aip0126_test.go:
--------------------------------------------------------------------------------
1 | package aip0126
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0126/upper_snake_values.go:
--------------------------------------------------------------------------------
1 | package aip0126
2 |
3 | import (
4 | "fmt"
5 | "strings"
6 |
7 | "github.com/googleapis/api-linter/lint"
8 | "github.com/googleapis/api-linter/locations"
9 | "github.com/jhump/protoreflect/desc"
10 | "github.com/stoewer/go-strcase"
11 | )
12 |
13 | // All enum values must use UPPER_SNAKE_CASE.
14 | var enumValueUpperSnakeCase = &lint.EnumRule{
15 | Name: lint.NewRuleName(126, "upper-snake-values"),
16 | LintEnum: func(e *desc.EnumDescriptor) []lint.Problem {
17 | var problems []lint.Problem
18 | for _, v := range e.GetValues() {
19 | if got, want := v.GetName(), toUpperSnakeCase(v.GetName()); got != want {
20 | problems = append(problems, lint.Problem{
21 | Message: fmt.Sprintf("Enum value %q must use UPPER_SNAKE_CASE.", got),
22 | Suggestion: want,
23 | Descriptor: v,
24 | Location: locations.DescriptorName(v),
25 | })
26 | }
27 | }
28 | return problems
29 | },
30 | }
31 |
32 | func toUpperSnakeCase(s string) string {
33 | return strings.ToUpper(strcase.SnakeCase(s))
34 | }
35 |
--------------------------------------------------------------------------------
/rules/aip0127/aip0127.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0127 contains rules defined in https://aip.dev/127.
16 | package aip0127
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-127 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 127,
26 | hasAnnotation,
27 | httpTemplatePattern,
28 | httpTemplateSyntax,
29 | leadingSlash,
30 | resourceNameExtraction,
31 | )
32 | }
33 |
--------------------------------------------------------------------------------
/rules/aip0127/aip0127_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 | package aip0127
15 |
16 | import (
17 | "testing"
18 |
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | func TestAddRules(t *testing.T) {
23 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
24 | t.Errorf("AddRules got an error: %v", err)
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/rules/aip0128/aip0128_test.go:
--------------------------------------------------------------------------------
1 | package aip0128
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0128/resource_reconciling_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0128
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var resourceReconcilingBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(128, "resource-reconciling-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isDeclarativeFriendlyResource(f.GetOwner()) && f.GetName() == "reconciling"
27 | },
28 | LintField: utils.LintOutputOnlyField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0131/aip0131_test.go:
--------------------------------------------------------------------------------
1 | package aip0131
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0131/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Get methods should not have an HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(131, "http-body"),
25 | OnlyIf: utils.IsGetMethod,
26 | LintMethod: utils.LintNoHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0131/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Get methods should use the HTTP GET verb.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(131, "http-method"),
25 | OnlyIf: utils.IsGetMethod,
26 | LintMethod: utils.LintHTTPMethod("GET"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0131/http_uri_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Get methods should have a proper HTTP pattern.
23 | var httpNameField = &lint.MethodRule{
24 | Name: lint.NewRuleName(131, "http-uri-name"),
25 | OnlyIf: utils.IsGetMethod,
26 | LintMethod: utils.LintHTTPURIHasNameVariable,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0131/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Get messages should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(131, "request-message-name"),
25 | OnlyIf: utils.IsGetMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0131/request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(131, "request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsGetRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0131/request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | // Get request should have a string name field.
24 | var requestNameField = &lint.FieldRule{
25 | Name: lint.NewRuleName(131, "request-name-field"),
26 | OnlyIf: func(f *desc.FieldDescriptor) bool {
27 | return utils.IsGetRequestMessage(f.GetOwner()) && f.GetName() == "name"
28 | },
29 | LintField: utils.LintSingularStringField,
30 | }
31 |
--------------------------------------------------------------------------------
/rules/aip0131/request_name_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0131
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(131, "request-name-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsGetRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0132/aip0132_test.go:
--------------------------------------------------------------------------------
1 | package aip0132
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0132/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0132
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // List methods should not have an HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(132, "http-body"),
25 | OnlyIf: utils.IsListMethod,
26 | LintMethod: utils.LintNoHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0132/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0132
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // List methods should use the HTTP GET verb.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(132, "http-method"),
25 | OnlyIf: utils.IsListMethod,
26 | LintMethod: utils.LintHTTPMethod("GET"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0132/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0132
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // List messages should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(132, "request-message-name"),
25 | OnlyIf: utils.IsListMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0132/request_parent_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0132
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(132, "request-parent-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsListRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0132/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0132
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(132, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsListRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0132/response_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0132
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // List messages should use a `ListFoosResponse` response message.
23 | var responseMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(132, "response-message-name"),
25 | OnlyIf: utils.IsListMethod,
26 | LintMethod: utils.LintMethodHasMatchingResponseName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0133/aip0133_test.go:
--------------------------------------------------------------------------------
1 | package aip0133
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0133/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0133
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Create methods should use the HTTP POST verb.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(133, "http-method"),
25 | OnlyIf: utils.IsCreateMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0133/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0133
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Create method should have a properly named input message.
23 | var inputName = &lint.MethodRule{
24 | Name: lint.NewRuleName(133, "request-message-name"),
25 | OnlyIf: utils.IsCreateMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0133/request_parent_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0133
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(133, "request-parent-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsCreateRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0133/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0133
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(133, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsCreateRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0134/aip0134_test.go:
--------------------------------------------------------------------------------
1 | package aip0134
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0134/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0134
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Update methods should use the HTTP PATCH verb.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(134, "http-method"),
25 | OnlyIf: utils.IsUpdateMethod,
26 | LintMethod: utils.LintHTTPMethod("PATCH"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0134/request_mask_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0134
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestMaskField = &lint.FieldRule{
24 | Name: lint.NewRuleName(134, "request-mask-field"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsUpdateRequestMessage(f.GetOwner()) && f.GetName() == "update_mask"
27 | },
28 | LintField: utils.LintFieldMask,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0134/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0134
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Update methods should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(134, "request-message-name"),
25 | OnlyIf: utils.IsUpdateMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0134/request_resource_required.go:
--------------------------------------------------------------------------------
1 | package aip0134
2 |
3 | import (
4 | "fmt"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | "github.com/googleapis/api-linter/rules/internal/utils"
8 | "github.com/jhump/protoreflect/desc"
9 | )
10 |
11 | // The create request message should have resource field.
12 | var requestResourceRequired = &lint.MessageRule{
13 | Name: lint.NewRuleName(134, "request-resource-required"),
14 | OnlyIf: utils.IsUpdateRequestMessage,
15 | LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
16 | resourceMsgName := extractResource(m.GetName())
17 | for _, fieldDesc := range m.GetFields() {
18 | msgDesc := fieldDesc.GetMessageType()
19 | if msgDesc != nil && msgDesc.GetName() == resourceMsgName {
20 | // found the resource field.
21 | return nil
22 | }
23 | }
24 |
25 | // No resource field.
26 | return []lint.Problem{{
27 | Message: fmt.Sprintf("Message %q has no %q type field", m.GetName(), resourceMsgName),
28 | Descriptor: m,
29 | }}
30 | },
31 | }
32 |
--------------------------------------------------------------------------------
/rules/aip0135/aip0135_test.go:
--------------------------------------------------------------------------------
1 | package aip0135
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0135/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete methods should not have an HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(135, "http-body"),
25 | OnlyIf: utils.IsDeleteMethod,
26 | LintMethod: utils.LintNoHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0135/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete methods should use the HTTP DELETE method.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(135, "http-method"),
25 | OnlyIf: utils.IsDeleteMethod,
26 | LintMethod: utils.LintHTTPMethod("DELETE"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0135/http_uri_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete methods should have a proper HTTP pattern.
23 | var httpNameField = &lint.MethodRule{
24 | Name: lint.NewRuleName(135, "http-uri-name"),
25 | OnlyIf: utils.IsDeleteMethod,
26 | LintMethod: utils.LintHTTPURIHasNameVariable,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0135/request_force_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestForceField = &lint.FieldRule{
24 | Name: lint.NewRuleName(135, "request-force-field"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsDeleteRequestMessage(f.GetOwner()) && f.GetName() == "force"
27 | },
28 | LintField: utils.LintSingularBoolField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0135/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete messages should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(135, "request-message-name"),
25 | OnlyIf: utils.IsDeleteMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0135/request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(135, "request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsDeleteRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0135/request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameField = &lint.FieldRule{
24 | Name: lint.NewRuleName(135, "request-name-field"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsDeleteRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintSingularStringField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0135/request_name_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0135
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(135, "request-name-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return utils.IsDeleteRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0136/aip0136_test.go:
--------------------------------------------------------------------------------
1 | package aip0136
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0136/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0136
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Custom methods should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(136, "request-message-name"),
25 | OnlyIf: utils.IsCustomMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0140/aip0140_test.go:
--------------------------------------------------------------------------------
1 | package aip0140
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0141/aip0141.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0141 contains rules defined in https://aip.dev/141.
16 | package aip0141
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-141 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 141,
26 | count,
27 | forbiddenTypes,
28 | )
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0141/aip0141_test.go:
--------------------------------------------------------------------------------
1 | package aip0141
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0142/aip0142_test.go:
--------------------------------------------------------------------------------
1 | package aip0142
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0143/aip0143.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0143 contains rules defined in https://aip.dev/143.
16 | package aip0143
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-143 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 143,
26 | fieldNames,
27 | fieldTypes,
28 | )
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0143/aip0143_test.go:
--------------------------------------------------------------------------------
1 | package aip0143
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0144/aip0144_test.go:
--------------------------------------------------------------------------------
1 | package aip0144
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0144/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0144
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Add/Remove methods should use "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(144, "http-body"),
25 | OnlyIf: isAddRemoveMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0144/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0144
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Add/Remove methods should use the HTTP POST method.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(144, "http-method"),
25 | OnlyIf: isAddRemoveMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0144/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0144
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Add/Remove methods should have a properly named request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(144, "request-message-name"),
25 | OnlyIf: isAddRemoveMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0146/aip0146.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0146 contains rules defined in https://aip.dev/146.
16 | package aip0146
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-146 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 146,
26 | any,
27 | )
28 | }
29 |
--------------------------------------------------------------------------------
/rules/aip0146/aip0146_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0146
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0148/aip0148.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0148 contains rules defined in https://aip.dev/148.
16 | package aip0148
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-148 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 148,
26 | declarativeFriendlyRequired,
27 | fieldBehavior,
28 | humanNames,
29 | ipAddressFormat,
30 | useUid,
31 | uidFormat,
32 | )
33 | }
34 |
--------------------------------------------------------------------------------
/rules/aip0148/aip0148_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0148
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0151/aip0151_test.go:
--------------------------------------------------------------------------------
1 | package aip0151
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0152/aip0152_test.go:
--------------------------------------------------------------------------------
1 | package aip0152
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0152/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0152
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Run methods should use "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(152, "http-body"),
25 | OnlyIf: isRunMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0152/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0152
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Run methods should use the HTTP POST method.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(152, "http-method"),
25 | OnlyIf: isRunMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0152/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0152
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Run messages should have a properly named request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(152, "request-message-name"),
25 | OnlyIf: isRunMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0152/request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0152
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(152, "request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isRunRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0152/request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0152
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | var requestNameField = &lint.MessageRule{
23 | Name: lint.NewRuleName(152, "request-name-field"),
24 | OnlyIf: isRunRequestMessage,
25 | LintMessage: utils.LintFieldPresentAndSingularString("name"),
26 | }
27 |
--------------------------------------------------------------------------------
/rules/aip0152/request_name_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0152
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(152, "request-name-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isRunRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0154/aip0154.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0154 contains rules defined in https://aip.dev/154.
16 | package aip0154
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-154 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 154,
26 | declarativeFriendlyRequired,
27 | fieldType,
28 | noDuplicateEtag,
29 | )
30 | }
31 |
--------------------------------------------------------------------------------
/rules/aip0154/aip0154_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0154
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0155/aip0155.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0155 contains rules defined in https://aip.dev/155.
16 | package aip0155
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-155 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 155,
26 | requestIdFormat,
27 | )
28 | }
29 |
--------------------------------------------------------------------------------
/rules/aip0155/aip0155_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0155
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0156/aip0156.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0156 contains rules defined in https://aip.dev/156.
16 | package aip0156
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-156 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 156,
26 | forbiddenMethods,
27 | )
28 | }
29 |
--------------------------------------------------------------------------------
/rules/aip0156/aip0156_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0156
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0157/request_read_mask_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0157
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestReadMaskField = &lint.FieldRule{
24 | Name: lint.NewRuleName(157, "request-read-mask-field"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isRequestMessage(f.GetOwner()) && f.GetName() == "read_mask"
27 | },
28 | LintField: utils.LintFieldMask,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0158/aip0158_test.go:
--------------------------------------------------------------------------------
1 | package aip0158
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0158/response_next_page_token_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0158
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | var responsePaginationNextPageToken = &lint.MessageRule{
23 | Name: lint.NewRuleName(158, "response-next-page-token-field"),
24 | OnlyIf: isPaginatedResponseMessage,
25 | LintMessage: utils.LintFieldPresentAndSingularString("next_page_token"),
26 | }
27 |
--------------------------------------------------------------------------------
/rules/aip0159/aip0159.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0159 contains rules defined in https://aip.dev/159.
16 | package aip0159
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-159 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 159,
26 | hardcodedHyphen,
27 | )
28 | }
29 |
--------------------------------------------------------------------------------
/rules/aip0159/aip0159_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0159
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/commit_http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Commit methods should have "*" as the HTTP body.
23 | var commitHTTPBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "commit-http-body"),
25 | OnlyIf: utils.IsCommitRevisionMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/commit_http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Commit methods should use the HTTP POST method.
23 | var commitHTTPMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "commit-http-method"),
25 | OnlyIf: utils.IsCommitRevisionMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/commit_request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Commit messages should have a properly named request message.
23 | var commitRequestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "commit-request-message-name"),
25 | OnlyIf: utils.IsCommitRevisionMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/commit_request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var commitRequestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(162, "commit-request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isCommitRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0162/commit_request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Commit request message should have a name field.
23 | var commitRequestNameField = &lint.MessageRule{
24 | Name: lint.NewRuleName(162, "commit-request-name-field"),
25 | OnlyIf: isCommitRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("name"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/commit_request_name_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var commitRequestNameReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(162, "commit-request-name-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isCommitRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0162/delete_revision_http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete Revision methods should have no HTTP body.
23 | var deleteRevisionHTTPBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "delete-revision-http-body"),
25 | OnlyIf: utils.IsDeleteRevisionMethod,
26 | LintMethod: utils.LintNoHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/delete_revision_http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete Revision methods should use the HTTP DELETE method.
23 | var deleteRevisionHTTPMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "delete-revision-http-method"),
25 | OnlyIf: utils.IsDeleteRevisionMethod,
26 | LintMethod: utils.LintHTTPMethod("DELETE"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/delete_revision_request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Delete Revision messages should have a properly named request message.
23 | var deleteRevisionRequestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "delete-revision-request-message-name"),
25 | OnlyIf: utils.IsDeleteRevisionMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/delete_revision_request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Delete Revision request message should have a name field.
23 | var deleteRevisionRequestNameField = &lint.MessageRule{
24 | Name: lint.NewRuleName(162, "delete-revision-request-name-field"),
25 | OnlyIf: isDeleteRevisionRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("name"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Rollback methods should have "*" as the HTTP body.
23 | var rollbackHTTPBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "rollback-http-body"),
25 | OnlyIf: utils.IsRollbackRevisionMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Rollback methods should use the HTTP POST method.
23 | var rollbackHTTPMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "rollback-http-method"),
25 | OnlyIf: utils.IsRollbackRevisionMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Rollback messages should have a properly named request message.
23 | var rollbackRequestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "rollback-request-message-name"),
25 | OnlyIf: utils.IsRollbackRevisionMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var rollbackRequestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(162, "rollback-request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isRollbackRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Rollback request message should have a name field.
23 | var rollbackRequestNameField = &lint.MessageRule{
24 | Name: lint.NewRuleName(162, "rollback-request-name-field"),
25 | OnlyIf: isRollbackRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("name"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_request_name_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var rollbackRequestNameReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(162, "rollback-request-name-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isRollbackRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0162/rollback_request_revision_id_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Rollback request message should have a revision_id field.
23 | var rollbackRequestRevisionIDField = &lint.MessageRule{
24 | Name: lint.NewRuleName(162, "rollback-request-revision-id-field"),
25 | OnlyIf: isRollbackRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("revision_id"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Tag Revision methods should have "*" as the HTTP body.
23 | var tagRevisionHTTPBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "tag-revision-http-body"),
25 | OnlyIf: utils.IsTagRevisionMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Tag Revision methods should use the HTTP POST method.
23 | var tagRevisionHTTPMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "tag-revision-http-method"),
25 | OnlyIf: utils.IsTagRevisionMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Tag Revision messages should have a properly named request message.
23 | var tagRevisionRequestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(162, "tag-revision-request-message-name"),
25 | OnlyIf: utils.IsTagRevisionMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var tagRevisionRequestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(162, "tag-revision-request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isTagRevisionRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Tag Revision request message should have a name field.
23 | var tagRevisionRequestNameField = &lint.MessageRule{
24 | Name: lint.NewRuleName(162, "tag-revision-request-name-field"),
25 | OnlyIf: isTagRevisionRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("name"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_request_tag_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var tagRevisionRequestTagBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(162, "tag-revision-request-tag-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isTagRevisionRequestMessage(f.GetOwner()) && f.GetName() == "tag"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0162/tag_revision_request_tag_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0162
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Tag Revision request message should have a tag field.
23 | var tagRevisionRequestTagField = &lint.MessageRule{
24 | Name: lint.NewRuleName(162, "tag-revision-request-tag-field"),
25 | OnlyIf: isTagRevisionRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("tag"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0163/aip0163.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0163 contains rules defined in https://aip.dev/163.
16 | package aip0163
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-163 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 163,
26 | declarativeFriendlyRequired,
27 | synonyms,
28 | )
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0163/aip0163_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0163
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0164/aip0164_test.go:
--------------------------------------------------------------------------------
1 | package aip0164
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0164/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0164
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Undelete methods should have "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(164, "http-body"),
25 | OnlyIf: isUndeleteMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0164/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0164
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Undelete methods should use the HTTP POST method.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(164, "http-method"),
25 | OnlyIf: isUndeleteMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0164/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0164
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Undelete messages should have a properly named request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(164, "request-message-name"),
25 | OnlyIf: isUndeleteMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0164/request_name_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0164
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(164, "request-name-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isUndeleteRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0164/request_name_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0164
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | var requestNameField = &lint.MessageRule{
23 | Name: lint.NewRuleName(164, "request-name-field"),
24 | OnlyIf: isUndeleteRequestMessage,
25 | LintMessage: utils.LintFieldPresentAndSingularString("name"),
26 | }
27 |
--------------------------------------------------------------------------------
/rules/aip0164/request_name_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0164
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNameReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(164, "request-name-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isUndeleteRequestMessage(f.GetOwner()) && f.GetName() == "name"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0164/resource_expire_time_field.go:
--------------------------------------------------------------------------------
1 | package aip0164
2 |
3 | import (
4 | "github.com/googleapis/api-linter/lint"
5 | "github.com/googleapis/api-linter/rules/internal/utils"
6 | "github.com/jhump/protoreflect/desc"
7 | )
8 |
9 | // Resources supporting soft delete must have an expire_time field.
10 | var resourceExpireTimeField = &lint.MessageRule{
11 | Name: lint.NewRuleName(164, "resource-expire-time-field"),
12 | OnlyIf: func(m *desc.MessageDescriptor) bool {
13 | resource := m.GetName()
14 | return utils.FindMethod(m.GetFile(), "Undelete"+resource) != nil
15 | },
16 | LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
17 | // for backwards compatibility, do not lint on expire_time.
18 | // previously expire_time was the recommended term.
19 | if m.FindFieldByName("expire_time") != nil {
20 | return nil
21 | }
22 | if m.FindFieldByName("purge_time") != nil {
23 | return nil
24 | }
25 | return []lint.Problem{{
26 | Message: "Resources supporting soft delete must have a `google.protobuf.Timestamp purge_time` field.",
27 | Descriptor: m,
28 | }}
29 | },
30 | }
31 |
--------------------------------------------------------------------------------
/rules/aip0165/aip0165_test.go:
--------------------------------------------------------------------------------
1 | package aip0165
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0165/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Purge methods should have "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(165, "http-body"),
25 | OnlyIf: isPurgeMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0165/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Purge methods should use the HTTP POST method.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(165, "http-method"),
25 | OnlyIf: isPurgeMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0165/request_filter_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestFilterBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(165, "request-filter-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isPurgeRequestMessage(f.GetOwner()) && f.GetName() == "filter"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0165/request_filter_field.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // The Purge request message should have filter field.
23 | var requestFilterField = &lint.MessageRule{
24 | Name: lint.NewRuleName(165, "request-filter-field"),
25 | OnlyIf: isPurgeRequestMessage,
26 | LintMessage: utils.LintFieldPresentAndSingularString("filter"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0165/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Purge messages should have a properly named request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(165, "request-message-name"),
25 | OnlyIf: isPurgeMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0165/request_parent_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(165, "request-parent-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isPurgeRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0165/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(165, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isPurgeRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0165/response_purge_sample_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0165
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var responsePurgeSampleReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(165, "response-purge-sample-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isPurgeResponseMessage(f.GetOwner()) && f.GetName() == "purge_sample"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0191/aip0191_test.go:
--------------------------------------------------------------------------------
1 | package aip0191
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0192/aip0192_test.go:
--------------------------------------------------------------------------------
1 | package aip0192
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0202/aip0202.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0202 contains rules defined in https://aip.dev/202.
16 | package aip0202
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-202 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 202,
26 | stringOnlyFormat,
27 | )
28 | }
29 |
--------------------------------------------------------------------------------
/rules/aip0202/aip0202_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0202
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0203/aip0203.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0203 contains rules defined in https://aip.dev/203.
16 | package aip0203
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-203 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 203,
26 | fieldBehaviorRequired,
27 | unorderedListRepeated,
28 | resourceNameIdentifier,
29 | resourceIdentifierOnly,
30 | )
31 | }
32 |
--------------------------------------------------------------------------------
/rules/aip0203/aip0203_test.go:
--------------------------------------------------------------------------------
1 | package aip0203
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0214/aip0214.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0214 contains rules defined in https://aip.dev/214.
16 | package aip0214
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-214 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 214,
26 | resourceExpiry,
27 | ttlType,
28 | )
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0214/aip0214_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0214
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0215/aip0215.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0215 contains rules defined in https://aip.dev/215.
16 | package aip0215
17 |
18 | import (
19 | "github.com/googleapis/api-linter/lint"
20 | )
21 |
22 | // AddRules adds all of the AIP-215 rules to the provided registry.
23 | func AddRules(r lint.RuleRegistry) error {
24 | return r.Register(
25 | 215,
26 | versionedPackages,
27 | foreignTypeReference,
28 | )
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0215/aip0215_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0215
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0216/aip0216.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0216 contains rules defined in https://aip.dev/216.
16 | package aip0216
17 |
18 | import "github.com/googleapis/api-linter/lint"
19 |
20 | // AddRules accepts a register function and registers each of
21 | // this AIP's rules to it.
22 | func AddRules(r lint.RuleRegistry) error {
23 | return r.Register(
24 | 216,
25 | nesting,
26 | synonyms,
27 | valueSynonyms,
28 | stateFieldOutputOnly,
29 | )
30 | }
31 |
--------------------------------------------------------------------------------
/rules/aip0216/aip0216_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0216
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0217/aip0217.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | // Package aip0217 contains rules defined in https://aip.dev/217.
16 | package aip0217
17 |
18 | import "github.com/googleapis/api-linter/lint"
19 |
20 | // AddRules accepts a register function and registers each of
21 | // this AIP's rules to it.
22 | func AddRules(r lint.RuleRegistry) error {
23 | return r.Register(
24 | 217,
25 | returnPartialSuccessType,
26 | returnPartialSuccessWithUnreachable,
27 | synonyms,
28 | unreachableFieldType,
29 | )
30 | }
31 |
--------------------------------------------------------------------------------
/rules/aip0217/aip0217_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0217
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0231/aip0231_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0231/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Get methods should not have an HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(231, "http-body"),
25 | OnlyIf: isBatchGetMethod,
26 | LintMethod: utils.LintNoHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0231/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Get methods should use the HTTP GET verb.
23 | var httpVerb = &lint.MethodRule{
24 | Name: lint.NewRuleName(231, "http-method"),
25 | OnlyIf: isBatchGetMethod,
26 | LintMethod: utils.LintHTTPMethod("GET"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0231/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Get method should have a properly named Request message.
23 | var inputName = &lint.MethodRule{
24 | Name: lint.NewRuleName(231, "request-message-name"),
25 | OnlyIf: isBatchGetMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0231/request_names_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNamesBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(231, "request-names-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchGetRequestMessage(f.GetOwner()) && f.GetName() == "names"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0231/request_names_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNamesReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(231, "request-names-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchGetRequestMessage(f.GetOwner()) && f.GetName() == "names"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0231/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(231, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchGetRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0231/response_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0231
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Get method should have a properly named Response message.
23 | var outputName = &lint.MethodRule{
24 | Name: lint.NewRuleName(231, "response-message-name"),
25 | OnlyIf: isBatchGetMethod,
26 | LintMethod: utils.LintMethodHasMatchingResponseName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0233/aip0233_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0233
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0233/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0233
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Create methods should use "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(233, "http-body"),
25 | OnlyIf: isBatchCreateMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0233/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0233
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Create methods should use the HTTP POST verb.
23 | var httpVerb = &lint.MethodRule{
24 | Name: lint.NewRuleName(233, "http-method"),
25 | OnlyIf: isBatchCreateMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0233/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0233
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Create method should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(233, "request-message-name"),
25 | OnlyIf: isBatchCreateMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0233/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0233
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(233, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchCreateRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0233/request_requests_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0233
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestRequestsBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(233, "request-requests-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchCreateRequestMessage(f.GetOwner()) && f.GetName() == "requests"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0234/aip0234_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0234
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0234/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0234
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Update methods should use "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(234, "http-body"),
25 | OnlyIf: isBatchUpdateMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0234/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0234
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Create methods should use the HTTP POST verb.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(234, "http-method"),
25 | OnlyIf: isBatchUpdateMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0234/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0234
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Update method should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(234, "request-message-name"),
25 | OnlyIf: isBatchUpdateMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0234/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0234
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(234, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchUpdateRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0234/request_requests_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0234
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestRequestsBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(234, "request-requests-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchUpdateRequestMessage(f.GetOwner()) && f.GetName() == "requests"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0235/aip0235_test.go:
--------------------------------------------------------------------------------
1 | package aip0235
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/googleapis/api-linter/lint"
7 | )
8 |
9 | func TestAddRules(t *testing.T) {
10 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
11 | t.Errorf("AddRules got an error: %v", err)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/rules/aip0235/http_body.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Delete methods should use "*" as the HTTP body.
23 | var httpBody = &lint.MethodRule{
24 | Name: lint.NewRuleName(235, "http-body"),
25 | OnlyIf: isBatchDeleteMethod,
26 | LintMethod: utils.LintWildcardHTTPBody,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0235/http_method.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Delete methods should use the HTTP POST method.
23 | var httpMethod = &lint.MethodRule{
24 | Name: lint.NewRuleName(235, "http-method"),
25 | OnlyIf: isBatchDeleteMethod,
26 | LintMethod: utils.LintHTTPMethod("POST"),
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0235/request_message_name.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | )
21 |
22 | // Batch Delete messages should have a properly named Request message.
23 | var requestMessageName = &lint.MethodRule{
24 | Name: lint.NewRuleName(235, "request-message-name"),
25 | OnlyIf: isBatchDeleteMethod,
26 | LintMethod: utils.LintMethodHasMatchingRequestName,
27 | }
28 |
--------------------------------------------------------------------------------
/rules/aip0235/request_names_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNamesBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(235, "request-names-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchDeleteRequestMessage(f.GetOwner()) && f.GetName() == "names"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0235/request_names_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestNamesReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(235, "request-names-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchDeleteRequestMessage(f.GetOwner()) && f.GetName() == "names"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0235/request_parent_reference.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestParentReference = &lint.FieldRule{
24 | Name: lint.NewRuleName(235, "request-parent-reference"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchDeleteRequestMessage(f.GetOwner()) && f.GetName() == "parent"
27 | },
28 | LintField: utils.LintFieldResourceReference,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip0235/request_requests_behavior.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip0235
16 |
17 | import (
18 | "github.com/googleapis/api-linter/lint"
19 | "github.com/googleapis/api-linter/rules/internal/utils"
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | var requestRequestsBehavior = &lint.FieldRule{
24 | Name: lint.NewRuleName(235, "request-requests-behavior"),
25 | OnlyIf: func(f *desc.FieldDescriptor) bool {
26 | return isBatchDeleteRequestMessage(f.GetOwner()) && f.GetName() == "requests"
27 | },
28 | LintField: utils.LintRequiredField,
29 | }
30 |
--------------------------------------------------------------------------------
/rules/aip4232/aip4232_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2021 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package aip4232
16 |
17 | import (
18 | "testing"
19 |
20 | "github.com/googleapis/api-linter/lint"
21 | )
22 |
23 | func TestAddRules(t *testing.T) {
24 | if err := AddRules(lint.NewRuleRegistry()); err != nil {
25 | t.Errorf("AddRules got an error: %v", err)
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/rules/internal/data/data_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2019 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package data
16 |
17 | import "testing"
18 |
19 | // "per" is a special exception to the preposition rule, per AIP-140
20 | // (but it would be easy for a well-meaning person to add it to the set).
21 | func TestPrepositionsExcludesPer(t *testing.T) {
22 | if Prepositions.Contains("per") {
23 | t.Errorf("`per` should be an acceptable preposition.")
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/rules/internal/utils/common_proto.go:
--------------------------------------------------------------------------------
1 | // Copyright 2020 Google LLC
2 | //
3 | // Licensed under the Apache License, Version 2.0 (the "License");
4 | // you may not use this file except in compliance with the License.
5 | // You may obtain a copy of the License at
6 | //
7 | // https://www.apache.org/licenses/LICENSE-2.0
8 | //
9 | // Unless required by applicable law or agreed to in writing, software
10 | // distributed under the License is distributed on an "AS IS" BASIS,
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | // See the License for the specific language governing permissions and
13 | // limitations under the License.
14 |
15 | package utils
16 |
17 | import (
18 | "strings"
19 |
20 | "github.com/jhump/protoreflect/desc"
21 | )
22 |
23 | // IsCommonProto returns true if a proto file is considered "common".
24 | func IsCommonProto(f *desc.FileDescriptor) bool {
25 | p := f.GetPackage()
26 | for _, prefix := range []string{"google.api", "google.protobuf", "google.rpc", "google.longrunning"} {
27 | if strings.HasPrefix(p, prefix) {
28 | return true
29 | }
30 | }
31 | return false
32 | }
33 |
--------------------------------------------------------------------------------