[API 2023-07-01 Update] Fixing distribute in ImageTemplateUpdateParameters#26487
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). |
|
Hi @zdelacerda-microsoft, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| imagebuilder.json | 2023-07-01(bd256d9) | 2023-07-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-07 | package-2023-07(bd256d9) | package-2023-07(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L1724 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L217 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L332 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L359 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L381 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L408 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L740 |
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.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L1980 |
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.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L2030 |
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L44 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L44 |
|
| Not using the common-types defined parameter 'location'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L44 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L44 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L83 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L83 |
|
| Not using the common-types defined parameter 'location'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L83 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L83 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L125 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L125 |
|
| Not using the common-types defined parameter 'location'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L125 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L125 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L187 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L187 |
|
| Not using the common-types defined parameter 'location'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L187 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L187 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L246 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L246 |
|
| Not using the common-types defined parameter 'location'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L246 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L246 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L286 |
|
| Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json#L286 |
️️✔️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.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
Please address or respond to feedback from the ARM API reviewer. |
|
/azp run TypeSpec Validation |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
…eters (#26487) * fixing distribute in ImageTemplateUpdateParameters * prettier * removing x-ms-identifiers from ImageTemplate
…eters (#26487) * fixing distribute in ImageTemplateUpdateParameters * prettier * removing x-ms-identifiers from ImageTemplate
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 review queue (for merge queues, see [4])
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 (for ARM review queue, [1])
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.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 ApiViewcomment 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.