Giter Site home page Giter Site logo

Mark authzed.api.v0 as deprecated about api HOT 1 CLOSED

authzed avatar authzed commented on August 23, 2024
Mark authzed.api.v0 as deprecated

from api.

Comments (1)

amckinney avatar amckinney commented on August 23, 2024 1

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!

from api.

Related Issues (15)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.