RESTful Naming Conventions for Inference APIs

[jiyer2016]

I'd like to name the inference API into the more RESTful looking - "/faces/detect".
But I get the following error:

bentoml.exceptions.InvalidArgument: Invalid API name: '/faces/detect', a valid identifier may only contain letters, numbers, underscores and not starting with a number

Is there any reason this is disallowed ?

Can this restriction be removed if possible ?

[parano]

The inference API name has this constraint because it is also used as the python API, CLI command, AWS resource name, and potentially K8S resource name.

We are adding an API for the user to defined additional HTTP routes for accessing their BentoService here #1161 with a more general API like add_url_route, would it help with your use case?

[jiyer2016]

I lose a lot of goodies if use the more general API. Is there a way by which this additional route can point back into the same inference api ? It doesn't hurt if the api is exposed via two routes - /detect and /faces/detect.

[parano]

@jiyer2016 we can potentially add an API for changing just the URL endpoint when serving via HTTP model server, something like @api(http_url_route='/faces/detect'), would that work for your use case?

[jiyer2016]

That works I guess. An alternate suggestion could be to do something like @api(additional_http_routes=('/abc/def', '/ghi/jkl/mno'))

That would retain the original route for backward compatibility and also add additional ones.

Having said that you original solution on http_url_route works perfectly fine.

[jiyer2016]

Thanks - May I know when this feature is likely to be released ? It is not critical - but just for my own planning

[parano]

@bojiang has a PR out for this already here #1334 - most likely it will be released in the next release within the next 2 weeks