Skip to content

Conversation

@abhishek-corp
Copy link
Member

@abhishek-corp abhishek-corp commented Nov 29, 2022

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. Dec 5, 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. Dec 15, 2022
  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
      -[x] 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, @abhishek-corp 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 Nov 29, 2022

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    ResourceHealth.json 2022-05-01-preview(1af201c) 2022-05-01-preview(main)
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L344:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L386:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L425:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L470:5
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 5 Errors, 4 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2022-05-01 package-preview-2022-05-01(1af201c) package-preview-2022-05-01(release-resourcehealth-Microsoft.ResourceHealth-2022-05-01-preview)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L369
    ResourceNameRestriction The resource name parameter 'impactedResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L386
    RPC-V2-URI-5
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L411
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L453
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L495
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ImpactedResourcesGet
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L418
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListBySubscriptionIdAndEventId'. Consider updating the operationId
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L430
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListByTenantIdAndEventId'. Consider updating the operationId
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L475
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ListEventsByTenantId
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L637


    The following errors/warnings exist before current PR submission:

    Rule Message
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L62
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L110
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ResourceHealth/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L142
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L146
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L193
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L240
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L285
    ResourceNameRestriction The resource name parameter 'impactedResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L302
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L330
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L540
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L588
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L627
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L672
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L716
    ⚠️ PageableOperation Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L128
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L764
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L925
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L929
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L937
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L941
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L1143
    ⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L1229
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L1233
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L1236
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L1545
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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 Nov 29, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ⚠️azure-sdk-for-go - sdk/resourcemanager/resourcehealth/armresourcehealth - 2.0.0
    +	Field `Error` of struct `ErrorResponse` has been removed
    +	Field `OccurredTime` of struct `AvailabilityStatusProperties` has been removed
    +	Field `UnavailabilitySummary` of struct `AvailabilityStatusPropertiesRecentlyResolved` has been removed
    +	Field `UnavailableOccurredTime` of struct `AvailabilityStatusPropertiesRecentlyResolved` has been removed
    +	Struct `ErrorResponseError` has been removed

    ⚠️azure-sdk-for-js - @azure/arm-resourcehealth - 4.0.0
    +	Class MicrosoftResourceHealth no longer has parameter childAvailabilityStatuses
    +	Class MicrosoftResourceHealth no longer has parameter childResources
    +	Class MicrosoftResourceHealth no longer has parameter emergingIssues
    +	Interface AvailabilityStatusProperties no longer has parameter recentlyResolvedState
    +	Removed Enum KnownSeverityValues
    +	Removed Enum KnownStageValues
    +	Removed operation group ChildAvailabilityStatuses
    +	Removed operation group ChildResources
    +	Removed operation group EmergingIssues
    ️⌛ azure-sdk-for-go pending [Detail]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b0a9b3030a0dfd6358dc93088eb2648a086a8dec. 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-resourcehealth [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface AvailabilityStatusPropertiesRecentlyResolved
      info	[Changelog]   - Added Interface ImpactedResourceStatus
      info	[Changelog]   - Added Type Alias ReasonTypeValues
      info	[Changelog]   - Interface AvailabilityStatusProperties has a new optional parameter recentlyResolved
      info	[Changelog]   - Interface AvailabilityStatusProperties has a new optional parameter title
      info	[Changelog]   - Added Enum KnownAvailabilityStateValues
      info	[Changelog]   - Added Enum KnownReasonChronicityTypes
      info	[Changelog]   - Added Enum KnownReasonTypeValues
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation group ChildAvailabilityStatuses
      info	[Changelog]   - Removed operation group ChildResources
      info	[Changelog]   - Removed operation group EmergingIssues
      info	[Changelog]   - Interface AvailabilityStatusProperties no longer has parameter recentlyResolvedState
      info	[Changelog]   - Class MicrosoftResourceHealth no longer has parameter childAvailabilityStatuses
      info	[Changelog]   - Class MicrosoftResourceHealth no longer has parameter childResources
      info	[Changelog]   - Class MicrosoftResourceHealth no longer has parameter emergingIssues
      info	[Changelog]   - Removed Enum KnownSeverityValues
      info	[Changelog]   - Removed Enum KnownStageValues
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from b0a9b3030a0dfd6358dc93088eb2648a086a8dec. 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.2 -> 9.1.3
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.3>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.1.3` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-resourcehealth [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from b0a9b3030a0dfd6358dc93088eb2648a086a8dec. 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
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-resourcehealth [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-net warning [Detail]
    • ⚠️Warning [Logs] Generate from b0a9b3030a0dfd6358dc93088eb2648a086a8dec. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/resourcehealth/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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from b0a9b3030a0dfd6358dc93088eb2648a086a8dec. 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
    • ️✔️resourcehealth [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b0a9b3030a0dfd6358dc93088eb2648a086a8dec. 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.ResourceHealth [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 29, 2022

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.ResourceHealth Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-resourcehealth Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-resourcehealth Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-resourcehealth Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @openapi-workflow-bot
    Copy link

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

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

    @openapi-workflow-bot
    Copy link

    Hi, @abhishek-corp your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @abhishek-corp abhishek-corp changed the title Added ImpactedResources for Tenant. ResourceHealth - Added ImpactedResources for Tenant. Dec 1, 2022
    @abhishek-corp
    Copy link
    Member Author

    abhishek-corp commented Dec 2, 2022

    the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L369

    the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L411

    the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L453

    the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ResourceHealth/preview/2022-05-01-preview/ResourceHealth.json#L495

    As a service, we do not want to break expected behavior and want to keep parity with other APIs and older version. Hence, we're not adopting recommended ErrorResponse. We have discussed this with ARM team members on emails.
    This has already been brought up while publishing 2022-05-01-preview version for the first time and resolved then.
    #21286

    @visingla-ms
    Copy link
    Contributor

    There are a bunch of breaking changes reported on this PR. That is because you need to add these changes in New API Version. Please create a new API version for adding new API Paths/operations. If you need these paths in the existing API version, please get a breaking changes approval and ARM can review the changes afterwards. Once you have the approval, please remove the "ARMChangesRequested" label from the PR to make the PR visible to the ARM reviewers.

    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 2, 2022
    @ghost
    Copy link

    ghost commented Dec 18, 2022

    Hi, @abhishek-corp. 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 Dec 18, 2022
    @ghost ghost closed this Jan 2, 2023
    @ghost
    Copy link

    ghost commented Jan 2, 2023

    Hi, @abhishek-corp. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    This pull request was closed.
    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.

    6 participants