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

require gateway resource ID to be a gateway resource ID #29922

Merged
merged 1 commit into from
Jul 24, 2024
Merged

require gateway resource ID to be a gateway resource ID #29922

merged 1 commit into from
Jul 24, 2024

Conversation

dimbleby
Copy link
Member

on the Microsoft.Kubernetes/connectedClusters

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.
  • 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.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • 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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • 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.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • 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.

@dimbleby
require gateway resource ID to be a gateway resource ID
87ebef9 
on the Microsoft.Kubernetes/connectedClusters
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 19, 2024 •
edited
Loading

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 openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 19, 2024 •
edited
Loading

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 db280a715f68f8a6cc66d294f20b3cdbcd2450e5. 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.2
cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2
cmderr	[automation_init.sh] npm notice To update run: npm install -g npm@10.8.2
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-hybridkubernetes [Preview SDK Changes]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from db280a715f68f8a6cc66d294f20b3cdbcd2450e5. SDK Automation 14.0.0 
    command	./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-hybridkubernetes [Preview SDK Changes] 
    info	[Changelog]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from db280a715f68f8a6cc66d294f20b3cdbcd2450e5. 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/hybridkubernetes/armhybridkubernetes [Preview SDK Changes]
️⚠️ azure-sdk-for-net-track2 warning [Detail]
    For more instructions, please refer to the FAQ .
  • ⚠️Warning in generating from db280a715f68f8a6cc66d294f20b3cdbcd2450e5. 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.Kubernetes [Preview SDK Changes] 
    info	[Changelog]
️❌ azure-resource-manager-schemas failed [Detail]
    For more instructions, please refer to the FAQ .
  • ❌Code Generator Failed in generating from db280a715f68f8a6cc66d294f20b3cdbcd2450e5. 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.2
cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2
cmderr	[initScript.sh] npm notice To update run: npm install -g npm@10.8.2
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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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/ts-node@9.0.0_typescript@5.3.3/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 succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from db280a715f68f8a6cc66d294f20b3cdbcd2450e5. 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.hybridkubernetes.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 19, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/hybridkubernetes/armhybridkubernetes https://apiview.dev/Assemblies/Review/b6465b94674b468db665de3b2f1e09a5?revisionId=e90ba95ef740426f9774321fe2dabf4d
Java azure-resourcemanager-hybridkubernetes https://apiview.dev/Assemblies/Review/5e285d4ddfa24fa2947d2c524eb5e9e4?revisionId=a5ee9fb2f5f748709cf0e3d9907e62d1
.Net Azure.ResourceManager.Kubernetes https://apiview.dev/Assemblies/Review/cd6322ea95614730b1f7400bf5e82611?revisionId=c1fde49f5190424b9cffff75cfe4770a
Swagger Microsoft.Kubernetes https://apiview.dev/Assemblies/Review/93922e6fb6434d928d8c42a44f25c01d?revisionId=1b440885fbe744218fc6b65f548f55c3

@AzureRestAPISpecReview AzureRestAPISpecReview added resource-manager RPaaS VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required labels Jul 19, 2024
This was referenced Jul 19, 2024
Closed
Closed
Closed
Closed
Closed
@dimbleby dimbleby marked this pull request as ready for review July 19, 2024 16:32
@dimbleby
Copy link
Member Author

dimbleby commented Jul 19, 2024 •
edited
Loading

I don't currently have the necessary permission to add the label - request pending - but am expecting per aka.ms/brch to add BreakingChange-Approved-BugFix on the grounds that

  • this is updating the definition to accurately describe the service behaviour
  • this API version is currently only available via feature flags, set only in internal subscriptions so we definitely won't break any public usage

edit: looks like Versioning-Approved-BugFix was the magic, but same reasoning

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels Jul 19, 2024
@dimbleby dimbleby added BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 labels Jul 23, 2024
@dimbleby
Copy link
Member Author

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior labels Jul 23, 2024
@razvanbadea-msft razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 24, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 24, 2024
@razvanbadea-msft razvanbadea-msft merged commit 03d0a5c into Azure:main Jul 24, 2024
29 of 31 checks passed
@dimbleby dimbleby deleted the gateway-resource-id-is-a-gateway branch July 24, 2024 18:16
@dimbleby dimbleby mentioned this pull request Jul 25, 2024
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@razvanbadea-msft razvanbadea-msft razvanbadea-msft approved these changes

Assignees
No one assigned
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dimbleby @razvanbadea-msft @AzureRestAPISpecReview