Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt AEP-202: Fields #155

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Conversation

rambleraptor
Copy link
Contributor

Addresses #148

This adopts AEP-202: Fields

  • Created new folder for AEP 202
  • Changed references from AIP to AEP

Note: this still uses the google.api.field_info proto type.

@rambleraptor rambleraptor requested a review from a team as a code owner March 19, 2024 05:09
@rofrankel rofrankel self-requested a review March 22, 2024 19:21
aep/general/0202/aep.yaml Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
@rofrankel
Copy link
Collaborator

Added a few high-level comments - will do a more thorough read of the PR once those are resolved.

@rambleraptor
Copy link
Contributor Author

Added the proto file for aep.api.FieldInfo. PTAL!

Copy link
Collaborator

@rofrankel rofrankel left a comment

Choose a reason for hiding this comment

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

Replied to comments, but have to send this to take myself out of the attention set.

@mkistler
Copy link
Contributor

Should we generalize this guidance to cover format in OAS?

@rambleraptor
Copy link
Contributor Author

Should we generalize this guidance to cover format in OAS?

We should do that in a subsequent PR. I think they'll be a lot of conversation about that.

Copy link
Contributor

@mkistler mkistler left a comment

Choose a reason for hiding this comment

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

Looks good. 👍

aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/0202/aep.md.j2 Show resolved Hide resolved
that are validated by the service, so conveying the format to the user ahead of
time is critical to their experience.

#### Why discourage primitive equality comparisons?
Copy link
Collaborator

Choose a reason for hiding this comment

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

It seems like there should be actual guidance that this explains. I think the rationale makes sense, we just need the corresponding guidance.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, this is too vague as-is. The biggest pieces of guidance I can think of are:

  • Fields that follow a pattern must have that pattern specified as proto-validate
  • Both the request + response fields must have the validation + and the validations must match (if applicable)
  • Returning a value that does not match the validation must return an error message.

Any others you can think of?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I meant specifically for "Why discourage primitive equality comparisons?"

Which guidance discourages primitive equality comparisons?

aep/general/0202/aep.md.j2 Show resolved Hide resolved
aep/general/0202/aep.md.j2 Outdated Show resolved Hide resolved
rambleraptor and others added 9 commits May 19, 2024 17:22
Co-authored-by: Richard Frankel <richard@frankel.tv>
Co-authored-by: Richard Frankel <richard@frankel.tv>
Co-authored-by: Richard Frankel <richard@frankel.tv>
Co-authored-by: Richard Frankel <richard@frankel.tv>
Co-authored-by: Richard Frankel <richard@frankel.tv>
Co-authored-by: Richard Frankel <richard@frankel.tv>
Co-authored-by: Richard Frankel <richard@frankel.tv>
@rofrankel rofrankel self-requested a review June 7, 2024 18:41
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.

None yet

3 participants