Create methods: Required fields types

This rule enforces that all Create standard methods have the correct types for required fields, as mandated in AIP-133.

Details

This rule looks at any message matching Create*Request and complains if the following required fields have the wrong type:

• string parent (AIP-133)
• {Resource} {resource} (must be a message)(AIP-133)
• string {resource}_id (AIP-133)

Examples

Incorrect code for this rule:

// Incorrect: The `book` field should be a message type (Book).
message CreateBookRequest {
  string parent = 1;
  string book = 2;
  string book_id = 3;
}

Correct code for this rule:

// Correct.
message CreateBookRequest {
  string parent = 1;
  Book book = 2;
  string book_id = 3;
}

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 CreateBookRequest {
  // (-- api-linter: core::0133::request-required-fields-types=disabled
  //     aip.dev/not-precedent: We need to use bytes for the parent because
  // reasons. --)
  bytes parent = 1;
  Book book = 2;
  string book_id = 3;
}

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