Skip to content

Conversation

@LarryZhang19
Copy link
Contributor

@LarryZhang19 LarryZhang19 commented Feb 6, 2018

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

  • 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

@msftclas
Copy link

msftclas commented Feb 6, 2018

CLA assistant check
All CLA requirements met.

@AutorestCI
Copy link

AutorestCI commented Feb 6, 2018

Automation for azure-sdk-for-python

A 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:
Azure/azure-sdk-for-python#1931

@AutorestCI
Copy link

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: profileBuilder -s preview -name preview
Finished with return code 127
and output:

/bin/sh: 1: profileBuilder: not found

@LarryZhang19
Copy link
Contributor Author

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.

@LarryZhang19
Copy link
Contributor Author

Please do not merge this PR until Feb 20th.

@AutorestCI
Copy link

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: profileBuilder -s preview -name preview
Finished with return code 127
and output:

/bin/sh: 1: profileBuilder: not found

@azuresdkciprbot
Copy link

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: specification/monitor/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

tag: package-2018-02
```
### Tag: package-2018-02
Copy link
Contributor

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?

Copy link
Contributor Author

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.

Copy link
Contributor

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)

Copy link
Contributor Author

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": {
Copy link
Contributor

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

Copy link
Contributor Author

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": {
Copy link
Contributor

@mcardosos mcardosos Feb 7, 2018

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)

Copy link
Contributor

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)

Copy link
Contributor Author

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": {
Copy link
Contributor

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?

Copy link
Contributor Author

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": {
Copy link
Contributor

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

Copy link
Contributor Author

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": {
Copy link
Contributor

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?

Copy link
Contributor Author

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": [
Copy link
Contributor

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

Copy link
Contributor Author

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": {
Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Client

@AutorestCI
Copy link

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: profileBuilder -s preview -name preview
Finished with return code 127
and output:

/bin/sh: 1: profileBuilder: not found

@azuresdkciprbot
Copy link

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: specification/monitor/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

Copy link
Contributor

@mcardosos mcardosos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! :D

@mcardosos mcardosos changed the title Adding 2018-01-01 version for metrics API [DO NOT MERGE, until feb 20] Adding 2018-01-01 version for metrics API Feb 8, 2018
@mcardosos
Copy link
Contributor

Ping Larry on february 20

@lmazuel
Copy link
Member

lmazuel commented Feb 16, 2018

@AutorestCI rebuild azure-sdk-for-python

@AutorestCI
Copy link

AutorestCI commented Feb 16, 2018

Automation for azure-sdk-for-go

Encountered a Subprocess error: (azure-sdk-for-go)

Command: profileBuilder -s list -l ./profiles/2017-03-09/defintion.txt -name 2017-03-09
Finished with return code 127
and output:

/bin/sh: 1: profileBuilder: not found

@lmazuel
Copy link
Member

lmazuel commented Feb 17, 2018

@AutorestCI rebuild azure-sdk-for-python

@mcardosos
Copy link
Contributor

@LarryZhang19
There are errors on model validation, PTAL

@mcardosos
Copy link
Contributor

Copy link
Contributor

@mcardosos mcardosos left a 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

@mcardosos mcardosos merged commit d10a7a1 into Azure:master Feb 20, 2018
AlitzelMendez added a commit to AlitzelMendez/azure-rest-api-specs that referenced this pull request Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants