Skip to content

Conversation

@dpwatrous
Copy link
Member

@dpwatrous dpwatrous commented Apr 28, 2021

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 28, 2021

Swagger Validation Report

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

️⚠️LintDiff: 0 Warnings warning [Detail]
The following errors/warnings exist before current PR submission:

Only 10 items are listed, please refer to log for more details.

Rule Message
R3016 - DefinitionsPropertiesNamesCamelCase Property named: 'nodeAgentSKUId', for definition: 'ImageInformation' must follow camelCase style. Example: 'nodeAgentSkuId'.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L10698
⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L11286
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Certificate_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L1257
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'JobSchedule_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L2867
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'JobSchedule_Terminate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L3793
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Job_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L4205
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Job_Disable' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L4828
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Job_Enable' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L4989
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Job_Terminate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L5141
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Pool_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json#L6235
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2020-09.12.0",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2020-09.12.0",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2020-09.12.0",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2020-03.11.0",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2020-03.11.0",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2019-08.10.0",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2019-08.10.0",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2019-06.9.0",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2019-06.9.0",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2018-12.8.0",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2018-12.8.0",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"batch/data-plane/readme.md",
"tag":"package-2018-08.7.0",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 28, 2021

Swagger Generation Artifacts

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️❌ azure-sdk-for-js failed [Detail]
  • Failed [Logs]Release - Generate from 741037c. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/batch/data-plane/readme.md
    cmdout	[Autorest] WARNING: HEAD 'getPropertiesFromTask' method missing 404 status code section -- this might be unintentional.
    cmdout	[Autorest] WARNING: HEAD 'getPropertiesFromComputeNode' method missing 404 status code section -- this might be unintentional.
  • @azure/batch [View full logs]  [Release SDK Changes]
    error	Script return with result [failed] code [2] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/batch/batch]: npm pack --silent
️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @dpwatrous 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. [email protected]

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

    @dpwatrous
    Copy link
    Member Author

    This is an update for documentation purposes only. No SDK changes are required.

    @jhendrixMSFT
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @jhendrixMSFT jhendrixMSFT merged commit 741037c into master Apr 29, 2021
    @JackTn JackTn deleted the Batch-data-plane-docs-updates-2020-09-01.12.0 branch August 17, 2021 06:05
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    None yet

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants