Adding Guardrails version to public swagger #25085
Merged
+209
−0
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, @sallasindhuja! 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 |
|---|---|---|
| managedClusters.json | 2023-07-02-preview(0f9636d) | 2023-07-01(main) |
| managedClusters.json | 2023-07-02-preview(0f9636d) | 2023-06-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-preview-2023-07 | package-preview-2023-07(0f9636d) | package-preview-2023-07(FumingZhang-containerservice-Microsoft.ContainerService-2023-07-02-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-07-02-preview/managedClusters.json#L7109 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/preview/2023-07-02-preview/managedClusters.json#L52 |
|
Operations API path must follow the schema provided in the common types. Location: aks/preview/2023-07-02-preview/managedClusters.json#L53 |
|
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/preview/2023-07-02-preview/managedClusters.json#L80 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-07-02-preview/managedClusters.json#L97 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-07-02-preview/managedClusters.json#L137 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-07-02-preview/managedClusters.json#L260 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-07-02-preview/managedClusters.json#L278 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-07-02-preview/managedClusters.json#L336 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-07-02-preview/managedClusters.json#L381 |
|
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-07-02-preview/managedClusters.json#L381 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-07-02-preview/managedClusters.json#L429 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L553 |
|
LRO PATCH must have 200 and 202 return codes. Location: aks/preview/2023-07-02-preview/managedClusters.json#L648 |
|
The patch operation body parameter schema should contain property 'identity'. Location: aks/preview/2023-07-02-preview/managedClusters.json#L667 |
|
The patch operation body parameter schema should contain property 'sku'. Location: aks/preview/2023-07-02-preview/managedClusters.json#L667 |
|
The async patch operation should return 202. Location: aks/preview/2023-07-02-preview/managedClusters.json#L677 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L687 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L737 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-07-02-preview/managedClusters.json#L797 |
|
A LRO POST operation must have both 200 & 202 return codes. Location: aks/preview/2023-07-02-preview/managedClusters.json#L967 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1011 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1163 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1276 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-07-02-preview/managedClusters.json#L1318 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1437 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-07-02-preview/managedClusters.json#L1457 |
|
200 response for a LRO POST operation must have a response schema specified. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1476 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1522 |
|
200 response for a LRO POST operation must have a response schema specified. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1538 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1585 |
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Aug 1, 2023
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @sallasindhuja! The automation detected breaking changes in this pull request. As a result, it added the |
This was referenced Aug 1, 2023
sallasindhuja
requested review from
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
tbarnes94
approved these changes
Aug 2, 2023
|
/azp run |
|
No commit pushedDate could be found for PR 25085 in repo Azure/azure-rest-api-specs |
FumingZhang
added
the
WaitForARMFeedback
|
Seeking for an ARM review and approval for this change as it's adding a new resource type As for the failed CI Breaking Change(Cross-Version), it's a false alert as it's comparing this change (a new preview API 2023-07-02-preview) with previous stable API (2023-06-01). |
weinong
reviewed
Aug 2, 2023
...crosoft.ContainerService/aks/preview/2023-07-02-preview/examples/ListGuardrailsVersions.json
Outdated
Show resolved
Hide resolved
rkmanda
added
the
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
matthchr
reviewed
Aug 2, 2023
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Outdated
Show resolved
Hide resolved
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Please resolve the branch conflicts before reviewing. 
|
ms-zhenhua
added
ARMChangesRequested
added 14 commits
August 8, 2023 23:09
sallasindhuja
force-pushed
the
julpcgrv/16943868
branch
from
dbaaa26 to
0f9636d
Compare
sallasindhuja
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ms-zhenhua
added
ARMSignedOff
FumingZhang
merged commit 2650e20
into
FumingZhang-containerservice-Microsoft.ContainerService-2023-07-02-preview
FumingZhang
pushed a commit
that referenced
this pull request
Aug 10, 2023
* Adding Guardrails version to public swagger * renamed GetGuardrailsVersions.json * Applied GetCollectionResponseSchema rule * Ran prettier fix * Minor change * moving parametre into managedClusters.json * GuardrailsAvailableVersion model change * Updated version param reference * Swagger SemanticValidation fix * model changes * prettier fix * Added version in list response * Changed to resource in GET and added descriptions where needed * Removed identifier in GuardrailsAvailableVersionsList --------- Co-authored-by: Sindhuja Salla <[email protected]>
ms-henglu
pushed a commit
that referenced
this pull request
Aug 22, 2023
…add version preview/2023-07-02-preview (#25254) * Adds base for updating Microsoft.ContainerService/aks from version preview/2023-06-02-preview to version 2023-07-02-preview * Updates readme * Updates API version in new specs and examples * update readmes (#25049) * add new field resourceUID to managed cluster properties (#25069) * add new field resourceUID to managed cluster properties https://msazure.visualstudio.com/CloudNativeCompute/_git/aks-rp/pullrequest/8416789 * update description * Mark guardrailsProfile Version as not required (#25081) * Mark guardrailsProfile Version as not required * Run prettier --------- Co-authored-by: Nick Keller <[email protected]> * Swagger Changes for Multiple DNS Zones for Web App Routing (#25064) * added web app routing changes for multiple dns zones * modified examples * Changes for unified azuremonitorprofile in Microsoft.ContainerService (#25063) * Changes for unified azuremonitorprofile * Update prettier changes * Update specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json Co-authored-by: FumingZhang <[email protected]> * Update specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json Co-authored-by: FumingZhang <[email protected]> --------- Co-authored-by: Janvi Jatakia (from Dev Box) <[email protected]> Co-authored-by: FumingZhang <[email protected]> * Add cost analysis to AKS preview Swagger (#25082) * update preview API to follow GA api - use one forceupgrade boolean in… (#25099) * update preview API to follow GA api - use one forceupgrade boolean instead of multiple overrides * update msg --------- Co-authored-by: Wenjun Gao <[email protected]> * Mark trusted access role binding PUT and DELETE operation as async (#25112) * Mark trusted access role binding PUT and DELETE operation as async * fix CI: update TA oepration's error to common type error * Swagger for Machine API (#25180) * Swagger for Machine List, Get API Related work items: #24759018 * Update managedClusters.json * Update managedClusters.json * Update MachineGet.json adding new line * Update MachineList.json * Update managedClusters.json * Update managedClusters.json * Update managedClusters.json * swagger: machine api * swagger: machine api * swagger:machine api * swagger: machine api * swagger: machine api * swagger: machine api * Update specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json Co-authored-by: FumingZhang <[email protected]> * swagger: machine api * swagger: machine api * swagger: machine api * swagger:machine api * swagger:machine api * swagger:machine api --------- Co-authored-by: FumingZhang <[email protected]> * Adding Guardrails version to public swagger (#25085) * Adding Guardrails version to public swagger * renamed GetGuardrailsVersions.json * Applied GetCollectionResponseSchema rule * Ran prettier fix * Minor change * moving parametre into managedClusters.json * GuardrailsAvailableVersion model change * Updated version param reference * Swagger SemanticValidation fix * model changes * prettier fix * Added version in list response * Changed to resource in GET and added descriptions where needed * Removed identifier in GuardrailsAvailableVersionsList --------- Co-authored-by: Sindhuja Salla <[email protected]> * Remove overlay vpa unused properties (#25242) * remove unused properties * only remove from required section * remove the whole properties --------- Co-authored-by: zhifanhui <[email protected]> * asm: update examples to use asm- prefix for revisions (#25247) * Revert "Mark trusted access role binding PUT and DELETE operation as async (#25112)" (#25233) This reverts commit db24ef8. * fix AgentPoolNameParameter location * Fuming zhang containerservice microsoft.container service 2023 07 02 preview (#25433) * adding requested properties. * adding requested properties * prettier check * removing read-only constraint --------- Co-authored-by: daru__ <[email protected]> Co-authored-by: Nick Keller <[email protected]> Co-authored-by: Nick Keller <[email protected]> Co-authored-by: Jaiveer Katariya <[email protected]> Co-authored-by: Janvi Jatakia <[email protected]> Co-authored-by: Janvi Jatakia (from Dev Box) <[email protected]> Co-authored-by: Matthew Christopher <[email protected]> Co-authored-by: Wenjun Gao <[email protected]> Co-authored-by: Wenjun Gao <[email protected]> Co-authored-by: Tongyao Si <[email protected]> Co-authored-by: sushmak295 <[email protected]> Co-authored-by: sallasindhuja <[email protected]> Co-authored-by: Sindhuja Salla <[email protected]> Co-authored-by: huizhifan <[email protected]> Co-authored-by: zhifanhui <[email protected]> Co-authored-by: Sanya Kochhar <[email protected]>
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.
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 PR review queue for azure-rest-api-specs repo
ARM PR review queue for azure-rest-api-specs-pr repo
The PRs are processed last (bottom) to first. Your PR may be on 2nd or later page.
If your PR is not on the queue, remove the
ARMChangesRequestedlabel. Most of the time automation should do it, but you can do it manually if necessary.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4]
ARM PR merge queue for azure-rest-api-specs repo
ARM PR merge queue for azure-rest-api-specs-pr repo
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 request review from an ARM API Review board.
ARM API changes review
ARMReviewlabel.ARMReviewlabel, if appropriate.If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.
Getting help
and https://aka.ms/ci-fix.