Checkin Microsoft.Dashboard 2022-05-01-preview#19448
Merged
ArcturusZhang merged 4 commits intoAzure:mainfrom Jun 18, 2022
qingquanzhao:main
Merged
Checkin Microsoft.Dashboard 2022-05-01-preview#19448ArcturusZhang merged 4 commits intoAzure:mainfrom qingquanzhao:main
ArcturusZhang merged 4 commits intoAzure:mainfrom
qingquanzhao:main
Conversation
|
Hi, @qingquanzhao 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
|
| Rule | Message |
|---|---|
| 'PUT' operation 'PrivateEndpointConnections_Approve' 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.Dashboard/preview/2022-05-01-preview/grafana.json#L410 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L808 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedGrafana', must have a list by immediate parent operation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L929 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'ManagedGrafana', must have a list by immediate parent operation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L991 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L433 |
|
| 'privateLinkResourceName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L635 |
|
| 'ApiKey' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L878 |
|
| 'DeterministicOutboundIP' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L890 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L689 |
|
| 'requestBodyParameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L214 |
|
| 'requestBodyParameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L278 |
|
| 'ManagedGrafanaListResponse' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L723 |
|
| '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.Dashboard/preview/2022-05-01-preview/grafana.json#L726 |
|
| 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L732 |
|
| 'ProvisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L836 |
|
| 'ResourceSku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L855 |
|
| 'name' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L861 |
|
| 'ZoneRedundancy' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Dashboard/preview/2022-05-01-preview/grafana.json#L866 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 21 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.5)
- current:preview/2022-05-01-preview/grafana.json compared with base:preview/2021-09-01-preview/grafana.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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 @qingquanzhao, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-BreakingChange-Go
CI-BreakingChange-JavaScript
labels
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @qingquanzhao your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Member
|
Our service is in Public Preview now. This PR is to add a new API version target for GA release. |
|
The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue. |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
Member
Author
|
Hi, Sorry for the inconvenience. I added two commits: the first one is just a full copy of the existing 2021-09-01-preview version, the second is the change of 2022-05-01-preview based on previous version. Thanks |
ArcturusZhang
added
Approved-SdkBreakingChange-Go
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ArcturusZhang
approved these changes
Jun 18, 2022
This was referenced Jun 18, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jun 18, 2022
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
5 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.
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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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.