diff --git a/docs/rules/0162/list-revisions-request-name-behavior.md b/docs/rules/0162/list-revisions-request-name-behavior.md new file mode 100644 index 000000000..6313ee2bb --- /dev/null +++ b/docs/rules/0162/list-revisions-request-name-behavior.md @@ -0,0 +1,81 @@ +--- +rule: + aip: 162 + name: [core, '0162', list-revisions-request-name-behavior] + summary: | + List Revisions requests should annotate the `name` field with `google.api.field_behavior`. +permalink: /162/list-revisions-request-name-behavior +redirect_from: + - /0162/list-revisions-request-name-behavior +--- + +# List Revisions requests: Name field behavior + +This rule enforces that all List Revisions requests have +`google.api.field_behavior` set to `REQUIRED` on their `string name` field, as +mandated in [AIP-162][]. + +## Details + +This rule looks at any message matching `List*RevisionsRequest` and complains if +the `name` field does not have a `google.api.field_behavior` annotation with a +value of `REQUIRED`. + +## Examples + +**Incorrect** code for this rule: + +```proto +// Incorrect. +message ListBookRevisionsRequest { + // The `google.api.field_behavior` annotation should also be included. + string name = 1 [ + (google.api.resource_reference).type = "library.googleapis.com/Book" + ]; + + int32 page_size = 2; + + string page_token = 3; +} +``` + +**Correct** code for this rule: + +```proto +// Correct. +message ListBookRevisionsRequest { + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference).type = "library.googleapis.com/Book" + ]; + + int32 page_size = 2; + + string page_token = 3; +} +``` + +## Disabling + +If you need to violate this rule, use a leading comment above the field. +Remember to also include an [aip.dev/not-precedent][] comment explaining why. + +```proto +message ListBookRevisionsRequest { + // (-- api-linter: core::0162::list-revisions-request-name-behavior=disabled + // aip.dev/not-precedent: We need to do this because reasons. --) + string name = 1 [ + (google.api.resource_reference).type = "library.googleapis.com/Book" + ]; + + int32 page_size = 2; + + string page_token = 3; +} +``` + +If you need to violate this rule for an entire file, place the comment at the +top of the file. + +[aip-162]: https://aip.dev/162 +[aip.dev/not-precedent]: https://aip.dev/not-precedent diff --git a/rules/aip0162/aip0162.go b/rules/aip0162/aip0162.go index ce70473bd..bb631d04e 100644 --- a/rules/aip0162/aip0162.go +++ b/rules/aip0162/aip0162.go @@ -46,6 +46,7 @@ func AddRules(r lint.RuleRegistry) error { listRevisionsHTTPMethod, listRevisionsHTTPURISuffix, listRevisionsRequestMessageName, + listRevisionsRequestNameBehavior, listRevisionsRequestNameField, listRevisionsRequestNoOrderByField, listRevisionsResponseMessageName, diff --git a/rules/aip0162/list_revisions_request_name_behavior.go b/rules/aip0162/list_revisions_request_name_behavior.go new file mode 100644 index 000000000..6449589a0 --- /dev/null +++ b/rules/aip0162/list_revisions_request_name_behavior.go @@ -0,0 +1,29 @@ +// Copyright 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package aip0162 + +import ( + "github.com/googleapis/api-linter/lint" + "github.com/googleapis/api-linter/rules/internal/utils" + "github.com/jhump/protoreflect/desc" +) + +var listRevisionsRequestNameBehavior = &lint.FieldRule{ + Name: lint.NewRuleName(162, "list-revisions-request-name-behavior"), + OnlyIf: func(f *desc.FieldDescriptor) bool { + return IsListRevisionsRequestMessage(f.GetOwner()) && f.GetName() == "name" + }, + LintField: utils.LintRequiredField, +} diff --git a/rules/aip0162/list_revisions_request_name_behavior_test.go b/rules/aip0162/list_revisions_request_name_behavior_test.go new file mode 100644 index 000000000..5d6d8b31a --- /dev/null +++ b/rules/aip0162/list_revisions_request_name_behavior_test.go @@ -0,0 +1,49 @@ +// Copyright 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package aip0162 + +import ( + "testing" + + "github.com/googleapis/api-linter/rules/internal/testutils" +) + +func TestListRevisionsRequestNameBehavior(t *testing.T) { + for _, test := range []struct { + name string + RPC string + Field string + FieldOpts string + problems testutils.Problems + }{ + {"Valid", "ListBookRevisions", "name", " [(google.api.field_behavior) = REQUIRED]", nil}, + {"Missing", "ListBookRevisions", "name", "", testutils.Problems{{Message: "(google.api.field_behavior) = REQUIRED"}}}, + {"IrrelevantMessage", "ListBooks", "name", "", nil}, + {"IrrelevantField", "ListBookRevisions", "something_else", "", nil}, + } { + t.Run(test.name, func(t *testing.T) { + f := testutils.ParseProto3Tmpl(t, ` + import "google/api/field_behavior.proto"; + message {{.RPC}}Request { + string {{.Field}} = 1{{.FieldOpts}}; + } + `, test) + field := f.GetMessageTypes()[0].GetFields()[0] + if diff := test.problems.SetDescriptor(field).Diff(listRevisionsRequestNameBehavior.Lint(f)); diff != "" { + t.Error(diff) + } + }) + } +}