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

chore: Set Custom Operation ID for ApiOperation Annotations #310

Merged
merged 1 commit into from
May 23, 2024

Conversation

manuraf
Copy link
Contributor

@manuraf manuraf commented May 23, 2024

List of Changes

  • Updated ApiOperation annotations that has changed to include a custom operationId.
  • Ensured that these endpoint has a previous operationId to prevent naming conflicts and ensure smooth updates on APIM.

Motivation and Context

This pull request introduces a custom operationId within the ApiOperation annotations to ensure consistent updates of our APIs on Azure API Management (APIM). The custom operationId is crucial to avoid issues that arise when the operationId changes, which can prevent the API from updating correctly. Without a custom operationId, renaming an operationId necessitates deleting and recreating the entire API group, leading to temporary service disruptions and loss of analytics data.

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@manuraf manuraf requested a review from a team as a code owner May 23, 2024 14:30
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@manuraf manuraf merged commit c98ea82 into releases/1.0.7 May 23, 2024
6 checks passed
@manuraf manuraf deleted the ops/operation-id-custom branch May 23, 2024 14:35
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.

1 participant