authorization: adding the missing $filter option
#25080
Open
Conversation
This file contains 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
|
Hi, @tombuildsstuff! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| RoleManagementPolicy.json | 2020-10-01(70888c5) | 2020-10-01(main) |
| Rule | Message |
|---|---|
|
The optional parameter '$filter' was added in the new version. New: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L205:11 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2020-10-01 | package-2020-10-01(70888c5) | package-2020-10-01(main) |
| package-2022-04-01 | package-2022-04-01(70888c5) | package-2022-04-01(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The resource name parameter 'roleManagementPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L37 |
|
The resource name parameter 'roleManagementPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L37 |
|
Path '/{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.Authorization/roleManagementPolicies' that has the scope parameter.'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L189 |
|
Path '/{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.Authorization/roleManagementPolicies' that has the scope parameter.'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L189 |
|
The top-level resource 'RoleManagementPolicy' does not have list by subscription operation, please add it. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L294 |
|
The top-level resource 'RoleManagementPolicy' does not have list by subscription operation, please add it. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L294 |
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L44 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L44 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L90 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L90 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L148 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L148 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L196 |
|
| Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L196 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L339 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Authorization/stable/2020-10-01/RoleManagementPolicy.json#L339 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/authorization/resource-manager/readme.md tag: specification/authorization/resource-manager/readme.md#tag-package-2022-05-01-preview |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[NotRequired_Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CadlAPIView 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.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
microsoft-github-policy-service
bot
added
the
customer-reported
tombuildsstuff
added a commit
to hashicorp/pandora
that referenced
this pull request
Aug 1, 2023
…`'s missing `$filter` Upstream PR on `Azure/azure-rest-api-specs`: Azure/azure-rest-api-specs#25080 Fixes hashicorp/go-azure-sdk#288
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
|
Hi @tombuildsstuff! The automation detected this pull request introduces changes to at least one existing API version that violate Azure's versioning policy. To comply with the policy, these changes must be made in a new API version. As a result, the automation added the |
This was referenced Aug 1, 2023
tombuildsstuff
added a commit
to tombuildsstuff/openapi-diff
that referenced
this pull request
Nov 15, 2023
…s as a breaking change Breaking changes happen when the Request payload between one version of the API and another version of the API are incompatible - meaning that the minimum viable payload from the old API version does not work with the new API version. In the event of a new Optional field being added to the Request (or Response) payload the minimum viable request payload remains valid, therefore provided the field is correctly flagged as Required/Optional, we can lean on that to determine whether a breaking change is actually a breaking change. This fixes an issue seen in Azure/azure-rest-api-specs#26680 and Azure/azure-rest-api-specs#22407 and Azure/azure-rest-api-specs#25080 where the API Definition doesn't correctly document all of the possible fields within the Request/Response payloads. Since this is going a conditional check, this commit changes this from an Error to a Warning - as whilst there are situations where this can be a breaking change; this requires understanding the change.
konrad-jamrozik
added
VersioningReviewRequired
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is defined here: https://learn.microsoft.com/en-us/rest/api/authorization/privileged-role-policy-rest-sample
Fixes hashicorp/go-azure-sdk#288