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 #22545

Merged
merged 3 commits into from
Feb 10, 2023
Merged

Update readme.python.md #22545

merged 3 commits into from
Feb 10, 2023

Conversation

Wzb123456789
Copy link
Contributor

@Wzb123456789 Wzb123456789 commented Feb 10, 2023

@openapi-workflow-bot
Copy link

Hi, @Wzb123456789 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 Feb 10, 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.0.0) new version base version
    default default(19e169f) default(main)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️❌SwaggerAPIView: 0 Errors, 1 Warnings failed [Detail]
    Rule Message
    ⚠️ Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log. "How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 10, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/databox/armdatabox - 2.0.0
    +	Field `AccountName` of struct `DiskGranularCopyLogDetails` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-databox - 1.0.0
    +	Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes
    +	Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes
    +	Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes
    +	Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes
    +	Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes
    +	Model JobDetails no longer has parameter expected_data_size_in_terabytes
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 2a5d005. 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	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.DataBox [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType> Azure.ResourceManager.DataBox.Models.DataBoxValidateAddressContent.TransportPreferencesPreferredShipmentType.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.DataBoxValidateAddressContent.TransportPreferencesPreferredShipmentType.set(System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.MitigateJobContent..ctor(Azure.ResourceManager.DataBox.Models.CustomerResolutionCode)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.DataBox.Models.CustomerResolutionCode Azure.ResourceManager.DataBox.Models.MitigateJobContent.CustomerResolutionCode.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
      info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.DataBox/Debug/netstandard2.0/Azure.ResourceManager.DataBox.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2a5d005. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.2` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-databox [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation JobsOperations.mark_devices_shipped
      info	[Changelog]   - Added operation group DataBoxManagementClientOperationsMixin
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter actions
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter data_center_code
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter granular_copy_log_details
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter granular_copy_progress
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model DataBoxDiskJobDetails has a new parameter reverse_shipping_details
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter actions
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter data_center_code
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model DataBoxHeavyJobDetails has a new parameter reverse_shipping_details
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter actions
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter data_center_code
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model DataBoxJobDetails has a new parameter reverse_shipping_details
      info	[Changelog]   - Model DataImportDetails has a new parameter log_collection_level
      info	[Changelog]   - Model JobDetails has a new parameter actions
      info	[Changelog]   - Model JobDetails has a new parameter data_center_code
      info	[Changelog]   - Model JobDetails has a new parameter datacenter_address
      info	[Changelog]   - Model JobDetails has a new parameter device_erasure_details
      info	[Changelog]   - Model JobDetails has a new parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model JobDetails has a new parameter last_mitigation_action_on_job
      info	[Changelog]   - Model JobDetails has a new parameter reverse_shipping_details
      info	[Changelog]   - Model JobResource has a new parameter reverse_shipping_details_update
      info	[Changelog]   - Model JobResource has a new parameter reverse_transport_preference_update
      info	[Changelog]   - Model JobResource has a new parameter system_data
      info	[Changelog]   - Model Preferences has a new parameter reverse_transport_preferences
      info	[Changelog]   - Model Preferences has a new parameter storage_account_access_tier_preferences
      info	[Changelog]   - Model RegionConfigurationRequest has a new parameter datacenter_address_request
      info	[Changelog]   - Model RegionConfigurationResponse has a new parameter datacenter_address_response
      info	[Changelog]   - Model SkuInformation has a new parameter countries_within_commerce_boundary
      info	[Changelog]   - Model TransportPreferences has a new parameter is_updated
      info	[Changelog]   - Model UpdateJobDetails has a new parameter preferences
      info	[Changelog]   - Model UpdateJobDetails has a new parameter return_to_customer_package_details
      info	[Changelog]   - Model UpdateJobDetails has a new parameter reverse_shipping_details
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes
      info	[Changelog]   - Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes
      info	[Changelog]   - Model JobDetails no longer has parameter expected_data_size_in_terabytes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2a5d005. 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-databox [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2a5d005. 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/databox/armdatabox [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `AccountName` of struct `DiskGranularCopyLogDetails` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New type alias `ReverseShippingDetailsEditStatus` with values `ReverseShippingDetailsEditStatusDisabled`, `ReverseShippingDetailsEditStatusEnabled`, `ReverseShippingDetailsEditStatusNotSupported`
      info	[Changelog] - New type alias `ReverseTransportPreferenceEditStatus` with values `ReverseTransportPreferenceEditStatusDisabled`, `ReverseTransportPreferenceEditStatusEnabled`, `ReverseTransportPreferenceEditStatusNotSupported`
      info	[Changelog] - New struct `ContactInfo`
      info	[Changelog] - New struct `ReverseShippingDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `CommonJobDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `CustomerDiskJobDetails`
      info	[Changelog] - New field `AccountID` in struct `DiskGranularCopyLogDetails`
      info	[Changelog] - New field `GranularCopyLogDetails` in struct `DiskJobDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `DiskJobDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `HeavyJobDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `JobDetails`
      info	[Changelog] - New field `ReverseShippingDetailsUpdate` in struct `JobProperties`
      info	[Changelog] - New field `ReverseTransportPreferenceUpdate` in struct `JobProperties`
      info	[Changelog] - New field `SerialNumberCustomerResolutionMap` in struct `MitigateJobRequest`
      info	[Changelog] - New field `ReverseTransportPreferences` in struct `Preferences`
      info	[Changelog] - New field `CountriesWithinCommerceBoundary` in struct `SKUProperties`
      info	[Changelog] - New field `IsUpdated` in struct `TransportPreferences`
      info	[Changelog] - New field `Preferences` in struct `UpdateJobDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `UpdateJobDetails`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 24 additive change(s).
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2a5d005. 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.1 -> 23.0
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
      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-databox [View full logs]  [Release SDK Changes]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2a5d005. 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
    • ️✔️databox [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2a5d005. 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.DataBox [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 10, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/databox/armdatabox https://apiview.dev/Assemblies/Review/e46a2e2ebecd4bdfaee3b61717abafa4
    Java azure-resourcemanager-databox https://apiview.dev/Assemblies/Review/472b9d1999714919aae6ce72914626e7
    .Net Azure.ResourceManager.DataBox https://apiview.dev/Assemblies/Review/05bb977050324ccbb962603d0e6402e4
    JavaScript @azure/arm-databox https://apiview.dev/Assemblies/Review/093d77de78974b3d95463a149a879909

    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.

    4 participants