Swagger for Machine API #25180
Merged
Swagger for Machine API #25180
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
added 2 commits
August 4, 2023 10:17
Related work items: #24759018
sushmak295
requested review from
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| managedClusters.json | 2023-07-02-preview(5dde315) | 2023-07-01(main) |
| managedClusters.json | 2023-07-02-preview(5dde315) | 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(5dde315) | 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] |
|---|---|---|
| The response of operation:'Machines_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-07-02-preview/managedClusters.json#L1385 |
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]
|
Hi, @sushmak295! 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 Generation Artifacts
|
Generated ApiView
|
microsoft-github-policy-service
bot
added
the
customer-reported
|
Thank you for your contribution sushmak295! We will review the pull request and get back to you soon. |
FumingZhang
reviewed
Aug 7, 2023
There was a problem hiding this comment.
Please fix sematic errors
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/parameters/AgentPoolNameParameter' is not referencing a valid location. paths,/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines,get,parameters,4
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:1385:11
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/definitions/MachineListResult' is not referencing a valid location. paths,/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines,get,responses,200,schema
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:1392:13
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/parameters/AgentPoolNameParameter' is not referencing a valid location. paths,/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName},get,parameters,4
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:1433:11
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/parameters/MachineNameParameter' is not referencing a valid location. paths,/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName},get,parameters,5
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:1436:11
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/definitions/Machine' is not referencing a valid location. paths,/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName},get,responses,200,schema
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:1443:13
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/definitions/Machine' is not referencing a valid location. parameters,MachineListResult,properties,value,items
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:8596:11
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/definitions/MachineProperties' is not referencing a valid location. parameters,Machine,properties,properties
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:8617:9
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/definitions/MachineNetworkProperties' is not referencing a valid location. parameters,MachineProperties,properties,network
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:8629:9
cmderr [generator automation-v2] [ERROR] error | InvalidRef | Ref '#/definitions/MachineIpAddress' is not referencing a valid location. parameters,MachineNetworkProperties,properties,ipAddresses,items
cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json:8648:11
matthchr
reviewed
Aug 7, 2023
...e-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/examples/MachineGet.json
Outdated
Show resolved
Hide resolved
...-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/examples/MachineList.json
Outdated
Show resolved
Hide resolved
|
Hi @sushmak295! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @sushmak295! The automation detected breaking changes in this pull request. As a result, it added the
|
added 2 commits
August 7, 2023 20:26
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
FumingZhang
reviewed
Aug 8, 2023
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Show resolved
Hide resolved
|
Hey @sushmak295, could you please fix the failed CI Swagger LintDiff?
|
serbrech
reviewed
Aug 8, 2023
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Show resolved
Hide resolved
…ainerService/aks/preview/2023-07-02-preview/managedClusters.json Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com>
added 2 commits
August 8, 2023 18:21
matthchr
reviewed
Aug 8, 2023
...e-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/examples/MachineGet.json
Outdated
Show resolved
Hide resolved
...-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/examples/MachineList.json
Outdated
Show resolved
Hide resolved
...e-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/examples/MachineGet.json
Outdated
Show resolved
Hide resolved
...-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/examples/MachineList.json
Outdated
Show resolved
Hide resolved
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Outdated
Show resolved
Hide resolved
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Outdated
Show resolved
Hide resolved
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Outdated
Show resolved
Hide resolved
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Show resolved
Hide resolved
...ource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json
Outdated
Show resolved
Hide resolved
added 2 commits
August 8, 2023 23:12
FumingZhang
approved these changes
Aug 9, 2023
FumingZhang
merged commit 43f4ef6
into
Azure:FumingZhang-containerservice-Microsoft.ContainerService-2023-07-02-preview
JeffreyRichter
added
the
Approved-BreakingChange
FumingZhang
added a commit
that referenced
this pull request
Aug 10, 2023
* 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 <81607949+FumingZhang@users.noreply.github.com> * swagger: machine api * swagger: machine api * swagger: machine api * swagger:machine api * swagger:machine api * swagger:machine api --------- Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com>
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 <nickkeller@nickmsftlaptop.lan> * 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 <81607949+FumingZhang@users.noreply.github.com> * Update specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-07-02-preview/managedClusters.json Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> --------- Co-authored-by: Janvi Jatakia (from Dev Box) <jajataki@microsoft.com> Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> * 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 <wenjungao@microsoft.com> * 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 <81607949+FumingZhang@users.noreply.github.com> * swagger: machine api * swagger: machine api * swagger: machine api * swagger:machine api * swagger:machine api * swagger:machine api --------- Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com> * 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 <sisalla@microsoft.com> * Remove overlay vpa unused properties (#25242) * remove unused properties * only remove from required section * remove the whole properties --------- Co-authored-by: zhifanhui <zhifanhui@microsoft.com> * 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__ <ptd2108@columbia.edu> Co-authored-by: Nick Keller <keller.nicholas@outlook.com> Co-authored-by: Nick Keller <nickkeller@nickmsftlaptop.lan> Co-authored-by: Jaiveer Katariya <35347859+jaiveerk@users.noreply.github.com> Co-authored-by: Janvi Jatakia <jatakiajanvi12@gmail.com> Co-authored-by: Janvi Jatakia (from Dev Box) <jajataki@microsoft.com> Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com> Co-authored-by: Wenjun Gao <wenjungaoat@gmail.com> Co-authored-by: Wenjun Gao <wenjungao@microsoft.com> Co-authored-by: Tongyao Si <tosi@microsoft.com> Co-authored-by: sushmak295 <sushmak295@gmail.com> Co-authored-by: sallasindhuja <114891776+sallasindhuja@users.noreply.github.com> Co-authored-by: Sindhuja Salla <sisalla@microsoft.com> Co-authored-by: huizhifan <60024380+huizhifan@users.noreply.github.com> Co-authored-by: zhifanhui <zhifanhui@microsoft.com> Co-authored-by: Sanya Kochhar <42152676+SanyaKochhar@users.noreply.github.com>
6 tasks
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] public repo review queue, private repo review queue
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
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.Getting help
and https://aka.ms/ci-fix.