search

aep-dev / api-linter

A linter for APIs defined in protocol buffers.
Apache License 2.0
0 stars 1 forks source link

do not require aep resources have user-settable ids. #97

Open toumorokoshi opened 4 days ago

toumorokoshi commented 4 days ago

the create API optionally supports the ID field, but the aep requires it. it should be categorized as a "should".

blocks https://github.com/aep-dev/aepc/pull/39

see: https://github.com/aep-dev/aepc/actions/runs/11624260167/job/32372581247?pr=39

example/bookstore/v1/bookstore.proto:360:1:create methods should contain a singular `string id` field. (buf-plugin-aep)

contingent on https://github.com/aep-dev/aep.dev/pull/222 merging.

rambleraptor commented 4 days ago

This check is currently categorized as a "should", which means the check can be disabled by users.

There's two paths we have here:

  1. Remove the check from the linter altogether.
  2. Disable the check on your side.

What are your thoughts? Might be misunderstanding the ask.