Users/tolee/new api version #14041
Merged
Users/tolee/new api version #14041
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
…api-versions to 2021-03-08
…g their api-versions to 2021-03-08" This reverts commit 8abd9f1.
|
Hi, @tonykslee 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] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| 'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2021-03-08/workbooks_API.json#L337 |
|
| 'GET' operation 'Workbooks_RevisionGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2021-03-08/workbooks_API.json#L379 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#L525 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: Microsoft.Insights/stable/2021-03-08/workbooks_API.json#L697 |
|
| 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#L385 |
|
| 'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#L416 |
|
| 'userAssignedIdentities' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#L522 |
|
| 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2021-03-08/workbooks_API.json#L484 |
|
| 'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2021-03-08/workbooks_API.json#L515 |
|
| 'userAssignedIdentities' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2021-03-08/workbooks_API.json#L694 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.Insights/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Insights/stable/2021-03-08/workbookOperations_API.json#L37 |
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList Location: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#L129 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/applicationinsights/resource-manager/readme.md tag: specification/applicationinsights/resource-manager/readme.md#tag-package-preview-2020-06 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross Version BreakingChange (Base on preview version): 16 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2018-06-17-preview/workbookOperations_API.json <---> new: stable/2021-03-08/workbookOperations_API.json
- original: preview/2018-06-17-preview/workbooks_API.json <---> new: stable/2021-03-08/workbooks_API.json
Only 10 items are listed, please refer to log for more details.
️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-10-20/myworkbooks_API.json <---> new: stable/2021-03-08/myworkbooks_API.json
- original: stable/2020-10-20/workbookOperations_API.json <---> new: stable/2021-03-08/workbookOperations_API.json
- original: stable/2020-10-20/workbooks_API.json <---> new: stable/2021-03-08/workbooks_API.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2021-03-only", "details":"The schema 'ErrorDefinition-innererror' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#/components/schemas/ErrorDefinition-innererror\n file:///home/vsts/work/1/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-03-08/workbooks_API.json#/components/schemas/ErrorDefinition-innererror" |
|
| 💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2021-03-only", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2021-03-only", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2021-03-only", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
[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 Generation Artifacts
|
|
Hi, @tonykslee your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @kairu-ms |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @tonykslee your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @akning-ms |
This was referenced Apr 20, 2021
[AutoPR @azure/arm-appinsights] Users/tolee/new api version
AzureSDKAutomation/azure-sdk-for-js#4464
Closed
26 tasks
|
Hi @tonykslee, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
kairu-ms
reviewed
Apr 25, 2021
...oninsights/resource-manager/Microsoft.Insights/stable/2021-03-08/workbookOperations_API.json
Show resolved
Hide resolved
|
Please link examples in API definition. |
|
Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently. |
@chiragg4u we made this mistake on the original PR (#13524) , so I created this new PR where the first commit contains the original files (9e2b9e5). Then I merged in the changes from the previous PR. So you should still be able to compare the current version to that "first commit" version. |
|
The Revisions API changes looks OK. Marking it ARMSignedoff. Please resolve warning and follow the process given @ https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review to complete and get the PR merged |
chiragg4u
added
ARMSignedOff
@kairu-ms Looks like all examples are referenced in the api-definition. Please review/merge when you get the chance |
|
@jianyexi , do you have any idea of why |
Ignore this comparison error because the other breaking change check against previous stable version passed. |
raych1
approved these changes
May 6, 2021
|
Thank you @raych1 |
kairu-ms
approved these changes
May 6, 2021
This was referenced May 6, 2021
[ReleasePR appinsights/mgmt/2015-05-01/insights] Add 2020Public version
Azure/azure-sdk-for-go#13559
Closed
Closed
[ReleasePR Microsoft.Azure.ApplicationInsights] Add 2020Public version
Azure/azure-sdk-for-net#16904
Closed
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Adding new api version- 2021-03-08 * Fixing validation issues * minor fixes * Adding missing file * removed unaffected apis since they aren't going to be changing their api-versions to 2021-03-08 * ran prettier check, added systemData to response * ran prettier check again * added path to systemData definition * removed systemData * adding systemData to response * moved systemData, ran prettier * Revert "removed unaffected apis since they aren't going to be changing their api-versions to 2021-03-08" This reverts commit 8abd9f1. * first commit with unmodified files from previous version * Revert "Revert "removed unaffected apis since they aren't going to be changing their api-versions to 2021-03-08"" This reverts commit d187dd4. * created unique names for definitions in api definition * updated definition names * removed 2020-02-12 api version * returned the 2020-02-12 package * renamed definitions in workbooks and myworkbooks api * Update specification/applicationinsights/resource-manager/readme.md Co-authored-by: Renu Rani <[email protected]> Co-authored-by: kai ru <[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.
Reposting this pr: #13524
Since the first commit of that PR did not contain the existing unmodified file versions
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.