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

[Hub Generated] Review request for Microsoft.KeyVault to add version stable/7.3 #18028

Merged
merged 4 commits into from
Mar 21, 2022

Conversation

maorleger
Copy link
Member

@maorleger maorleger commented Feb 28, 2022

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

This PR migrates 7.3-preview to stable

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.

@openapi-workflow-bot
Copy link

Hi, @maorleger 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-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 Feb 28, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/stable/7.3/rbac.json#L476
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/stable/7.3/rbac.json#L518
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/stable/7.3/rbac.json#L530
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'CreateCertificate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.KeyVault/stable/7.3/certificates.json#L458
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    DOUBLE_FORWARD_SLASHES_IN_URL In operation RoleDefinitions_Delete, example for parameter scope: / starts with a forward slash and the path template: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName} contains a forward slash before the parameter starts. This will cause double forward slashes in the request url. Thus making it incorrect.
    Url: Microsoft.KeyVault/stable/7.3/rbac.json#L31:17
    ExampleUrl: stable/7.3/examples/DeleteRoleDefinition-example.json#L38:11
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: scope
    Url: Microsoft.KeyVault/stable/7.3/rbac.json#L38:11
    ExampleUrl: stable/7.3/examples/DeleteRoleDefinition-example.json#L4:14
    DOUBLE_FORWARD_SLASHES_IN_URL In operation RoleDefinitions_Get, example for parameter scope: / starts with a forward slash and the path template: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName} contains a forward slash before the parameter starts. This will cause double forward slashes in the request url. Thus making it incorrect.
    Url: Microsoft.KeyVault/stable/7.3/rbac.json#L132:14
    ExampleUrl: stable/7.3/examples/GetRoleDefinition-example.json#L139:11
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: scope
    Url: Microsoft.KeyVault/stable/7.3/rbac.json#L139:11
    ExampleUrl: stable/7.3/examples/GetRoleDefinition-example.json#L4:14
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️Cross-Version Breaking Changes: 10 Warnings warning [Detail]
    The following breaking changes are detected by comparison with latest preview version:
    Rule Message
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'value' renamed or removed?
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'kid' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'kty' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'key_ops' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'n' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'e' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'x5c' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'x5t#S256' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'alg' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L304:7
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L256:7
    ⚠️ 1034 - AddedRequiredProperty The new version has new required property 'kty, key_ops, alg, kid, x5c, x5t#S256, n, e' that was not found in the old version.
    New: Microsoft.KeyVault/stable/7.3/securitydomain.json#L235:11
    Old: Microsoft.KeyVault/preview/7.2-preview/securitydomain.json#L235:11
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️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 Feb 28, 2022

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-workflow-bot
    Copy link

    Hi @maorleger, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    Copy link
    Member

    @heaths heaths left a comment

    Choose a reason for hiding this comment

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

    Paths and versions look right, and OpenAPI Hub Diff between 7.3 and 7.3-preview (in main) shows no diffs.

    * add exclusion for known spellcheck issue
    
    * collapse cspell ignore for keyvault's storage.json
    @heaths
    Copy link
    Member

    heaths commented Mar 4, 2022

    Note to maintainers e.g., @lmazuel @kurtzeborn: the 2 errors are consummate errors. One is a validation bug, and the other is a red herring (the double slash one) because of how KV treats a path parameter as optional, which validation doesn't understand (and, arguably, is a violation of REST API guidelines but it's always been that way).

    @maorleger maorleger marked this pull request as ready for review March 17, 2022 18:27
    @maorleger maorleger requested a review from a team as a code owner March 17, 2022 18:27
    @maorleger maorleger requested review from BlackRider97 and weidongxu-microsoft and removed request for a team March 17, 2022 18:27
    Copy link
    Member

    @lmazuel lmazuel left a comment

    Choose a reason for hiding this comment

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

    ModelValidation are false positive on triple slashes that are acceptable for KV

    @lmazuel lmazuel merged commit e2ef44b into main Mar 21, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    …stable/7.3 (Azure#18028)
    
    * Adds base for updating Microsoft.KeyVault from version preview/7.3-preview to version 7.3
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * [KeyVault] - Add exclusion for known spellcheck issue (Azure#18031)
    
    * add exclusion for known spellcheck issue
    
    * collapse cspell ignore for keyvault's storage.json
    @JackTn JackTn deleted the dev-keyvault-Microsoft.KeyVault-7.3 branch June 16, 2022 00:49
    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.

    4 participants