[OperationalInsights] Add stable version for query packs #17923
Merged
Conversation
This file contains 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
|
Hi, @dabenhamMic 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. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Since operation 'Queries_Search' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json#L91 |
|
| 'PUT' operation 'Queries_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json#L191 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json#L452 |
|
| The child tracked resource, 'queries' with immediate parent 'LogAnalyticsQueryPack', must have a list by immediate parent operation. Location: Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json#L356 |
️❌Avocado: 2 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/operationalinsights/resource-manager/readme.md json: Microsoft.OperationalInsights/preview/2019-09-01-preview/QueryPackQueries_API.json |
|
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/operationalinsights/resource-manager/readme.md json: Microsoft.OperationalInsights/preview/2019-09-01-preview/QueryPacks_API.json |
| 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-02 |
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 2 Warnings warning [Detail]
| Rule | Message |
|---|---|
| "details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:Queries_Get, Queries_Put, Queries_Update, Queries_Delete;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json" |
|
| "details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:QueryPacks_Delete, QueryPacks_Get, QueryPacks_CreateOrUpdate, QueryPacks_UpdateTags;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/QueryPacks.json" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Hi @dabenhamMic, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 21, 2022
openapi-pipeline-app
bot
removed
CI-BreakingChange-Go-V2
CI-BreakingChange-JavaScript
labels
jianyexi
reviewed
Mar 3, 2022
...ights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json
Outdated
Show resolved
Hide resolved
...nalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/QueryPacks.json
Outdated
Show resolved
Hide resolved
…perationalInsights/stable/2019-09-01/QueryPacks.json Co-authored-by: JianyeXi <[email protected]>
…perationalInsights/stable/2019-09-01/QueryPackQueries.json Co-authored-by: JianyeXi <[email protected]>
|
hi @jianyexi , thank you for the help. Can we proceed with this pr? |
|
@akning-ms can we move forward with this PR? |
|
@msyyc , can you have a look at the python SDK failures? @dabenhamMic, can you remove |
|
@raych1 , tag was removed. |
|
Have fixed python failure |
|
Hi @dabenhamMic, I just noticed you are creating a 2019 stable version, but your latest stable is :2021-06-01. Looks you are just moving a preview version into stable version, right? if so, can you use OpenAPI hub to do it which will make review more easy for us to know what change your PR include: below is guide in ARM review section in first comment |
@akning-ms This change is not only bumping the API version from package-2021-12-01-preview to package-2022-02,
haven't found a way to do both actions through the link you sent... |
My key question is: beside version change from 2019-09-01-preview to 2019-09-01, what actual change you have made? |
akning-ms
approved these changes
Mar 15, 2022
This was referenced Mar 15, 2022
FredericHeem
pushed a commit
to grucloud/azure-rest-api-specs
that referenced
this pull request
May 16, 2022
* Add blockchain to latest profile * Add additional types * added QueryPack and QueryPackQueries stable version * update default swagger version to package-2022-02 * fixed issue in x-ms-examples for QueryPacksList * added type: object to some definitions in order to fix build validations * removed Operations_List from QueryPacks resource * rename QueryPacks files to suit the file naming convention * rename files in readme.md * build errors * rename default package * update referenced package in readme to package-2022-02 * update error details with common-type * build error * Update specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/QueryPacks.json Co-authored-by: JianyeXi <[email protected]> * Update specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/QueryPackQueries.json Co-authored-by: JianyeXi <[email protected]> * Update readme.python.md Co-authored-by: Mark Cowlishaw <[email protected]> Co-authored-by: JianyeXi <[email protected]> Co-authored-by: Jiefeng Chen <[email protected]>
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.
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:
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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.