Declarative-friendly resources: Annotations field

This rule enforces that all declarative-friendly resources have a map<string, string> annotations field, as mandated in AIP-128.

Details

This rule looks at any message with a google.api.resource annotation that includes style: DECLARATIVE_FRIENDLY, and complains if the annotations field is missing or if it has any type other than map<string, string>.

Examples

Incorrect code for this rule:

// Incorrect.
// The `annotations` field is missing.
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/Book"
    pattern: "publishers/{publisher}/books/{book}"
    style: DECLARATIVE_FRIENDLY
  };

  string name = 1;
}

// Incorrect.
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/Book"
    pattern: "publishers/{publisher}/books/{book}"
    style: DECLARATIVE_FRIENDLY
  };

  string name = 1;
  repeated string annotations = 2; // Type should be `map<string, string>`.
}

Correct code for this rule:

// Correct.
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/Book"
    pattern: "publishers/{publisher}/books/{book}"
    style: DECLARATIVE_FRIENDLY
  };

  string name = 1;
  map<string, string> annotations = 2;
}

Disabling

If you need to violate this rule, use a leading comment above the message (if the annotations field is missing) or above the field (if it is the wrong type). Remember to also include an aip.dev/not-precedent comment explaining why.

// (-- api-linter: core::0128::resource-annotations-field=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/Book"
    pattern: "publishers/{publisher}/books/{book}"
    style: DECLARATIVE_FRIENDLY
  };

  string name = 1;
}

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