-
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
Updated new api version from 05-01 to 05-02 #24050
Updated new api version from 05-01 to 05-02 #24050
Conversation
Hi, @pauld-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
AuthConfigs.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
AuthConfigs.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
AvailableWorkloadProfiles.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
AvailableWorkloadProfiles.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
BillingMeters.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
BillingMeters.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
CommonDefinitions.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
CommonDefinitions.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ConnectedEnvironments.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ConnectedEnvironments.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ConnectedEnvironmentsCertificates.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ConnectedEnvironmentsCertificates.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ConnectedEnvironmentsDaprComponents.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ConnectedEnvironmentsDaprComponents.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ConnectedEnvironmentsStorages.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ConnectedEnvironmentsStorages.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ContainerApps.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ContainerApps.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ContainerAppsRevisions.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ContainerAppsRevisions.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
Diagnostics.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
Diagnostics.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
Global.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
Global.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ManagedEnvironments.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ManagedEnvironments.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ManagedEnvironmentsDaprComponents.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ManagedEnvironmentsDaprComponents.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
ManagedEnvironmentsStorages.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
ManagedEnvironmentsStorages.json | 2023-05-02-preview(e8fc692) | 2022-11-01-preview(main) |
SourceControls.json | 2023-05-02-preview(e8fc692) | 2022-10-01(main) |
SourceControls.json | 2023-05-02-preview(e8fc692) | 2022-11-01-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:
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/e8fc692fca94fe96e424b47cf8784d15c035615c/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/Jobs.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.53/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR: Schema violation: Array is too short (0), minimum 1\n - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/Jobs.json:791:6 ($.definitions.Job.required)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n" |
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-preview-2023-05 | package-preview-2023-05(e8fc692) | package-preview-2023-05(release-app-Microsoft.App-2023-05-01-preview) |
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 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/AuthConfigs.json#L18 |
ResourceNameRestriction |
The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/AuthConfigs.json#L67 |
ResourceNameRestriction |
The resource name parameter 'authConfigName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/AuthConfigs.json#L67 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-05-02-preview/AuthConfigs.json#L160 |
DefinitionsPropertiesNamesCamelCase |
Property name should be camel case. Location: Microsoft.App/preview/2023-05-02-preview/AuthConfigs.json#L547 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.App/preview/2023-05-02-preview/BillingMeters.json#L37 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/Builders.json#L222 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/Builders.json#L290 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/Builders.json#L349 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/Builds.json#L213 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/Builds.json#L285 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironments.json#L100 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironments.json#L182 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironments.json#L198 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironments.json#L255 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironments.json#L311 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsCertificates.json#L18 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsCertificates.json#L68 |
ResourceNameRestriction |
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsCertificates.json#L68 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsCertificates.json#L161 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsDaprComponents.json#L18 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsDaprComponents.json#L67 |
ResourceNameRestriction |
The resource name parameter 'componentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsDaprComponents.json#L67 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsDaprComponents.json#L160 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsDaprComponents.json#L235 |
ResourceNameRestriction |
The resource name parameter 'componentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsDaprComponents.json#L235 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsStorages.json#L18 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsStorages.json#L47 |
ResourceNameRestriction |
The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsStorages.json#L65 |
ResourceNameRestriction |
The resource name parameter 'storageName' should be defined with a 'pattern' restriction. Location: Microsoft.App/preview/2023-05-02-preview/ConnectedEnvironmentsStorages.json#L65 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The JSON file has a circular reference. readme: specification/app/resource-manager/readme.md json: Microsoft.App/preview/2023-05-02-preview/CommonDefinitions.json |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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.
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @pauld-msft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Hi @pauld-msft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Hi, @pauld-msft, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
@Wzb123456789 is there a better way that I can update the API version? Container Apps needed to create another api version |
@pauld-msft Is the PR for the previous api version already available ? Can you please share that one so that we can chronologially review it and check the diffs across each version ? |
Also the target branch says that this is the release branch for 05-01-preview .. is that expected ? |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
@raosuhas - pull request where this version was introduced: #23697 Once the |
Its expected for now, but I was planning on pushing to the new branch in the near future |
@raosuhas - i don't seem to have permissions to, but do you think that you could name this branch to |
Closing in favor of #24240 |
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[x] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.