Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.python.md #26207

Merged
merged 2 commits into from
Oct 16, 2023
Merged

Update readme.python.md #26207

merged 2 commits into from
Oct 16, 2023

Conversation

ChenxiJiang333
Copy link
Member

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 13, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 13, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.6) new version base version
default default(93bc86b) default(main)
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 13, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/resourcehealth/armresourcehealth - Approved - 2.0.0-beta.1
+	Field `Properties` of struct `EmergingIssuesGetResult` has been removed
+	Field `Properties` of struct `EventImpactedResource` has been removed
+	Field `Properties` of struct `Event` has been removed
+	Field `Properties` of struct `MetadataEntity` has been removed
+	Struct `EmergingIssue` has been removed
+	Struct `EventImpactedResourceProperties` has been removed
+	Struct `EventProperties` has been removed
+	Struct `MetadataEntityProperties` has been removed

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 9ec0fcc. 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 `EmergingIssue` has been removed
    info	[Changelog] - Struct `EventImpactedResourceProperties` has been removed
    info	[Changelog] - Struct `EventProperties` has been removed
    info	[Changelog] - Struct `MetadataEntityProperties` has been removed
    info	[Changelog] - Field `Properties` of struct `EmergingIssuesGetResult` has been removed
    info	[Changelog] - Field `Properties` of struct `Event` has been removed
    info	[Changelog] - Field `Properties` of struct `EventImpactedResource` has been removed
    info	[Changelog] - Field `Properties` of struct `MetadataEntity` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New enum type `EventSubTypeValues` with values `EventSubTypeValuesRetirement`
    info	[Changelog] - New field `RefreshTimestamp`, `StatusActiveEvents`, `StatusBanners` in struct `EmergingIssuesGetResult`
    info	[Changelog] - New field `AdditionalInformation`, `ArgQuery`, `Article`, `Description`, `Duration`, `EnableChatWithUs`, `EnableMicrosoftSupport`, `EventLevel`, `EventSource`, `EventSubType`, `EventType`, `ExternalIncidentID`, `Faqs`, `Header`, `HirStage`, `Impact`, `ImpactMitigationTime`, `ImpactStartTime`, `ImpactType`, `IsHIR`, `LastUpdateTime`, `Level`, `Links`, `MaintenanceID`, `MaintenanceType`, `PlatformInitiated`, `Priority`, `Reason`, `RecommendedActions`, `Status`, `Summary`, `Title` in struct `Event`
    info	[Changelog] - New field `Info`, `MaintenanceEndTime`, `MaintenanceStartTime`, `ResourceGroup`, `ResourceName`, `Status`, `TargetRegion`, `TargetResourceID`, `TargetResourceType` in struct `EventImpactedResource`
    info	[Changelog] - New field `ApplicableScenarios`, `DependsOn`, `DisplayName`, `SupportedValues` in struct `MetadataEntity`
    info	[Changelog]
    info	[Changelog] Total 12 breaking change(s), 6 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 9ec0fcc. 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 Type Alias EventSubTypeValues
    info	[Changelog]   - Interface Event_2 has a new optional parameter argQuery
    info	[Changelog]   - Interface Event_2 has a new optional parameter eventSubType
    info	[Changelog]   - Interface Event_2 has a new optional parameter maintenanceId
    info	[Changelog]   - Interface Event_2 has a new optional parameter maintenanceType
    info	[Changelog]   - Interface EventImpactedResource has a new optional parameter maintenanceEndTime
    info	[Changelog]   - Interface EventImpactedResource has a new optional parameter maintenanceStartTime
    info	[Changelog]   - Interface EventImpactedResource has a new optional parameter resourceGroup
    info	[Changelog]   - Interface EventImpactedResource has a new optional parameter resourceName
    info	[Changelog]   - Interface EventImpactedResource has a new optional parameter status
    info	[Changelog]   - Added Enum KnownEventSubTypeValues
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Class MicrosoftResourceHealth has a new signature
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 9ec0fcc. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    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]
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.0` 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 Event has a new parameter arg_query
    info	[Changelog]   - Model Event has a new parameter event_sub_type
    info	[Changelog]   - Model Event has a new parameter maintenance_id
    info	[Changelog]   - Model Event has a new parameter maintenance_type
    info	[Changelog]   - Model EventImpactedResource has a new parameter maintenance_end_time
    info	[Changelog]   - Model EventImpactedResource has a new parameter maintenance_start_time
    info	[Changelog]   - Model EventImpactedResource has a new parameter resource_group
    info	[Changelog]   - Model EventImpactedResource has a new parameter resource_name
    info	[Changelog]   - Model EventImpactedResource has a new parameter status
️⚠️ azure-sdk-for-java warning [Detail]
️❌ azure-sdk-for-net failed [Detail]
  • Code Generator Failed [Logs]Release - Generate from 9ec0fcc. 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 --use=@microsoft.azure/autorest.csharp@2.3.101 --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
    cmdout	[Autorest] WARNING (PostOperationIdContainsUrlVerb/R2066/SDKViolation): OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListBySubscriptionIdAndEventId'. Consider updating the operationId
    cmdout	[Autorest] WARNING (PostOperationIdContainsUrlVerb/R2066/SDKViolation): OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListByTenantIdAndEventId'. Consider updating the operationId
    cmdout	[Autorest] WARNING (PostOperationIdContainsUrlVerb/R2066/SDKViolation): OperationId should contain the verb: 'fetcheventdetails' in:'Event_fetchDetailsBySubscriptionIdAndTrackingId'. Consider updating the operationId
    cmdout	[Autorest] WARNING (PostOperationIdContainsUrlVerb/R2066/SDKViolation): OperationId should contain the verb: 'fetcheventdetails' in:'Event_fetchDetailsByTenantIdAndTrackingId'. Consider updating the operationId
    cmdout	[Autorest] WARNING (PageableOperation/R2029/SDKViolation): Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventsModel'. Consider using the plural form of 'Events' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventModel'. Consider using the plural form of 'Event' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventModel'. Consider using the plural form of 'Event' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventsModel'. Consider using the plural form of 'Events' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventModel'. Consider using the plural form of 'Event' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventModel'. Consider using the plural form of 'Event' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmdout	[Autorest] WARNING (OperationIdNounConflictingModelNames/R2063/SDKViolation): OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventsModel'. Consider using the plural form of 'Events' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    cmderr	[Autorest] ERROR (BodyTopLevelProperties/R3006/ARMViolation): Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'MetadataEntity' has extra properties ['systemData'].
    cmderr	[Autorest]     - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2023-10-01-preview/ResourceHealth.json:1618:6 ($.definitions.MetadataEntity.properties)
    cmderr	[Autorest] ERROR (BodyTopLevelProperties/R3006/ARMViolation): Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'eventImpactedResource' has extra properties ['systemData'].
    cmderr	[Autorest]     - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2023-10-01-preview/ResourceHealth.json:2053:6 ($.definitions.eventImpactedResource.properties)
    cmderr	[Autorest] ERROR (BodyTopLevelProperties/R3006/ARMViolation): Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'event' has extra properties ['systemData'].
    cmderr	[Autorest]     - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2023-10-01-preview/ResourceHealth.json:1129:6 ($.definitions.event.properties)
    cmderr	[Autorest] ERROR (BodyTopLevelProperties/R3006/ARMViolation): Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'emergingIssuesGetResult' has extra properties ['systemData'].
    cmderr	[Autorest]     - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2023-10-01-preview/ResourceHealth.json:2152:6 ($.definitions.emergingIssuesGetResult.properties)
    cmderr	[Autorest] ERROR (BodyTopLevelProperties/R3006/ARMViolation): Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'impactedResourceStatus' has extra properties ['systemData'].
    cmderr	[Autorest]     - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2023-10-01-preview/ResourceHealth.json:1543:6 ($.definitions.impactedResourceStatus.properties)
    cmderr	[Autorest] ERROR (BodyTopLevelProperties/R3006/ARMViolation): Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'AzureEntityResource' has extra properties ['systemData'].
    cmderr	[Autorest]     - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v3/types.json:43:6 ($.definitions.AzureEntityResource.properties)
    cmdout	[Autorest] WARNING (AvoidNestedProperties/R2001/SDKViolation): Consider using x-ms-client-flatten to provide a better end user experience
    cmdout	[Autorest] WARNING (EnumInsteadOfBoolean/R3018/ARMViolation): Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: published
    cmdout	[Autorest] WARNING (DescriptionAndTitleMissing/R4000/SDKViolation): 'identity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    cmdout	[Autorest] WARNING (DescriptionAndTitleMissing/R4000/SDKViolation): 'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    cmdout	[Autorest] WARNING (DescriptionAndTitleMissing/R4000/SDKViolation): 'plan' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    cmdout	[Autorest] WARNING (DescriptionAndTitleMissing/R4000/SDKViolation): 'tier' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    error	Script return with result [failed] code [6] signal [null] cwd [azure-sdk-for-net]: autorest
    warn	Skip package processing as generation is failed
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed [Logs]Release - Generate from 9ec0fcc. 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] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.0` to update!
    cmderr	[initScript.sh] npm notice
    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/resource-manager [View full logs
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from 9ec0fcc. 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
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ️✔️Az.resourcehealth.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.resourcehealth.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 13, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/resourcehealth/armresourcehealth https://apiview.dev/Assemblies/Review/66539ec8faf349d7b5e7cc1fcf3e6a3e
Java azure-resourcemanager-resourcehealth https://apiview.dev/Assemblies/Review/e7472fa0057f41d6a27283a95477ece4
JavaScript @azure/arm-resourcehealth https://apiview.dev/Assemblies/Review/b496871360c44230a60a28b38a04d135

@msyyc msyyc added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 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 Oct 16, 2023
@msyyc msyyc added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go labels Oct 16, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 16, 2023
@msyyc msyyc added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 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 Oct 16, 2023
@msyyc msyyc merged commit 9ec0fcc into Azure:main Oct 16, 2023
27 of 31 checks passed
@openapi-pipeline-app
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants