googleapis / googleapis/api-linter

Enable api-linter on buf

Open
#1,095 4 comments 12 reactions 0 assignees View on GitHub
priority: p3 type: feature request will not fix
Dominant language
Go
Stars
765
Forks
181
Avg merge
2d 12h
Merged PRs (30d)
3

Description

Thanks for stopping by to let us know something could be better!

**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.

**Is your feature request related to a problem? Please describe.**
The API linter is a useful way of ensuring API protobuf definitions are AIP-compliant. [buf](buf.build) is gradually becoming an industry standard for publishing and managing protobufs, but today: 1) There is no way of natively running aip-linter in buf, and 2) The buf default lint rules contradict AIP lint rules. For example, buf recommends that no two RPC methods return the same message, but AIP recommends `Get` and `Create` methods both return the same message.

**Describe the solution you'd like**
Native aip-linter integration into buf as a plugin.

**Describe alternatives you've considered**
Run aip-linter entirely separately, or don't use it at all, if using buf.

**Additional context**
N/A

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.