Skip to content

adding missing links, example improvement, and retitle-ing #104

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 12, 2025
Merged

adding missing links, example improvement, and retitle-ing #104

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dda217d
adding missing links & retitle-ing
earth2marsh Aug 1, 2025
eb56b88
improved initial example
earth2marsh Aug 1, 2025
ea37422
Update README.md
rambleraptor Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
# Google API Linter
# AEP Protobuf Linter

[![ci](https://github.com/aep-dev/api-linter/actions/workflows/ci.yaml/badge.svg)](https://github.com/aep-dev/api-linter/actions/workflows/ci.yaml)
![latest release](https://img.shields.io/github/v/release/aep-dev/api-linter)
![go version](https://img.shields.io/github/go-mod/go-version/aep-dev/api-linter)

The API linter provides real-time checks for compliance with many of the API
standards, documented using [API Enhancement Proposals][]. It operates on API
surfaces defined in [protocol buffers][]. For APIs defined in
[OpenAPI specification][] an equivalent [OpenAPI specification linter][] is
standards, documented using [API Enhancement Proposals](https://aep.dev). It operates on API
surfaces defined in [protocol buffers][].

For APIs using the
[OpenAPI Specification][], an equivalent [OpenAPI linter](https://github.com/aep-dev/aep-openapi-linter) is
available.

It identifies common mistakes and inconsistencies in API surfaces:

```proto
// Incorrect.
// Incorrect: Do not use the resource type as the field name here.
message GetBookRequest {
// This is wrong; it should be spelled `name`.
// Field names for resource identifiers in Get requests must be `name`.
// Tools and standards expect this for consistency and interoperability.
string book = 1;
}
```

When able, it also offers a suggestion for the correct fix.
```proto
// Correct: This version follows AEP-148, which requires resource identifiers in Get requests to use the field name `name`.
// See https://aep.dev/148/ for details.
message GetBookRequest {
// The name of the book to retrieve.
// Format: publishers/{publisher}/books/{book}
string name = 1;
}
```

[_Read more ≫_](docs/index.md)

Expand Down