Skip to content

Conversation

@rambleraptor
Copy link
Member

@rambleraptor rambleraptor commented Oct 12, 2025

Closes #109

This is a big PR. It changes all of the google.api.field_behavior logic to aep.api.field_behavior

Copy link
Member

@toumorokoshi toumorokoshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for this mega-PR


This rule enforces that all `List` standard methods have
`google.api.field_behavior` set to `REQUIRED` on their `string parent` field,
`aep.api.field_behavior` set to `REQUIRED` on their `string parent` field,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this say "set to FIELD_BEHAVIOR_REQUIRED on their string parent"?

semi-related note - why the added FIELD_BEHAVIOR_ prefix? asking since AEP-126 encourages dropping the prefix unless it's needed for disambiguation:

enum Format {
    // Default value. This value is unused.
    FORMAT_UNSPECIFIED = 0;

    // The printed format, in hardback.
    HARDBACK = 1;

    // The printed format, in paperback.
    PAPERBACK = 2;

    // An electronic book format.
    EBOOK = 3;

    // An audio recording.
    AUDIOBOOK = 4;
  }

Is is because there's a need to disambiguate REQUIRED within aep.api?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @toumorokoshi answer that one. Docs changes have been made

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@odsod good question! I primarily wanted to future proof enum values, as you mentioned.

This is also a default rule to lint against, e.g. in buf: https://buf.build/docs/lint/rules/#enum_value_prefix

Copy link
Member

@toumorokoshi toumorokoshi Oct 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not holding on this opinion particularly strongly... maybe we can do a quick poll in the #aep slack to see what people think? link: https://cloud-native.slack.com/archives/C04TX46UCTV/p1760729260615679

@rambleraptor rambleraptor merged commit 1e90f9a into main Oct 18, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

adopt AEP field behavior and resource reference enums

4 participants