Merged
Conversation
|
Hi, @weng5e 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(d83c55a) | 2022-08-01(main) |
| Rule | Message |
|---|---|
|
The new version has a new property 'grafanaIntegrations' in response that was not found in the old version. New: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L746:7 Old: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L746:7 |
|
The new version has a new optional property 'grafanaIntegrations' that was not found in the old version. New: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L746:7 Old: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L746:7 |
|
The new version has a new optional property 'grafanaIntegrations' that was not found in the old version. New: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L826:7 Old: Microsoft.Dashboard/stable/2022-08-01/grafana.json#L823:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⌛CredScan pending [Detail]
️⚠️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(d83c55a) | package-2022-08-01(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| 'azureMonitorWorkspaceIntegrations' 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#L945 |
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#L817 |
|
| 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 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#L964 |
|
| 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#L1026 |
|
| '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#L848 |
|
| '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#L867 |
|
| '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#L873 |
|
| '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#L878 |
|
| '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#L890 |
|
| '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#L902 |
️️✔️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.
️⌛PoliCheck pending [Detail]
️️✔️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/d83c55aec572f679c39e21725a1a37204dc7ad72/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
|
Generated ApiView
|
|
NewApiVersionRequired reason: |
This was referenced Aug 2, 2022
This was referenced Aug 2, 2022
Closed
Closed
Closed
Contributor
|
According to @qingquanzhao , Service will official GA on 23 Aug. not any CLI/SDK released. so I approved and merged this change |
akning-ms
approved these changes
Aug 3, 2022
akning-ms
added
the
Approved-BreakingChange
This was referenced Aug 3, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Aug 3, 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
3 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.