Update swagger for Azure Monitor metrics query #14609
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, @srnagar 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 |
|---|---|
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/autoscalesettings' Location: Microsoft.Insights/stable/2015-04-01/autoscale_API.json#L39 |
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/autoscalesettings/{autoscaleSettingName}' Location: Microsoft.Insights/stable/2015-04-01/autoscale_API.json#L81 |
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/microsoft.insights/autoscalesettings' Location: Microsoft.Insights/stable/2015-04-01/autoscale_API.json#L264 |
|
Resource provider naming must follow the pascal case. Path: '/providers/microsoft.insights/operations' Location: Microsoft.Insights/stable/2015-04-01/operations_API.json#L39 |
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents/{incidentName}' Location: Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json#L39 |
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}/incidents' Location: Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json#L88 |
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles/{logProfileName}' Location: Microsoft.Insights/stable/2016-03-01/logProfiles_API.json#L39 |
|
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles' Location: Microsoft.Insights/stable/2016-03-01/logProfiles_API.json#L189 |
|
Resource provider naming must follow the pascal case. Path: '/{resourceUri}/providers/microsoft.insights/diagnosticSettings/{name}' Location: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json#L39 |
|
Resource provider naming must follow the pascal case. Path: '/{resourceUri}/providers/microsoft.insights/diagnosticSettings' Location: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json#L161 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2020-03 |
️️✔️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 succeeded [Detail]
- The following tags are being changed in this PR
- monitor/resource-manager/readme.md#package-2020-03
- monitor/resource-manager/readme.md#package-2019-11
- monitor/resource-manager/readme.md#package-2019-06
- monitor/resource-manager/readme.md#package-2019-03
- monitor/resource-manager/readme.md#package-2018-11-preview
- monitor/resource-manager/readme.md#package-2018-09
- monitor/resource-manager/readme.md#package-2018-03
- monitor/resource-manager/readme.md#package-2018-02-preview
- monitor/resource-manager/readme.md#package-2018-01-01-only
- monitor/resource-manager/readme.md#package-2017-12-01-preview-only
- monitor/resource-manager/readme.md#profile-hybrid-2019-03-01
- monitor/resource-manager/readme.md#profile-hybrid-2020-09-01
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2020-03",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2020-03",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:627", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:628", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:648", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:649", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:627", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:628", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:624", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:625", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:632", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:633", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"Error: Plugin prechecker reported failure." |
️️✔️[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
|
|
NewApiVersionRequired reason: |
26 tasks
This was referenced Jun 1, 2021
ToddKingMSFT
requested changes
Jun 1, 2021
...tor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json
Show resolved
Hide resolved
...or/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json
Outdated
Show resolved
Hide resolved
...or/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json
Outdated
Show resolved
Hide resolved
...tion/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json
Outdated
Show resolved
Hide resolved
ToddKingMSFT
approved these changes
Jun 8, 2021
This was referenced Jun 8, 2021
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
* Update swaggers for logs and metrics queries * Update version * add missing fields * include statistics * include statistics * statistics in log query result * Include metrics namespace param * Update title and client name * Include namespace param * Add namespace and region * Fix top and orderby query params * Fix linting errors * Update security to oauth2 * Remove logs query changes * Update 2018-01-01 version and revert 2017-05-01-preview
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Update swaggers for logs and metrics queries * Update version * add missing fields * include statistics * include statistics * statistics in log query result * Include metrics namespace param * Update title and client name * Include namespace param * Add namespace and region * Fix top and orderby query params * Fix linting errors * Update security to oauth2 * Remove logs query changes * Update 2018-01-01 version and revert 2017-05-01-preview
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
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.