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

Operation ids for actuator endpoints #1233

Closed
fjakop opened this issue Jul 30, 2021 · 1 comment
Closed

Operation ids for actuator endpoints #1233

fjakop opened this issue Jul 30, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@fjakop
Copy link

fjakop commented Jul 30, 2021

We're generating typescript fetch clients from openapi definition. When we enable actuator to be generated into the openapi.yaml the operation ids are rather unuseable because the're named handle_14 and so on while the summary looks good. Example below.

/actuator/health:
  get:
    tags:
      - Actuator
    summary: Actuator web endpoint 'health'
    operationId: handle_14

In consequence the generated typescript methods look like actuatorApi.handle14() that is unreadable.

I would expect the operationId to be set to the endpoint name, i.e. in this example

/actuator/health:
  get:
    tags:
      - Actuator
    summary: Actuator web endpoint 'health'
    operationId: health

which would lead to a method actuatorApi.health().

Used springdoc-openapi version is 1.5.4.

@bnasslahsen
Copy link
Contributor

@fjakop,

Note that operationIds using actuator is not unique.
An update will be available with the next release to make them clearer/understandable ...

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

No branches or pull requests

2 participants