change response code #20081

xwang971 · 2022-08-02T22:14:19Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-08-02T22:14:21Z

Hi, @xwang971 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2022-08-02T22:14:22Z

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.9.6)]	new version	base version
SourceControls.json	2022-01-01-preview(c3301a4)	2022-01-01-preview(main)
SourceControls.json	2022-03-01(c3301a4)	2022-03-01(main)

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '201'. New: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L185:11
`❌` 1011 - AddingResponseCode	The new version adds a response code '201'. New: Microsoft.App/stable/2022-03-01/SourceControls.json#L185:11
`❌` 1012 - RemovedResponseCode	The new version removes the response code '202' Old: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L185:11
`❌` 1012 - RemovedResponseCode	The new version removes the response code '202' Old: Microsoft.App/stable/2022-03-01/SourceControls.json#L185:11

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️⌛CredScan pending [Detail]

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-03	package-2022-03(c3301a4)	package-2022-03(main)
package-2022-01-01-preview	package-2022-01-01-preview(c3301a4)	package-2022-01-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L137
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L205
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L137
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L205
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L264
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L264

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️⌛PoliCheck pending [Detail]

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/c3301a473afea4dd69f20565c843caebc4060cfe/specification/app/resource-manager/readme.md#tag-package-2022-03">app/resource-manager/readme.md#package-2022-03
"https://github.com/Azure/azure-rest-api-specs/blob/c3301a473afea4dd69f20565c843caebc4060cfe/specification/app/resource-manager/readme.md#tag-package-2022-01-01-preview">app/resource-manager/readme.md#package-2022-01-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"app/resource-manager/readme.md", "tag":"package-2022-03", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"
⚠️ UnkownSecurityScheme	"readme":"app/resource-manager/readme.md", "tag":"package-2022-01-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-08-02T22:14:23Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - armappcontainers - 2.0.0

❌azure-sdk-for-python-track2 - track2_azure-mgmt-appcontainers - 1.0.0

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 680eab4. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-appcontainers [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter id
info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter name
info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter system_data
info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter type

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 680eab4. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-appcontainers [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 680eab4. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️armappcontainers [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*CertificatesClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, string, *CertificatesClientCreateOrUpdateOptions)` to `(context.Context, string, string, string, Certificate, *CertificatesClientCreateOrUpdateOptions)`
info	[Changelog] - Struct `CustomHostnameAnalysisResultProperties` has been removed
info	[Changelog] - Field `CertificateEnvelope` of struct `CertificatesClientCreateOrUpdateOptions` has been removed
info	[Changelog] - Field `Properties` of struct `CustomHostnameAnalysisResult` has been removed
info	[Changelog] - Field `ID` of struct `CustomHostnameAnalysisResult` has been removed
info	[Changelog] - Field `Name` of struct `CustomHostnameAnalysisResult` has been removed
info	[Changelog] - Field `SystemData` of struct `CustomHostnameAnalysisResult` has been removed
info	[Changelog] - Field `Type` of struct `CustomHostnameAnalysisResult` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `AlternateCNameRecords` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `AlternateTxtRecords` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `ConflictingContainerAppResourceID` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `CustomDomainVerificationTest` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `HasConflictOnManagedEnvironment` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `ARecords` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `CNameRecords` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `TxtRecords` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `CustomDomainVerificationFailureInfo` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `HostName` in struct `CustomHostnameAnalysisResult`
info	[Changelog] - New field `IsHostnameAlreadyVerified` in struct `CustomHostnameAnalysisResult`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 1 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 680eab4. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-appcontainers [View full logs] [Release SDK Changes]

azure-arm-appcontainers-1.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface AuthConfig
info	[Changelog]   - Added Interface Certificate
info	[Changelog]   - Added Interface ContainerApp
info	[Changelog]   - Added Interface CustomHostnameAnalysisResult
info	[Changelog]   - Added Interface DaprComponent
info	[Changelog]   - Added Interface ManagedEnvironment
info	[Changelog]   - Added Interface ManagedEnvironmentStorage
info	[Changelog]   - Added Interface ProxyResource
info	[Changelog]   - Added Interface Replica
info	[Changelog]   - Added Interface Revision
info	[Changelog]   - Added Interface SourceControl
info	[Changelog]   - Added Interface TrackedResource
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 680eab4. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️app [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 680eab4. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.ContainerAppsApi [View full logs] [Release SDK Changes]
- Az.ContainerAppsApi.0.1.0.nupkg

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-08-02T22:14:23Z

Generated ApiView

Language	Package Name	ApiView Link
Python	track2_azure-mgmt-appcontainers	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
Java	azure-resourcemanager-appcontainers	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
JavaScript	@azure/arm-appcontainers	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help

openapi-workflow-bot · 2022-08-02T22:23:16Z

Hi @xwang971, 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.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

openapi-workflow-bot · 2022-08-02T22:23:17Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

ruslany · 2022-08-08T17:12:00Z

@lirenhe - the breaking change was approved - please merge the PR

change response code

c3301a4

openapi-assignment-bot bot assigned leni-msft Aug 2, 2022

openapi-workflow-bot bot added the FixS360 label Aug 2, 2022

openapi-pipeline-app bot added resource-manager BreakingChangeReviewRequired labels Aug 2, 2022

azure-sdk mentioned this pull request Aug 2, 2022

[AutoPR armappcontainers] change response code azure-sdk/azure-sdk-for-go#1917

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Aug 2, 2022

azure-sdk mentioned this pull request Aug 2, 2022

[AutoPR track2_azure-mgmt-appcontainers] change response code azure-sdk/azure-sdk-for-python#998

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Aug 2, 2022

mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 8, 2022

lirenhe approved these changes Aug 9, 2022

View reviewed changes

lirenhe merged commit 680eab4 into main Aug 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

change response code #20081

change response code #20081

xwang971 commented Aug 2, 2022 •

edited

Loading

openapi-workflow-bot bot commented Aug 2, 2022

openapi-pipeline-app bot commented Aug 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 2, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 2, 2022 •

edited

Loading

openapi-workflow-bot bot commented Aug 2, 2022

openapi-workflow-bot bot commented Aug 2, 2022

ruslany commented Aug 8, 2022

change response code #20081

change response code #20081

Conversation

xwang971 commented Aug 2, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Aug 2, 2022

openapi-pipeline-app bot commented Aug 2, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Aug 2, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 2, 2022 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Aug 2, 2022

openapi-workflow-bot bot commented Aug 2, 2022

ruslany commented Aug 8, 2022

xwang971 commented Aug 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 2, 2022 •

edited

Loading

openapi-pipeline-app bot commented Aug 2, 2022 •

edited

Loading