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

fix: proto-linter compliance #55

Merged
merged 4 commits into from
Dec 11, 2024
Merged

Conversation

toumorokoshi
Copy link
Member

Adding some fixes for the proto linter, to
re-enable it in CI and show it can be used to
validate AEP-compliant APIs.

Adding some fixes for the proto linter, to 
re-enable it in CI and show it can be used to
validate AEP-compliant APIs.
@toumorokoshi
Copy link
Member Author

Errors, with commentary:

# I can't get this to work by adjusting the HTTP URI. Including the path is a no-op for resources without a parent.
example/bookstore/v1/bookstore.proto:127:5:HTTP URI should include a `parent` variable. (buf-plugin-aep)
example/bookstore/v1/bookstore.proto:165:5:HTTP URI should include a `parent` variable. (buf-plugin-aep)
# looks to be an old aip linter issues.
example/bookstore/v1/bookstore.proto:178:3:Type must be UpperCamelCase with alphanumeric characters: "Book" (buf-plugin-aep)
# not sure about this one. Perhaps it doesn't like the dash?
example/bookstore/v1/bookstore.proto:215:3:Resource pattern "publishers/{publisher}/books/{book}/editions/{book-edition}" must alternate between collection and identifier. "{book-edition}" is not an identifier (buf-plugin-aep)
# more casing differences.
example/bookstore/v1/bookstore.proto:215:3:Resource plural should be lowerCamelCase: "bookEditions" (buf-plugin-aep)
example/bookstore/v1/bookstore.proto:215:3:Resource singular should be lower camel case of type: "bookEdition" (buf-plugin-aep)
example/bookstore/v1/bookstore.proto:215:3:Type must be UpperCamelCase with alphanumeric characters: "BookEdition" (buf-plugin-aep)
example/bookstore/v1/bookstore.proto:233:3:Type must be UpperCamelCase with alphanumeric characters: "Isbn" (buf-plugin-aep)
example/bookstore/v1/bookstore.proto:246:3:Type must be UpperCamelCase with alphanumeric characters: "Publisher" (buf-plugin-aep)

@toumorokoshi toumorokoshi merged commit 0c34806 into aep-dev:main Dec 11, 2024
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.

1 participant