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

Added missing updatable properties in ConfigurationStorePropertiesUpdateParameters #14452

Conversation

jimmyca15
Copy link
Member

@jimmyca15 jimmyca15 commented May 18, 2021

Changelog

Please ensure to add changelog with 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

When we added this swagger we missed the property being added in this PR. This causes a problem because we cannot generate the correct SDK.

This property exists here in our latest stable version. It was missed when we added this new 2021-03-01-preview API version.

  1. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.

This API version was made available last week.

  1. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.

This swagger is checked in but it has this bug.

  1. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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
Copy link

Hi, @jimmyca15 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 18, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 18, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️⌛[Staging] SDK Breaking Change Tracking pending [Detail]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 8295604. 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
      Resource not accessible by integration
      HttpError: Resource not accessible by integration
          at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit/request@5.5.0/node_modules/@octokit/request/dist-node/index.js:76:23
          at processTicksAndRejections (internal/process/task_queues.js:95:5)
          at async workflowPkgUpdatePR (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:330:21)
          at async Object.exports.workflowPkgMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:41:5)
          at async workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
          at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
          at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️Az.AppConfiguration [View full logs
      error	Fatal error: Resource not accessible by integration
      error	The following packages are still pending:
      error		Az.AppConfiguration
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8295604. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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
    • ️✔️azure-mgmt-appconfiguration [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model OperationDefinition has a new parameter is_data_action
      info	[Changelog]   - Model OperationDefinition has a new parameter properties
      info	[Changelog]   - Model OperationDefinition has a new parameter origin
      info	[Changelog]   - Model ConfigurationStore has a new parameter system_data
      info	[Changelog]   - Model ConfigurationStore has a new parameter disable_local_auth
      info	[Changelog]   - Model KeyValue has a new parameter id
      info	[Changelog]   - Model KeyValue has a new parameter name
      info	[Changelog]   - Model KeyValue has a new parameter type
      info	[Changelog]   - Model ConfigurationStoreUpdateParameters has a new parameter disable_local_auth
      info	[Changelog]   - Added operation group KeyValuesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model Resource no longer has parameter tags
      info	[Changelog]   - Model Resource no longer has parameter location
      info	[Changelog]   - Removed operation ConfigurationStoresOperations.list_key_value
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8295604. 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
    • ️✔️track2_azure-mgmt-appconfiguration [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationStore has a new parameter disable_local_auth
      info	[Changelog]   - Model ConfigurationStore has a new parameter system_data
      info	[Changelog]   - Model ConfigurationStoreUpdateParameters has a new parameter disable_local_auth
      info	[Changelog]   - Model OperationDefinition has a new parameter is_data_action
      info	[Changelog]   - Model OperationDefinition has a new parameter properties
      info	[Changelog]   - Model OperationDefinition has a new parameter origin
      info	[Changelog]   - Model KeyValue has a new parameter name
      info	[Changelog]   - Model KeyValue has a new parameter id
      info	[Changelog]   - Model KeyValue has a new parameter type
      info	[Changelog]   - Added operation group KeyValuesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model Resource no longer has parameter tags
      info	[Changelog]   - Model Resource no longer has parameter location
      info	[Changelog]   - Removed operation ConfigurationStoresOperations.list_key_value
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8295604. 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
      cmderr	[generate.py] 2021-06-18 02:04:51 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-appconfiguration;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-18 02:04:51 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-18 02:04:51 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.30 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/appconfiguration/azure-resourcemanager-appconfiguration --java.namespace=com.azure.resourcemanager.appconfiguration   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-appconfiguration
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [POM][Skip] pom already has module azure-resourcemanager-appconfiguration
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [POM][Skip] pom already has module sdk/appconfiguration
      cmderr	[generate.py] 2021-06-18 02:05:22 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-appconfiguration [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-18 02:07:54 DEBUG Got artifact_id: azure-resourcemanager-appconfiguration
      cmderr	[Inst] 2021-06-18 02:07:54 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-18 02:07:54 DEBUG Got artifact: azure-resourcemanager-appconfiguration-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-18 02:07:54 DEBUG Match jar package: azure-resourcemanager-appconfiguration-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-18 02:07:54 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14452/azure-sdk-for-java/azure-resourcemanager-appconfiguration/azure-resourcemanager-appconfiguration-1.0.0-beta.2.jar\" -o azure-resourcemanager-appconfiguration-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-appconfiguration -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-appconfiguration-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8295604. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --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]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8295604. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
    • ️✔️@azure/arm-appconfiguration [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/appConfigurationManagementClient.js → ./dist/arm-appconfiguration.js...
      cmderr	[npmPack] created ./dist/arm-appconfiguration.js in 331ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8295604. SDK Automation 14.0.0
      command	sh ./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
    • ️✔️appconfiguration/mgmt/2020-06-01/appconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️appconfiguration/mgmt/2019-10-01/appconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/appconfiguration/mgmt/2021-03-01-preview/appconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New field `PublicNetworkAccess` in struct `ConfigurationStorePropertiesUpdateParameters`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/appconfiguration/mgmt/2020-07-01-preview/appconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/appconfiguration/mgmt/2019-11-01-preview/appconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/appconfiguration/mgmt/2019-02-01-preview/appconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8295604. 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
    • ️✔️appconfiguration [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    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.

    @weidongxu-microsoft
    Copy link
    Member

    Java is OK as SDK in preview.

    @msyyc
    Copy link
    Member

    msyyc commented May 19, 2021

    For python, the breaking change is expected

    Copy link
    Member

    @lirenhe lirenhe left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approved as the JS SDK is not released yet, no impact to the current user

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 21, 2021
    @jimmyca15
    Copy link
    Member Author

    @ruowan looks you got assigned, can you do the merge for us?

    @ghost
    Copy link

    ghost commented Jun 6, 2021

    Hi, @jimmyca15. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Jun 6, 2021
    @jimmyca15
    Copy link
    Member Author

    @ruowan can you please merge this?

    @ghost ghost removed the no-recent-activity label Jun 15, 2021
    @ruowan ruowan merged commit 8295604 into Azure:master Jun 16, 2021
    This was referenced Jun 16, 2021
    @RAY-316
    Copy link
    Contributor

    RAY-316 commented Jun 18, 2021

    /azp run

    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    …ateParameters (Azure#14452)
    
    Co-authored-by: jimmypc92 <jimmypc92>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …ateParameters (Azure#14452)
    
    Co-authored-by: jimmypc92 <jimmypc92>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants