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

Usable OpenAPI operation names #3

Closed
zevisert opened this issue Nov 26, 2023 · 0 comments · Fixed by #8
Closed

Usable OpenAPI operation names #3

zevisert opened this issue Nov 26, 2023 · 0 comments · Fixed by #8

Comments

@zevisert
Copy link
Contributor

zevisert commented Nov 26, 2023

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 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.

operationId: post-v2-models-$-MODEL_NAME-versions-$-MODEL_VERSION-infer

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?


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant