-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
add all apis to 2020 readme #14870
add all apis to 2020 readme #14870
Conversation
Hi, @tofriedl 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. vsswagger@microsoft.com |
[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 |
---|---|
'ErrorResponseLinkedStorage' 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/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json#L219 |
|
'ErrorResponseLinkedStorage' 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/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json#L219 |
|
'ErrorResponseComponents' 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/2020-02-02/components_API.json#L369 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/workbooks' Location: Microsoft.Insights/stable/2015-05-01/workbooks_API.json#L37 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/workbooks/{resourceName}' Location: Microsoft.Insights/stable/2015-05-01/workbooks_API.json#L85 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/linkedStorageAccounts/{storageType}' Location: Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json#L37 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/providers/microsoft.insights/operations' Location: Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json#L39 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/{resourceUri}/providers/microsoft.insights/generatelivetoken' Location: Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json#L77 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/workbooks' Location: Microsoft.Insights/stable/2015-05-01/workbooks_API.json#L37 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/workbooks/{resourceName}' Location: Microsoft.Insights/stable/2015-05-01/workbooks_API.json#L85 |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/linkedStorageAccounts/{storageType}' Location: Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json#L37 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Insights/stable/2015-05-01/aiOperations_API.json#L50 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Insights/stable/2015-05-01/aiOperations_API.json#L50 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
- applicationinsights/resource-manager/readme.md#package-preview-2020-06-only
- applicationinsights/resource-manager/readme.md#package-preview-2020-06
- applicationinsights/resource-manager/readme.md#package-2020-04
- applicationinsights/resource-manager/readme.md#package-2020-03-01-preview
- applicationinsights/resource-manager/readme.md#package-2020-02-02
Rule | Message |
---|---|
"readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"The schema 'ComponentPurgeBodyFilters-value' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value" |
|
"readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-04", "details":"The schema 'ComponentPurgeBodyFilters-value' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value" |
|
"readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-02-02", "details":"The schema 'ComponentPurgeBodyFilters-value' 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/2020-02-02/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value" |
|
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06-only", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06-only", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
|
"readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"Duplicate Operation 'List' detected." |
AutorestCore/Exception |
"readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"Error: Plugin checker reported failure." |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06-only", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-preview-2020-06", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-04", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-04", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-03-01-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-03-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"applicationinsights/resource-manager/readme.md", "tag":"package-2020-02-02", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
Hi, @tofriedl your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Please go through the contribution checklist and ARM API Review Checklist added as part of the review and mark them completed. It will help you fix most of the issues and improve the quality of swagger and help close the PR faster. This is a requirement before review can be continued. |
Hi @tofriedl , As this is mainly for GO SDK, so reassign to @ArcturusZhang to review. and it is not need ARM review. for track 2 validation error, pls refer to https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md#sdk-track2-validation to fix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we please also add this tag package-2020-02-02
to the readme.go.md
file?
https://github.com/Azure/azure-rest-api-specs/blob/ef0083e8b0d9cd81c3d52a58dce3fff69a29287d/specification/applicationinsights/resource-manager/readme.go.md
The breaking change is due to the refinement of error models |
* add all apis to 2020 readme * fix * add 2020 to Go Readme * change error definitions in 2020-02-02 * changes to fix issues * fix more errors * change error response to custom to fix errors * add code property to error * fix error response * change errorResponse name * fix * fix * fix * fix * fix * fix * fix * fix * fixes * fixes * fix * fixes * fix remaining issues in readme.go.md Co-authored-by: ArcturusZhang <dapzhang@microsoft.com>
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.