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

Mark authzed.api.v0 as deprecated #26

Closed
jzelinskie opened this issue Feb 2, 2022 · 1 comment · Fixed by #28
Closed

Mark authzed.api.v0 as deprecated #26

jzelinskie opened this issue Feb 2, 2022 · 1 comment · Fixed by #28
Labels
area/tooling Affects the dev or user toolchain priority/1 high This is the top priority

Comments

@jzelinskie
Copy link
Member

Once we've published a timeline for formally dropping support for the v0 API, we'll mark the gRPC services as deprecated.

I'm not sure if this is something formally supported by the buf registry.

cc @bufdev

@jzelinskie jzelinskie added area/tooling Affects the dev or user toolchain priority/1 high This is the top priority labels Feb 2, 2022
@amckinney
Copy link

Service-level deprecation isn't something that the BSR supports - it's an option baked into the Protobuf language itself. You can deprecate an entire service or individual methods with the following:

// The entire HelloService is deprecated.
service HelloService {
  option deprecated = true;
  rpc Hello(HelloRequest) returns (HelloResponse) {}
}

// Only the SayGoodbye RPC is deprecated.
service GoodbyeService {
  rpc SayGoodbye(SayGoodbyeRequest) returns (SayGoodbyeResponse) {
    option deprecated = true;
  }
}

With that said, the BSR does offer repository-level deprecation. If your v0 API is tied to a BSR repository, you can deprecate the repository and direct your users to another BSR repository devoted to your v1 API. I imagine you have other types you don't want to deprecate in your BSR repository though, so you might not want to deprecate the entire thing.

Hopefully one of these approaches is what you're looking for - I'd be curious to hear what you end up going with, so please let us know!

@jzelinskie jzelinskie linked a pull request Feb 9, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tooling Affects the dev or user toolchain priority/1 high This is the top priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants