Skip to content

OperationID correction#81

Merged
FabrizioMoggio merged 5 commits intocamaraproject:mainfrom
ALIIQBAL786:OperationID-Correction-Branch
Oct 29, 2025
Merged

OperationID correction#81
FabrizioMoggio merged 5 commits intocamaraproject:mainfrom
ALIIQBAL786:OperationID-Correction-Branch

Conversation

@ALIIQBAL786
Copy link
Contributor

What type of PR is this?

Add one of the following kinds:

  • correction

What this PR does / why we need it:

Corrects misleading operationId values in the Traffic Influence API spec. Changes getAllTrafficInfluences to getTrafficInfluenceById for GET /traffic-influences/{trafficInfluenceID} to reflect single resource retrieval and getTrafficInfluence to getTrafficInfluences for GET /traffic-influences to align with its plural path and list output. These changes improve API clarity and usability.

Which issue(s) this PR fixes:

Fixes #80

Special notes for reviewers:

Please verify the updated operationId values align with endpoint functionality and OpenAPI best practices.

Changelog input

 release-note
- Fixed `operationId` for `GET /traffic-influences/{trafficInfluenceID}` from `getAllTrafficInfluences` to `getTrafficInfluenceById`.
- Updated `operationId` for `GET /traffic-influences` from `getTrafficInfluence` to `getTrafficInfluences` for consistency.

Additional documentation

This section can be blank.

docs
- Updated OpenAPI spec to reflect corrected `operationId` values in `traffic-influence.yaml`.

the two operationIDs where reversed. Anyway the new name "getTrafficInfluenceById" is a good one.
@FabrizioMoggio
Copy link
Contributor

the two operationIDs where reversed so one option would have been just switching them but the new proposed operationID getTrafficInfluenceById is too good to ignore it. @ALIIQBAL786 is this fine to you?

@ALIIQBAL786
Copy link
Contributor Author

@FabrizioMoggio Thank you for the review. It's fine for me.

FabrizioMoggio added a commit to FabrizioMoggio/TrafficInfluence that referenced this pull request Oct 29, 2025
Fixes: camaraproject#80

Substitutes (it is equal to) : camaraproject#81
@FabrizioMoggio
Copy link
Contributor

I made my code modification using the github editor. It appends extra lines at the end of the file so MegaLinter blocks the merge. I'm sorry but the easiest way for me to manage this situation is to create a new PR equal to this one. So unless @ALIIQBAL786 has other means to fix this problem, being the original author of the PR, I suggest to close this PR and to create a new one. I have the new PR ready to go if we decide to go with this option.

@JoseMConde
Copy link

Hi @FabrizioMoggio , but now is ok, isn't it??
It is just waiting for codeowner approval...
image

@ALIIQBAL786
Copy link
Contributor Author

@FabrizioMoggio Iet me try if I can fix this issue, if not we will go with the second option.

@ALIIQBAL786
Copy link
Contributor Author

@JoseMConde Thank you for the comment,
@FabrizioMoggio All checks has been passed now.

Copy link
Contributor

@FabrizioMoggio FabrizioMoggio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@FabrizioMoggio FabrizioMoggio merged commit 59c7031 into camaraproject:main Oct 29, 2025
2 checks passed
@FabrizioMoggio
Copy link
Contributor

I honestly didn't noticed that, I even don't know what I did differently :-)

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 this pull request may close these issues.

Fix Misleading operationId for GET /traffic-influences/{trafficInfluenceID}

3 participants