-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Microsoft.ContainerInstance: Added API version 2024-05-01-preview #28964
Microsoft.ContainerInstance: Added API version 2024-05-01-preview #28964
Conversation
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-05-01 to preview/2024-05-01-preview.
…Pool to Container Group Properties and ConfigMap to ContainerProperties specs and modified examples
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.12) | new version | base version |
---|---|---|
containerInstance.json | 2024-05-01-preview(e2ab4eb) | 2023-05-01(main) |
containerInstance.json | 2024-05-01-preview(e2ab4eb) | 2023-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L861:7 Old: Microsoft.ContainerInstance/stable/2023-05-01/containerInstance.json#L862:7 |
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1417:11 Old: Microsoft.ContainerInstance/stable/2023-05-01/containerInstance.json#L1400:11 |
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1417:11 Old: Microsoft.ContainerInstance/stable/2023-05-01/containerInstance.json#L1400:11 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 2 Warnings warning [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-preview-2024-05 | package-preview-2024-05(e2ab4eb) | default(main) |
[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: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1573 |
||
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: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1610 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L113 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L221 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L249 |
UnSupportedPatchProperties |
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L249 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L274 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L300 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L304 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L313 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L320 |
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.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L321 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L351 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L358 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L395 |
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.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L396 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L420 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L429 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ContainerInstance/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L456 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L457 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L495 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L511 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L511 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L512 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L558 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L571 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L571 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L627 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L627 |
ResourceNameRestriction |
The resource name parameter 'containerGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L754 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L755 |
ResourceNameRestriction |
The resource name parameter 'virtualNetworkName' should be defined with a 'pattern' restriction. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L790 |
️️✔️
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.
️️✔️
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
|
…iew_apiversion_2024-05-01-preview
…iew_apiversion_2024-05-01-preview
...source-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json
Show resolved
Hide resolved
...source-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json
Show resolved
Hide resolved
...source-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json
Show resolved
Hide resolved
…iew_apiversion_2024-05-01-preview
/azp run |
Azure Pipelines successfully started running 4 pipeline(s). |
…iew_apiversion_2024-05-01-preview
suppressions: | ||
- code: AvoidAdditionalProperties | ||
from: containerInstance.json | ||
reason: Using additionalProperties type as the object is user-defined and not subject to any validations at RP level. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/azp run |
Azure Pipelines successfully started running 4 pipeline(s). |
/azp run |
…iew_apiversion_2024-05-01-preview
/pr RequestMerge |
…iew_apiversion_2024-05-01-preview
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving to merge
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. 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 the diagram Step 2, "ARM API changes review", for this PR.
Additional information
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 ApiView
comment 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
suppressions guide to get approval.
Getting help
Purpose of this PR
andDue diligence checklist
.Next Steps to Merge
comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.