Fixes against AEPC

docs/rules/0132/request-unknown-fields.md

@@ -19,7 +19,7 @@ This rule looks at any message matching `List*Request` and complains if it
 comes across any fields other than:
 
 - `string parent` ([AEP-132][])
-- `int32 page_size` ([AEP-158][])
+- `int32 max_page_size` ([AEP-158][])
 - `string page_token` ([AEP-158][])
 - `int32 skip` ([AEP-158][])
 - `string filter` ([AEP-132][])
@@ -41,7 +41,7 @@ handled by other rules, such as
 // Incorrect.
 message ListBooksRequest {
   string parent = 1;
-  int32 page_size = 2;
+  int32  max_page_size = 2;
   string page_token = 3;
   string library_id = 4;  // Non-standard field.
 }
@@ -53,7 +53,7 @@ message ListBooksRequest {
 // Correct.
 message ListBooksRequest {
   string parent = 1;
-  int32 page_size = 2;
+  int32  max_page_size = 2;
   string page_token = 3;
 }
 ```
@@ -66,7 +66,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why.
 ```proto
 message ListBooksRequest {
   string parent = 1;
-  int32 page_size = 2;
+  int32  max_page_size = 2;
   string page_token = 3;
 
   // (-- api-linter: core::0132::request-unknown-fields=disabled

docs/rules/0132/response-unknown-fields.md

@@ -33,7 +33,7 @@ repeated-ness.
 ```proto
 // Incorrect.
 message ListBooksResponse {
-  repeated Book books = 1;
+  repeated Book results = 1;
   string next_page_token = 2;
   string publisher_id = 3;  // Unrecognized field.
 }
@@ -44,7 +44,7 @@ message ListBooksResponse {
 ```proto
 // Correct.
 message ListBooksResponse {
-  repeated Book books = 1;
+  repeated Book results = 1;
   string next_page_token = 2;
 }
 ```
@@ -56,7 +56,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why.
 
 ```proto
 message ListBooksResponse {
-  repeated Book books = 1;
+  repeated Book results = 1;
   string next_page_token = 2;
   // (-- api-linter: core::0132::response-unknown-fields=disabled
   //     aep.dev/not-precedent: We really need this field because reasons. --)

docs/rules/0134/http-uri-path.md

@@ -30,7 +30,7 @@ separation uses `snake_case`.
 // Incorrect.
 rpc UpdateBookRequest(UpdateBookRequest) returns (Book) {
   option (google.api.http) = {
-    post: "/v1/{path=publishers/*/books/*}"  // Should be `book.path`.
+    post: "/v1/{book.path=publishers/*/books/*}"  // Should be `path`
     body: "book"
   };
 }
@@ -42,7 +42,7 @@ rpc UpdateBookRequest(UpdateBookRequest) returns (Book) {
 // Correct.
 rpc UpdateBookRequest(UpdateBookRequest) returns (Book) {
   option (google.api.http) = {
-    post: "/v1/{book.path=publishers/*/books/*}"
+    post: "/v1/{path=publishers/*/books/*}"
     body: "book"
   };
 }
@@ -58,7 +58,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why.
 //     aep.dev/not-precedent: We need to do this because reasons. --)
 rpc UpdateBookRequest(UpdateBookRequest) returns (Book) {
   option (google.api.http) = {
-    post: "/v1/{path=publishers/*/books/*}"
+    post: "/v1/{book.path=publishers/*/books/*}"
     body: "book"
   };
 }

docs/rules/0134/request-required-fields.md

@@ -38,8 +38,9 @@ message UpdateBookRequest {
 ```proto
 // Correct.
 message UpdateBookRequest {
-  Book book = 1 [(google.api.field_behavior) = REQUIRED];
-  bool allow_missing = 2 [(google.api.field_behavior) = OPTIONAL];
+  string path = 1 [(google.api.field_behavior) = REQUIRED];
+  Book book = 2 [(google.api.field_behavior) = REQUIRED];
+  bool allow_missing = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 ```
 

rules/aep0132/request_unknown_fields.go

@@ -23,7 +23,7 @@ import (
 
 var allowedFields = stringset.New(
 	"parent",       // AEP-132
-	"page_size",    // AEP-158
+	"max_page_size",    // AEP-158
 	"page_token",   // AEP-158
 	"skip",         // AEP-158
 	"filter",       // AEP-132

rules/aep0132/request_unknown_fields_test.go

@@ -38,7 +38,7 @@ func TestUnknownFields(t *testing.T) {
 		fieldType   *builder.FieldType
 		problems    testutils.Problems
 	}{
-		{"PageSize", "ListBooksRequest", "page_size", builder.FieldTypeInt32(), testutils.Problems{}},
+		{"PageSize", "ListBooksRequest", "max_page_size", builder.FieldTypeInt32(), testutils.Problems{}},
 		{"PageToken", "ListBooksRequest", "page_token", builder.FieldTypeString(), testutils.Problems{}},
 		{"Skip", "ListBooksRequest", "skip", builder.FieldTypeInt32(), testutils.Problems{}},
 		{"Filter", "ListBooksRequest", "filter", builder.FieldTypeString(), testutils.Problems{}},

rules/aep0132/response_unknown_fields.go

@@ -15,8 +15,6 @@
 package aep0132
 
 import (
-	"strings"
-
 	"bitbucket.org/creachadair/stringset"
 	"github.com/aep-dev/api-linter/lint"
 	"github.com/aep-dev/api-linter/rules/internal/utils"
@@ -26,6 +24,7 @@ import (
 // The resource itself is not included here, but also permitted.
 // This is covered in code in the rule itself.
 var respAllowedFields = stringset.New(
+	"results",
 	"max_page_size",         // AEP-132
 	"next_page_token",       // AEP-158
 	"total_size",            // AEP-132
@@ -40,20 +39,6 @@ var responseUnknownFields = &lint.FieldRule{
 		return utils.IsListResponseMessage(f.GetOwner())
 	},
 	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
-		// A repeated variant of the resource should be permitted.
-		resource := utils.ListResponseResourceName(f.GetOwner())
-		if strings.HasSuffix(resource, "_revisions") {
-			// This is an AEP-162 ListFooRevisions response, which is subtly
-			// different from an AEP-132 List response. We need to modify the RPC
-			// name to what the AEP-132 List response would be in order to permit
-			// the resource field properly.
-			resource = utils.ToPlural(strings.TrimSuffix(resource, "_revisions"))
-		}
-		if f.GetName() == resource {
-			return nil
-		}
-
-		// It is not the resource field; check it against the whitelist.
 		if !respAllowedFields.Contains(f.GetName()) {
 			return []lint.Problem{{
 				Message:    "List responses should only contain fields explicitly described in AEPs.",

rules/aep0132/response_unknown_fields_test.go

@@ -28,22 +28,23 @@ func TestResponseUnknownFields(t *testing.T) {
 		problems    testutils.Problems
 	}{
 		{"ListBooksResponse", "total_size", nil},
+		{"ListBooksResponse", "results", nil},
 		{"ListBooksResponse", "max_page_size", nil},
 		{"ListBooksResponse", "unreachable", nil},
 		{"ListBooksResponse", "unreachable_locations", nil},
 		{"ListBookRevisionsResponse", "total_size", nil},
 		{"ListBooksResponse", "extra", testutils.Problems{{Message: "List responses"}}},
+		{"ListBooksResponse", "books", testutils.Problems{{Message: "List responses"}}},
 	} {
 		t.Run(strcase.UpperCamelCase(test.FieldName), func(t *testing.T) {
 			f := testutils.ParseProto3Tmpl(t, `
 				message {{.MessageName}} {
-					repeated Book books = 1;
-					string next_page_token = 2;
-					string {{.FieldName}} = 3;
+					string next_page_token = 1;
+					string {{.FieldName}} = 2;
 				}
 				message Book {}
 			`, test)
-			field := f.GetMessageTypes()[0].GetFields()[2]
+			field := f.GetMessageTypes()[0].GetFields()[1]
 			if diff := test.problems.SetDescriptor(field).Diff(responseUnknownFields.Lint(f)); diff != "" {
 				t.Error(diff)
 			}

rules/aep0134/http_uri_path.go

@@ -15,12 +15,9 @@
 package aep0134
 
 import (
-	"fmt"
-
 	"github.com/aep-dev/api-linter/lint"
 	"github.com/aep-dev/api-linter/rules/internal/utils"
 	"github.com/jhump/protoreflect/desc"
-	"github.com/stoewer/go-strcase"
 )
 
 // Update methods should have a proper HTTP pattern.
@@ -29,8 +26,6 @@ var httpNameField = &lint.MethodRule{
 	RuleType: lint.NewRuleType(lint.MustRule),
 	OnlyIf:   utils.IsUpdateMethod,
 	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
-		fieldName := strcase.SnakeCase(m.GetName()[6:])
-		want := fmt.Sprintf("%s.path", fieldName)
-		return utils.LintHTTPURIHasVariable(m, want)
+		return utils.LintHTTPURIHasVariable(m, "path")
 	},
 }

rules/aep0134/http_uri_path_test.go

@@ -27,32 +27,34 @@ func TestHttpNameField(t *testing.T) {
 		MethodName string
 		problems   testutils.Problems
 	}{
-		{"Valid", "/v1/{big_book.path=publishers/*/books/*}", "UpdateBigBook", nil},
-		{"ValidWithNumber", "/v1/{dv360.path=publishers/*/dv360s/*}", "UpdateDv360", nil},
+		{
+			"InvalidWithExtraName", "/v1/{big_book.path=publishers/*/books/*}",
+			"UpdateBigBook",
+			testutils.Problems{{Message: "`path`"}},
+		},
+		{"InvalidWithNumber", "/v1/{dv360.path=publishers/*/dv360s/*}", "UpdateDv360", testutils.Problems{{Message: "`path`"}}},
 		{
 			"InvalidNoUnderscore", "/v1/{bigbook.path=publishers/*/books/*}",
 			"UpdateBigBook",
-			testutils.Problems{{Message: "`big_book.path`"}},
+			testutils.Problems{{Message: "`path`"}},
 		},
 		{
 			"InvalidVarNameBook", "/v1/{big_book=publishers/*/books/*}",
 			"UpdateBigBook",
-			testutils.Problems{{Message: "`big_book.path`"}},
+			testutils.Problems{{Message: "`path`"}},
 		},
 		{
-			"InvalidVarNameName", "/v1/{path=publishers/*/books/*}",
-			"UpdateBigBook",
-			testutils.Problems{{Message: "`big_book.path`"}},
+			"Valid", "/v1/{path=publishers/*/books/*}", "UpdateBigBook", nil,
 		},
 		{
 			"InvalidVarNameReversed", "/v1/{path.big_book=publishers/*/books/*}",
 			"UpdateBigBook",
-			testutils.Problems{{Message: "`big_book.path`"}},
+			testutils.Problems{{Message: "`path`"}},
 		},
 		{
 			"NoVarName", "/v1/publishers/*/books/*",
 			"UpdateBigBook",
-			testutils.Problems{{Message: "`big_book.path`"}},
+			testutils.Problems{{Message: "`path`"}},
 		},
 		{
 			"Irrelevant", "/v1/{book=publishers/*/books/*}",

rules/aep0134/request_path_required.go

@@ -24,7 +24,7 @@ import (
 
 var requestPathRequired = &lint.MessageRule{
 	Name:   lint.NewRuleName(134, "request-path-required"),
-	OnlyIf: utils.IsListRequestMessage,
+	OnlyIf: utils.IsUpdateRequestMessage,
 	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
 		if m.FindFieldByName("path") == nil {
 			return []lint.Problem{{

rules/aep0134/request_path_required_test.go

@@ -28,8 +28,8 @@ func TestRequestNameRequired(t *testing.T) {
 		FieldName   string
 		problems    testutils.Problems
 	}{
-		{"Valid", "ListBookRequest", "path", nil},
-		{"InvalidName", "ListBookRequest", "id", testutils.Problems{{Message: "path"}}},
+		{"Valid", "UpdateBookRequest", "path", nil},
+		{"InvalidName", "UpdateBookRequest", "id", testutils.Problems{{Message: "path"}}},
 		{"Irrelevant", "RemoveBookRequest", "id", nil},
 	}
 

rules/aep0134/request_required_fields.go

@@ -32,7 +32,7 @@ var requestRequiredFields = &lint.MethodRule{
 		ot := utils.GetResponseType(m)
 		it := m.GetInputType()
 
-		allowedRequiredFields := stringset.New("update_mask")
+		allowedRequiredFields := stringset.New("update_mask", "path")
 
 		for _, f := range it.GetFields() {
 			if !utils.GetFieldBehavior(f).Contains("REQUIRED") {

rules/aep0134/request_resource_field_test.go

@@ -30,6 +30,7 @@ func TestResourceField(t *testing.T) {
 		problems          testutils.Problems
 	}{
 		{"Valid", "UpdateBookRequest", "Book", "book", nil},
+		{"Valid", "UpdateBookRequest", "string", "path", nil},
 		{"InvalidFieldName", "UpdateBookRequest", "Book", "big_book", testutils.Problems{{Suggestion: "book"}}},
 		{"IrrelevantMessage", "ModifyBookRequest", "Book", "big_book", nil},
 		{"IrrelevantFieldType", "UpdateBookRequest", "string", "big_book", nil},

rules/aep0136/aep0136.go

@@ -51,7 +51,7 @@ func isCustomMethod(m *desc.MethodDescriptor) bool {
 
 	// Methods with no `:` in the URI are standard methods if they begin with
 	// one of the standard method names.
-	for _, prefix := range []string{"Get", "List", "Create", "Update", "Delete", "Replace"} {
+	for _, prefix := range []string{"Get", "List", "Create", "Update", "Delete", "Replace", "Apply"} {
 		if strings.HasPrefix(m.GetName(), prefix) {
 			return false
 		}