Conversation
…10-01-preview to version 2023-09-01
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| grafana.json | 2023-09-01(04c8aef) | 2022-08-01(main) |
| grafana.json | 2023-09-01(04c8aef) | 2022-10-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-09-01 | package-2023-09-01(04c8aef) | default(main) |
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 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L145 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L259 |
PatchResponseCodes |
Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L259 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L302 |
XMSLongRunningOperationProperty |
If an operation's (PUT/POST/PATCH/DELETE) responses have Location or Azure-AsyncOperation headers then it MUST have the property x-ms-long-running-operation set to trueLocation: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L303 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L325 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L354 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L382 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L382 |
ProvisioningStateSpecifiedForLROPut |
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L429 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L429 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L524 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L552 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L600 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L648 |
ResourceNameRestriction |
The resource name parameter 'privateLinkResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L648 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L699 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L747 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L791 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L839 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L840 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L869 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L894 |
ResourceNameRestriction |
The resource name parameter 'managedPrivateEndpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L894 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L1062 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L1089 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L1121 |
DefinitionsPropertiesNamesCamelCase |
Property name should be camel case. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L1498 |
| Use the latest version v5 of types.json. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L31 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Dashboard/stable/2023-09-01/grafana.json#L38 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @yjsong11! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2023-09-01/grafana.json
Show resolved
Hide resolved
|
Please address or respond to feedback from the ARM API reviewer. |
|
/pr RequestMerge |
|
/pr RequestMerge |
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
* Adds base for updating Microsoft.Dashboard from version preview/2022-10-01-preview to version 2023-09-01 * Updates readme * Updates API version in new specs and examples * minor fixes --------- Co-authored-by: Younjin Song <younjinsong@microsoft.com>
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.