marketplacenotifications: fixing a duplicate Operation ID#16092
Closed
tombuildsstuff wants to merge 1 commit intoAzure:mainfrom
Closed
marketplacenotifications: fixing a duplicate Operation ID#16092tombuildsstuff wants to merge 1 commit intoAzure:mainfrom
tombuildsstuff wants to merge 1 commit intoAzure:mainfrom
Conversation
Prior to this commit, both the URI's:
GET /subscriptions/{subscription}/providers/Microsoft.MarketplaceNotifications/reviewsNotifications
GET /subscriptions/{subscription}/providers/Microsoft.MarketplaceNotifications/reviewsNotification/{notification}
had the same Operation ID `GetWithAuthorization` - when these should be unique per Operation.
As such this commit fixes this so that they have a unique Operation ID - introducing GetByIdWithAuthorization
|
Hi, @tombuildsstuff Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The operation id has been changed from 'Notification_GetWithAuthorization' to 'Notification_GetByIdWithAuthorization'. This will impact generated code. New: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L61:7 Old: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L61:7 |
️⚠️LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
| Rule | Message |
|---|---|
| Notification_GetByIdWithAuthorization lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L61 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L226 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L310 |
| Since operation 'Notifications_GetWithAuthorization' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L24 |
|
| Since operation 'Notification_GetOperations' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L106 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L282 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'NotificationModel'. Consider using the plural form of 'Notification' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L65 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'NotificationModel'. Consider using the plural form of 'Notification' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L106 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L270 |
|
| 'OfferProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L331 |
|
| 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L176 |
|
| Notifications_GetWithAuthorization lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L20 |
|
| Notification_GetOperations lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation. Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L102 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetReviewsNotifications Location: Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json#L94 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
ghost
added
the
customer-reported
Swagger Generation Artifacts
|
|
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
|
Hi @tombuildsstuff, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
25 tasks
Contributor
Author
|
@chunyu3 since there's two operations with the same Operation ID this isn't a breaking change - this didn't work previously, so I believe this is a bug in the breaking change detector. |
Contributor
Author
|
Closing this in favour of #16326 which is more semantically correct/in-line with other Azure API's |
tombuildsstuff
deleted the
b/marketplacenotifications-duplicate-operation-ids
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prior to this commit, both the URI's:
GET /subscriptions/{subscription}/providers/Microsoft.MarketplaceNotifications/reviewsNotifications
GET /subscriptions/{subscription}/providers/Microsoft.MarketplaceNotifications/reviewsNotification/{notification}
had the same Operation ID
GetWithAuthorization- when these should be unique per Operation.As such this commit fixes this so that they have a unique Operation ID - introducing GetByIdWithAuthorization