-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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 : Preview API-Version 2024-05-01-preview #28962
Closed
drishtipeshwani09
wants to merge
4
commits into
Azure:main
from
drishtipeshwani09:drishtipeshwani09/containerinstance_new_apiversion_2024-05-01-preview
Closed
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
Contributor
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 MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/6aa04c53d24f56d36048a4bd71f5924479111c42/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/containerInstance.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.98/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-1B8z7T 2: ERROR: Schema violation: Data does not match any schemas from 'anyOf' 3: 4: code: 'ANY-OF-MISSING', 5: params: [], 6: message: "Data does not match any schemas from 'anyOf'", 7: path: '#/definitions/StandbyPoolProfileDefinition/properties/failContainerGroupCreateOnReuseFailure/type', 8: schemaId: 'https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json#', 9: inner: [ 10: 11: code: 'ENUM-MISMATCH', 12: params: [ 'bool' ], 13: message: 'No enum match for: bool', 14: path: '#/definitions/StandbyPoolProfileDefinition/properties/failContainerGroupCreateOnReuseFailure/type', 15: schemaId: undefined 16: , 17: 18: code: 'INVALID-TYPE', 19: params: [ 'array', 'string' ], 20: message: 'Expected type array but found type string', " |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/6aa04c53d24f56d36048a4bd71f5924479111c42/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2023-02-01-preview/containerInstance.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.98/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-L4NzOS 2: ERROR: Schema violation: Data does not match any schemas from 'anyOf' 3: 4: code: 'ANY-OF-MISSING', 5: params: [], 6: message: "Data does not match any schemas from 'anyOf'", 7: path: '#/definitions/StandbyPoolProfileDefinition/properties/failContainerGroupCreateOnReuseFailure/type', 8: schemaId: 'https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json#', 9: inner: [ 10: 11: code: 'ENUM-MISMATCH', 12: params: [ 'bool' ], 13: message: 'No enum match for: bool', 14: path: '#/definitions/StandbyPoolProfileDefinition/properties/failContainerGroupCreateOnReuseFailure/type', 15: schemaId: undefined 16: , 17: 18: code: 'INVALID-TYPE', 19: params: [ 'array', 'string' ], 20: message: 'Expected type array but found type string', " |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 18 Errors, 0 Warnings failed [Detail]
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L851 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L958 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L968 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1400 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1429 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L2086 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must be equal to one of the allowed values (definitions > ContainerGroupProperties > properties > properties > properties > isCreatedFromStandbyPool > type) allowedValues: array, boolean, integer, null, number, object, string" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must be array (definitions > ContainerGroupProperties > properties > properties > properties > isCreatedFromStandbyPool > type)" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must match a schema in anyOf (definitions > ContainerGroupProperties > properties > properties > properties > isCreatedFromStandbyPool > type)" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must be equal to one of the allowed values (definitions > ContainerGroupProfileReferenceDefinition > properties > revision > type) allowedValues: array, boolean, integer, null, number, object, string" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must be array (definitions > ContainerGroupProfileReferenceDefinition > properties > revision > type)" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must match a schema in anyOf (definitions > ContainerGroupProfileReferenceDefinition > properties > revision > type)" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must be equal to one of the allowed values (definitions > StandbyPoolProfileDefinition > properties > failContainerGroupCreateOnReuseFailure > type) allowedValues: array, boolean, integer, null, number, object, string" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must be array (definitions > StandbyPoolProfileDefinition > properties > failContainerGroupCreateOnReuseFailure > type)" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Schema violation: must match a schema in anyOf (definitions > StandbyPoolProfileDefinition > properties > failContainerGroupCreateOnReuseFailure > type)" |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Plugin 'schema-validator-swagger' completed with some error." |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"!Error: Plugin 'schema-validator-swagger' completed with some error." |
|
AutoRest exception |
"tag":"package-preview-2024-05", "details":"Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing." |
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: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
unacceptable kind of an object to dump [object Error] |
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/6aa04c53d24f56d36048a4bd71f5924479111c42/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json" |
unacceptable kind of an object to dump [object Error] |
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/6aa04c53d24f56d36048a4bd71f5924479111c42/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json" |
️❌
SemanticValidation: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
ENUM_MISMATCH |
No enum match for: bool JsonUrl: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1578:23 |
INVALID_TYPE |
Expected type array but found type string JsonUrl: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1578:23 |
ANY_OF_MISSING |
Data does not match any schemas from 'anyOf' JsonUrl: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1578:23 |
ENUM_MISMATCH |
No enum match for: int JsonUrl: Microsoft.ContainerInstance/preview/2024-05-01-preview/containerInstance.json#L1578:23 |
️️✔️
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
|
drishtipeshwani09
changed the title
Microsoft.ContainerInstance : New Preview Version 2024-05-01-preview
Microsoft.ContainerInstance : Preview API-Version 2024-05-01-preview
May 3, 2024
This was referenced May 3, 2024
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
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.