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

Merged
merged 2 commits into from
Feb 13, 2023
Merged

Update readme.python.md #22571

merged 2 commits into from
Feb 13, 2023

Conversation

msyyc
Copy link
Member

@msyyc msyyc commented Feb 13, 2023

@msyyc msyyc self-assigned this Feb 13, 2023
@msyyc msyyc requested a review from Wzb123456789 as a code owner February 13, 2023 07:05
@openapi-workflow-bot
Copy link

Hi, @msyyc 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 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.0.0) new version base version
    default default(6fccc71) 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 13, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/databoxedge/armdataboxedge - 2.0.0
    +	Struct `CloudErrorBody` has been removed
    +	Struct `CloudError` has been removed
    azure-sdk-for-js - @azure/arm-databoxedge - 3.0.0
    +	Interface DevicesListByResourceGroupNextOptionalParams no longer has parameter expand
    +	Interface DevicesListBySubscriptionNextOptionalParams no longer has parameter expand
    +	Interface TriggersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
    +	Interface UsersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
    azure-sdk-for-python-track2 - track2_azure-mgmt-databoxedge - 1.0.0
    +	Operation UsersOperations.list_by_data_box_edge_device no longer has parameter expand
    +	Parameter user_type of model User is now required
    +	Removed operation DevicesOperations.begin_create_or_update
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7628df5. 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]
      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-databoxedge [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation DevicesOperations.create_or_update
      info	[Changelog]   - Added operation group DeviceCapacityCheckOperations
      info	[Changelog]   - Added operation group DeviceCapacityInfoOperations
      info	[Changelog]   - Added operation group DiagnosticSettingsOperations
      info	[Changelog]   - Added operation group SupportPackagesOperations
      info	[Changelog]   - Model DataBoxEdgeDevice has a new parameter data_residency
      info	[Changelog]   - Model DataBoxEdgeDevice has a new parameter system_data_properties_system_data
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter cloud_witness_container_name
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter cloud_witness_storage_account_name
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter cloud_witness_storage_endpoint
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter cluster_witness_type
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter file_share_witness_location
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter file_share_witness_username
      info	[Changelog]   - Model DataBoxEdgeDeviceExtendedInfo has a new parameter system_data
      info	[Changelog]   - Model DataBoxEdgeSku has a new parameter capabilities
      info	[Changelog]   - Model Order has a new parameter kind
      info	[Changelog]   - Model Order has a new parameter order_id
      info	[Changelog]   - Model UpdateDetails has a new parameter friendly_version_number
      info	[Changelog]   - Model UpdateDetails has a new parameter installation_impact
      info	[Changelog]   - Model UpdateSummary has a new parameter last_successful_install_job_date_time
      info	[Changelog]   - Model UpdateSummary has a new parameter last_successful_scan_job_time
      info	[Changelog]   - Operation UsersOperations.list_by_data_box_edge_device has a new optional parameter filter
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Operation UsersOperations.list_by_data_box_edge_device no longer has parameter expand
      info	[Changelog]   - Parameter user_type of model User is now required
      info	[Changelog]   - Removed operation DevicesOperations.begin_create_or_update
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7628df5. 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-databoxedge [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group DeviceCapacityCheck
      info	[Changelog]   - Added operation group DeviceCapacityInfoOperations
      info	[Changelog]   - Added Interface ClusterCapacityViewData
      info	[Changelog]   - Added Interface ClusterGpuCapacity
      info	[Changelog]   - Added Interface ClusterMemoryCapacity
      info	[Changelog]   - Added Interface ClusterStorageViewData
      info	[Changelog]   - Added Interface DeviceCapacityCheckCheckResourceCreationFeasibilityOptionalParams
      info	[Changelog]   - Added Interface DeviceCapacityInfo
      info	[Changelog]   - Added Interface DeviceCapacityInfoGetDeviceCapacityInfoOptionalParams
      info	[Changelog]   - Added Interface DeviceCapacityRequestInfo
      info	[Changelog]   - Added Interface HostCapacity
      info	[Changelog]   - Added Interface NumaNodeData
      info	[Changelog]   - Added Interface VmMemory
      info	[Changelog]   - Added Interface VmPlacementRequestResult
      info	[Changelog]   - Added Type Alias ClusterWitnessType
      info	[Changelog]   - Added Type Alias DeviceCapacityInfoGetDeviceCapacityInfoResponse
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessContainerName
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessStorageAccountName
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter cloudWitnessStorageEndpoint
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter clusterWitnessType
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter fileShareWitnessLocation
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter fileShareWitnessUsername
      info	[Changelog]   - Interface DataBoxEdgeDeviceExtendedInfo has a new optional parameter systemData
      info	[Changelog]   - Interface Order has a new optional parameter kind
      info	[Changelog]   - Interface Order has a new optional parameter orderId
      info	[Changelog]   - Added Enum KnownClusterWitnessType
      info	[Changelog]   - Enum KnownSkuName has a new value EdgeMRTCP
      info	[Changelog]   - Enum KnownSkuName has a new value EP2128GPU1Mx1W
      info	[Changelog]   - Enum KnownSkuName has a new value EP2256GPU2Mx1
      info	[Changelog]   - Enum KnownSkuName has a new value EP264Mx1W
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface DevicesListByResourceGroupNextOptionalParams no longer has parameter expand
      info	[Changelog]   - Interface DevicesListBySubscriptionNextOptionalParams no longer has parameter expand
      info	[Changelog]   - Interface TriggersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
      info	[Changelog]   - Interface UsersListByDataBoxEdgeDeviceNextOptionalParams no longer has parameter filter
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7628df5. 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/databoxedge/armdataboxedge [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7628df5. 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-databoxedge [View full logs]  [Release SDK Changes]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7628df5. 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
    • ️✔️databoxedge [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7628df5. 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.DataBoxEdge [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 13, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/databoxedge/armdataboxedge https://apiview.dev/Assemblies/Review/9598fef6d458446b97c7133defed7969
    Java azure-resourcemanager-databoxedge https://apiview.dev/Assemblies/Review/d19ebdd865b845e984c2e1415872fab1
    .Net Azure.ResourceManager.DataBoxEdge There is no API change compared with the previous version
    JavaScript @azure/arm-databoxedge https://apiview.dev/Assemblies/Review/fb37c4e8448c49d983eacd412d942482

    @msyyc msyyc merged commit 7628df5 into main Feb 13, 2023
    @msyyc msyyc deleted the msyyc-patch-1 branch February 13, 2023 07:42
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * Update readme.python.md
    
    * Update readme.python.md
    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.

    3 participants