update path #3579

ruowan · 2022-09-19T03:13:33Z

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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-pipeline-app-test · 2022-09-19T03:13:35Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.1)]	new version	base version
appconfiguration.json	2022-05-01(a1fed63)	2022-05-01(main)

Rule	Message
`❌` 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores' removed or restructured? Old: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L18:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L18:5

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

There are no breaking changes.

️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-05-01	package-2022-05-01(a1fed63)	package-2022-05-01(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
`❌` R4017 - TopLevelResourcesListBySubscription	The top-level resource 'ConfigurationStore' does not have list by subscription operation, please add it. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1220

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4037 - MissingTypeObject	The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1902
`❌` R4037 - MissingTypeObject	The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1936
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1688
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePurgeProtection Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1319
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePurgeProtection Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1441
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1812
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: purgeProtectionEnabled Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L2205
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L559
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L606
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'KeyValues_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L868
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'KeyValues_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L915
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameAvailable Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1191
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameNotAvailable Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1191

️️✔️PR Summary succeeded [Detail] [Expand]

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

Validation passes for Avocado.

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

Rule	Message
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L236:22 ExampleUrl: stable/2022-05-01/examples/ConfigurationStoresDelete.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L696:22 ExampleUrl: stable/2022-05-01/examples/ConfigurationStoresDeletePrivateEndpointConnection.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L998:22 ExampleUrl: stable/2022-05-01/examples/ConfigurationStoresDeleteKeyValue.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1126:22 ExampleUrl: stable/2022-05-01/examples/DeletedConfigurationStoresPurge.json

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

Validation passes for SemanticValidation.

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

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️❌[Staging] SpellCheck: 3 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` HowToFix	Unknown word (thes), please fix the error or add words to ./custom-words.txt path: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L23:31
`❌` HowToFix	Unknown word (configsursation), please fix the error or add words to ./custom-words.txt path: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L23:36
`❌` HowToFix	Unknown word (sssstoress), please fix the error or add words to ./custom-words.txt path: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L23:52

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

The following tags are being changed in this PR

"https://github.com/openapi-env-test/azure-rest-api-specs/blob/a1fed63cc93ff7ebf23a0c0673dfbd8b6820f0eb/specification/appconfiguration/resource-manager/readme.md#tag-package-2022-05-01">appconfiguration/resource-manager/readme.md#package-2022-05-01

The following errors/warnings exist before current PR submission:

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

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

Validation passes for CadlValidation.

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

openapi-pipeline-app-test · 2022-09-19T03:13:36Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

⚠️Warning [Logs] Generate from 65909f9e91a64162f394f257958c172a2c5b4de5. 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]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-appconfiguration [View full logs] [Preview SDK Changes]
- azure-mgmt-appconfiguration-2.1.0.zip
- azure_mgmt_appconfiguration-2.1.0-py3-none-any.whl
```
info	[Changelog]
```

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs] Generate from 65909f9e91a64162f394f257958c172a2c5b4de5. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:515
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m 515 | �[0m         �[96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m     | �[91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91m�[96m     | �[91mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.ResourceManager.AppConfiguration [View full logs] [Preview SDK Changes] Breaking Change Detected

Azure.ResourceManager.AppConfiguration.1.1.0-alpha.20221021.1.nupkg

info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.AppConfiguration/Debug/netstandard2.0/Azure.ResourceManager.AppConfiguration.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/src/Azure.ResourceManager.AppConfiguration.csproj]

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from 65909f9e91a64162f394f257958c172a2c5b4de5. 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
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs] Generate from 65909f9e91a64162f394f257958c172a2c5b4de5. 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
cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.

️✔️@azure/arm-appconfiguration [View full logs] [Preview SDK Changes]
- azure-arm-appconfiguration-3.0.0-beta.5.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

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

️✔️Succeeded [Logs] Generate from 65909f9e91a64162f394f257958c172a2c5b4de5. 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

️✔️sdk/resourcemanager/appconfiguration/armappconfiguration [View full logs] [Preview SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

openapi-pipeline-app-test · 2022-09-19T03:13:36Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/appconfiguration/armappconfiguration	Create ApiView failed. Please ask PR assignee for help
Python	track2_azure-mgmt-appconfiguration	Create ApiView failed. Please ask PR assignee for help
.Net	Azure.ResourceManager.AppConfiguration	Create ApiView failed. Please ask PR assignee for help
JavaScript	@azure/arm-appconfiguration	Create ApiView failed. Please ask PR assignee for help

ruowan · 2022-09-19T03:50:18Z

/azp run

azure-pipelines · 2022-09-19T03:50:23Z

No pipelines are associated with this pull request.

ruowan · 2022-09-19T06:17:11Z

/azp run

azure-pipelines · 2022-09-19T06:17:16Z

No pipelines are associated with this pull request.

ruowan · 2022-09-19T13:57:07Z

/azp run

azure-pipelines · 2022-09-19T13:57:12Z

No pipelines are associated with this pull request.

ruowan · 2022-09-20T01:28:43Z

/azp run

azure-pipelines · 2022-09-20T01:28:48Z

No pipelines are associated with this pull request.

update path

4523b71

openapi-pipeline-app-test bot added resource-manager BreakingChangeReviewRequired CI-FixRequiredOnFailure labels Sep 19, 2022

AzureRestAPISpecReview added WaitForARMFeedback ARMReview labels Sep 19, 2022

ruowan removed WaitForARMFeedback ARMReview labels Sep 19, 2022

AzureRestAPISpecReview added ARMReview WaitForARMFeedback labels Sep 19, 2022

AzureRestAPISpecReview removed NewApiVersionRequired labels Sep 26, 2022

Update appconfiguration.json

930c48f

ruowan added 4 commits October 21, 2022 11:22

Update appconfiguration.json

5be117e

Merge ok

72d4f29

Merge ok

3b0b2ab

Update appconfiguration.json

a4c069a

AzureRestAPISpecReview added BreakingChangeReviewRequired NewApiVersionRequired labels Oct 21, 2022

Update appconfiguration.json

38ff1e9

azure-sdk mentioned this pull request Oct 21, 2022

[AutoPR Azure.ResourceManager.AppConfiguration] update path openapi-env-test/azure-sdk-for-net#1259

Closed

ruowan added the Approved-OkToMerge label Oct 21, 2022

ruowan added 2 commits October 21, 2022 11:33

Merge branch

d72cc07

Update appconfiguration.json

a1fed63

MaryGao force-pushed the main branch from 10d6e6a to d632c45 Compare March 24, 2023 09:31

MaryGao requested review from msyyc, ArcturusZhang, qiaozha and mikekistler as code owners March 24, 2023 09:31

MaryGao force-pushed the main branch from c9d3abd to ff6b6bf Compare March 24, 2023 10:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

update path #3579

update path #3579

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 •

edited

Loading

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

azure-pipelines bot commented Sep 19, 2022

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

azure-pipelines bot commented Sep 19, 2022

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

azure-pipelines bot commented Sep 19, 2022

Uh oh!

ruowan commented Sep 20, 2022

Uh oh!

azure-pipelines bot commented Sep 20, 2022

Uh oh!

Uh oh!

update path #3579

Are you sure you want to change the base?

update path #3579

Uh oh!

Conversation

ruowan commented Sep 19, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

azure-pipelines bot commented Sep 19, 2022

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

azure-pipelines bot commented Sep 19, 2022

Uh oh!

ruowan commented Sep 19, 2022

Uh oh!

azure-pipelines bot commented Sep 19, 2022

Uh oh!

ruowan commented Sep 20, 2022

Uh oh!

azure-pipelines bot commented Sep 20, 2022

Uh oh!

Uh oh!

openapi-pipeline-app-test bot commented Sep 19, 2022 •

edited

Loading

openapi-pipeline-app-test bot commented Sep 19, 2022 •

edited

Loading

openapi-pipeline-app-test bot commented Sep 19, 2022 •

edited

Loading