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.

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

clean up flagged value and replace with placeholder #28844

Merged
merged 3 commits into from Apr 29, 2024

Conversation

Arif-lakhani
Copy link
Contributor

@Arif-lakhani Arif-lakhani commented Apr 25, 2024

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.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

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.
  • 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.
  • 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 PR workflow diagram Step 2 (ARM review), 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.

Copy link

openapi-pipeline-app bot commented Apr 25, 2024

Next Steps to Merge

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

Copy link

openapi-pipeline-app bot commented Apr 25, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/kubernetesconfiguration/resource-manager/readme.md
tag: specification/kubernetesconfiguration/resource-manager/readme.md#tag-package-preview-2024-04
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 9 Errors, 0 Warnings failed [Detail]
Rule Message
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensions.json#L198:22
ExampleUrl: preview/2021-05-01-preview/examples/DeleteExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/preview/2021-11-01-preview/extensions.json#L198:22
ExampleUrl: preview/2021-11-01-preview/examples/DeleteExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/preview/2021-11-01-preview/extensions.json#L264:22
ExampleUrl: preview/2021-11-01-preview/examples/PatchExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/extensions.json#L198:22
ExampleUrl: preview/2022-01-01-preview/examples/DeleteExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/preview/2022-04-02-preview/extensions.json#L201:22
ExampleUrl: preview/2022-04-02-preview/examples/DeleteExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/stable/2021-09-01/extensions.json#L198:22
ExampleUrl: stable/2021-09-01/examples/DeleteExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/stable/2021-09-01/extensions.json#L264:22
ExampleUrl: stable/2021-09-01/examples/PatchExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/stable/2022-03-01/extensions.json#L198:22
ExampleUrl: stable/2022-03-01/examples/DeleteExtension.json
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.KubernetesConfiguration/stable/2022-07-01/extensions.json#L198:22
ExampleUrl: stable/2022-07-01/examples/DeleteExtension.json
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️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?

Copy link

openapi-pipeline-app bot commented Apr 25, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 2347fa9. 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]
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.6.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️azure-mgmt-kubernetesconfiguration [Preview SDK Changes]
    • azure_mgmt_kubernetesconfiguration-3.1.0-py3-none-any.whl
    • azure-mgmt-kubernetesconfiguration-3.1.0.zip
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning in generating from 2347fa9. 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
    cmderr	[init.sh]  notice
    cmderr	[init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
    cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
    cmderr	[init.sh] npm notice Run `npm install -g npm@10.6.0` to update!
    cmderr	[init.sh] npm notice
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-kubernetesconfiguration [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-kubernetesconfiguration-1.1.0-beta.1-sources.jar
    • azure-resourcemanager-kubernetesconfiguration-1.1.0-beta.1.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 2347fa9. 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/kubernetesconfiguration/armkubernetesconfiguration [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 2347fa9. 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
  • ️✔️@azure/arm-kubernetesconfiguration [Preview SDK Changes]
    • azure-arm-kubernetesconfiguration-7.0.0-beta.1.tgz
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed in generating from 2347fa9. 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]  notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.6.0` to update!
    cmderr	[initScript.sh] npm notice
    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
  • kubernetesconfiguration/resource-manager [Preview Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 2347fa9. 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.kubernetesconfiguration.DefaultTag [Preview SDK Changes]
    • Az.SourceControlConfiguration.0.1.0.nupkg
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Apr 25, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration https://apiview.dev/Assemblies/Review/a54df2a0c1e54238a5d668c54b45f1ef?revisionId=6ef3d8c228344a78a412ff4663d188d5
Java azure-resourcemanager-kubernetesconfiguration https://apiview.dev/Assemblies/Review/b32f2ce6cb0c483b98818ba71fed6114?revisionId=de61da179f50474eadfa4524b2785e3a
JavaScript @azure/arm-kubernetesconfiguration https://apiview.dev/Assemblies/Review/9c38fe14e2c0467c9767f42827a62a52?revisionId=9c7aebca63644942bf765b395875b036

@RickWinter
Copy link
Member

RickWinter commented Apr 25, 2024

@mikekistler, @JeffreyRichter - The service team made a fix to use substitute tokens so that scanners won't flag the values as secrets. However, the swagger itself is failing checks due to pre-existing problems. Is there a flag I can set to get this PR through without fixing those unrelated pre-existing issues?

@mikekistler
Copy link
Member

@RickWinter I think you need a suppression label for this. @weshaggard can probably help with that.

@RickWinter RickWinter added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 26, 2024
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 26, 2024
@weshaggard
Copy link
Member

@RickWinter there is no required checks here so the PR can be merged when ready.

Is there a reason we choose fakeTokenPlaceholder as the placeholder here?

@RickWinter
Copy link
Member

@RickWinter there is no required checks here so the PR can be merged when ready.

Is there a reason we choose fakeTokenPlaceholder as the placeholder here?

Renhe choose that. Feel free to suggest something better.

@RickWinter RickWinter merged commit 4e44971 into Azure:main Apr 29, 2024
31 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-ModelValidation ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants