Skip to content
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

Update appconfiguration.json #3089

Open
wants to merge 777 commits into
base: main
Choose a base branch
from
Open

Update appconfiguration.json #3089

wants to merge 777 commits into from

Conversation

dw511214992
Copy link

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:

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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:

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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.

zhenglaizhang and others added 30 commits March 10, 2022 15:02
* Update readme.md

* Update readme.md
* Update readme.md

* Update iotspaces.json
@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Apr 8, 2022

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores' removed or restructured?
Old: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L64:5
️❌LintDiff: 1 Errors, 1 Warnings failed [Detail]
The following errors/warnings are introduced by current PR:
Rule Message
R4016 - TopLevelResourcesListByResourceGroup The top-level resource 'ConfigurationStore' does not have list by resource group operation, please add it.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L1171
⚠️ R3027 - TrackedResourceListByResourceGroup The tracked resource, 'ConfigurationStore', must have a list by resource group operation.(This rule does not apply for tenant level resources.)
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L1171


The following errors/warnings exist before current PR submission:

Rule Message
R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L510
R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L557
R4009 - RequiredReadOnlySystemData The response of operation:'KeyValues_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L819
R4009 - RequiredReadOnlySystemData The response of operation:'KeyValues_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L866
R4037 - MissingTypeObject The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L1853
R4037 - MissingTypeObject The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L1887
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L1639
⚠️ 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/preview/2021-10-01-preview/appconfiguration.json#L1270
⚠️ 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/preview/2021-10-01-preview/appconfiguration.json#L1392
⚠️ 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/preview/2021-10-01-preview/appconfiguration.json#L1763
⚠️ 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/preview/2021-10-01-preview/appconfiguration.json#L2156
⚠️ 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/preview/2021-10-01-preview/appconfiguration.json#L1142
⚠️ 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/preview/2021-10-01-preview/appconfiguration.json#L1142
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌Avocado: 2 Errors, 0 Warnings failed [Detail]
Rule Message
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/appconfiguration/resource-manager/readme.md
json: preview/2021-10-01-preview/examples/ConfigurationStoresListByResourceGroup.json
MISSING_APIS_IN_DEFAULT_TAG The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag.
readme: specification/appconfiguration/resource-manager/readme.md
json: Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Apr 8, 2022

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 f01cbf4e9db921b23fbcfed2a5232092790024dd. 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] npm notice
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.5.0 -> 8.6.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.6.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
    warn	No file changes detected after generation
    warn	No package detected after generation
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs] Generate from f01cbf4e9db921b23fbcfed2a5232092790024dd. 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-GeneratAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    the given reference name 'refs/heads/sdkAuto/3089/' is not valid
    Error: the given reference name 'refs/heads/sdkAuto/3089/' is not valid
  • ️✔️ [View full logs
    error	Fatal error: the given reference name 'refs/heads/sdkAuto/3089/' is not valid
    error	The following packages are still pending:
    error
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from f01cbf4e9db921b23fbcfed2a5232092790024dd. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	sudo apt-get install -y dotnet-sdk-6.0
    command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
  • ️✔️Microsoft.Azure.Management.AppConfiguration [View full logs]  [Preview SDK Changes]
    warn	Skip artifact folder because it doesn't exist: artifacts/packages
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs] Generate from f01cbf4e9db921b23fbcfed2a5232092790024dd. 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
    cmderr	[automation_init.sh]  [email protected]: The functionality that this package provided is now in @npmcli/arborist
    cmderr	[automation_init.sh]  @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
    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-appconfiguration [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️❌ azure-sdk-for-go failed [Detail]
  • Failed [Logs] Generate from f01cbf4e9db921b23fbcfed2a5232092790024dd. SDK Automation 14.0.0
    command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    cmderr	[generator automation] [AUTOREST] FATAL: System.NullReferenceException: Object reference not set to an instance of an object.
    cmderr	[generator automation] [AUTOREST]    at AutoRest.Go.Model.PageTypeGo..ctor(MethodGo method) in /home/vsts/work/1/s/src/Model/PageTypeGo.cs:line 31
    cmderr	[generator automation] [AUTOREST]    at AutoRest.Go.Model.CodeModelGo.CreatePageableTypeForMethod(MethodGo method) in /home/vsts/work/1/s/src/Model/CodeModelGo.cs:line 387
    cmderr	[generator automation] [AUTOREST]    at AutoRest.Go.TransformerGo.TransformMethods(CodeModelGo cmg) in /home/vsts/work/1/s/src/TransformerGo.cs:line 342
    cmderr	[generator automation] [AUTOREST]    at AutoRest.Go.TransformerGo.TransformCodeModel(CodeModel cm) in /home/vsts/work/1/s/src/TransformerGo.cs:line 29
    cmderr	[generator automation] [AUTOREST]    at AutoRest.Go.Program.<ProcessInternal>d__3.MoveNext() in /home/vsts/work/1/s/src/Program.cs:line 107
    cmderr	[generator automation] [AUTOREST] --- End of stack trace from previous location where exception was thrown ---
    cmderr	[generator automation] [AUTOREST]    at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
    cmderr	[generator automation] [AUTOREST]    at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
    cmderr	[generator automation] [AUTOREST]    at System.Runtime.CompilerServices.TaskAwaiter`1.GetResult()
    cmderr	[generator automation] [AUTOREST]    at NewPlugin.<Process>d__20.MoveNext() in /home/vsts/work/1/s/autorest.common/src/Plugins/NewPlugin.cs:line 163
    cmderr	[generator automation] [AUTOREST] FATAL: go/generate - FAILED
    cmderr	[generator automation] [AUTOREST] FATAL: Error: Plugin go reported failure.
    cmderr	[generator automation] [AUTOREST]   Error: Plugin go reported failure.
    cmderr	[generator automation] [ERROR] total 1 error(s):
    cmderr	[generator automation] [ERROR] failed to execute autorest: autorest error with arguments '[email protected]/[email protected], --go, --verbose, --go-sdk-folder=., --use-onever, --version=2.0.4421, --go.license-header=MICROSOFT_MIT_NO_VERSION, --enum-prefix, --tag=package-2021-03-01-preview, --metadata-output-folder=/home/vsts/work/1/s/azure-sdk-for-go_tmp/generation-metadata-1649434104/package-2021-03-01-preview, ../../../../../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md':
    cmderr	[generator automation] [ERROR] exit status 1
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation
    warn	Skip package processing as generation is failed
️❌ azure-sdk-for-go-track2 failed [Detail]
  • Failed [Logs] Generate from f01cbf4e9db921b23fbcfed2a5232092790024dd. 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
    cmderr	[generator automation-v2] [ERROR] total 1 error(s):
    cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` 'go: downloading github.com/Azure/azure-sdk-for-go v61.1.0+incompatible
    cmderr	[generator automation-v2] [ERROR] �[33;1mWARNING: Unable to find version for /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration�[0m
    cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/appconfiguration/armappconfiguration, try to build in /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration
    cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration
    cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration
    cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.0.6335; node: v14.19.1, max-memory: 8192 MB]
    cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
    cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
    cmderr	[generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.1).
    cmderr	[generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest
    cmderr	[generator automation-v2] [ERROR] NOTE: AutoRest core version selected from configuration: ~2.0.4413.
    cmderr	[generator automation-v2] [ERROR] Loading AutoRest core      '/home/vsts/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4421)
    cmderr	[generator automation-v2] [ERROR] Loading AutoRest extension '@autorest/go' (4.0.0-preview.35->4.0.0-preview.35)
    cmderr	[generator automation-v2] [ERROR] Installing AutoRest extension '@microsoft.azure/autorest.go' (~2.1.47)
    cmderr	[generator automation-v2] [ERROR] Failed to acquire 'require'd configuration 'file:///home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/$%28this-folder%29/autorest-configuration.md'
    cmderr	[generator automation-v2] [ERROR] Failed to install or start extension '@microsoft.azure/autorest.go' (~2.1.47)
    cmderr	[generator automation-v2] [ERROR] Error: Could not read 'file:///home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/$%28this-folder%29/autorest-configuration.md'.
    cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
    cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh.exe": exit status 1
    cmderr	[generator automation-v2] [ERROR] ': exit status 1
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
    warn	Skip package processing as generation is failed
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Apr 8, 2022

Generated ApiView

Language Package Name ApiView Link
Java azure-resourcemanager-appconfiguration https://faked/apiView
JavaScript @azure/arm-appconfiguration https://faked/apiView

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.