Skip to content

Conversation

@sumitis14
Copy link
Contributor

@sumitis14 sumitis14 commented Feb 23, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @sumitis14 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    managedccf.json 2023-01-26-preview(a06ef6d) 2023-01-26-preview(main)
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'nodeCount' in response that was not found in the old version.
    New: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L422:7
    Old: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L415:7
    1045 - AddedOptionalProperty The new version has a new optional property 'nodeCount' that was not found in the old version.
    New: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L422:7
    Old: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L415:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2023-01 package-preview-2023-01(a06ef6d) package-preview-2023-01(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L44
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L85
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L130
    ⚠️ LroStatusCodesReturnTypeSchema 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'ManagedCCF_Create', Response code: '201'
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L165
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L187
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L240
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L289
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L472
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    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-python-track2 - track2_azure-mgmt-confidentialledger - 2.0.0b1
    +	Model LedgerProperties no longer has parameter ledger_storage_account
    +	Parameter location of model ConfidentialLedger is now required

    azure-sdk-for-go - sdk/resourcemanager/confidentialledger/armconfidentialledger - 2.0.0-beta.1
    +	Struct `ResourceLocation` has been removed
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2b3114d. 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 major version of npm available! 8.19.3 -> 9.5.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-confidentialledger [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group ConfidentialLedgerOperationsMixin
      info	[Changelog]   - Added operation group ManagedCCFOperations
      info	[Changelog]   - Model ConfidentialLedger has a new parameter running_state
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model LedgerProperties no longer has parameter ledger_storage_account
      info	[Changelog]   - Parameter location of model ConfidentialLedger is now required
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2b3114d. 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
    • ️✔️azure-resourcemanager-confidentialledger [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2b3114d. 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
    • ️✔️sdk/resourcemanager/confidentialledger/armconfidentialledger [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `ResourceLocation` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New type alias `LanguageRuntime` with values `LanguageRuntimeCPP`, `LanguageRuntimeJS`
      info	[Changelog] - New type alias `RunningState` with values `RunningStateActive`, `RunningStatePaused`, `RunningStatePausing`, `RunningStateResuming`, `RunningStateUnknown`
      info	[Changelog] - New function `NewManagedCCFClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ManagedCCFClient, error)`
      info	[Changelog] - New function `*ManagedCCFClient.BeginCreate(context.Context, string, string, ManagedCCF, *ManagedCCFClientBeginCreateOptions) (*runtime.Poller[ManagedCCFClientCreateResponse], error)`
      info	[Changelog] - New function `*ManagedCCFClient.BeginDelete(context.Context, string, string, *ManagedCCFClientBeginDeleteOptions) (*runtime.Poller[ManagedCCFClientDeleteResponse], error)`
      info	[Changelog] - New function `*ManagedCCFClient.Get(context.Context, string, string, *ManagedCCFClientGetOptions) (ManagedCCFClientGetResponse, error)`
      info	[Changelog] - New function `*ManagedCCFClient.NewListByResourceGroupPager(string, *ManagedCCFClientListByResourceGroupOptions) *runtime.Pager[ManagedCCFClientListByResourceGroupResponse]`
      info	[Changelog] - New function `*ManagedCCFClient.NewListBySubscriptionPager(*ManagedCCFClientListBySubscriptionOptions) *runtime.Pager[ManagedCCFClientListBySubscriptionResponse]`
      info	[Changelog] - New function `*ManagedCCFClient.BeginUpdate(context.Context, string, string, ManagedCCF, *ManagedCCFClientBeginUpdateOptions) (*runtime.Poller[ManagedCCFClientUpdateResponse], error)`
      info	[Changelog] - New struct `CertificateTags`
      info	[Changelog] - New struct `DeploymentType`
      info	[Changelog] - New struct `ManagedCCF`
      info	[Changelog] - New struct `ManagedCCFClient`
      info	[Changelog] - New struct `ManagedCCFList`
      info	[Changelog] - New struct `ManagedCCFProperties`
      info	[Changelog] - New struct `MemberIdentityCertificate`
      info	[Changelog] - New struct `TrackedResource`
      info	[Changelog] - New field `RunningState` in struct `ConfidentialLedger`
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 33 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2b3114d. 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
      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-confidentialledger [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group ManagedCCFOperations
      info	[Changelog]   - Added Interface CertificateTags
      info	[Changelog]   - Added Interface DeploymentType
      info	[Changelog]   - Added Interface ManagedCCF
      info	[Changelog]   - Added Interface ManagedCCFCreateOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFDeleteOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFGetOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFList
      info	[Changelog]   - Added Interface ManagedCCFListByResourceGroupNextOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFListByResourceGroupOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFListBySubscriptionNextOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFListBySubscriptionOptionalParams
      info	[Changelog]   - Added Interface ManagedCCFProperties
      info	[Changelog]   - Added Interface ManagedCCFUpdateOptionalParams
      info	[Changelog]   - Added Interface MemberIdentityCertificate
      info	[Changelog]   - Added Interface TrackedResource
      info	[Changelog]   - Added Type Alias LanguageRuntime
      info	[Changelog]   - Added Type Alias ManagedCCFCreateResponse
      info	[Changelog]   - Added Type Alias ManagedCCFGetResponse
      info	[Changelog]   - Added Type Alias ManagedCCFListByResourceGroupNextResponse
      info	[Changelog]   - Added Type Alias ManagedCCFListByResourceGroupResponse
      info	[Changelog]   - Added Type Alias ManagedCCFListBySubscriptionNextResponse
      info	[Changelog]   - Added Type Alias ManagedCCFListBySubscriptionResponse
      info	[Changelog]   - Added Type Alias RunningState
      info	[Changelog]   - Interface ConfidentialLedger has a new optional parameter runningState
      info	[Changelog]   - Added Enum KnownLanguageRuntime
      info	[Changelog]   - Added Enum KnownRunningState
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 2b3114d. 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/confidentialledger/armconfidentialledger https://apiview.dev/Assemblies/Review/120e1ff3fe734ddf844e412811a3a2e6
    JavaScript @azure/arm-confidentialledger https://apiview.dev/Assemblies/Review/62073227d8b04efa96704ee5b4de91f0
    .Net Azure.ResourceManager.ConfidentialLedger https://apiview.dev/Assemblies/Review/353ea5be5b9b4984a849ff51f3ffd9a5

    @sumitis14
    Copy link
    Contributor Author

    @ruowan Only the swagger breaking change is failing, because of the new property type being added in this version.
    This version is currently not used by customers and internally as well. So appreciate if you can sign off this change

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

    @sumitis14 sumitis14 requested a review from musabbir February 23, 2023 13:26
    @sumitis14 sumitis14 requested a review from vimauro February 23, 2023 13:32
    @ruowan ruowan added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 23, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 23, 2023
    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 ARMReview CI-BreakingChange-Go NewApiVersionRequired resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants