{"id":44188663,"url":"https://github.com/aep-dev/api-linter","last_synced_at":"2026-02-09T16:35:33.393Z","repository":{"id":232324132,"uuid":"784047111","full_name":"aep-dev/api-linter","owner":"aep-dev","description":"A linter for APIs defined in protocol buffers.","archived":false,"fork":false,"pushed_at":"2026-01-13T18:34:32.000Z","size":4765,"stargazers_count":6,"open_issues_count":21,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-13T20:56:24.548Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"googleapis/api-linter","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aep-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-09T04:43:36.000Z","updated_at":"2026-01-13T18:34:37.000Z","dependencies_parsed_at":"2025-10-18T08:01:47.484Z","dependency_job_id":"81c26839-b2e5-4613-8a40-47ace226035b","html_url":"https://github.com/aep-dev/api-linter","commit_stats":null,"previous_names":["aep-dev/api-linter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aep-dev/api-linter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aep-dev%2Fapi-linter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aep-dev%2Fapi-linter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aep-dev%2Fapi-linter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aep-dev%2Fapi-linter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aep-dev","download_url":"https://codeload.github.com/aep-dev/api-linter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aep-dev%2Fapi-linter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29272897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T13:47:44.167Z","status":"ssl_error","status_checked_at":"2026-02-09T13:47:43.721Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-09T16:35:32.587Z","updated_at":"2026-02-09T16:35:33.374Z","avatar_url":"https://github.com/aep-dev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AEP Protobuf Linter\n\n[![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)\n![latest release](https://img.shields.io/github/v/release/aep-dev/api-linter)\n![go version](https://img.shields.io/github/go-mod/go-version/aep-dev/api-linter)\n\nThe API linter provides real-time checks for compliance with many of the API\nstandards, documented using [API Enhancement Proposals](https://aep.dev). It operates on API\nsurfaces defined in [protocol buffers][]. \n\nFor APIs using the \n[OpenAPI Specification][], an equivalent [OpenAPI linter](https://github.com/aep-dev/aep-openapi-linter) is\navailable.\n\nIt identifies common mistakes and inconsistencies in API surfaces:\n\n```proto\n// Incorrect: Do not use the resource type as the field name here.\nmessage GetBookRequest {\n  // Field names for resource identifiers in Get requests must be `name`.\n  // Tools and standards expect this for consistency and interoperability.\n  string book = 1;\n}\n```\nWhen able, it also offers a suggestion for the correct fix.\n```proto\n// Correct: This version follows AEP-148, which requires resource identifiers in Get requests to use the field name `name`.\n// See https://aep.dev/148/ for details.\nmessage GetBookRequest {\n  // The name of the book to retrieve.\n  // Format: publishers/{publisher}/books/{book}\n  string name = 1;\n}\n```\n\n[_Read more ≫_](docs/index.md)\n\n## Versioning\n\nThe AEP API linter does **not** follow semantic versioning. Semantic\nversioning is challenging for a tool like a linter because the addition or\ncorrection of virtually any rule is \"breaking\" (in the sense that a file that\npreviously reported no problems may now do so).\n\nTherefore, the version numbers refer to the linter's core interface. In\ngeneral:\n\n- Releases with only documentation, chores, dependency upgrades, and/or\n  bugfixes are patch releases.\n- Releases with new rules (or potentially removed rules) are minor releases.\n- Releases with core interface alterations are major releases. This could\n  include changes to the internal Go interface or the CLI user interface.\n\n**Note:** Releases that increment the Go version will be considered minor.\n\nThis is an attempt to follow the spirit of semantic versioning while still\nbeing useful.\n\n## Contributing\n\nIf you are interested in contributing to the API linter, please review the [contributing guide](https://aep.dev/contributing/) to learn more.\n\n## License\n\nThis software is made available under the [Apache 2.0][] license.\n\n[apache 2.0]: https://www.apache.org/licenses/LICENSE-2.0\n[api improvement proposals]: https://aip.dev/\n[protocol buffers]: https://developers.google.com/protocol-buffers\n[OpenAPI specification]: https://www.openapis.org/\n[OpenAPI specification linter]: https://github.com/aep-dev/aep-openapi-linter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faep-dev%2Fapi-linter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faep-dev%2Fapi-linter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faep-dev%2Fapi-linter/lists"}