azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Fix sourcecontrol in main branch

Open yalixiang opened this issue 3 years ago • 7 comments

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 language 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: :warning:

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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
  • [x] 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.

yalixiang avatar Aug 02 '22 09:08 yalixiang

Hi, @yalixiang 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]

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    SourceControls.json 2022-01-01-preview(dc122f3) 2022-01-01-preview(main)
    SourceControls.json 2022-03-01(dc122f3) 2022-03-01(main)
    Rule Message
    1011 - AddingResponseCode The new version adds a response code '201'.
    New: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L185:11
    1011 - AddingResponseCode The new version adds a response code '201'.
    New: Microsoft.App/stable/2022-03-01/SourceControls.json#L185:11
    1012 - RemovedResponseCode The new version removes the response code '202'
    Old: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L185:11
    1012 - RemovedResponseCode The new version removes the response code '202'
    Old: Microsoft.App/stable/2022-03-01/SourceControls.json#L185:11
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⌛CredScan pending [Detail]
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-03 package-2022-03(dc122f3) package-2022-03(main)
    package-2022-01-01-preview package-2022-01-01-preview(dc122f3) package-2022-01-01-preview(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    :warning: R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L137
    :warning: R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L205
    :warning: R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L137
    :warning: R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
    Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L205
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation.
    Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L264
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation.
    Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L264
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/dc122f34cba659ff4dd9c34b64f5bb11d9a82c57/specification/app/resource-manager/readme.md#tag-package-2022-03">app/resource-manager/readme.md#package-2022-03
      • "https://github.com/Azure/azure-rest-api-specs/blob/dc122f34cba659ff4dd9c34b64f5bb11d9a82c57/specification/app/resource-manager/readme.md#tag-package-2022-01-01-preview">app/resource-manager/readme.md#package-2022-01-01-preview
    The following errors/warnings exist before current PR submission:
    Rule Message
    :warning: UnkownSecurityScheme "readme":"app/resource-manager/readme.md",
    "tag":"package-2022-03",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    :warning: UnkownSecurityScheme "readme":"app/resource-manager/readme.md",
    "tag":"package-2022-01-01-preview",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - armappcontainers - 2.0.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-appcontainers - 1.0.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 0b25cfb5888f05864d72577781113d0869e10313. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.15.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.15.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-appcontainers [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter id
      info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter name
      info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter system_data
      info	[Changelog]   - Model CustomHostnameAnalysisResult no longer has parameter type
    ️❌ azure-sdk-for-java failed [Detail]
    • Failed [Logs] Generate from 0b25cfb5888f05864d72577781113d0869e10313. 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
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.
      HttpError: You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.
          at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@[email protected][email protected]/node_modules/@octokit/request/dist-node/index.js:86:21
          at runMicrotasks (<anonymous>)
          at processTicksAndRejections (internal/process/task_queues.js:95:5)
          at async workflowPkgUpdatePR (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:396:21)
          at async Object.exports.workflowPkgMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:63:5)
          at async workflowHandleReadmeMd (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
          at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:87:13)
          at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:188:13)
          at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️azure-resourcemanager-appcontainers [View full logs
      error	Fatal error: You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.
      error	The following packages are still pending:
      error		azure-resourcemanager-appcontainers
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 0b25cfb5888f05864d72577781113d0869e10313. 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
    • ️✔️armappcontainers [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `*CertificatesClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, string, *CertificatesClientCreateOrUpdateOptions)` to `(context.Context, string, string, string, Certificate, *CertificatesClientCreateOrUpdateOptions)`
      info	[Changelog] - Struct `CustomHostnameAnalysisResultProperties` has been removed
      info	[Changelog] - Field `CertificateEnvelope` of struct `CertificatesClientCreateOrUpdateOptions` has been removed
      info	[Changelog] - Field `Properties` of struct `CustomHostnameAnalysisResult` has been removed
      info	[Changelog] - Field `ID` of struct `CustomHostnameAnalysisResult` has been removed
      info	[Changelog] - Field `Name` of struct `CustomHostnameAnalysisResult` has been removed
      info	[Changelog] - Field `SystemData` of struct `CustomHostnameAnalysisResult` has been removed
      info	[Changelog] - Field `Type` of struct `CustomHostnameAnalysisResult` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New field `CustomDomainVerificationFailureInfo` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `TxtRecords` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `CustomDomainVerificationTest` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `AlternateCNameRecords` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `IsHostnameAlreadyVerified` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `CNameRecords` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `ConflictingContainerAppResourceID` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `HasConflictOnManagedEnvironment` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `HostName` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `ARecords` in struct `CustomHostnameAnalysisResult`
      info	[Changelog] - New field `AlternateTxtRecords` in struct `CustomHostnameAnalysisResult`
      info	[Changelog]
      info	[Changelog] Total 5 breaking change(s), 1 additive change(s).
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs] Generate from 0b25cfb5888f05864d72577781113d0869e10313. 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
      cmderr	[automation_generate.sh] ERROR: The command failed with exit code 1
      cmderr	[automation_generate.sh] [ERROR] Error:
      cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for readme file: "specification/app/resource-manager/readme.md":
      cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush update
      cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
      cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
      cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush update
      cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (child_process.js:790:11)
      cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (child_process.js:863:15)
      cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/14.20.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:74:33)
      cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/opt/hostedtoolcache/node/14.20.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)"
      the given reference name 'refs/heads/sdkAuto/20065/' is not valid
      Error: the given reference name 'refs/heads/sdkAuto/20065/' is not valid
    • error	Fatal error: the given reference name 'refs/heads/sdkAuto/20065/' is not valid
      error	The following packages are still pending:
      error
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 0b25cfb5888f05864d72577781113d0869e10313. 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
    • ️✔️app [View full logs
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 0b25cfb5888f05864d72577781113d0869e10313. 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
      You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.
      HttpError: You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.
          at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@[email protected][email protected]/node_modules/@octokit/request/dist-node/index.js:86:21
          at processTicksAndRejections (internal/process/task_queues.js:95:5)
          at async workflowPkgUpdatePR (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:396:21)
          at async Object.exports.workflowPkgMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:63:5)
          at async workflowHandleReadmeMd (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:172:9)
          at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:188:13)
          at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️Az.ContainerAppsApi [View full logs
      error	Fatal error: You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.
      error	The following packages are still pending:
      error		Az.ContainerAppsApi
    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-appcontainers Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and re-trigger the CI. If issue still exists, please ask PR assignee for help
    Java azure-resourcemanager-appcontainers Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and re-trigger the CI. If issue still exists, please ask PR assignee for help

    Hi @yalixiang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    Hi, @yalixiang. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    ghost avatar Aug 21 '22 16:08 ghost

    Hi, @yalixiang. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    ghost avatar Sep 05 '22 05:09 ghost