-
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
Publish public preview swagger spec for "Azure metrics Ingestion REST API" #3856
Conversation
Automation for azure-sdk-for-rubyThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-pythonThe initial PR has been merged into your service PR: |
Can one of the admins verify this patch? |
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.
Missing README.md file, see here for an example.
specification/monitor/data-plane/preview/2018-09-01-preview.json
Outdated
Show resolved
Hide resolved
specification/monitor/data-plane/preview/2018-09-01-preview.json
Outdated
Show resolved
Hide resolved
specification/monitor/data-plane/preview/2018-09-01-preview.json
Outdated
Show resolved
Hide resolved
- 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
output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-monitor | ||
``` | ||
|
||
# Validation |
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.
I'm guessing this Validation section is a result of copy/paste? If so you can remove it (lines 149+).
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.
Thats correct. Dropping it.
Automation for azure-sdk-for-nodeNothing to generate for azure-sdk-for-node |
Automation for azure-sdk-for-goThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-javaThe initial PR has been merged into your service PR: |
output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2018-03-01/insights | ||
``` | ||
|
||
## Python |
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.
@lmazuel can you please review the config section for python?
output-folder: $(python-sdks-folder)/azure-mgmt-monitor | ||
``` | ||
|
||
## Java |
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.
@jianghaolu can you please review the config section for Java?
``` yaml $(go) | ||
go: | ||
license-header: MICROSOFT_APACHE_NO_VERSION | ||
namespace: insights |
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.
If the package directory is going to be monitor
then this namespace will need to match it.
…sible names instead
``` yaml $(python) && $(python-mode) == 'create' | ||
python: | ||
basic-setup-py: true | ||
output-folder: $(python-sdks-folder)/azure-monitor/azure/dataplane/monitor |
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.
output-folder: $(python-sdks-folder)/azure-monitor/
...ion/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json
Outdated
Show resolved
Hide resolved
...ion/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json
Outdated
Show resolved
Hide resolved
- Fix the readme.md naming incompatibilities - Remove the c#-ish namespace prefix
...ion/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json
Outdated
Show resolved
Hide resolved
...ion/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json
Outdated
Show resolved
Hide resolved
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
-Update path and namespace for Java section
There are multiple enum types named |
…imple object type instead. This should make the swagger spec clean and more easily maintainable in the long run
Down to just two errors in the model validation regarding the example, see the log. |
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
api-version
in the path should match theapi-version
in the spec).Quality of Swagger