Rollback requests: Revision ID field behavior

This rule enforces that all Rollback requests have google.api.field_behavior set to REQUIRED on their string revision_id field, as mandated in AIP-162.

Details

This rule looks at any message matching Rollback*Request and complains if the revision_id field does not have a google.api.field_behavior annotation with a value of REQUIRED.

Examples

Incorrect code for this rule:

// Incorrect.
message RollbackBookRequest {
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference).type = "library.googleapis.com/Book"
  ];

  // The `google.api.field_behavior` annotation should be included.
  string revision_id = 2;
}

Correct code for this rule:

// Correct.
message RollbackBookRequest {
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference).type = "library.googleapis.com/Book"
  ];

  string revision_id = 2 [(google.api.field_behavior) = REQUIRED];
}

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.

message RollbackBookRequest {
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference).type = "library.googleapis.com/Book"
  ];

  // (-- api-linter: core::0162::rollback-request-revision-id-behavior=disabled
  //     aip.dev/not-precedent: We need to do this because reasons. --)
  string revision_id = 2;
}

If you need to violate this rule for an entire file, place the comment at the top of the file.