Delete requests: force field

This rule enforces that all Delete request force fields have type bool, as mandated in AIP-135.

Details

This rule looks at any message matching Delete*Request that contains a force field and complains if the field is not a singular bool.

Examples

Incorrect code for this rule:

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

  int32 force = 2;  // Field type should be `bool`.
}

Correct code for this rule:

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

  bool force = 2;
}

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 DeletePublisherRequest {
  string name = 1 [
    (google.api.resource_reference).type = "library.googleapis.com/Publisher",
    (google.api.field_behavior) = REQUIRED
  ];

  // (-- api-linter: core::0135::request-force-field=disabled
  //     aip.dev/not-precedent: We need to do this because reasons. --)
  int32 force = 2;
}

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