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

Allowlist "standard fields" for all request-unknown-fields rules #1128

Open
noahdietz opened this issue Mar 31, 2023 · 2 comments
Open

Allowlist "standard fields" for all request-unknown-fields rules #1128

noahdietz opened this issue Mar 31, 2023 · 2 comments

Comments

@noahdietz
Copy link
Collaborator

Many standard methods have a rule that warns on fields that are not considered part of the standard request message. The same AIPs for these rules often allow other standardized fields on request messages. We should make sure they are allow listed in any request-unknown-fields rules.

@packirisamykaran
Copy link

packirisamykaran commented Mar 31, 2023

Hi, I want to contribute to this project and take on this issue as my first task. Could you guide me on this issue?

@toumorokoshi
Copy link
Contributor

Hey! sorry we missed the comment.

You can take a look at the demo PR to get started: #968.

The work is effectively auditing every standard method AIP (google.aip.dev/131 through google.aip.dev/135), checking the wording to see all the allowed values, then modifying the request_unknown_fields.go rules: https://github.com/googleapis/api-linter/blob/main/rules/aip0131/request_unknown_fields.go.

And if you're interested in a more in-depth walkthrough, we do have a community meeting every other week. It's primarily focused on the AIPs themselves, but discussing linter rules is totally fine too: https://github.com/aip-dev/aip.dev#learn-and-connect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants