From a930c33bd51d0b26343c5696947edaa181775557 Mon Sep 17 00:00:00 2001 From: Alex Stephen Date: Tue, 4 Nov 2025 22:51:40 +0530 Subject: [PATCH] Change docs --- docs/rules/0004/resource-reference-type.md | 8 ++------ docs/rules/0121/no-mutable-cycles.md | 12 ++++++------ docs/rules/0122/resource-reference-type.md | 12 +++--------- docs/rules/0124/reference-same-package.md | 12 +++--------- docs/rules/0127/http-template-pattern.md | 4 ++-- docs/rules/0131/request-path-behavior.md | 10 +++------- docs/rules/0131/request-path-reference-type.md | 6 +++--- docs/rules/0131/request-path-reference.md | 2 +- docs/rules/0131/request-path-required.md | 6 +++--- docs/rules/0131/request-required-fields.md | 12 +++--------- docs/rules/0132/request-parent-behavior.md | 10 +++------- docs/rules/0132/request-parent-reference.md | 2 +- docs/rules/0132/request-parent-valid-reference.md | 6 +++--- docs/rules/0132/request-required-fields.md | 15 ++++++--------- docs/rules/0133/request-id-field.md | 12 +++--------- docs/rules/0133/request-parent-behavior.md | 10 +++------- docs/rules/0133/request-resource-behavior.md | 6 +++--- docs/rules/0135/force-field.md | 6 +++--- docs/rules/0135/request-force-field.md | 6 +++--- docs/rules/0135/request-path-behavior.md | 10 +++------- docs/rules/0135/request-path-reference.md | 2 +- docs/rules/0157/request-read-mask-field.md | 6 +++--- docs/rules/0158/request-skip-field.md | 6 +++--- docs/rules/0162/commit-request-name-behavior.md | 6 +++--- docs/rules/0162/commit-request-name-field.md | 6 +++--- docs/rules/0162/commit-request-name-reference.md | 2 +- .../0162/delete-revision-request-name-behavior.md | 6 +++--- .../0162/delete-revision-request-name-field.md | 6 +++--- .../delete-revision-request-name-reference.md | 2 +- docs/rules/0162/rollback-request-name-behavior.md | 6 +++--- docs/rules/0162/rollback-request-name-field.md | 6 +++--- .../rules/0162/rollback-request-name-reference.md | 2 +- .../0162/rollback-request-revision-id-behavior.md | 6 +++--- .../0162/rollback-request-revision-id-field.md | 8 ++++---- .../0162/tag-revision-request-name-behavior.md | 6 +++--- .../rules/0162/tag-revision-request-name-field.md | 6 +++--- .../0162/tag-revision-request-name-reference.md | 2 +- .../0162/tag-revision-request-tag-behavior.md | 6 +++--- docs/rules/0162/tag-revision-request-tag-field.md | 8 ++++---- docs/rules/0164/request-name-behavior.md | 10 +++------- docs/rules/0164/request-name-field.md | 2 +- docs/rules/0164/request-name-reference.md | 2 +- docs/rules/0164/request-unknown-fields.md | 6 +++--- 43 files changed, 117 insertions(+), 168 deletions(-) diff --git a/docs/rules/0004/resource-reference-type.md b/docs/rules/0004/resource-reference-type.md index d0629e3..01882f7 100644 --- a/docs/rules/0004/resource-reference-type.md +++ b/docs/rules/0004/resource-reference-type.md @@ -33,9 +33,7 @@ message Book { string path = 1; // This is not a resource reference; the annotation does not belong. - Author author = 2 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Author" - }]; + Author author = 2 [(aep.api.field_info).resource_reference = "library.googleapis.com/Author"]; } ``` @@ -55,9 +53,7 @@ message Book { message Book { string path = 1; - string author = 2 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Author" - }]; + string author = 2 [(aep.api.field_info).resource_reference = "library.googleapis.com/Author"]; } ``` diff --git a/docs/rules/0121/no-mutable-cycles.md b/docs/rules/0121/no-mutable-cycles.md index 91adaa2..5caad86 100644 --- a/docs/rules/0121/no-mutable-cycles.md +++ b/docs/rules/0121/no-mutable-cycles.md @@ -33,7 +33,7 @@ message Book { // Incorrect. Creates potential reference cycle. string author = 2 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Author" + (aep.api.field_info).resource_reference = "library.googleapis.com/Author" ]; } @@ -47,7 +47,7 @@ message Author { // Incorrect. Creates potential reference cycle. string book = 2 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -65,7 +65,7 @@ message Book { // Correct because the other reference is OUTPUT_ONLY. string author = 2 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Author" + (aep.api.field_info).resource_reference = "library.googleapis.com/Author" ]; } @@ -79,7 +79,7 @@ message Author { // Correct because an OUTPUT_ONLY reference breaks the mutation cycle. string book = 2 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_OUTPUT_ONLY ]; } @@ -102,7 +102,7 @@ message Book { // (-- api-linter: core::0121::no-mutable-cycles=disabled // aep.dev/not-precedent: We need to do this because reasons. --) string author = 2 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Author" + (aep.api.field_info).resource_reference = "library.googleapis.com/Author" ]; } @@ -117,7 +117,7 @@ message Author { // (-- api-linter: core::0121::no-mutable-cycles=disabled // aep.dev/not-precedent: We need to do this because reasons. --) string book = 2 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0122/resource-reference-type.md b/docs/rules/0122/resource-reference-type.md index 4c0b653..5d4cd2c 100644 --- a/docs/rules/0122/resource-reference-type.md +++ b/docs/rules/0122/resource-reference-type.md @@ -28,9 +28,7 @@ message Book { string path = 1; // Resource references should be strings. - Author author = 2 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Author" - }]; + Author author = 2 [(aep.api.field_info).resource_reference = "library.googleapis.com/Author"]; } ``` @@ -41,9 +39,7 @@ message Book { message Book { string path = 1; - string author = 2 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Author" - }]; + string author = 2 [(aep.api.field_info).resource_reference = "library.googleapis.com/Author"]; } ``` @@ -69,9 +65,7 @@ message Book { // (-- api-linter: core::0122::resource-reference-type=disabled // aep.dev/not-precedent: We need to do this because reasons. --) - Author author = 2 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Author" - }]; + Author author = 2 [(aep.api.field_info).resource_reference = "library.googleapis.com/Author"]; } ``` diff --git a/docs/rules/0124/reference-same-package.md b/docs/rules/0124/reference-same-package.md index 8c9d820..ddf29f5 100644 --- a/docs/rules/0124/reference-same-package.md +++ b/docs/rules/0124/reference-same-package.md @@ -46,9 +46,7 @@ message Book { package google.example.libray.v1; // Typo: Different package. message GetBookRequest { - string name = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" // Lint warning: package mismatch. - }]; + string name = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; // Lint warning: package mismatch. } ``` @@ -70,9 +68,7 @@ message Book { } message GetBookRequest { - string name = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string name = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` @@ -98,9 +94,7 @@ package google.example.library.v1; message GetBookRequest { // (-- api-linter: core::0124::reference-same-package=disabled // aep.dev/not-precedent: We need to do this because reasons. --) - string name = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string name = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` diff --git a/docs/rules/0127/http-template-pattern.md b/docs/rules/0127/http-template-pattern.md index d19432f..2366ad8 100644 --- a/docs/rules/0127/http-template-pattern.md +++ b/docs/rules/0127/http-template-pattern.md @@ -36,7 +36,7 @@ rpc GetBook(GetBookRequest) returns (Book) { } message GetBookRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } message Book { @@ -61,7 +61,7 @@ rpc GetBook(GetBookRequest) returns (Book) { } message GetBookRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } message Book { diff --git a/docs/rules/0131/request-path-behavior.md b/docs/rules/0131/request-path-behavior.md index 7737def..0da8d01 100644 --- a/docs/rules/0131/request-path-behavior.md +++ b/docs/rules/0131/request-path-behavior.md @@ -29,9 +29,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. // Incorrect. message GetBookRequest { // The `aep.api.field_behavior` annotation should also be included. - string path = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string path = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` @@ -42,7 +40,7 @@ message GetBookRequest { message GetBookRequest { string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -56,9 +54,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message GetBookRequest { // (-- api-linter: core::0131::request-path-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) - string path = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string path = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` diff --git a/docs/rules/0131/request-path-reference-type.md b/docs/rules/0131/request-path-reference-type.md index 34b5703..7c9692c 100644 --- a/docs/rules/0131/request-path-reference-type.md +++ b/docs/rules/0131/request-path-reference-type.md @@ -33,7 +33,7 @@ message GetBookRequest { // reference. string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.child_type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book" ]; } ``` @@ -45,7 +45,7 @@ message GetBookRequest { message GetBookRequest { string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -61,7 +61,7 @@ message GetBookRequest { // aep.dev/not-precedent: We need to do this because reasons. --) string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.child_type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0131/request-path-reference.md b/docs/rules/0131/request-path-reference.md index 9fb0c5d..fc44dd6 100644 --- a/docs/rules/0131/request-path-reference.md +++ b/docs/rules/0131/request-path-reference.md @@ -39,7 +39,7 @@ message GetBookRequest { message GetBookRequest { string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0131/request-path-required.md b/docs/rules/0131/request-path-required.md index 6df934c..bad4299 100644 --- a/docs/rules/0131/request-path-required.md +++ b/docs/rules/0131/request-path-required.md @@ -27,7 +27,7 @@ the `path` field is missing. message GetBookRequest { string book = 1 [ // Field path should be `path`. (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -39,7 +39,7 @@ message GetBookRequest { message GetBookRequest { string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -55,7 +55,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message GetBookRequest { string book = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0131/request-required-fields.md b/docs/rules/0131/request-required-fields.md index bca81dc..755488e 100644 --- a/docs/rules/0131/request-required-fields.md +++ b/docs/rules/0131/request-required-fields.md @@ -31,9 +31,7 @@ message GetBookRequest { // Format: publishers/{publisher}/books/{book} string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + (aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; // Non-standard required field. google.protobuf.FieldMask read_mask = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -49,9 +47,7 @@ message GetBookRequest { // Format: publishers/{publisher}/books/{book} string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + (aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; google.protobuf.FieldMask read_mask = 2 [(aep.api.field_info).field_behavior = OPTIONAL]; } @@ -68,9 +64,7 @@ message GetBookRequest { // Format: publishers/{publisher}/books/{book} string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + (aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; // (-- api-linter: core::0131::request-required-fields=disabled // aep.dev/not-precedent: We really need this field to be required because diff --git a/docs/rules/0132/request-parent-behavior.md b/docs/rules/0132/request-parent-behavior.md index b457158..150dbb0 100644 --- a/docs/rules/0132/request-parent-behavior.md +++ b/docs/rules/0132/request-parent-behavior.md @@ -29,9 +29,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. // Incorrect. message ListBooksRequest { // The `aep.api.field_behavior` annotation should also be included. - string parent = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Publisher" - }]; + string parent = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; int32 page_size = 2; string page_token = 3; } @@ -44,7 +42,7 @@ message ListBooksRequest { message ListBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher" + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher" ]; int32 page_size = 2; string page_token = 3; @@ -60,9 +58,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. // (-- api-linter: core::0132::request-parent-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) message ListBooksRequest { - string parent = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Publisher" - }]; + string parent = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; int32 page_size = 2; string page_token = 3; } diff --git a/docs/rules/0132/request-parent-reference.md b/docs/rules/0132/request-parent-reference.md index 8f3ace2..dc0dbe6 100644 --- a/docs/rules/0132/request-parent-reference.md +++ b/docs/rules/0132/request-parent-reference.md @@ -41,7 +41,7 @@ message ListBooksRequest { message ListBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher" + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher" ]; int32 page_size = 2; string page_token = 3; diff --git a/docs/rules/0132/request-parent-valid-reference.md b/docs/rules/0132/request-parent-valid-reference.md index de5c147..5ebb1f5 100644 --- a/docs/rules/0132/request-parent-valid-reference.md +++ b/docs/rules/0132/request-parent-valid-reference.md @@ -33,7 +33,7 @@ message ListBooksRequest { // being listed. string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; int32 page_size = 2; string page_token = 3; @@ -47,7 +47,7 @@ message ListBooksRequest { message ListBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.child_type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book" ]; int32 page_size = 2; string page_token = 3; @@ -65,7 +65,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message ListBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0132/request-required-fields.md b/docs/rules/0132/request-required-fields.md index fc30d21..1a4394f 100644 --- a/docs/rules/0132/request-required-fields.md +++ b/docs/rules/0132/request-required-fields.md @@ -31,9 +31,8 @@ message ListBooksRequest { // Format: publishers/{publisher} string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference = { - child_type: "library.googleapis.com/Book" - }]; + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book" + ]; // Non-standard required field. int32 page_size = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED] @@ -49,9 +48,8 @@ message ListBooksRequest { // Format: publishers/{publisher} string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference = { - child_type: "library.googleapis.com/Book" - }]; + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book" + ]; int32 page_size = 2 [(aep.api.field_info).field_behavior = OPTIONAL] } @@ -68,9 +66,8 @@ message ListBooksRequest { // Format: publishers/{publisher} string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference = { - child_type: "library.googleapis.com/Book" - }]; + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book" + ]; // (-- api-linter: core::0132::request-required-fields=disabled // aep.dev/not-precedent: We really need this field to be required because diff --git a/docs/rules/0133/request-id-field.md b/docs/rules/0133/request-id-field.md index 726cc3f..d5487a8 100644 --- a/docs/rules/0133/request-id-field.md +++ b/docs/rules/0133/request-id-field.md @@ -25,9 +25,7 @@ it lacks a client-specified ID (e.g. `string book_id`) field. ```proto // Incorrect. message CreateBookRequest { - string parent = 1 [(aep.api.field_info).resource_reference = { - child_type: "library.googleapis.com/Book" - }]; + string parent = 1 [(aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book"]; Book book = 2; @@ -40,9 +38,7 @@ message CreateBookRequest { ```proto // Correct. message CreateBookRequest { - string parent = 1 [(aep.api.field_info).resource_reference = { - child_type: "library.googleapis.com/Book" - }]; + string parent = 1 [(aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book"]; string id = 2; @@ -60,9 +56,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. // (-- api-linter: core::0133::request-id-field=disabled // aep.dev/not-precedent: We need to do this because reasons. --) message CreateBookRequest { - string parent = 1 [(aep.api.field_info).resource_reference = { - child_type: "library.googleapis.com/Book" - }]; + string parent = 1 [(aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book"]; Book book = 2; } diff --git a/docs/rules/0133/request-parent-behavior.md b/docs/rules/0133/request-parent-behavior.md index 74ed314..21a4e31 100644 --- a/docs/rules/0133/request-parent-behavior.md +++ b/docs/rules/0133/request-parent-behavior.md @@ -29,9 +29,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. // Incorrect. message CreateBooksRequest { // The `aep.api.field_behavior` annotation should also be included. - string parent = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Publisher" - }]; + string parent = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; Book book = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; } ``` @@ -43,7 +41,7 @@ message CreateBooksRequest { message CreateBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher" + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher" ]; Book book = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; } @@ -58,9 +56,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message CreateBooksRequest { // (-- api-linter: core::0133::request-parent-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) - string parent = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Publisher" - }]; + string parent = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; Book book = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; } ``` diff --git a/docs/rules/0133/request-resource-behavior.md b/docs/rules/0133/request-resource-behavior.md index f534691..cb9f162 100644 --- a/docs/rules/0133/request-resource-behavior.md +++ b/docs/rules/0133/request-resource-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message CreateBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher" + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher" ]; Book book = 2; // Should also have (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED. } @@ -43,7 +43,7 @@ message CreateBooksRequest { message CreateBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher" + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher" ]; Book book = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; } @@ -58,7 +58,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message CreateBooksRequest { string parent = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher" + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher" ]; // (-- api-linter: core::0133::request-resource-behavior=disabled diff --git a/docs/rules/0135/force-field.md b/docs/rules/0135/force-field.md index 2b20b51..0ddc190 100644 --- a/docs/rules/0135/force-field.md +++ b/docs/rules/0135/force-field.md @@ -29,7 +29,7 @@ missing. message DeletePublisherRequest { // Where Publisher parents the Book resource. string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher"]; + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; // Missing `bool force` field. } @@ -42,7 +42,7 @@ message DeletePublisherRequest { message DeletePublisherRequest { // Where Publisher parents the Book resource. string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher"]; + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; // If set to true, any books from this publisher will also be deleted. // (Otherwise, the request will only work if the publisher has no books.) @@ -62,7 +62,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message DeletePublisherRequest { // Where Publisher parents the Book resource. string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher"]; + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher"]; } ``` diff --git a/docs/rules/0135/request-force-field.md b/docs/rules/0135/request-force-field.md index 70f30b5..f09855a 100644 --- a/docs/rules/0135/request-force-field.md +++ b/docs/rules/0135/request-force-field.md @@ -25,7 +25,7 @@ field and complains if the field is not a singular `bool`. ```proto message DeletePublisherRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher", + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; @@ -38,7 +38,7 @@ message DeletePublisherRequest { ```proto message DeletePublisherRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher", + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; @@ -54,7 +54,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. ```proto message DeletePublisherRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Publisher", + (aep.api.field_info).resource_reference = "library.googleapis.com/Publisher", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; diff --git a/docs/rules/0135/request-path-behavior.md b/docs/rules/0135/request-path-behavior.md index 584eea9..3582d68 100644 --- a/docs/rules/0135/request-path-behavior.md +++ b/docs/rules/0135/request-path-behavior.md @@ -29,9 +29,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. // Incorrect. message DeleteBookRequest { // The `aep.api.field_behavior` annotation should also be included. - string path = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string path = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` @@ -42,7 +40,7 @@ message DeleteBookRequest { message DeleteBookRequest { string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -56,9 +54,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message DeleteBookRequest { // (-- api-linter: core::0135::request-path-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) - string path = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string path = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` diff --git a/docs/rules/0135/request-path-reference.md b/docs/rules/0135/request-path-reference.md index d5ae46d..a10b6b9 100644 --- a/docs/rules/0135/request-path-reference.md +++ b/docs/rules/0135/request-path-reference.md @@ -39,7 +39,7 @@ message DeleteBookRequest { message DeleteBookRequest { string path = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0157/request-read-mask-field.md b/docs/rules/0157/request-read-mask-field.md index b57aeb9..f32a479 100644 --- a/docs/rules/0157/request-read-mask-field.md +++ b/docs/rules/0157/request-read-mask-field.md @@ -26,7 +26,7 @@ field, and complains if the field is not a singular `google.protobuf.FieldMask`. // Incorrect. message GetBookRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; @@ -41,7 +41,7 @@ message GetBookRequest { // Correct. message GetBookRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; @@ -57,7 +57,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. ```proto message GetBookRequest { string path = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; diff --git a/docs/rules/0158/request-skip-field.md b/docs/rules/0158/request-skip-field.md index 17d133e..88bb632 100644 --- a/docs/rules/0158/request-skip-field.md +++ b/docs/rules/0158/request-skip-field.md @@ -25,7 +25,7 @@ contains a `skip` field, and complains if the field is not a singular `int32`. ```proto message ListBooksRequest { string parent = 1 [ - (aep.api.field_info).resource_reference.child_type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; @@ -42,7 +42,7 @@ message ListBooksRequest { ```proto message ListBooksRequest { string parent = 1 [ - (aep.api.field_info).resource_reference.child_type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; @@ -62,7 +62,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. ```proto message ListBooksRequest { string parent = 1 [ - (aep.api.field_info).resource_reference.child_type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference_child_type = "library.googleapis.com/Book", (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED ]; diff --git a/docs/rules/0162/commit-request-name-behavior.md b/docs/rules/0162/commit-request-name-behavior.md index aef80e7..4afdabd 100644 --- a/docs/rules/0162/commit-request-name-behavior.md +++ b/docs/rules/0162/commit-request-name-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message CommitBookRequest { // The `aep.api.field_behavior` annotation should also be included. string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -42,7 +42,7 @@ message CommitBookRequest { message CommitBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -57,7 +57,7 @@ message CommitBookRequest { // (-- api-linter: core::0162::commit-request-name-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0162/commit-request-name-field.md b/docs/rules/0162/commit-request-name-field.md index dc518dd..b7bc038 100644 --- a/docs/rules/0162/commit-request-name-field.md +++ b/docs/rules/0162/commit-request-name-field.md @@ -35,7 +35,7 @@ message CommitBookRequest { // Field type should be `string`. bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -47,7 +47,7 @@ message CommitBookRequest { message CommitBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -64,7 +64,7 @@ message CommitBookRequest { // aep.dev/not-precedent: We need to do this because reasons. --) bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0162/commit-request-name-reference.md b/docs/rules/0162/commit-request-name-reference.md index 4ecc0c1..1e3d6b7 100644 --- a/docs/rules/0162/commit-request-name-reference.md +++ b/docs/rules/0162/commit-request-name-reference.md @@ -39,7 +39,7 @@ message CommitBookRequest { message CommitBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0162/delete-revision-request-name-behavior.md b/docs/rules/0162/delete-revision-request-name-behavior.md index 5079ff9..9ef3138 100644 --- a/docs/rules/0162/delete-revision-request-name-behavior.md +++ b/docs/rules/0162/delete-revision-request-name-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message DeleteBookRevisionRequest { // The `aep.api.field_behavior` annotation should also be included. string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -42,7 +42,7 @@ message DeleteBookRevisionRequest { message DeleteBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -57,7 +57,7 @@ message DeleteBookRevisionRequest { // (-- api-linter: core::0162::delete-revision-request-name-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0162/delete-revision-request-name-field.md b/docs/rules/0162/delete-revision-request-name-field.md index dd3fa50..fb99c5d 100644 --- a/docs/rules/0162/delete-revision-request-name-field.md +++ b/docs/rules/0162/delete-revision-request-name-field.md @@ -34,7 +34,7 @@ message DeleteBookRevisionRequest { // Field type should be `string`. bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -46,7 +46,7 @@ message DeleteBookRevisionRequest { message DeleteBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -63,7 +63,7 @@ message DeleteBookRevisionRequest { // aep.dev/not-precedent: We need to do this because reasons. --) bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0162/delete-revision-request-name-reference.md b/docs/rules/0162/delete-revision-request-name-reference.md index 7c83256..3640393 100644 --- a/docs/rules/0162/delete-revision-request-name-reference.md +++ b/docs/rules/0162/delete-revision-request-name-reference.md @@ -39,7 +39,7 @@ message DeleteBookRevisionRequest { message DeleteBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0162/rollback-request-name-behavior.md b/docs/rules/0162/rollback-request-name-behavior.md index c3ada6b..cdfb807 100644 --- a/docs/rules/0162/rollback-request-name-behavior.md +++ b/docs/rules/0162/rollback-request-name-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message RollbackBookRequest { // The `aep.api.field_behavior` annotation should also be included. string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -44,7 +44,7 @@ message RollbackBookRequest { message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -61,7 +61,7 @@ message RollbackBookRequest { // (-- api-linter: core::0162::rollback-request-name-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; diff --git a/docs/rules/0162/rollback-request-name-field.md b/docs/rules/0162/rollback-request-name-field.md index 3dc034d..453d5e5 100644 --- a/docs/rules/0162/rollback-request-name-field.md +++ b/docs/rules/0162/rollback-request-name-field.md @@ -36,7 +36,7 @@ message RollbackBookRequest { // Field type should be `string`. bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -50,7 +50,7 @@ message RollbackBookRequest { message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -69,7 +69,7 @@ message RollbackBookRequest { // aep.dev/not-precedent: We need to do this because reasons. --) bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; diff --git a/docs/rules/0162/rollback-request-name-reference.md b/docs/rules/0162/rollback-request-name-reference.md index 5e97585..272535d 100644 --- a/docs/rules/0162/rollback-request-name-reference.md +++ b/docs/rules/0162/rollback-request-name-reference.md @@ -41,7 +41,7 @@ message RollbackBookRequest { message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; diff --git a/docs/rules/0162/rollback-request-revision-id-behavior.md b/docs/rules/0162/rollback-request-revision-id-behavior.md index bef8ed9..9aab5fc 100644 --- a/docs/rules/0162/rollback-request-revision-id-behavior.md +++ b/docs/rules/0162/rollback-request-revision-id-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // The `aep.api.field_behavior` annotation should be included. @@ -45,7 +45,7 @@ message RollbackBookRequest { message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -61,7 +61,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // (-- api-linter: core::0162::rollback-request-revision-id-behavior=disabled diff --git a/docs/rules/0162/rollback-request-revision-id-field.md b/docs/rules/0162/rollback-request-revision-id-field.md index 40b66ed..ba7666c 100644 --- a/docs/rules/0162/rollback-request-revision-id-field.md +++ b/docs/rules/0162/rollback-request-revision-id-field.md @@ -28,7 +28,7 @@ either the `revision_id` field is missing or it has any type other than `string` message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -38,7 +38,7 @@ message RollbackBookRequest { message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // Field type should be `string`. @@ -53,7 +53,7 @@ message RollbackBookRequest { message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string revision_id = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -70,7 +70,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message RollbackBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // (-- api-linter: core::0162::rollback-request-revision-id-field=disabled diff --git a/docs/rules/0162/tag-revision-request-name-behavior.md b/docs/rules/0162/tag-revision-request-name-behavior.md index 6e8f672..942c1dd 100644 --- a/docs/rules/0162/tag-revision-request-name-behavior.md +++ b/docs/rules/0162/tag-revision-request-name-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message TagBookRevisionRequest { // The `aep.api.field_behavior` annotation should also be included. string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -44,7 +44,7 @@ message TagBookRevisionRequest { message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -61,7 +61,7 @@ message TagBookRevisionRequest { // (-- api-linter: core::0162::tag-revision-request-name-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) string name = 1 [ - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; diff --git a/docs/rules/0162/tag-revision-request-name-field.md b/docs/rules/0162/tag-revision-request-name-field.md index 594bbb7..59917a4 100644 --- a/docs/rules/0162/tag-revision-request-name-field.md +++ b/docs/rules/0162/tag-revision-request-name-field.md @@ -36,7 +36,7 @@ message TagBookRevisionRequest { // Field type should be `string`. bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -50,7 +50,7 @@ message TagBookRevisionRequest { message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -69,7 +69,7 @@ message TagBookRevisionRequest { // aep.dev/not-precedent: We need to do this because reasons. --) bytes name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; diff --git a/docs/rules/0162/tag-revision-request-name-reference.md b/docs/rules/0162/tag-revision-request-name-reference.md index f88d8bd..7f541a3 100644 --- a/docs/rules/0162/tag-revision-request-name-reference.md +++ b/docs/rules/0162/tag-revision-request-name-reference.md @@ -41,7 +41,7 @@ message TagBookRevisionRequest { message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; diff --git a/docs/rules/0162/tag-revision-request-tag-behavior.md b/docs/rules/0162/tag-revision-request-tag-behavior.md index 0074f2b..6225d92 100644 --- a/docs/rules/0162/tag-revision-request-tag-behavior.md +++ b/docs/rules/0162/tag-revision-request-tag-behavior.md @@ -30,7 +30,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // The `aep.api.field_behavior` annotation should be included. @@ -45,7 +45,7 @@ message TagBookRevisionRequest { message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -61,7 +61,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // (-- api-linter: core::0162::tag-revision-request-tag-behavior=disabled diff --git a/docs/rules/0162/tag-revision-request-tag-field.md b/docs/rules/0162/tag-revision-request-tag-field.md index 9a838c4..2121cbe 100644 --- a/docs/rules/0162/tag-revision-request-tag-field.md +++ b/docs/rules/0162/tag-revision-request-tag-field.md @@ -28,7 +28,7 @@ either the `tag` field is missing or it has any type other than `string`. message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -38,7 +38,7 @@ message TagBookRevisionRequest { message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // Field type should be `string`. @@ -53,7 +53,7 @@ message TagBookRevisionRequest { message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; string tag = 2 [(aep.api.field_info).field_behavior = FIELD_BEHAVIOR_REQUIRED]; @@ -70,7 +70,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message TagBookRevisionRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; // (-- api-linter: core::0162::tag-revision-request-tag-field=disabled diff --git a/docs/rules/0164/request-name-behavior.md b/docs/rules/0164/request-name-behavior.md index 42293f3..f6f88a7 100644 --- a/docs/rules/0164/request-name-behavior.md +++ b/docs/rules/0164/request-name-behavior.md @@ -29,9 +29,7 @@ value of `FIELD_BEHAVIOR_REQUIRED`. // Incorrect. message UndeleteBookRequest { // The `aep.api.field_behavior` annotation should also be included. - string name = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string name = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` @@ -42,7 +40,7 @@ message UndeleteBookRequest { message UndeleteBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` @@ -56,9 +54,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message UndeleteBookRequest { // (-- api-linter: core::0164::request-name-behavior=disabled // aep.dev/not-precedent: We need to do this because reasons. --) - string name = 1 [(aep.api.field_info).resource_reference = { - type: "library.googleapis.com/Book" - }]; + string name = 1 [(aep.api.field_info).resource_reference = "library.googleapis.com/Book"]; } ``` diff --git a/docs/rules/0164/request-name-field.md b/docs/rules/0164/request-name-field.md index 5f2a1d5..beb3e93 100644 --- a/docs/rules/0164/request-name-field.md +++ b/docs/rules/0164/request-name-field.md @@ -43,7 +43,7 @@ message UndeleteBookRequest { message UndeleteBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0164/request-name-reference.md b/docs/rules/0164/request-name-reference.md index af06b8e..d9603b3 100644 --- a/docs/rules/0164/request-name-reference.md +++ b/docs/rules/0164/request-name-reference.md @@ -39,7 +39,7 @@ message UndeleteBookRequest { message UndeleteBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book" + (aep.api.field_info).resource_reference = "library.googleapis.com/Book" ]; } ``` diff --git a/docs/rules/0164/request-unknown-fields.md b/docs/rules/0164/request-unknown-fields.md index 694e71a..0c026b7 100644 --- a/docs/rules/0164/request-unknown-fields.md +++ b/docs/rules/0164/request-unknown-fields.md @@ -32,7 +32,7 @@ comes across any fields other than: message UndeleteBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", ]; string library_id = 2; // Non-standard field. } @@ -45,7 +45,7 @@ message UndeleteBookRequest { message UndeleteBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", ]; } ``` @@ -59,7 +59,7 @@ Remember to also include an [aep.dev/not-precedent][] comment explaining why. message UndeleteBookRequest { string name = 1 [ (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED, - (aep.api.field_info).resource_reference.type = "library.googleapis.com/Book", + (aep.api.field_info).resource_reference = "library.googleapis.com/Book", ]; // (-- api-linter: core::0164::request-unknown-fields=disabled