request-parent-behavior.md

rule	aep name summary 132 core 0132 request-parent-behavior List RPCs should annotate the `parent` field with `aep.api.field_behavior`.
permalink	/132/request-parent-behavior
redirect_from	/0132/request-parent-behavior

List methods: Field behavior

This rule enforces that all List standard methods have aep.api.field_behavior set to FIELD_BEHAVIOR_REQUIRED on their string parent field, as mandated in AEP-132.

Details

This rule looks at any message matching List*Request and complains if the parent field does not have a aep.api.field_behavior annotation with a value of FIELD_BEHAVIOR_REQUIRED.

Examples

Incorrect code for this rule:

// Incorrect.
message ListBooksRequest {
  // The `aep.api.field_behavior` annotation should also be included.
  string parent = 1 [(google.api.resource_reference) = {
    type: "library.googleapis.com/Publisher"
  }];
  int32 page_size = 2;
  string page_token = 3;
}

Correct code for this rule:

// Correct.
message ListBooksRequest {
  string parent = 1 [
    (aep.api.field_behavior) = FIELD_BEHAVIOR_REQUIRED,
    (google.api.resource_reference).type = "library.googleapis.com/Publisher"
  ];
  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 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 [(google.api.resource_reference) = {
    type: "library.googleapis.com/Publisher"
  }];
  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.