Publish public preview swagger spec for "Azure metrics Ingestion REST API" by vickyv51 · Pull Request #3856 · Azure/azure-rest-api-specs

vickyv51 · 2018-09-10T19:29:17Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

[Done] The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

msftclas · 2018-09-10T19:29:28Z

All CLA requirements met.

AutorestCI · 2018-09-10T19:29:44Z

Automation for azure-sdk-for-ruby

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-ruby#1643

AutorestCI · 2018-09-10T19:31:05Z

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#3345

azuresdkci · 2018-09-10T19:35:29Z

Can one of the admins verify this patch?

jhendrixMSFT

Missing README.md file, see here for an example.

specification/monitor/data-plane/preview/2018-09-01-preview.json

- Use a shorter operationId - Remove any non-success response code with default response clause - Add a new example and reference it in the swagger spec - Include readme.md file for the swagger spec

- Inline the readme.python.md file in the readme.md

jhendrixMSFT · 2018-09-10T23:24:55Z

specification/monitor/data-plane/readme.md

+output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-monitor
+```
+
+# Validation


I'm guessing this Validation section is a result of copy/paste? If so you can remove it (lines 149+).

Thats correct. Dropping it.

AutorestCI · 2018-09-11T00:54:34Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

AutorestCI · 2018-09-11T01:00:13Z

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#2694

AutorestCI · 2018-09-11T02:56:37Z

Automation for azure-sdk-for-java

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-java#2392

specification/monitor/data-plane/readme.md

jhendrixMSFT · 2018-09-11T19:11:09Z

specification/monitor/data-plane/readme.md

+output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2018-03-01/insights
+```
+
+## Python


@lmazuel can you please review the config section for python?

jhendrixMSFT · 2018-09-11T19:12:25Z

specification/monitor/data-plane/readme.md

+  output-folder: $(python-sdks-folder)/azure-mgmt-monitor
+```
+
+## Java


@jianghaolu can you please review the config section for Java?

specification/monitor/data-plane/readme.md

jhendrixMSFT · 2018-09-11T19:41:37Z

specification/monitor/data-plane/readme.md

+``` yaml $(go)
+go:
+  license-header: MICROSOFT_APACHE_NO_VERSION
+  namespace: insights


If the package directory is going to be monitor then this namespace will need to match it.

…sible names instead

specification/monitor/data-plane/readme.md

lmazuel · 2018-09-11T20:12:45Z

specification/monitor/data-plane/readme.md

+``` yaml $(python) && $(python-mode) == 'create'
+python:
+  basic-setup-py: true
+  output-folder: $(python-sdks-folder)/azure-monitor/azure/dataplane/monitor


output-folder: $(python-sdks-folder)/azure-monitor/

...ion/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json

- Fix the readme.md naming incompatibilities - Remove the c#-ish namespace prefix

...ion/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json

jhendrixMSFT · 2018-09-12T16:30:27Z

Please take a look at the linter errors and model validation failures.

-Rename bunch of properties to follow camel case naming -Update the enum types to have the "x-ms-enum" part of the json

specification/monitor/data-plane/readme.md

-Update path and namespace for Java section

jhendrixMSFT · 2018-09-13T17:05:56Z

There are multiple enum types named attributes that have different sets of values which is not allowed, see this build log. Either they all need to have the same set of values (which in that case just define it once and reference it) or their names need to be different.
Also you can run some of these validation tools locally, see https://github.com/Azure/oav for details.

…imple object type instead. This should make the swagger spec clean and more easily maintainable in the long run

jhendrixMSFT · 2018-09-13T19:14:21Z

Down to just two errors in the model validation regarding the example, see the log.

…meters.

-Publish "Azure metrics REST Ingestion API" public preview swagger spec

dbe6e9d

vickyv51 changed the title ~~Publish "Azure metrics REST Ingestion API" public preview swagger spec~~ Publish "Azure metrics Ingestion REST API" public preview swagger spec Sep 10, 2018

vickyv51 changed the title ~~Publish "Azure metrics Ingestion REST API" public preview swagger spec~~ Publish public preview swagger spec for "Azure metrics Ingestion REST API" Sep 10, 2018

azuresdkci assigned jhendrixMSFT Sep 10, 2018

azuresdkci requested a review from jhendrixMSFT September 10, 2018 19:40

jhendrixMSFT requested changes Sep 10, 2018

View reviewed changes

jhendrixMSFT reviewed Sep 10, 2018

View reviewed changes

specification/monitor/data-plane/preview/2018-09-01-preview.json Outdated Show resolved Hide resolved

jhendrixMSFT reviewed Sep 10, 2018

View reviewed changes

specification/monitor/data-plane/preview/2018-09-01-preview.json Outdated Show resolved Hide resolved

jhendrixMSFT reviewed Sep 10, 2018

View reviewed changes

specification/monitor/data-plane/preview/2018-09-01-preview.json Outdated Show resolved Hide resolved

vickyv51 added 2 commits September 10, 2018 15:33

Address review comments

25acd4f

- Use a shorter operationId - Remove any non-success response code with default response clause - Add a new example and reference it in the swagger spec - Include readme.md file for the swagger spec

Fix a bug in readme.md.

47b3f99

- Inline the readme.python.md file in the readme.md

jhendrixMSFT reviewed Sep 10, 2018

View reviewed changes

-Remove validation section that is not necessary

922f781

jhendrixMSFT reviewed Sep 11, 2018

View reviewed changes