-
Notifications
You must be signed in to change notification settings - Fork 5.6k
[DO NOT MERGE, until feb 20] Adding 2018-01-01 version for metrics API #2435
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
Conversation
Automation for azure-sdk-for-pythonA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)
Command: profileBuilder -s preview -name preview /bin/sh: 1: profileBuilder: not found |
|
I am seeing a error in one of the test, but it seems it failed in trying to install npm. And not related to my change. |
|
Please do not merge this PR until Feb 20th. |
Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)
Command: profileBuilder -s preview -name preview /bin/sh: 1: profileBuilder: not found |
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
| tag: package-2018-02 | ||
| ``` | ||
| ### Tag: package-2018-02 | ||
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.
Since there are both stable and preview swaggers, should this package be a preview?
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.
What this package mean, is it the SDK? if so, it should remain preview.
Please do not merge after your signoff, since the GA date for the api is not til Feb 20th. That's when we would like the swagger spec to be published.
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.
Yes, I have seen the publish date :) Thanks for adding this info from the very beginning, actually :D
The tag will become an SDK tag, yes, but if it includes preview APIs (I assume preview APIs might change anytime), the best would be to mark it as a preview package/tag.
In reply to: 166483608 [](ancestors = 166483608)
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.
resolved
| "schema": { | ||
| "$ref": "#/definitions/Response" | ||
| }, | ||
| "examples": { |
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.
examples [](start = 13, length = 8)
It is preferred that examples are only provided in the x-ms-examples section
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.
fixed
| "x-ms-parameter-location": "method", | ||
| "x-ms-skip-url-encoding": true | ||
| }, | ||
| "MetricNamespaceParameter": { |
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.
MetricNamespaceParameter [](start = 2, length = 24)
Is it expected to generate this parameter as a method or a client parameter? (My guess is it is expected to be a method parameter)
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 it is expected to be part of the method, please add "x-ms-parameter-location": "method"
In reply to: 166487297 [](ancestors = 166487297)
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.
After consult with team member, will leave this as Client
| "type": "string", | ||
| "description": "The namespace of the metrics been queried" | ||
| }, | ||
| "resourceregion": { |
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.
resourceregion [](start = 9, length = 14)
Should this be resourceRegion?
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.
It should be resourceregion
| } | ||
| } | ||
| }, | ||
| "definitions": { |
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.
definitions [](start = 3, length = 11)
Please add "type": "object" to the definitions that are type objects
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.
Talked to colleague who helped publish the preview swagger and SDK, at this point, we should not change these types as previous version has already been published this way. And for the change I am making in this version, only include one optional parameter: metricnamespace, which should be string type.
| "TimeSeriesElement": { | ||
| "type": "object", | ||
| "properties": { | ||
| "metadatavalues": { |
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.
metadatavalues [](start = 9, length = 14)
metadataValues?
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.
should be metadatavalues
| ], | ||
| "operationId": "Metrics_List", | ||
| "description": "**Lists the metric values for a resource**.", | ||
| "parameters": [ |
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.
parameters [](start = 9, length = 10)
Since there are many parameters, x-ms-parameter-grouping could help gen better looking code
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.
Same reason as the type one, we can not change this at this point as previous version is already using this style, changing it now will confuse existing customers
| "type": "string", | ||
| "description": "Client Api Version." | ||
| }, | ||
| "MetricNamespaceParameter": { |
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.
MetricNamespaceParameter [](start = 2, length = 24)
Is this parameter meant for the client or the method?
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.
Client
Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)
Command: profileBuilder -s preview -name preview /bin/sh: 1: profileBuilder: not found |
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
mcardosos
left a comment
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.
Awesome! :D
|
Ping Larry on february 20 |
|
@AutorestCI rebuild azure-sdk-for-python |
…, it's just a typo of the names.
Automation for azure-sdk-for-goEncountered a Subprocess error: (azure-sdk-for-go)
Command: profileBuilder -s list -l ./profiles/2017-03-09/defintion.txt -name 2017-03-09 /bin/sh: 1: profileBuilder: not found |
|
@AutorestCI rebuild azure-sdk-for-python |
|
@LarryZhang19 |
mcardosos
left a comment
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.
Everything green again :D
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-versionin the path should match theapi-versionin the spec).Quality of Swagger