add x-ms-enum for eventgrid #17226
Merged
add x-ms-enum for eventgrid #17226
Conversation
This file contains 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
|
Hi, @ArcturusZhang 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. [email protected] |
|
[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 enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5953 |
|
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2609 |
|
The response of operation:'PrivateEndpointConnections_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2681 |
|
The response of operation:'TopicTypes_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L3548 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2307 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2826 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L3706 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L4097 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L4333 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L4394 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5002 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5072 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5106 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5140 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5186 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5347 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5360 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5659 |
|
Missing identifier id in array item property Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5738 |
| Since operation 'EventSubscriptions_GetDeliveryAttributes' response has model definition 'array', 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.EventGrid/stable/2021-12-01/EventGrid.json#L2021 |
|
| Since operation 'SystemTopicEventSubscriptions_GetDeliveryAttributes' response has model definition 'array', 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.EventGrid/stable/2021-12-01/EventGrid.json#L2071 |
|
| 'PUT' operation 'PrivateEndpointConnections_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2687 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2544 |
|
| The summary and description values should not be same. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L1101 |
|
| The summary and description values should not be same. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L1162 |
|
| OperationId should contain the verb: 'listkeys' in:'Domains_ListSharedAccessKeys'. Consider updating the operationId Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L360 |
|
| OperationId should contain the verb: 'listkeys' in:'Topics_ListSharedAccessKeys'. Consider updating the operationId Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L2499 |
|
| The child tracked resource, 'topics' with immediate parent 'Domain', must have a list by immediate parent operation. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L4186 |
|
| The child tracked resource, 'eventSubscriptions' with immediate parent 'SystemTopic', must have a list by immediate parent operation. Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L5239 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.EventGrid/stable/2021-12-01/EventGrid.json#L3713 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️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 inProgress [Detail]
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @ArcturusZhang, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
msyyc
approved these changes
Jan 14, 2022
|
Hi, @ArcturusZhang. 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 |
ghost
closed this
|
Hi, @ArcturusZhang. 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. |
|
We still need this PR, please do not close it. |
ahamad-MS
approved these changes
Feb 23, 2022
| "topics", | ||
| "domains" | ||
| ] | ||
| "$ref": "#/parameters/ParentTypeParameter" |
There was a problem hiding this comment.
It is not clear to me what is the purpose of this change and why needed? Can you please provide more context.
Please note that we are automatically generating the swagger using swashbuckle and hence any changes will require us to modify our generation code.
lirenhe
approved these changes
Feb 28, 2022
lirenhe
approved these changes
Feb 28, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Feb 28, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
Mar 7, 2022
* add x-ms-enum * add type name to keep consistency in java sdk * add parameter location flag * remove the common parameter * update * update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.