{AzureOperationalInsights} fixes Azure/azure-cli#23618 #20362
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Workspaces eTag is an invalid name, should be renamed to etag. The previous PR #18447 did that for stable versions only. This PR will fix it for preview versions too. fixes Azure/azure-cli#23618 More Info: az monitor log-analytics workspace show --resource-group MyResourceGroup --workspace-name MyWorkspace the response shouldn't contain "eTag" property, but only "etag"
|
Hi, @navba-MSFT Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| Workspaces.json | 2021-12-01-preview(6e69f65) | 2021-12-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version is missing a property found in the old version. Was 'eTag' renamed or removed? New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L637:7 Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L637:7 |
|
The new version has a new property 'etag' in response that was not found in the old version. New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L637:7 Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L637:7 |
|
The new version has a new optional property 'etag' that was not found in the old version. New: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L637:7 Old: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L637:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-02 | package-2022-02(6e69f65) | package-2022-02(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The schema 'WorkspaceSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L402 |
|
The schema 'WorkspaceCapping' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L451 |
|
The schema 'WorkspaceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L509 |
|
The schema 'WorkspaceFeatures' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L592 |
|
The schema 'PrivateLinkScopedResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L623 |
|
The schema 'Workspace' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L636 |
|
The schema 'WorkspacePatch' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L659 |
|
The schema 'WorkspaceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L686 |
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L203 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceCmkForQuery Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L566 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableDataExport Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L594 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: immediatePurgeDataOn30Days Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L599 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableLogAccessUsingOnlyResourcePermissions Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L604 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L614 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkspacesSubscriptionList Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L324 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkspacesGet Location: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L363 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/operationalinsights/resource-manager/readme.md tag: specification/operationalinsights/resource-manager/readme.md#tag-package-2022-10 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L210:22 ExampleUrl: preview/2021-12-01-preview/examples/WorkspacesDelete.json |
|
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.OperationalInsights/preview/2021-12-01-preview/Workspaces.json#L636:18 ExampleUrl: preview/2021-12-01-preview/examples/WorkspacesGet.json#L10:15 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Workspaces eTag is an invalid name, should be renamed to etag. The previous PR #18447 did that for stable versions only. This PR will fix it for preview versions too. fixes Azure/azure-cli#23618 More Info: az monitor log-analytics workspace show --resource-group MyResourceGroup --workspace-name MyWorkspace the response shouldn't contain "eTag" property, but only "etag"
|
NewApiVersionRequired reason: |
|
Hi @navba-MSFT, 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. |
This was referenced Aug 24, 2022
Contributor
Author
|
@dulikvor Could you please review this PR once you get a chance ? Thanks in advance. |
Contributor
Looking good and addressing the fact the preview version was not aligned to the previous stable version change, where eTag -> etag. so, it makes sense. |
Contributor
|
PR looks good |
Contributor
Author
|
I have added he Service team on this issue Azure/azure-cli#23618 to look into this and take this forward since there are breaking changes in SDK. |
|
Hi, @navba-MSFT. 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 |
Contributor
|
@navba-MSFT any updates? |
Contributor
Author
@dabenhamMic See this comment. It is pending on Service team and I have tagged them already in this issue Azure/azure-cli#23618 |
Contributor
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi, @navba-MSFT. 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 |
|
Hi @navba-MSFT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
tadelesh
force-pushed
the
navba-MSFT-patch-4
branch
from
a65760f to
6e69f65
Compare
tadelesh
added
the
Approved-SdkBreakingChange-Go
Member
|
The param is not changed compared with stable version. So approve for Go breaking change. |
|
Hi, @navba-MSFT. 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 |
|
Hi, @navba-MSFT. 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 |
ghost
closed this
|
Hi, @navba-MSFT. 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. |
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Workspaces eTag is an invalid name, should be renamed to etag.
The previous PR #18447 did that for stable versions only.
This PR will fix it for preview versions too.
fixes Azure/azure-cli#23618
More Info:
az monitor log-analytics workspace show --resource-group MyResourceGroup --workspace-name MyWorkspace
the response shouldn't contain "eTag" property, but only "etag"
The fact its a fix which will make sure the preview version is aligned to previous stable version.
This issue is addressed that in stable versions already. Since it is not allowed to use preview versions in stable releases of CLI and Powershell, by standard that preview version should be deprecated once the new stable one is to be released.
So this PR is only for the preview version 2021-12-01-preview and not 2021-06-01 (stable) because the Azure CLi is using this preview feature.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.
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.