chore(api): make version prefix optional #3306
Conversation
meta-cla
bot
added
the
CLA Signed
mattf
requested review from
ashwinb,
yanxi0830,
hardikjshah,
raghotham,
ehhuang,
terrytangyuan,
leseb,
bbrowning,
reluctantfuturist and
slekkala1
as code owners
not directly. default is to include the version. on a per- |
| @@ -60,7 +60,9 @@ def get_all_api_routes( | |||
| # The __webmethod__ attribute is dynamically added by the @webmethod decorator | |||
| # mypy doesn't know about this dynamic attribute, so we ignore the attr-defined error | |||
| webmethod = method.__webmethod__ # type: ignore[attr-defined] | |||
| path = f"/{LLAMA_STACK_API_VERSION}/{webmethod.route.lstrip('/')}" | |||
| path = webmethod.route.lstrip("/") | |||
There was a problem hiding this comment.
is allowing v1 to be omitted something that is a norm? If so, I think this is nice as v1/openai/v1 is redundant. However, I am unsure if this Is something that'd play nicely with API stability down the line, or if this is something other project with API contracts regularly do.
There was a problem hiding this comment.
is the goal of this "prettification" of the URL?
There was a problem hiding this comment.
what issues do you anticipate?
There was a problem hiding this comment.
would a flexible prefix be a good option instead of boolean to set it v1 given the stability levels ?
What does this PR do?
it provides infrastructure for
@webmethodendpoints that do not have / should not have a version prefix added, e.g. future openai endpoints.Test Plan
ci