Update swagger for Azure Monitor logs query by srnagar · Pull Request #14514 · Azure/azure-rest-api-specs

srnagar · 2021-05-21T10:14:58Z

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.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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.
- Adding new API(s)
- Adding a new API version
- 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.
- Adding a new service
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.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

openapi-workflow-bot · 2021-05-21T10:14:59Z

Hi, @srnagar Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-workflow-bot · 2021-05-21T10:15:00Z

[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.

openapi-pipeline-app · 2021-05-21T10:15:02Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 2 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- operationalinsights/data-plane/readme.md tag:20210519
Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- operationalinsights/data-plane/readme.md tag:default

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2018 - XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Property name: path Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L1351
⚠️ R2018 - XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Property name: method Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L1357

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L591
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L678
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L768
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L907
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L991

️️✔️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: 1 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2021-05-19_Preview/OperationalInsights.json compared with base:stable/v1/OperationalInsights.json

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one 'string'. New: Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#L368:13 Old: Microsoft.OperationalInsights/stable/v1/OperationalInsights.json#L306:13

️️✔️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

operationalinsights/data-plane/readme.md#20210519

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ Modeler/MissingType	"readme":"operationalinsights/data-plane/readme.md", "tag":"20210519", "details":"The schema 'metadataResource' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json#/components/schemas/metadataResource"
💬 AutorestCore/Exception	"readme":"operationalinsights/data-plane/readme.md", "tag":"20210519", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
💬 AutorestCore/Exception	"readme":"operationalinsights/data-plane/readme.md", "tag":"20210519", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"
💬 AutorestCore/Exception	"readme":"operationalinsights/data-plane/readme.md", "tag":"20210519", "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).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-05-21T10:15:03Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-python-track2 - track2_azure-mgmt-monitor - 2.0.0

️✔️azure-sdk-for-go - operationalinsights/v1/operationalinsights - v55.3.0

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 2737ef8. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️operationalinsights/v1/operationalinsights [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️❌ azure-sdk-for-python failed [Detail]

❌Failed [Logs]Release - Generate from 2737ef8. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmdout	[automation_generate.sh] [Autorest]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!Error happened during package
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

️❌ azure-sdk-for-js failed [Detail]

❌Failed [Logs]Release - Generate from 2737ef8. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/operationalinsights/data-plane/readme.md

❌@azure/loganalytics [View full logs] [Release SDK Changes]

error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/operationalinsights/loganalytics]: npm pack --silent

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-05-21T22:06:30Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

akning-ms · 2021-06-01T06:16:25Z

Hi @srnagar , can you split your PR into 2? one for ARM, one for dataplane. as we have different PR reviewer for them

srnagar · 2021-06-01T06:57:07Z

@akning-ms I have created a separate PR for ARM changes - #14609

srnagar · 2021-06-01T20:16:32Z

Pipelines stuck in queued status. Closing and re-opening the PR to trigger the pipelines.

...data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json

pakrym · 2021-06-02T23:16:20Z

...data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json

+        },
+        "type": {
+          "description": "The data type of this column.",
+          "$ref": "#/definitions/ColumnDataType"


Is the type optional?

pakrym · 2021-06-02T23:16:31Z

...data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json

+      "properties": {
+        "name": {
+          "description": "The name of this column.",
+          "type": "string"


Is the name optional?

It shouldn't be but all the previous versions of the swagger didn't declared this field as required, so, didn't make it more restrictive than the previous versions.

Can we clarify this? It would have API/functional consequences for libraries.

...data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json

* 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 * Revert metrics changes * Update path * add batch sample * Update query body * Address PR comments * Add error info for single query response * Include batch example * update batch results * rendering response as object * Update row value type to object * update security definition to oauth2

srnagar added 2 commits May 21, 2021 02:55

Update swaggers for logs and metrics queries

7daed1d

Update version

b3bfaff

openapi-assignment-bot bot assigned akning-ms May 21, 2021

openapi-pipeline-app bot added CI-BreakingChange-Python-Track2 CI-BreakingChange-Go labels May 21, 2021

add missing fields

94ac050

srnagar requested review from ToddKingMSFT and pdrayton May 21, 2021 20:04

srnagar added 2 commits May 21, 2021 14:12

include statistics

8a6b14c

include statistics

80cf358

openapi-pipeline-app bot added the NewApiVersionRequired label May 21, 2021

statistics in log query result

fe671b0

srnagar requested a review from jamlai May 21, 2021 23:02

srnagar added 5 commits May 23, 2021 22:31

Include metrics namespace param

a8bbcbb

Update title and client name

73d0a27

Include namespace param

2c3281c

Add namespace and region

1edabc6

Fix top and orderby query params

0b0838b

srnagar requested a review from pakrym May 25, 2021 17:14

Revert metrics changes

e0aac6f

srnagar changed the title ~~Update swaggers for logs and metrics queries~~ Update swagger for Azure Monitor logs query Jun 1, 2021

srnagar closed this Jun 1, 2021

srnagar reopened this Jun 1, 2021

srnagar added 3 commits June 2, 2021 11:48

Update path

ef469d0

add batch sample

2b97b8a

Update query body

a40aabf