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.

Sign up for GitHub

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

Jump to bottom

Fix examples for keyvault default tag: package-preview-2021-11 #18962

Merged
merged 1 commit into from
May 25, 2022
Merged

Fix examples for keyvault default tag: package-preview-2021-11 #18962

merged 1 commit into from
May 25, 2022

Conversation

Alancere
Copy link
Contributor

@Alancere Alancere commented May 9, 2022 •
edited
Loading

fix Azure/azure-sdk-for-go#17882
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.

@Alancere Alancere requested review from heaths and jlichwa as code owners May 9, 2022 05:53
@openapi-workflow-bot
Copy link

Hi, @Alancere 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
    Copy link

    openapi-pipeline-app bot commented May 9, 2022 •
    edited
    Loading

    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.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation
    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 9, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go-track2 - armkeyvault - 0.5.1
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-keyvault - 9.3.0
    ❌azure-sdk-for-go - keyvault/mgmt/2019-09-01/keyvault - v63.4.0
    +	Field `ActionRequired` of struct `PrivateLinkServiceConnectionState` has been removed
    ️✔️azure-sdk-for-go - keyvault/mgmt/2018-02-14/keyvault - v63.4.0
    ️✔️azure-sdk-for-go - keyvault/mgmt/2016-10-01/keyvault - v63.4.0
    ️✔️azure-sdk-for-go - keyvault/mgmt/2015-06-01/keyvault - v63.4.0
    ❌azure-sdk-for-go - preview/keyvault/mgmt/2020-04-01-preview/keyvault - v63.4.0
    +	Field `ActionRequired` of struct `PrivateLinkServiceConnectionState` has been removed
    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6d33e72. 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/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
warn	No file changes detected after generation
warn	Skip detect changed packages
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6d33e72. 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.5.5 -> 8.10.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.10.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.10.0` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6d33e72. 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] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    • ️✔️azure-resourcemanager-keyvault-generated [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6d33e72. 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
    • ️✔️keyvault/mgmt/2021-10-01/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️keyvault/mgmt/2019-09-01/keyvault [View full logs] 
      Only show 20 items here, please refer to log for details.
      info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `VaultProvisioningStateSucceeded`
info	[Changelog] - New const `VaultProvisioningStateRegisteringDNS`
info	[Changelog] - New function `PossibleVaultProvisioningStateValues() []VaultProvisioningState`
info	[Changelog] - New struct `DimensionProperties`
info	[Changelog] - New struct `MetricSpecification`
info	[Changelog] - New field `ActionsRequired` in struct `PrivateLinkServiceConnectionState`
info	[Changelog] - New field `PurgeProtectionEnabled` in struct `DeletedVaultProperties`
info	[Changelog] - New field `IgnoreMissingVnetServiceEndpoint` in struct `VirtualNetworkRule`
info	[Changelog] - New field `Etag` in struct `PrivateEndpointConnectionItem`
info	[Changelog] - New field `ID` in struct `PrivateEndpointConnectionItem`
info	[Changelog] - New field `ProvisioningState` in struct `VaultProperties`
info	[Changelog] - New field `HsmPoolResourceID` in struct `VaultProperties`
info	[Changelog] - New field `IsDataAction` in struct `Operation`
info	[Changelog] - New field `MetricSpecifications` in struct `ServiceSpecification`
info	[Changelog] - New field `Etag` in struct `PrivateEndpointConnection`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 15 additive change(s).
    • ️✔️keyvault/mgmt/2018-02-14/keyvault [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️keyvault/mgmt/2016-10-01/keyvault [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️keyvault/mgmt/2015-06-01/keyvault [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/keyvault/mgmt/2020-04-01-preview/keyvault [View full logs] 
      Only show 20 items here, please refer to log for details.
      info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `VaultProvisioningStateRegisteringDNS`
info	[Changelog] - New const `VaultProvisioningStateSucceeded`
info	[Changelog] - New function `PossibleVaultProvisioningStateValues() []VaultProvisioningState`
info	[Changelog] - New struct `DimensionProperties`
info	[Changelog] - New struct `MetricSpecification`
info	[Changelog] - New field `MetricSpecifications` in struct `ServiceSpecification`
info	[Changelog] - New field `ProvisioningState` in struct `VaultProperties`
info	[Changelog] - New field `HsmPoolResourceID` in struct `VaultProperties`
info	[Changelog] - New field `IgnoreMissingVnetServiceEndpoint` in struct `VirtualNetworkRule`
info	[Changelog] - New field `Etag` in struct `PrivateEndpointConnection`
info	[Changelog] - New field `Etag` in struct `PrivateEndpointConnectionItem`
info	[Changelog] - New field `ID` in struct `PrivateEndpointConnectionItem`
info	[Changelog] - New field `PurgeProtectionEnabled` in struct `DeletedVaultProperties`
info	[Changelog] - New field `ActionsRequired` in struct `PrivateLinkServiceConnectionState`
info	[Changelog] - New field `IsDataAction` in struct `Operation`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 15 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6d33e72. 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
    • ️✔️armkeyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6d33e72. 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] WARN deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh]  WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 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-keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface Action
info	[Changelog]   - Added Interface KeyReleasePolicy
info	[Changelog]   - Added Interface KeyRotationPolicyAttributes
info	[Changelog]   - Added Interface LifetimeAction
info	[Changelog]   - Added Interface RotationPolicy
info	[Changelog]   - Added Interface Trigger
info	[Changelog]   - Added Type Alias KeyRotationPolicyActionType
info	[Changelog]   - Interface KeyProperties has a new optional parameter releasePolicy
info	[Changelog]   - Interface KeyProperties has a new optional parameter rotationPolicy
info	[Changelog]   - Type Alias Key has a new parameter rotationPolicy
info	[Changelog]   - Type Alias Key has a new parameter releasePolicy
info	[Changelog]   - Enum KnownJsonWebKeyOperation has a new value Release
info	[Changelog]   - Enum KnownKeyPermissions has a new value Getrotationpolicy
info	[Changelog]   - Enum KnownKeyPermissions has a new value Release
info	[Changelog]   - Enum KnownKeyPermissions has a new value Rotate
info	[Changelog]   - Enum KnownKeyPermissions has a new value Setrotationpolicy
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6d33e72. 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
    • ️✔️keyvault [View full logs] 
    ️❌ azure-powershell failed [Detail]
    • ❌Failed [Logs]Release - Generate from 6d33e72. 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.keyvault [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @Alancere Alancere requested a review from tadelesh May 9, 2022 05:55
    This was referenced May 9, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @ruowan
    Copy link
    Member

    ruowan commented May 9, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @tadelesh tadelesh requested a review from raych1 May 9, 2022 12:53
    @tadelesh tadelesh added the FixSwaggerExample PR includes swagger example fix label May 12, 2022
    @Alancere Alancere mentioned this pull request May 19, 2022
    Closed
    @Alancere
    Copy link
    Contributor Author

    @dw511214992 If there is no problem, please help me merge it

    @heaths
    Copy link
    Member

    heaths commented May 24, 2022

    @lmazuel @weshaggard could you help merge this? The build issues are erroneous.

    @dw511214992 dw511214992 merged commit 6d33e72 into Azure:main May 25, 2022
    This was referenced May 25, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    gargankit-microsoft pushed a commit that referenced this pull request May 26, 2022
    @Alancere @gargankit-microsoft
    Fix examples for keyvault default tag: package-preview-2021-11 (#18962)
    0ed7725
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @tadelesh tadelesh tadelesh approved these changes

    @heaths heaths heaths approved these changes

    @jlichwa jlichwa Awaiting requested review from jlichwa jlichwa is a code owner

    @raych1 raych1 Awaiting requested review from raych1

    Assignees

    @dw511214992 dw511214992

    Labels
    FixSwaggerExample PR includes swagger example fix
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.

    Resolve example problems for core RPs
    5 participants
    @Alancere @ruowan @heaths @tadelesh @dw511214992