-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding base commit for new API Preview Version 2023-07-31-preview #26900
Adding base commit for new API Preview Version 2023-07-31-preview #26900
Conversation
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 |
---|---|---|
ManagedIdentity.json | 2023-07-31-preview(da815d9) | 2023-01-31(main) |
ManagedIdentity.json | 2023-07-31-preview(da815d9) | 2022-01-31-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-07-31-preview | package-2023-07-31-preview(da815d9) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Not using the common-types defined parameter 'scope'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L361 |
||
Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L361 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L361 |
||
Not using the common-types defined parameter 'api-version'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L361 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ManagedIdentity/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L87 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L88 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L178 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L388 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L436 |
MissingTypeObject |
The schema 'Identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L575 |
MissingTypeObject |
The schema 'IdentityUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L607 |
MissingTypeObject |
The schema 'SystemAssignedIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L643 |
TrackedResourcesMustHavePut |
The tracked resource SystemAssignedIdentity does not have a corresponding put operation. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L643 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L690 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L696 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L702 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L720 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L726 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L732 |
MissingTypeObject |
The schema 'UserAssignedIdentitiesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L785 |
MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L801 |
MissingTypeObject |
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L811 |
MissingTypeObject |
The schema 'OperationDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L856 |
MissingTypeObject |
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L882 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L915 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L938 |
The service-defined (reserved name) resource 'default' should be represented as a path parameter enum with modelAsString set to true .Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L37 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L46 |
|
Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L46 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L46 |
|
Not using the common-types defined parameter 'api-version'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L46 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: MsiOperationsList Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L74 |
|
Not using the common-types defined parameter 'scope'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L79 |
|
Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json#L79 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
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.
️️✔️
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
|
51f3969
to
98216ef
Compare
Hi @RamyaElangovanP! 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. |
pr/ RequestMerge |
/pr RequestMerge |
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.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReview
label.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
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
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section 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 the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
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 ApiView
comment 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.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.