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

Adding files and folders from previous stable version

Open ravigautam1896 opened this issue 1 year ago • 15 comments

ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • [ ] New resource provider.
  • [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix OpenAPI spec quality issues in S360.
  • [ ] Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [x] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

ravigautam1896 avatar Jun 25 '24 09:06 ravigautam1896

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app[bot] avatar Jun 25 '24 09:06 openapi-pipeline-app[bot]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 201 Warnings warning [Detail]

Only 0 items are rendered, please refer to log for more details.

The following breaking changes are detected by comparison with the latest preview version:

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

Rule Message
️🔄LintDiff inProgress [Detail]
️⚠️Avocado: 1 Warnings warning [Detail]

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

Rule Message
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 508 Errors, 0 Warnings failed [Detail]

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

Rule Message
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand] 
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

openapi-pipeline-app[bot] avatar Jun 25 '24 09:06 openapi-pipeline-app[bot]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand] 
 Please click here to preview with your @microsoft account.
️⚠️ azure-sdk-for-python warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 4dba00828cbad8333212e0bb9ef6897ad11a6224. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh] npm notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
cmderr	[automation_init.sh] npm notice To update run: npm install -g [email protected]
cmderr	[automation_init.sh] npm notice
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-sql [Preview SDK Changes]
️⚠️ azure-sdk-for-net-track2 warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 4dba00828cbad8333212e0bb9ef6897ad11a6224. SDK Automation 14.0.0 
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:787
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  787 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
  • ️✔️Azure.ResourceManager.Sql [Preview SDK Changes] 
    info	[Changelog]
️🔄 azure-sdk-for-java inProgress [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 4dba00828cbad8333212e0bb9ef6897ad11a6224. 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/sql/armsql [Preview SDK Changes]
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
    For more instructions, please refer to the FAQ .
  • ❌Code Generator Failed in generating from 4dba00828cbad8333212e0bb9ef6897ad11a6224. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
cmderr	[initScript.sh] npm notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
cmderr	[initScript.sh] npm notice To update run: npm install -g [email protected]
cmderr	[initScript.sh] npm notice
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
cmderr	[generateScript.sh]            ^
cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️⚠️ azure-powershell warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from 4dba00828cbad8333212e0bb9ef6897ad11a6224. 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.sql.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

openapi-pipeline-app[bot] avatar Jun 25 '24 09:06 openapi-pipeline-app[bot]

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/sql/armsql https://apiview.dev/Assemblies/Review/ddcdbf3100fb45bbaafb400a9a70d425?revisionId=08496582abc143a4a15808f8d410c04b
.Net Azure.ResourceManager.Sql https://apiview.dev/Assemblies/Review/1e3ea1e2dc2c4679b3acd45b20b81a18?revisionId=09ab44dca0f447af83edce9dd9715304
Swagger Microsoft.Sql https://apiview.dev/Assemblies/Review/86f9467cec6a49f899d90b4872280851?revisionId=28ae8277e4f14c6485ce72d5c63b953e

openapi-pipeline-app[bot] avatar Jun 25 '24 09:06 openapi-pipeline-app[bot]

  1. Please add the template as per https://github.com/Azure/azure-rest-api-specs/pull/29573#issue-2372227281
  2. Make the first commit with the exact copy of what you have today. In the subsequent commit, make changes as needed for this PR. This way, reviewers can compare what is changing in this PR. You can choose to abondon this PR and create a new one or update the commits on this. This PR has a single commit and 669 files changed. It is impossible to review this currently.
  3. Please fix the errors from Swagger LintDiff and Swagger ModelValidation if they are in the scope of this PR.

ramoka178 avatar Jun 25 '24 22:06 ramoka178

@ramoka178 it seems the PR description selection is broken. I tried in "edit"/"preview" and choose control plane link, but it cannot work with multiple retries. do we know how we could get the PR description? thanks~

ericshape avatar Jun 26 '24 21:06 ericshape

  1. Please add the template as per Adding files and folders from previous stable version #29573 (comment)
  2. Make the first commit with the exact copy of what you have today. In the subsequent commit, make changes as needed for this PR. This way, reviewers can compare what is changing in this PR. You can choose to abondon this PR and create a new one or update the commits on this. This PR has a single commit and 669 files changed. It is impossible to review this currently.
  3. Please fix the errors from Swagger LintDiff and Swagger ModelValidation if they are in the scope of this PR.

ravigautam1896 avatar Jun 27 '24 13:06 ravigautam1896

  1. Please add the template as per Adding files and folders from previous stable version #29573 (comment)
  2. Make the first commit with the exact copy of what you have today. In the subsequent commit, make changes as needed for this PR. This way, reviewers can compare what is changing in this PR. You can choose to abondon this PR and create a new one or update the commits on this. This PR has a single commit and 669 files changed. It is impossible to review this currently.
  3. Please fix the errors from Swagger LintDiff and Swagger ModelValidation if they are in the scope of this PR. @ramoka178
  1. added the template.
  2. The first commit is just copy pasting the folders which were available in the last stable version 2021-11-01
  3. The LintDiff and swagger Model Validation errors are coming from feature teams present in SQL org, and we are infrastructure framework team responsible for releasing preview and stable version, having said that we wanted these validation flags so that we can push the feature team for the fix. we wanted the exception for these errors on this PR.

ravigautam1896 avatar Jun 27 '24 13:06 ravigautam1896

Can you all fix the PR description before we merge this?

TimLovellSmith avatar Jul 03 '24 02:07 TimLovellSmith

Can you all fix the PR description before we merge this?

The current PR description is not correct, is it? This is a control Plane PR.

ravigautam1896 avatar Jul 03 '24 04:07 ravigautam1896

Can you all fix the PR description before we merge this?

The current PR description is not correct, is it? This is a control Plane PR.

Yes but the form is not filled in, right.

TimLovellSmith avatar Jul 03 '24 06:07 TimLovellSmith

Can you all fix the PR description before we merge this?

The current PR description is not correct, is it? This is a control Plane PR.

Yes but the form is not filled in, right.

done now.

ravigautam1896 avatar Jul 03 '24 11:07 ravigautam1896

ModelValidation seems to be identifying some actual validation issues. Could you please review them and fix any you can? They might be identifying quality issues in your spec or examples. Like I'm not sure if the additionalProperties is declared correctly here, the validation seems to think it doesn't match the examples?

PS note there are more than 50 errors and you'll have to click through to see the other 400+.

[I.e. ignoring the errors is just allowing any quality issues to linger. If we aren't taking proper advantage of tools to help achieve quality, the tools are STILL incurring the costs (such as this PR analysis discussion) yet we're not getting the corresponding benefits!]

TimLovellSmith avatar Jul 03 '24 20:07 TimLovellSmith

  1. Please add the template as per Adding files and folders from previous stable version #29573 (comment)
  2. Make the first commit with the exact copy of what you have today. In the subsequent commit, make changes as needed for this PR. This way, reviewers can compare what is changing in this PR. You can choose to abondon this PR and create a new one or update the commits on this. This PR has a single commit and 669 files changed. It is impossible to review this currently.
  3. Please fix the errors from Swagger LintDiff and Swagger ModelValidation if they are in the scope of this PR. @ramoka178
  1. added the template.
  2. The first commit is just copy pasting the folders which were available in the last stable version 2021-11-01
  3. The LintDiff and swagger Model Validation errors are coming from feature teams present in SQL org, and we are infrastructure framework team responsible for releasing preview and stable version, having said that we wanted these validation flags so that we can push the feature team for the fix. we wanted the exception for these errors on this PR.

How about you loop in folks from those feature teams as needed.

And any model errors that aren't fixable because they'd actually change your API, which I guess you don't want to be part of this particular PR, I'm sure we can agree not to fix when you call them out.

TimLovellSmith avatar Jul 03 '24 20:07 TimLovellSmith

The feature team is working on these model Validation checks and that fix is not part of this PR. https://msdata.visualstudio.com/Database%20Systems/_workitems/edit/2984707

ravigautam1896 avatar Jul 04 '24 10:07 ravigautam1896