[Hub Generated] Review request for Microsoft.Insights to add version stable/2018-01-01 #14716
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
Fix lint errors, adopt the standard error response object, fix inconsistencies between swagger and real service flagged by S360
Add error case to example
Fix lint errors
Add lint suppression for errors in the common types file
Update swagger to reflect what is actually being returned by the service as flagged by S360
|
Hi, @ToddKingMSFT 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 |
|---|---|
|
The new version has a new property 'errorMessage' in response that was not found in the old version. New: Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json#L301:7 Old: Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json#L301:7 |
️🔄LintDiff inProgress [Detail]
️⚠️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: 7 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
- monitor/resource-manager/readme.md#package-2021-04-only
- monitor/resource-manager/readme.md#package-2021-02-preview-only
- monitor/resource-manager/readme.md#package-2020-10-only
- monitor/resource-manager/readme.md#package-2020-05-preview-only
- monitor/resource-manager/readme.md#package-2020-01-01-preview-only
- monitor/resource-manager/readme.md#package-2020-03
- monitor/resource-manager/readme.md#package-2019-11
- monitor/resource-manager/readme.md#package-2019-10-17-preview-only
- monitor/resource-manager/readme.md#package-2019-07-only
- 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-2017-12
- monitor/resource-manager/readme.md#package-2017-09
- monitor/resource-manager/readme.md#package-2017-09-preview-only
- monitor/resource-manager/readme.md#package-2017-08
- monitor/resource-manager/readme.md#package-2019-11-01-preview-only
- monitor/resource-manager/readme.md#package-2019-06-01-only
- monitor/resource-manager/readme.md#package-2019-03-01-only
- monitor/resource-manager/readme.md#package-2018-11-27-preview-only
- monitor/resource-manager/readme.md#package-2018-09-01-only
- monitor/resource-manager/readme.md#package-2018-06-01-preview-only
- monitor/resource-manager/readme.md#package-2018-04-16-only
- monitor/resource-manager/readme.md#package-2018-03-01-only
- 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#package-2017-11-01-preview-only
- monitor/resource-manager/readme.md#package-2017-05-01-preview-only
- monitor/resource-manager/readme.md#package-2017-04-01-only
- monitor/resource-manager/readme.md#package-2017-03-01-preview-only
- monitor/resource-manager/readme.md#package-2016-09-01-only
- monitor/resource-manager/readme.md#package-2016-06-only
- monitor/resource-manager/readme.md#package-2016-03-01-only
- monitor/resource-manager/readme.md#package-2015-07-01-only
- monitor/resource-manager/readme.md#package-2015-04-01-only
- monitor/resource-manager/readme.md#profile-hybrid-2019-03-01
- monitor/resource-manager/readme.md#profile-hybrid-2020-09-01
| Rule | Message |
|---|---|
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:629", "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:630", "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":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:650", "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:651", "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":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:629", "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:630", "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":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:626", "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:627", "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":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:634", "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:635", "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-09", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:634", "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:635", "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-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:630", "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:631", "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." |
| 💬 AutorestCore/Exception | "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-04-only", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-04-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":"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":"Error: Plugin prechecker reported failure." |
|
"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":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-09", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-03", "details":"Error: Plugin prechecker reported failure." |
| 💬 AutorestCore/Exception | "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-04-only", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-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.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
This was referenced Jun 8, 2021
Add example of partial error case
|
Hi @ToddKingMSFT, 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. |
Add example for metric definitions for metricClass
Add metricClass field
Switch back to the same error response format used by the rest of Azure Monitor
Switch back to the same error response format used by the rest of Azure Monitor
This was referenced Jun 10, 2021
Update suppressions
Add type object to LocalizableString to match the LocalizableString in metrics
Reverting change to baseline API, there are a number of other problems with this swagger that I can't fix.
Add suppression for MissingTypeObject on LocalizableString due to collision
Removing the explicit type specification from LocalizableString so it continues to match other APIs
Removing the explicit type specification from LocalizableString so it continues to match other APIs
Fix formatting problems
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Jun 17, 2021
|
@ToddKingMSFT let me know when you need it merged. |
|
@weidongxu-microsoft Can you please merge this? |
This was referenced Jun 21, 2021
Closed
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
…stable/2018-01-01 (Azure#14716) * Update metrics_API.json Fix lint errors, adopt the standard error response object, fix inconsistencies between swagger and real service flagged by S360 * Update GetMetricDefinitions.json Add error case to example * Update metricDefinitions_API.json Fix lint errors * Update readme.md Add lint suppression for errors in the common types file * Update metrics_API.json Update swagger to reflect what is actually being returned by the service as flagged by S360 * Create GetMetricError.json Add example of partial error case * Create GetMetricDefinitionsMetricClass.json Add example for metric definitions for metricClass * Update metricDefinitions_API.json Add metricClass field * Update metricDefinitions_API.json Switch back to the same error response format used by the rest of Azure Monitor * Update metrics_API.json Switch back to the same error response format used by the rest of Azure Monitor * Update readme.md Update suppressions * Update baseline_API.json Add type object to LocalizableString to match the LocalizableString in metrics * Update baseline_API.json Reverting change to baseline API, there are a number of other problems with this swagger that I can't fix. * Update readme.md Add suppression for MissingTypeObject on LocalizableString due to collision * Update metricDefinitions_API.json Removing the explicit type specification from LocalizableString so it continues to match other APIs * Update metrics_API.json Removing the explicit type specification from LocalizableString so it continues to match other APIs * Update GetMetricDefinitionsMetricClass.json Fix formatting problems
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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.