-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[EventHubs]: Adding appropriate identifiers to array properties #23066
[EventHubs]: Adding appropriate identifiers to array properties #23066
Conversation
Hi, @damodaravadhani 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
ApplicationGroups.json | 2022-01-01-preview(989ce52) | 2022-01-01-preview(main) |
networkrulessets-preview.json | 2022-01-01-preview(989ce52) | 2022-01-01-preview(main) |
ApplicationGroups.json | 2022-10-01-preview(989ce52) | 2022-10-01-preview(main) |
networkrulessets-preview.json | 2022-10-01-preview(989ce52) | 2022-10-01-preview(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 2 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-01-preview | package-2022-01-preview(989ce52) | package-2022-01-preview(main) |
package-2022-10-preview | package-2022-10-preview(989ce52) | package-2022-10-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
XmsIdentifierValidation |
Missing identifier /properties/subnet/id in array item property Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L238 |
|
XmsIdentifierValidation |
Missing identifier /properties/subnet/id in array item property Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L238 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L37 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L82 |
ResourceNameRestriction |
The resource name parameter 'applicationGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L82 |
TrackedResourcePatchOperation |
Tracked resource 'ApplicationGroup' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L82 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'ApplicationGroup' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L87 |
AllResourcesMustHaveDelete |
The resource NetworkRuleSet does not have a corresponding delete operation. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L37 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L37 |
TrackedResourcePatchOperation |
Tracked resource 'NetworkRuleSet' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L37 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L128 |
MissingTypeObject |
The schema 'Subnet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L172 |
MissingTypeObject |
The schema 'NWRuleSetIpRules' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L181 |
MissingTypeObject |
The schema 'NWRuleSetVirtualNetworkRules' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L202 |
MissingTypeObject |
The schema 'NetworkRuleSet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L216 |
MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json#L218 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-10-01-preview/ApplicationGroups.json#L37 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-10-01-preview/ApplicationGroups.json#L82 |
ResourceNameRestriction |
The resource name parameter 'applicationGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-10-01-preview/ApplicationGroups.json#L82 |
TrackedResourcePatchOperation |
Tracked resource 'ApplicationGroup' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2022-10-01-preview/ApplicationGroups.json#L82 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'ApplicationGroup' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EventHub/preview/2022-10-01-preview/ApplicationGroups.json#L87 |
AllResourcesMustHaveDelete |
The resource NetworkRuleSet does not have a corresponding delete operation. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L37 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L37 |
TrackedResourcePatchOperation |
Tracked resource 'NetworkRuleSet' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L37 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L128 |
MissingTypeObject |
The schema 'Subnet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L172 |
MissingTypeObject |
The schema 'NWRuleSetIpRules' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L181 |
MissingTypeObject |
The schema 'NWRuleSetVirtualNetworkRules' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L202 |
MissingTypeObject |
The schema 'NetworkRuleSet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L216 |
MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json#L218 |
The API version:2022-01-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L6 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationGroupModel'. Consider using the plural form of 'ApplicationGroup' 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.EventHub/preview/2022-01-01-preview/ApplicationGroups.json#L42 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 4 Errors, 0 Warnings failed [Detail]
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌
PrettierCheck: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Code style issues found path: Microsoft.EventHub/preview/2022-01-01-preview/ApplicationGroups.json |
HowToFix |
Code style issues found path: Microsoft.EventHub/preview/2022-01-01-preview/networkrulessets-preview.json |
HowToFix |
Code style issues found path: Microsoft.EventHub/preview/2022-10-01-preview/ApplicationGroups.json |
HowToFix |
Code style issues found path: Microsoft.EventHub/preview/2022-10-01-preview/networkrulessets-preview.json |
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @damodaravadhani, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @damodaravadhani could you fix the failed checks? |
@ArcturusZhang, according to https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers, we have provided for an identifier in format "/properties/subnet/id". But LintDiff says this is invalid, can you help figure out what might be wrong with this format ? Thanks in advance. |
@ArcturusZhang , any help here would be appreciated ? Thanks ! |
Hi, @damodaravadhani. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @damodaravadhani. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.