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.

Sign up for GitHub

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

Jump to bottom

revert default API in python.md for containerservice #22577

Merged
merged 1 commit into from
Feb 13, 2023
Merged

revert default API in python.md for containerservice #22577

merged 1 commit into from
Feb 13, 2023

Conversation

FumingZhang
Copy link
Member

@FumingZhang FumingZhang commented Feb 13, 2023 •
edited
Loading

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, revert readme changes
  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-workflow-bot
Copy link

Hi @FumingZhang, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth. @FumingZhang , please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO.

  • You can refer to Service API Toolset Introduction for details.
  • Please contact service focal @FumingZhang contacts or Service API Toolset Support Channel if need further help.

    		•

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 13, 2023 •
    edited
    Loading

    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(f9e7991) 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 •
    edited
    Loading

    Swagger Generation Artifacts

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

    Breaking Changes Tracking




    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4802c0f. 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-containerservice [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model ManagedCluster has a new parameter upgrade_settings
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4802c0f. 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/containerservice/armcontainerservice [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `ManagedClusterSKUNameBase` added to type alias `ManagedClusterSKUName`
info	[Changelog] - New value `ManagedClusterSKUTierStandard` added to type alias `ManagedClusterSKUTier`
info	[Changelog] - New function `*AgentPoolsClient.BeginAbortLatestOperation(context.Context, string, string, string, *AgentPoolsClientBeginAbortLatestOperationOptions) (*runtime.Poller[AgentPoolsClientAbortLatestOperationResponse], error)`
info	[Changelog] - New function `*ManagedClustersClient.BeginAbortLatestOperation(context.Context, string, string, *ManagedClustersClientBeginAbortLatestOperationOptions) (*runtime.Poller[ManagedClustersClientAbortLatestOperationResponse], error)`
info	[Changelog] - New struct `AgentPoolsClientAbortLatestOperationResponse`
info	[Changelog] - New struct `ManagedClusterAzureMonitorProfile`
info	[Changelog] - New struct `ManagedClusterAzureMonitorProfileKubeStateMetrics`
info	[Changelog] - New struct `ManagedClusterAzureMonitorProfileMetrics`
info	[Changelog] - New struct `ManagedClustersClientAbortLatestOperationResponse`
info	[Changelog] - New field `AzureMonitorProfile` in struct `ManagedClusterProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 15 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4802c0f. 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-containerservice [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation AgentPools.beginAbortLatestOperation
info	[Changelog]   - Added operation AgentPools.beginAbortLatestOperationAndWait
info	[Changelog]   - Added operation ManagedClusters.beginAbortLatestOperation
info	[Changelog]   - Added operation ManagedClusters.beginAbortLatestOperationAndWait
info	[Changelog]   - Added Interface AgentPoolsAbortLatestOperationHeaders
info	[Changelog]   - Added Interface AgentPoolsAbortLatestOperationOptionalParams
info	[Changelog]   - Added Interface ManagedClusterAzureMonitorProfile
info	[Changelog]   - Added Interface ManagedClusterAzureMonitorProfileKubeStateMetrics
info	[Changelog]   - Added Interface ManagedClusterAzureMonitorProfileMetrics
info	[Changelog]   - Added Interface ManagedClustersAbortLatestOperationHeaders
info	[Changelog]   - Added Interface ManagedClustersAbortLatestOperationOptionalParams
info	[Changelog]   - Added Type Alias AgentPoolsAbortLatestOperationResponse
info	[Changelog]   - Added Type Alias ManagedClustersAbortLatestOperationResponse
info	[Changelog]   - Interface ManagedCluster has a new optional parameter azureMonitorProfile
info	[Changelog]   - Enum KnownManagedClusterSKUName has a new value Base
info	[Changelog]   - Enum KnownManagedClusterSKUTier has a new value Standard
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4802c0f. 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
    • ️✔️containerservice [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • ❌Failed [Logs]Release - Generate from 4802c0f. 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.containerservice [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Feb 13, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 13, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/containerservice/armcontainerservice https://apiview.dev/Assemblies/Review/ae5c318d6eaf469db4984bf390fd3ffc
    Java azure-resourcemanager-containerservice-generated https://apiview.dev/Assemblies/Review/4f8d01dee8d14280be2de21b13b68adb
    .Net Azure.ResourceManager.ContainerService There is no API change compared with the previous version
    JavaScript @azure/arm-containerservice https://apiview.dev/Assemblies/Review/6d27c1eff38a4aae9085ac5896a73815

    @ghost ghost added the Container Service label Feb 13, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @FumingZhang 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

    This was referenced Feb 13, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @xiaoxuqi-ms xiaoxuqi-ms merged commit 4802c0f into Azure:main Feb 13, 2023
    This was referenced Feb 13, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @FumingZhang FumingZhang deleted the fuming/revert-containerservice-python-config-0213 branch February 17, 2023 02:20
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    @FumingZhang @aviyerMSFT
    revert default api for container service (Azure#22577)
    a4f74f7
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @xiaoxuqi-ms xiaoxuqi-ms xiaoxuqi-ms approved these changes

    @msyyc msyyc Awaiting requested review from msyyc msyyc is a code owner

    @Wzb123456789 Wzb123456789 Awaiting requested review from Wzb123456789

    Assignees

    @raych1 raych1

    Labels
    Container Service DoNotMerge <valid label in PR review process> use to hold merge after approval resource-manager ShiftLeftViolation
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @FumingZhang @xiaoxuqi-ms @raych1 @AzureRestAPISpecReview