Skip to content

Conversation

@abhayohri
Copy link
Contributor

@abhayohri abhayohri commented Mar 6, 2023

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

ARM API Information (Control Plane)

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-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 6, 2023

Swagger Validation Report

️❌BreakingChange: 26 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
resourcehealth.json 2015-01-01(f458d4f) 2015-01-01(main)
resourcehealth.json 2017-07-01(f458d4f) 2017-07-01(main)
ResourceHealth.json 2018-07-01(f458d4f) 2018-07-01(main)
ResourceHealth.json 2020-05-01(f458d4f) 2020-05-01(main)
ResourceHealth.json 2022-05-01(f458d4f) 2022-05-01(main)
Rule Message
1041 - AddedPropertyInResponse The new version has a new property '_ActionUrl.Comment' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L562:7
Old: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L545:7
1041 - AddedPropertyInResponse The new version has a new property 'context' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L448:11
Old: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L443:11
1041 - AddedPropertyInResponse The new version has a new property 'category' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L448:11
Old: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L443:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L448:11
Old: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L443:11
1041 - AddedPropertyInResponse The new version has a new property '_ActionUrl.Comment' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L646:7
Old: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L629:7
1041 - AddedPropertyInResponse The new version has a new property 'context' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L520:11
Old: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L515:11
1041 - AddedPropertyInResponse The new version has a new property 'category' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L520:11
Old: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L515:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L520:11
Old: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L515:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L618:15
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L609:15
1041 - AddedPropertyInResponse The new version has a new property 'parameters' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L618:15
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L609:15
1041 - AddedPropertyInResponse The new version has a new property 'reason' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L532:11
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L527:11
1041 - AddedPropertyInResponse The new version has a new property '_ActionUrl.Comment' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L1038:7
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L1009:7
1041 - AddedPropertyInResponse The new version has a new property 'context' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L911:11
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L894:11
1041 - AddedPropertyInResponse The new version has a new property 'category' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L911:11
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L894:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L911:11
Old: Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json#L894:11
1041 - AddedPropertyInResponse The new version has a new property '_ActionUrl.Comment' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L543:7
Old: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L531:7
1041 - AddedPropertyInResponse The new version has a new property 'context' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L360:11
Old: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L360:11
1041 - AddedPropertyInResponse The new version has a new property 'category' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L360:11
Old: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L360:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L360:11
Old: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L360:11
1041 - AddedPropertyInResponse The new version has a new property '_ActionUrl.Comment' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1269:7
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1245:7
1041 - AddedPropertyInResponse The new version has a new property 'context' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1080:11
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1068:11
1041 - AddedPropertyInResponse The new version has a new property 'category' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1080:11
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1068:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1080:11
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1068:11
1041 - AddedPropertyInResponse The new version has a new property 'articleId' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L686:15
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L682:15
1041 - AddedPropertyInResponse The new version has a new property 'parameters' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L686:15
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L682:15
1041 - AddedPropertyInResponse The new version has a new property 'reason' in response that was not found in the old version.
New: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L596:11
Old: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L596:11
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-2022-05 package-2022-05(f458d4f) package-2022-05(main)
package-2017-07 package-2017-07(f458d4f) package-2017-07(main)
package-2015-01 package-2015-01(f458d4f) package-2015-01(main)
package-2018-07-01 package-2018-07-01(f458d4f) package-2018-07-01(main)
package-2020-05-01 package-2020-05-01(f458d4f) package-2020-05-01(main)

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

Rule Message Related RPC [For API reviewers]
DefinitionsPropertiesNamesCamelCase Property name should be camel case.
Location: Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json#L552
DefinitionsPropertiesNamesCamelCase Property name should be camel case.
Location: Microsoft.ResourceHealth/stable/2022-05-01/ResourceHealth.json#L1278


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

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/stable/2015-01-01/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/stable/2015-01-01/resourcehealth.json#L110
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/stable/2015-01-01/resourcehealth.json#L160
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/stable/2015-01-01/resourcehealth.json#L207
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/stable/2015-01-01/resourcehealth.json#L257
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/stable/2015-01-01/resourcehealth.json#L304
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/stable/2015-01-01/resourcehealth.json#L354
OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ResourceHealth/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L386
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/stable/2015-01-01/resourcehealth.json#L390
MissingTypeObject The schema 'availabilityStatusListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L406
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L542
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L549
MissingTypeObject The schema 'recommendedAction' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L560
MissingTypeObject The schema 'serviceImpactingEvent' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L581
MissingTypeObject The schema 'operationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L632
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L634
MissingTypeObject The schema 'operation' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L647
XmsParameterLocation The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L701
XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json#L708
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/stable/2017-07-01/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/stable/2017-07-01/resourcehealth.json#L110
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/stable/2017-07-01/resourcehealth.json#L160
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/stable/2017-07-01/resourcehealth.json#L207
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/stable/2017-07-01/resourcehealth.json#L257
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/stable/2017-07-01/resourcehealth.json#L304
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/stable/2017-07-01/resourcehealth.json#L354
OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ResourceHealth/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L386
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/stable/2017-07-01/resourcehealth.json#L390
ResourceNameRestriction The resource name parameter 'issueName' should be defined with a 'pattern' restriction.
Location: Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json#L404
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/stable/2017-07-01/resourcehealth.json#L426
️️✔️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]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @abhayohri 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 Mar 6, 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-go - sdk/resourcemanager/resourcehealth/armresourcehealth - 2.0.0-beta.1
    +	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-beta.1
    +	Class MicrosoftResourceHealth no longer has parameter childAvailabilityStatuses
    +	Class MicrosoftResourceHealth no longer has parameter childResources
    +	Interface AvailabilityStatusProperties no longer has parameter recentlyResolvedState
    +	Operation EmergingIssues.get has a new signature
    +	Removed operation group ChildAvailabilityStatuses
    +	Removed operation group ChildResources
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f0e86b9. 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/resourcehealth/armresourcehealth [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `ErrorResponseError` has been removed
      info	[Changelog] - Field `OccurredTime` of struct `AvailabilityStatusProperties` has been removed
      info	[Changelog] - Field `UnavailabilitySummary` of struct `AvailabilityStatusPropertiesRecentlyResolved` has been removed
      info	[Changelog] - Field `UnavailableOccurredTime` of struct `AvailabilityStatusPropertiesRecentlyResolved` has been removed
      info	[Changelog] - Field `Error` of struct `ErrorResponse` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `CreatedByType` with values `CreatedByTypeApplication`, `CreatedByTypeKey`, `CreatedByTypeManagedIdentity`, `CreatedByTypeUser`
      info	[Changelog] - New enum type `EventLevelValues` with values `EventLevelValuesCritical`, `EventLevelValuesError`, `EventLevelValuesInformational`, `EventLevelValuesWarning`
      info	[Changelog] - New enum type `EventSourceValues` with values `EventSourceValuesResourceHealth`, `EventSourceValuesServiceHealth`
      info	[Changelog] - New enum type `EventStatusValues` with values `EventStatusValuesActive`, `EventStatusValuesResolved`
      info	[Changelog] - New enum type `EventTypeValues` with values `EventTypeValuesEmergingIssues`, `EventTypeValuesHealthAdvisory`, `EventTypeValuesPlannedMaintenance`, `EventTypeValuesRCA`, `EventTypeValuesSecurityAdvisory`, `EventTypeValuesServiceIssue`
      info	[Changelog] - New enum type `IssueNameParameter` with values `IssueNameParameterDefault`
      info	[Changelog] - New enum type `LevelValues` with values `LevelValuesCritical`, `LevelValuesWarning`
      info	[Changelog] - New enum type `LinkTypeValues` with values `LinkTypeValuesButton`, `LinkTypeValuesHyperlink`
      info	[Changelog] - New enum type `Scenario` with values `ScenarioAlerts`
      info	[Changelog] - New enum type `SeverityValues` with values `SeverityValuesError`, `SeverityValuesInformation`, `SeverityValuesWarning`
      info	[Changelog] - New enum type `StageValues` with values `StageValuesActive`, `StageValuesArchived`, `StageValuesResolve`
      info	[Changelog] - New function `NewClientFactory(string, azcore.TokenCredential, *arm.ClientOptions) (*ClientFactory, error)`
      info	[Changelog] - New function `*ClientFactory.NewAvailabilityStatusesClient() *AvailabilityStatusesClient`
      info	[Changelog] - New function `*ClientFactory.NewEmergingIssuesClient() *EmergingIssuesClient`
      info	[Changelog] - New function `*ClientFactory.NewEventClient() *EventClient`
      info	[Changelog] - New function `*ClientFactory.NewEventsClient() *EventsClient`
      info	[Changelog] - New function `*ClientFactory.NewImpactedResourcesClient() *ImpactedResourcesClient`
      info	[Changelog] - New function `*ClientFactory.NewMetadataClient() *MetadataClient`
      info	[Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient`
      info	[Changelog] - New function `*ClientFactory.NewSecurityAdvisoryImpactedResourcesClient() *SecurityAdvisoryImpactedResourcesClient`
      info	[Changelog] - New function `NewEmergingIssuesClient(azcore.TokenCredential, *arm.ClientOptions) (*EmergingIssuesClient, error)`
      info	[Changelog] - New function `*EmergingIssuesClient.Get(context.Context, IssueNameParameter, *EmergingIssuesClientGetOptions) (EmergingIssuesClientGetResponse, error)`
      info	[Changelog] - New function `*EmergingIssuesClient.NewListPager(*EmergingIssuesClientListOptions) *runtime.Pager[EmergingIssuesClientListResponse]`
      info	[Changelog] - New function `NewEventClient(string, azcore.TokenCredential, *arm.ClientOptions) (*EventClient, error)`
      info	[Changelog] - New function `*EventClient.FetchDetailsBySubscriptionIDAndTrackingID(context.Context, string, *EventClientFetchDetailsBySubscriptionIDAndTrackingIDOptions) (EventClientFetchDetailsBySubscriptionIDAndTrackingIDResponse, error)`
      info	[Changelog] - New function `*EventClient.FetchDetailsByTenantIDAndTrackingID(context.Context, string, *EventClientFetchDetailsByTenantIDAndTrackingIDOptions) (EventClientFetchDetailsByTenantIDAndTrackingIDResponse, error)`
      info	[Changelog] - New function `*EventClient.GetBySubscriptionIDAndTrackingID(context.Context, string, *EventClientGetBySubscriptionIDAndTrackingIDOptions) (EventClientGetBySubscriptionIDAndTrackingIDResponse, error)`
      info	[Changelog] - New function `*EventClient.GetByTenantIDAndTrackingID(context.Context, string, *EventClientGetByTenantIDAndTrackingIDOptions) (EventClientGetByTenantIDAndTrackingIDResponse, error)`
      info	[Changelog] - New function `NewEventsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*EventsClient, error)`
      info	[Changelog] - New function `*EventsClient.NewListBySingleResourcePager(string, *EventsClientListBySingleResourceOptions) *runtime.Pager[EventsClientListBySingleResourceResponse]`
      info	[Changelog] - New function `*EventsClient.NewListBySubscriptionIDPager(*EventsClientListBySubscriptionIDOptions) *runtime.Pager[EventsClientListBySubscriptionIDResponse]`
      info	[Changelog] - New function `*EventsClient.NewListByTenantIDPager(*EventsClientListByTenantIDOptions) *runtime.Pager[EventsClientListByTenantIDResponse]`
      info	[Changelog] - New function `NewImpactedResourcesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ImpactedResourcesClient, error)`
      info	[Changelog] - New function `*ImpactedResourcesClient.Get(context.Context, string, string, *ImpactedResourcesClientGetOptions) (ImpactedResourcesClientGetResponse, error)`
      info	[Changelog] - New function `*ImpactedResourcesClient.GetByTenantID(context.Context, string, string, *ImpactedResourcesClientGetByTenantIDOptions) (ImpactedResourcesClientGetByTenantIDResponse, error)`
      info	[Changelog] - New function `*ImpactedResourcesClient.NewListBySubscriptionIDAndEventIDPager(string, *ImpactedResourcesClientListBySubscriptionIDAndEventIDOptions) *runtime.Pager[ImpactedResourcesClientListBySubscriptionIDAndEventIDResponse]`
      info	[Changelog] - New function `*ImpactedResourcesClient.NewListByTenantIDAndEventIDPager(string, *ImpactedResourcesClientListByTenantIDAndEventIDOptions) *runtime.Pager[ImpactedResourcesClientListByTenantIDAndEventIDResponse]`
      info	[Changelog] - New function `NewMetadataClient(azcore.TokenCredential, *arm.ClientOptions) (*MetadataClient, error)`
      info	[Changelog] - New function `*MetadataClient.GetEntity(context.Context, string, *MetadataClientGetEntityOptions) (MetadataClientGetEntityResponse, error)`
      info	[Changelog] - New function `*MetadataClient.NewListPager(*MetadataClientListOptions) *runtime.Pager[MetadataClientListResponse]`
      info	[Changelog] - New function `NewSecurityAdvisoryImpactedResourcesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SecurityAdvisoryImpactedResourcesClient, error)`
      info	[Changelog] - New function `*SecurityAdvisoryImpactedResourcesClient.NewListBySubscriptionIDAndEventIDPager(string, *SecurityAdvisoryImpactedResourcesClientListBySubscriptionIDAndEventIDOptions) *runtime.Pager[SecurityAdvisoryImpactedResourcesClientListBySubscriptionIDAndEventIDResponse]`
      info	[Changelog] - New function `*SecurityAdvisoryImpactedResourcesClient.NewListByTenantIDAndEventIDPager(string, *SecurityAdvisoryImpactedResourcesClientListByTenantIDAndEventIDOptions) *runtime.Pager[SecurityAdvisoryImpactedResourcesClientListByTenantIDAndEventIDResponse]`
      info	[Changelog] - New struct `ClientFactory`
      info	[Changelog] - New struct `EmergingIssue`
      info	[Changelog] - New struct `EmergingIssueImpact`
      info	[Changelog] - New struct `EmergingIssueListResult`
      info	[Changelog] - New struct `EmergingIssuesGetResult`
      info	[Changelog] - New struct `Event`
      info	[Changelog] - New struct `EventImpactedResource`
      info	[Changelog] - New struct `EventImpactedResourceListResult`
      info	[Changelog] - New struct `EventImpactedResourceProperties`
      info	[Changelog] - New struct `EventProperties`
      info	[Changelog] - New struct `EventPropertiesAdditionalInformation`
      info	[Changelog] - New struct `EventPropertiesArticle`
      info	[Changelog] - New struct `EventPropertiesRecommendedActions`
      info	[Changelog] - New struct `EventPropertiesRecommendedActionsItem`
      info	[Changelog] - New struct `Events`
      info	[Changelog] - New struct `Faq`
      info	[Changelog] - New struct `Impact`
      info	[Changelog] - New struct `ImpactedServiceRegion`
      info	[Changelog] - New struct `KeyValueItem`
      info	[Changelog] - New struct `Link`
      info	[Changelog] - New struct `LinkDisplayText`
      info	[Changelog] - New struct `MetadataEntity`
      info	[Changelog] - New struct `MetadataEntityListResult`
      info	[Changelog] - New struct `MetadataEntityProperties`
      info	[Changelog] - New struct `MetadataSupportedValueDetail`
      info	[Changelog] - New struct `ProxyResource`
      info	[Changelog] - New struct `StatusActiveEvent`
      info	[Changelog] - New struct `SystemData`
      info	[Changelog] - New struct `Update`
      info	[Changelog] - New field `Category` in struct `AvailabilityStatusProperties`
      info	[Changelog] - New field `Context` in struct `AvailabilityStatusProperties`
      info	[Changelog] - New field `OccuredTime` in struct `AvailabilityStatusProperties`
      info	[Changelog] - New field `UnavailableOccuredTime` in struct `AvailabilityStatusPropertiesRecentlyResolved`
      info	[Changelog] - New field `UnavailableSummary` in struct `AvailabilityStatusPropertiesRecentlyResolved`
      info	[Changelog] - New field `Code` in struct `ErrorResponse`
      info	[Changelog] - New field `Details` in struct `ErrorResponse`
      info	[Changelog] - New field `Message` in struct `ErrorResponse`
      info	[Changelog] - New field `SystemData` in struct `ImpactedResourceStatus`
      info	[Changelog] - New field `SystemData` in struct `Resource`
      info	[Changelog]
      info	[Changelog] Total 5 breaking change(s), 136 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f0e86b9. 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]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group EventOperations
      info	[Changelog]   - Added operation group EventsOperations
      info	[Changelog]   - Added operation group ImpactedResources
      info	[Changelog]   - Added operation group Metadata
      info	[Changelog]   - Added operation group SecurityAdvisoryImpactedResources
      info	[Changelog]   - Added Interface AvailabilityStatusPropertiesRecentlyResolved
      info	[Changelog]   - Added Interface Event_2
      info	[Changelog]   - Added Interface EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams
      info	[Changelog]   - Added Interface EventFetchDetailsByTenantIdAndTrackingIdOptionalParams
      info	[Changelog]   - Added Interface EventGetBySubscriptionIdAndTrackingIdOptionalParams
      info	[Changelog]   - Added Interface EventGetByTenantIdAndTrackingIdOptionalParams
      info	[Changelog]   - Added Interface EventImpactedResource
      info	[Changelog]   - Added Interface EventImpactedResourceListResult
      info	[Changelog]   - Added Interface EventPropertiesAdditionalInformation
      info	[Changelog]   - Added Interface EventPropertiesArticle
      info	[Changelog]   - Added Interface EventPropertiesRecommendedActions
      info	[Changelog]   - Added Interface EventPropertiesRecommendedActionsItem
      info	[Changelog]   - Added Interface Events
      info	[Changelog]   - Added Interface EventsListBySingleResourceNextOptionalParams
      info	[Changelog]   - Added Interface EventsListBySingleResourceOptionalParams
      info	[Changelog]   - Added Interface EventsListBySubscriptionIdNextOptionalParams
      info	[Changelog]   - Added Interface EventsListBySubscriptionIdOptionalParams
      info	[Changelog]   - Added Interface EventsListByTenantIdNextOptionalParams
      info	[Changelog]   - Added Interface EventsListByTenantIdOptionalParams
      info	[Changelog]   - Added Interface Faq
      info	[Changelog]   - Added Interface Impact
      info	[Changelog]   - Added Interface ImpactedResourcesGetByTenantIdOptionalParams
      info	[Changelog]   - Added Interface ImpactedResourcesGetOptionalParams
      info	[Changelog]   - Added Interface ImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams
      info	[Changelog]   - Added Interface ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams
      info	[Changelog]   - Added Interface ImpactedResourcesListByTenantIdAndEventIdNextOptionalParams
      info	[Changelog]   - Added Interface ImpactedResourcesListByTenantIdAndEventIdOptionalParams
      info	[Changelog]   - Added Interface ImpactedResourceStatus
      info	[Changelog]   - Added Interface ImpactedServiceRegion
      info	[Changelog]   - Added Interface KeyValueItem
      info	[Changelog]   - Added Interface Link
      info	[Changelog]   - Added Interface LinkDisplayText
      info	[Changelog]   - Added Interface MetadataEntity
      info	[Changelog]   - Added Interface MetadataEntityListResult
      info	[Changelog]   - Added Interface MetadataGetEntityOptionalParams
      info	[Changelog]   - Added Interface MetadataListNextOptionalParams
      info	[Changelog]   - Added Interface MetadataListOptionalParams
      info	[Changelog]   - Added Interface MetadataSupportedValueDetail
      info	[Changelog]   - Added Interface ProxyResource
      info	[Changelog]   - Added Interface SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams
      info	[Changelog]   - Added Interface SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams
      info	[Changelog]   - Added Interface SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextOptionalParams
      info	[Changelog]   - Added Interface SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams
      info	[Changelog]   - Added Interface SystemData
      info	[Changelog]   - Added Interface Update
      info	[Changelog]   - Added Type Alias CreatedByType
      info	[Changelog]   - Added Type Alias EventFetchDetailsBySubscriptionIdAndTrackingIdResponse
      info	[Changelog]   - Added Type Alias EventFetchDetailsByTenantIdAndTrackingIdResponse
      info	[Changelog]   - Added Type Alias EventGetBySubscriptionIdAndTrackingIdResponse
      info	[Changelog]   - Added Type Alias EventGetByTenantIdAndTrackingIdResponse
      info	[Changelog]   - Added Type Alias EventLevelValues
      info	[Changelog]   - Added Type Alias EventsListBySingleResourceNextResponse
      info	[Changelog]   - Added Type Alias EventsListBySingleResourceResponse
      info	[Changelog]   - Added Type Alias EventsListBySubscriptionIdNextResponse
      info	[Changelog]   - Added Type Alias EventsListBySubscriptionIdResponse
      info	[Changelog]   - Added Type Alias EventsListByTenantIdNextResponse
      info	[Changelog]   - Added Type Alias EventsListByTenantIdResponse
      info	[Changelog]   - Added Type Alias EventSourceValues
      info	[Changelog]   - Added Type Alias EventStatusValues
      info	[Changelog]   - Added Type Alias EventTypeValues
      info	[Changelog]   - Added Type Alias ImpactedResourcesGetByTenantIdResponse
      info	[Changelog]   - Added Type Alias ImpactedResourcesGetResponse
      info	[Changelog]   - Added Type Alias ImpactedResourcesListBySubscriptionIdAndEventIdNextResponse
      info	[Changelog]   - Added Type Alias ImpactedResourcesListBySubscriptionIdAndEventIdResponse
      info	[Changelog]   - Added Type Alias ImpactedResourcesListByTenantIdAndEventIdNextResponse
      info	[Changelog]   - Added Type Alias ImpactedResourcesListByTenantIdAndEventIdResponse
      info	[Changelog]   - Added Type Alias IssueNameParameter
      info	[Changelog]   - Added Type Alias LevelValues
      info	[Changelog]   - Added Type Alias LinkTypeValues
      info	[Changelog]   - Added Type Alias MetadataGetEntityResponse
      info	[Changelog]   - Added Type Alias MetadataListNextResponse
      info	[Changelog]   - Added Type Alias MetadataListResponse
      info	[Changelog]   - Added Type Alias ReasonTypeValues
      info	[Changelog]   - Added Type Alias Scenario
      info	[Changelog]   - Added Type Alias SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextResponse
      info	[Changelog]   - Added Type Alias SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdResponse
      info	[Changelog]   - Added Type Alias SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextResponse
      info	[Changelog]   - Added Type Alias SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdResponse
      info	[Changelog]   - Interface AvailabilityStatusProperties has a new optional parameter category
      info	[Changelog]   - Interface AvailabilityStatusProperties has a new optional parameter context
      info	[Changelog]   - Interface AvailabilityStatusProperties has a new optional parameter recentlyResolved
      info	[Changelog]   - Interface AvailabilityStatusProperties has a new optional parameter title
      info	[Changelog]   - Interface Resource has a new optional parameter systemData
      info	[Changelog]   - Added Enum KnownAvailabilityStateValues
      info	[Changelog]   - Added Enum KnownCreatedByType
      info	[Changelog]   - Added Enum KnownEventLevelValues
      info	[Changelog]   - Added Enum KnownEventSourceValues
      info	[Changelog]   - Added Enum KnownEventStatusValues
      info	[Changelog]   - Added Enum KnownEventTypeValues
      info	[Changelog]   - Added Enum KnownIssueNameParameter
      info	[Changelog]   - Added Enum KnownLevelValues
      info	[Changelog]   - Added Enum KnownLinkTypeValues
      info	[Changelog]   - Added Enum KnownReasonChronicityTypes
      info	[Changelog]   - Added Enum KnownReasonTypeValues
      info	[Changelog]   - Added Enum KnownScenario
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation group ChildAvailabilityStatuses
      info	[Changelog]   - Removed operation group ChildResources
      info	[Changelog]   - Operation EmergingIssues.get has a new signature
      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
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f0e86b9. 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 minor version of npm available! 9.5.0 -> 9.6.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-resourcehealth [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model AvailabilityStatusProperties has a new parameter article_id
      info	[Changelog]   - Model AvailabilityStatusProperties has a new parameter category
      info	[Changelog]   - Model AvailabilityStatusProperties has a new parameter context
      info	[Changelog]   - Model Event has a new parameter reason
      info	[Changelog]   - Model EventPropertiesArticle has a new parameter article_id
      info	[Changelog]   - Model EventPropertiesArticle has a new parameter parameters
      info	[Changelog]   - Model RecommendedAction has a new parameter action_url_comment
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️⚠️ azure-sdk-for-net warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f0e86b9. 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
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f0e86b9. 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]
      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]Release - Generate from f0e86b9. 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.DefaultTag [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 Mar 6, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/resourcehealth/armresourcehealth https://apiview.dev/Assemblies/Review/4bd9b8d6e3744441b4b2c89959046d78
    Java azure-resourcemanager-resourcehealth https://apiview.dev/Assemblies/Review/918ad5107e2b48829e9a35ecbd0c846f
    JavaScript @azure/arm-resourcehealth https://apiview.dev/Assemblies/Review/21de9ad4878e47fc9855f4dde7c3a6ad

    @abhayohri
    Copy link
    Contributor Author

    abhayohri commented Mar 6, 2023

    Hey this request is to fix the following s360 items:

    https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=260F1CBF-7480-46E2-B8E1-2C5C518FD39A
    https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=7A661FA3-A486-491A-96A2-D68649102642
    https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=D0645A0D-77A7-4AB5-B734-D42B2E3BEBEB
    https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=647F3368-7670-4ADF-9D8D-6A6F02006D3F

    The properties seem to have been added to the code but never made it to swagger
    The following are the dates they were added to the code:

    events endpoints: added to response code on 5/16/2019 for all api version
    properties.article.articleId (string)
    properties.article.parameters (IReadOnlyDictionary<string, string>)
    properties.reason (string)

    Availability status endpoints:
    properties.ArticleId (string)-> added in 1/13/2022 to all api versions
    properties.Context (string) -> added in 12/8/2022 to all api versions
    properties.Category (string)-> added on 12/8/2022 to all api versions
    properties.recommendedActions[*]._ActionUrl.Comment (string)-> added on 11/14/2018 to all api version

    (adding this last property seems to be triggering a linter exception for DefinitionsPropertiesNamesCamelCase but the name cannot be changed as it is been served to clients for years)

    I sent an email to breaking change team asking for guidance and they said to create the pr and that they would approve the fixes.

    for the other api versions should i create separate prs for each or can i update the within this pr?

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 6, 2023
    @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 openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 6, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @abhayohri your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @abhayohri abhayohri marked this pull request as ready for review March 13, 2023 18:59
    @TimLovellSmith TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Mar 16, 2023
    @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 Mar 16, 2023
    @TimLovellSmith
    Copy link
    Member

    The main validation error I see is "Property name should be camel case."

    I assume that if this is a S360 fix, then that is by design?

    I don't see any other problem from API POV.

    @abhayohri
    Copy link
    Contributor Author

    The main validation error I see is "Property name should be camel case."

    I assume that if this is a S360 fix, then that is by design?

    I don't see any other problem from API POV.

    @TimLovellSmith yeah its a fix for https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=647F3368-7670-4ADF-9D8D-6A6F02006D3F

    @openapi-workflow-bot
    Copy link

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

    @weidongxu-microsoft weidongxu-microsoft merged commit f0e86b9 into main Mar 30, 2023
    @weidongxu-microsoft weidongxu-microsoft deleted the abhayohri-resourcehealth-Microsoft.ResourceHealth-2022-05-01 branch March 30, 2023 04:56
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    …rsion stable/2022-05-01 (Azure#22916)
    
    * make fixes for s360 items
    
    * spelling fix
    
    * added missing properties to all stable api versions
    
    * fix model validation errors
    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 Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure FixS360 NewApiVersionRequired resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    6 participants