kserve / kserve/open-inference-protocol

Usable OpenAPI operation names

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
77
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Generating a client based on the OpenAPI REST specification yields some pretty unusable clients, something that can go a long way is coming up with some half decent `operationId`

The [OpenAPI spec](https://spec.openapis.org/oas/v3.1.0#operationObject) suggests:
> _Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions._

Something like `post-v2-models-$-MODEL_NAME-versions-$-MODEL_VERSION-infer` certainly isn't a common naming convention in many languages I know of.

https://github.com/kserve/open-inference-protocol/blob/eeb043e2c95c1dd35f8b9185f5dadf44c7f10c9f/specification/protocol/open_inference_rest.yaml#L119

I'm not sure if including the spec version in the operationId is a good idea or not, eg, is `infer` a better operationId than `inferv2` or `v2-infer`?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with specification/protocol/open_inference_rest.yaml around line 119 and compare the operation names with the OpenAPI Operation Object guidance linked in the issue. Establish a consistent naming convention for the affected operations, including how versioning is represented, then verify that the resulting operationIds are unique and produce usable generated client method names.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.