Add swagger for missing CheckPolicyRestrictions API version #15888
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, @calecarter 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. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The API version:2020-07-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.PolicyInsights/preview/2020-07-01-preview/checkPolicyRestrictions.json#L5 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The integer type does not have a format, please add it. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1233 |
|
The integer type does not have a format, please add it. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1238 |
|
The integer type does not have a format, please add it. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1243 |
|
The integer type does not have a format, please add it. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1483 |
|
The integer type does not have a format, please add it. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1483 |
|
The response schema of operations API '/providers/Microsoft.PolicyInsights/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1135 |
|
The schema 'PolicyTrackedResourcesQueryResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json#L233 |
|
The schema 'QueryFailure' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json#L341 |
|
The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json#L344 |
|
The schema 'RemediationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1054 |
|
The schema 'RemediationDeploymentsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1072 |
|
The schema 'RemediationDeployment' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1090 |
|
The schema 'Remediation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1132 |
|
The schema 'RemediationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1158 |
|
The schema 'RemediationFilters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1219 |
|
The schema 'RemediationDeploymentSummary' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1231 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1251 |
|
The schema 'ErrorDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1260 |
|
The schema 'TypedErrorInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-07-01/remediations.json#L1296 |
|
The schema 'PolicyEventsQueryResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json#L680 |
|
The schema 'QueryFailure' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json#L881 |
|
The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json#L884 |
|
The schema 'PolicyStatesQueryResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1210 |
|
The schema 'SummarizeResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1489 |
|
The schema 'Summary' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1512 |
|
The schema 'SummaryResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1536 |
|
The schema 'ComplianceDetail' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1578 |
|
The schema 'PolicyAssignmentSummary' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1592 |
|
The schema 'PolicyDefinitionSummary' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1623 |
|
The schema 'PolicyGroupSummary' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#L1651 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/policyinsights/resource-manager/readme.md tag: specification/policyinsights/resource-manager/readme.md#tag-package-2021-01 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.0)
- current:preview/2020-07-01-preview/checkPolicyRestrictions.json compared with base:stable/2020-07-01/checkPolicyRestrictions.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌[Staging] SDK Track2 Validation: 3 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"policyinsights/resource-manager/readme.md", "tag":"package-2020-07-preview", "details":"Duplicate Schema named ErrorResponse -- properties.error.$ref: undefined => "#/components/schemas/schemas:292" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"policyinsights/resource-manager/readme.md", "tag":"package-2020-07-preview", "details":"Duplicate Schema named ErrorDefinition -- properties.details.$ref: undefined => "#/components/schemas/schemas:296" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"policyinsights/resource-manager/readme.md", "tag":"package-2020-07-preview", "details":"Error: Plugin prechecker reported failure." |
| 💬 AutorestCore/Exception | "readme":"policyinsights/resource-manager/readme.md", "tag":"package-2020-07-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"policyinsights/resource-manager/readme.md", "tag":"package-2020-07-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"policyinsights/resource-manager/readme.md", "tag":"package-2020-07-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @calecarter, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Sep 1, 2021
pilor
reviewed
Sep 1, 2021
...sights/preview/2020-07-01-preview/examples/PolicyRestrictions_CheckAtResourceGroupScope.json
Outdated
Show resolved
Hide resolved
pilor
added
the
ARMSignedOff
pilor
approved these changes
Sep 1, 2021
weidongxu-microsoft
approved these changes
Sep 7, 2021
|
I assume this is not really a new api-version, but just adding something missing in specs? Let me know when it need merged. |
|
@weidongxu-microsoft you are correct. We were just flagged for missing this api version in swagger. Nothing new. It can be merged at your earliest convenience. |
This was referenced Sep 8, 2021
iscai-msft
added a commit
to iscai-msft/azure-rest-api-specs
that referenced
this pull request
Sep 10, 2021
…into add_endpoint * 'main' of https://github.com/Azure/azure-rest-api-specs: (5079 commits) Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version (Azure#15967) Updated SKU property to be read only (Azure#15965) Add Microsoft.Communication.UserDisconnected Event (Azure#15870) Add collection APIs (Azure#15221) [Cognitive Services - Personalizer] v1.1-preview.2 (Azure#15699) Adding default error response & updating basePath (Azure#15784) Update readme and readme.python (Azure#15973) add synapse batch tag package-composite-v1 (Azure#15974) Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 (Azure#15680) change readme.go.md template to track 2 (Azure#15972) [CosmosDB] Adding apiVersion 2021-07-01-preview (Azure#14817) Merge Dev-containerservice-microsoft.containerservice-2021-08-01 branch to main (Azure#15954) DiskRP swagger for 2021-04-01 (Azure#15665) Use IncidentSeverity in IncidentInfo (Azure#15762) Add stable API version "2021-09-01" (Azure#15897) add-purview-typescript-file (Azure#15948) Swagger Completeness for Microsoft.Authorization (Azure#15253) [Hub Generated] Review request for Microsoft.Aadiam to add version preview/2020-03-01-preview and stable/2020-03-01 (Azure#15861) Add swagger for missing CheckPolicyRestrictions API version (Azure#15888) Add Red Hat OpenShift 2021-09-01-preview (Azure#15616) ...
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.
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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[x] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.