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

Modified description of maxTaskRetryCount to include default value an… #17293

Merged
merged 1 commit into from
Jan 10, 2022
Merged

Modified description of maxTaskRetryCount to include default value an… #17293

merged 1 commit into from
Jan 10, 2022

Conversation

NickKouds
Copy link
Member

@NickKouds NickKouds commented Jan 10, 2022 •
edited
Loading

…d clarify infinite retries

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

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. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.

  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @NickKouds 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 10, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 10, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - batch/2021-06-01.14.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2020-09-01.12.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2020-03-01.11.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2019-08-01.10.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2019-06-01.9.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2018-12-01.8.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2018-08-01.7.0/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2018-03-01.6.1/batch - v61.1.0
    ️✔️azure-sdk-for-go - batch/2017-05-01.5.0/batch - v61.1.0
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5e455f9. SDK Automation 14.0.0 
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️batch/2021-06-01.14.0/batch [View full logs]  [Release SDK Changes] 
      info	[Changelog] This is a new package
info	[Changelog]
    • ️✔️batch/2020-09-01.12.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2020-03-01.11.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2019-08-01.10.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2019-06-01.9.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2018-12-01.8.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2018-08-01.7.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2018-03-01.6.1/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️batch/2017-05-01.5.0/batch [View full logs]  
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5e455f9. 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
cmderr	[automation_init.sh]  deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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/batch [View full logs]  [Release SDK Changes] 
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    Posted by Swagger Pipeline | How to fix these errors?

    @tjprescott tjprescott merged commit 5e455f9 into Azure:main Jan 10, 2022
    This was referenced Jan 10, 2022
    Closed
    Closed
    @NickKouds NickKouds deleted the nikoudsi/maxTaskRetryCountDocUpdate branch January 18, 2022 17:22
    mstrisoline pushed a commit to mstrisoline/azure-rest-api-specs that referenced this pull request Feb 1, 2022
    @NickKouds @mstrisoline
    Modified description of maxTaskRetryCount to include default value an…
    c627fbb 
    …d clarify infinite retries (Azure#17293)
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @NickKouds @LeiWang3
    Modified description of maxTaskRetryCount to include default value an…
    e68168e 
    …d clarify infinite retries (Azure#17293)
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @tjprescott tjprescott tjprescott approved these changes

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

    @paterasMSFT paterasMSFT Awaiting requested review from paterasMSFT

    Assignees

    @tjprescott tjprescott

    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @NickKouds @tjprescott