Skip to content

Usable OpenAPI operation names #16

@zevisert

Description

@zevisert

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions