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

Add Stable mgmt for Confidential Ledger #19069

Merged
merged 10 commits into from
May 19, 2022
Merged

Add Stable mgmt for Confidential Ledger #19069

merged 10 commits into from
May 19, 2022

Conversation

musabbir
Copy link
Member

@musabbir musabbir commented May 13, 2022

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 - Stable swagger for GA. Same as last approved preview version.
  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 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.

@musabbir musabbir requested a review from ArcturusZhang as a code owner May 13, 2022 19:06
@openapi-workflow-bot
Copy link

Hi, @musabbir 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 13, 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.ConfidentialLedger/stable/2022-05-13/confidentialledger.json#L678
    ⚠️ R2064 - LROStatusCodesReturnTypeSchema 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'Ledger_Create', Response code: '201'
    Location: Microsoft.ConfidentialLedger/stable/2022-05-13/confidentialledger.json#L247
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: Microsoft.ConfidentialLedger/stable/2022-05-13/confidentialledger.json#L504
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: AuthorizationFailed,
    message: The client '0a32c980-8601-446c-843e-9411a8f586c7' with object id '0a32c980-8601-446c-843e-9411a8f586c7' does not have authorization to perform action 'Microsoft.ConfidentialLedger/operations/read' over scope '/providers/Microsoft.ConfidentialLedger' or the scope is invalid. If access was recently granted,
    please refresh your credentials."
    ️️✔️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 13, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go-track2 - armconfidentialledger - 0.5.1
    azure-sdk-for-python-track2 - track2_azure-mgmt-confidentialledger - Approved - 1.0.0b1
    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 61001b6. 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 61001b6. 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-confidentialledger [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group ConfidentialLedgerOperationsMixin
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model LedgerProperties no longer has parameter ledger_storage_account
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 61001b6. 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: 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.
      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-confidentialledger [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 61001b6. 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
    • ️✔️armconfidentialledger [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 61001b6. 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] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] 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]  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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 61001b6. 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.ConfidentialLedger [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @musabbir, 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.

    @musabbir musabbir added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates and removed Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates labels May 13, 2022
    @musabbir musabbir requested a review from qiaozha as a code owner May 13, 2022 20:31
    Copy link
    Member

    @qiaozha qiaozha left a comment

    Choose a reason for hiding this comment

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

    @msyyc can you take a look at the Python breaking change ? Thanks

    @@ -69,11 +69,14 @@ This is not used by Autorest itself.
    ```yaml $(swagger-to-sdk)
    swagger-to-sdk:
    - repo: azure-sdk-for-net
    - repo: azure-sdk-for-net-track2
    Copy link
    Member

    Choose a reason for hiding this comment

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

    @ArcturusZhang Does .net SDK track2 use this way ?

    - repo: azure-sdk-for-python-track2
    - repo: azure-sdk-for-java
    - repo: azure-sdk-for-java-track2
    Copy link
    Member

    Choose a reason for hiding this comment

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

    @weidongxu-microsoft does jave track2 use this way ?

    Copy link
    Member

    @weidongxu-microsoft weidongxu-microsoft May 19, 2022

    Choose a reason for hiding this comment

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

    Musabbir has updated it and track2 removed.

    This is correct for Java.

    namespace: Microsoft.ConfidentialLedger
    output-folder: $(csharp-sdks-folder)/confidentialledger/management/Microsoft.ConfidentialLedger/GeneratedProtocol
    namespace: Azure.Management.ConfidentialLedger
    output-folder: $(csharp-sdks-folder)/confidentialledger/Azure.Management.ConfidentialLedger/GeneratedProtocol
    Copy link
    Member

    Choose a reason for hiding this comment

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

    @ArcturusZhang Does this change make sense for csharp ?

    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    Updated to Azure.ResourceManager.ConfidentialLedger based on this page.
    https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-namespaces-approved-list

    Please let me know if this is more appropriate

    @msyyc
    Copy link
    Member

    msyyc commented May 18, 2022

    approved for python breaking change

    @ArcturusZhang
    Copy link
    Member

    @fengzhou-msft could you please help about the details on azure-sdk-for-net-track2 pipelines? Some details are not looking correct

    @fengzhou-msft
    Copy link
    Member

    fengzhou-msft commented May 19, 2022

    @fengzhou-msft could you please help about the details on azure-sdk-for-net-track2 pipelines? Some details are not looking correct

    Confidential Ledger only has a dotnet data plane track 2 package, therefore this PR has no impact on azure-sdk-for-net-track2.

    Copy link
    Member

    @weidongxu-microsoft weidongxu-microsoft left a comment

    Choose a reason for hiding this comment

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

    LGTM for Java

    @musabbir musabbir requested a review from qiaozha May 19, 2022 07:35
    @musabbir
    Copy link
    Member Author

    @akning-ms Could you help merge this PR?

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    Approve for Go SDK related configurations

    @akning-ms
    Copy link
    Contributor

    Hi @musabbir, can you confirm what you did for this PR just move preview version 2021-5-13-preview? if any other change in swagger in new version, we may need ARM to sign off, and BTW, is there new version deployed to production? if no, when it will be deployed?

    @musabbir
    Copy link
    Member Author

    Hi @musabbir, can you confirm what you did for this PR just move preview version 2021-5-13-preview? if any other change in swagger in new version, we may need ARM to sign off, and BTW, is there new version deployed to production? if no, when it will be deployed?

    There are no changes other than copying over the last approved swagger (2021-5-13) to a stable folder.

    This version is fully supported in production.

    @musabbir
    Copy link
    Member Author

    Hi @musabbir, can you confirm what you did for this PR just move preview version 2021-5-13-preview? if any other change in swagger in new version, we may need ARM to sign off, and BTW, is there new version deployed to production? if no, when it will be deployed?

    There are no changes other than copying over the last approved swagger (2021-5-13) to a stable folder.

    This version is fully supported in production.

    We will update the ARM Manifest after this PR is merged.

    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.

    7 participants