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

[feature] queryParameter renaming should be mentionned as warning #107

Open
LasneF opened this issue Feb 26, 2024 · 0 comments
Open

[feature] queryParameter renaming should be mentionned as warning #107

LasneF opened this issue Feb 26, 2024 · 0 comments
Labels

Comments

@LasneF
Copy link
Contributor

LasneF commented Feb 26, 2024

given an endpoint with a query parameter

parameters:
- $ref: '#/components/parameters/query_calibrationResultId'

given

query_calibrationResultId:
  name: calibrationResultId
  description: |
    Calibration result in which the resource(s) will be queried.
  in: query
  schema:
    type: string
  example: '1234'
  required: true

changing the parameterName (for instance changing here query_calibrationResultI to queryCalibrationResultId,
but keeping the same name shoud not be detected as special : meaning it s a change but not a breaking change , just renaming

currently it is a added / removed

openAPI change can be heavily used in case of refactoring ...

could be hard to detect with may be some edge cased, @daveshanley do not hesitate to close it if not applicable

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

No branches or pull requests

2 participants