Adding Microsoft.Dashboard stable 2022-08-01 API version#19692
Adding Microsoft.Dashboard stable 2022-08-01 API version#19692weidongxu-microsoft merged 2 commits intoAzure:mainfrom
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
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| grafana.json | 2022-08-01(a9848fc) | 2022-05-01(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version adds a response code '202'. New: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L294:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08-01 | package-2022-08-01(a9848fc) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| The operation 'Grafana_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L253 |
The following errors/warnings exist before current PR submission:
| 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/stable/2022-08-01/grafana.json#L416 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L695 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L814 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedGrafana', must have a list by immediate parent operation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L935 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'ManagedGrafana', must have a list by immediate parent operation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L997 |
|
| 'requestBodyParameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L214 |
|
| 'requestBodyParameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L278 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L439 |
|
| 'privateLinkResourceName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L641 |
|
| '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/stable/2022-08-01/grafana.json#L729 |
|
| '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/stable/2022-08-01/grafana.json#L732 |
|
| '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/stable/2022-08-01/grafana.json#L738 |
|
| '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/stable/2022-08-01/grafana.json#L842 |
|
| '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/stable/2022-08-01/grafana.json#L861 |
|
| '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/stable/2022-08-01/grafana.json#L867 |
|
| '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/stable/2022-08-01/grafana.json#L872 |
|
| '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/stable/2022-08-01/grafana.json#L884 |
|
| '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/stable/2022-08-01/grafana.json#L896 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Dashboard' for api version '2022-08-01'. The supported api-versions are '2021-09-01-preview, 2022-05-01-preview'." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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
- "https://github.com/Azure/azure-rest-api-specs/blob/a9848fce4e7f9fe1d0f5b0cbc9c7447c05af3948/specification/dashboard/resource-manager/readme.md#tag-package-2022-08-01">dashboard/resource-manager/readme.md#package-2022-08-01
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
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). |
specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2022-08-01/grafana.json
Show resolved
Hide resolved
|
Hi @qingquanzhao, 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. |
|
What is the purpose of the new api-version? I only see a few 202 response code. Is there no new feature in it? |
|
hi @weidongxu-microsoft |
|
Approved. Notify me to merge when service roll out. |
|
Oh, I forget breaking changes on Go SDK. @tadelesh for check on Go. |
|
hi @weidongxu-microsoft It has pass GO SDK check. Can you please help merge it? |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
It seems you service is not rolled out. API Readiness Check still fails. |
Yes, we just triggered the rollout yesterday after the RPSaaSMaster PR is merged, will wait until the rollout is complete. Thanks! |
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.