Skip to content

Conversation

@parisa-naeimi
Copy link
Contributor

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

@AutorestCI
Copy link

AutorestCI commented Oct 3, 2018

Automation for azure-sdk-for-js

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

@AutorestCI
Copy link

AutorestCI commented Oct 3, 2018

Automation for azure-sdk-for-python

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

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@AutorestCI
Copy link

AutorestCI commented Oct 3, 2018

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

@AutorestCI
Copy link

AutorestCI commented Oct 3, 2018

Automation for azure-sdk-for-ruby

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-ruby#1684

@AutorestCI
Copy link

AutorestCI commented Oct 3, 2018

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

@AutorestCI
Copy link

AutorestCI commented Oct 3, 2018

Automation for azure-sdk-for-go

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

@annatisch annatisch added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 3, 2018
@annatisch
Copy link
Member

Adding @ravbhatnagar for ARM feedback.

@annatisch
Copy link
Member

ping @ravbhatnagar

Copy link
Contributor

@ravbhatnagar ravbhatnagar left a comment

Choose a reason for hiding this comment

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

Looks good. Signing off from ARM.

"type": "string"
}
},
"excludedSubscriptions": {
Copy link
Contributor

Choose a reason for hiding this comment

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

What are the excluded subscriptions based on?

Copy link
Contributor

Choose a reason for hiding this comment

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

Checked with Parisa, currently the feature is only supported for EA subs. The excluded subs will show the subs part of management group which are non-EA

@ravbhatnagar ravbhatnagar added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 10, 2018
@annatisch
Copy link
Member

@parisa-naeimi - could you please update the readme tags to include the new API version?

@parisa-naeimi
Copy link
Contributor Author

@annatisch Could you please let me know what do you mean by updating readme tags? do you mean I need to update readme.md under resource-manager and if so, do I need to do it manually?

@annatisch
Copy link
Member

Thanks @parisa-naeimi - yes that's correct:
https://github.com/Azure/azure-rest-api-specs/blob/eceb8b730d20aef8f2602b0e65215685c5648cd3/specification/consumption/resource-manager/readme.md

You can create a new "Tag: package-2018-10" with the path to your new API file.
You can then update the "tag" field under "Basic Information" to your latest version.

In addition to above, each "multi API" SDK will need a specific tag setup:

@parisa-naeimi
Copy link
Contributor Author

@annatisch Thank you very much for providing information. I updated read me tags, please let me know if I need to revisit something.

@annatisch
Copy link
Member

Thanks @parisa-naeimi - could you please update them for all languages (or at least - every language for which you have a published SDK)? :)

@parisa-naeimi
Copy link
Contributor Author

@annatisch I think I already have added the version to readme files. I do not know what are you referring here or at least let me know what I am missing here.

@annatisch
Copy link
Member

Thanks @parisa-naeimi - In commit 81df0a1, you have only added a tag for the Java multi-api SDK.
You will need to add additional tags, the update the tags which are used for generation.

So first, add a generic tag at the top of the file, like these ones:
https://github.com/Azure/azure-rest-api-specs/blob/81df0a1f83f74c8afe11331ce788cca62d754569/specification/consumption/resource-manager/readme.md#tag-package-2017-11

Next, update the tag used for standard code gen in the Basic Information at the top here:
https://github.com/Azure/azure-rest-api-specs/blob/81df0a1f83f74c8afe11331ce788cca62d754569/specification/consumption/resource-manager/readme.md#basic-information

Finally, in the same way that you just added a "tag and java", you will need to add a "tag and go" and tag and ruby" sections as well.

Then you will need to list those new tags under each language - for example here in java:
https://github.com/Azure/azure-rest-api-specs/blob/81df0a1f83f74c8afe11331ce788cca62d754569/specification/consumption/resource-manager/readme.md#basic-information

I hope this helps... indeed it is a bit complicated.
In future, you can submit new API version specs using the OpenAPI portal - this will automatically handle all the readme tags for you :)

@parisa-naeimi
Copy link
Contributor Author

@annatisch thank you very much. I think I missed those areas in my first commit. I got it now and updated the readme file. Please let me know if it is good now.

@annatisch
Copy link
Member

Thanks @parisa-naeimi! The changes look good - but it looks like there is a conflict, could you rebase against master?

# Conflicts:
#	specification/consumption/resource-manager/readme.md
@parisa-naeimi
Copy link
Contributor Author

@annatisch I got the latest from master branch and resolved conflict. I think we are good now. Please let me know if I need to do something in my side. Thank you very much :)

Copy link
Member

@annatisch annatisch left a comment

Choose a reason for hiding this comment

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

Just a couple of tiny things then it's good to go :)

{
"swagger": "2.0",
"info": {
"version": "2018-08-31",
Copy link
Member

Choose a reason for hiding this comment

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

Please update the version tag to "2018-10-01"

}
},
"x-ms-pageable": {
"nextLinkNa
Copy link
Member

Choose a reason for hiding this comment

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

Please make "subscriptionGuids" two words: "subscription GUIDs"

}
},
"x-ms-pageable": {
"nextLinkNa
Copy link
Member

Choose a reason for hiding this comment

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

Please make "subscriptionGuids" two words: "subscription GUIDs"

@parisa-naeimi
Copy link
Contributor Author

@annatisch Hello, thank you for the feedback, I applied all of them. Please let me know if I need to update it again.

@annatisch
Copy link
Member

Thanks @parisa-naeimi -
Just one last comment - I see on line 4302 that the API version parameter description includes the version - I would remove the 2nd sentence here, so we don't forget to update it for future API verisons.

"description": "Version of the API to be used with the client request. The current version is 2018-08-31."

@parisa-naeimi
Copy link
Contributor Author

@annatisch I kept it as it is just updated the version. Thanks for catching it.

@annatisch annatisch merged commit 8f39551 into Azure:master Oct 15, 2018
@parisa-naeimi
Copy link
Contributor Author

@annatisch Hello Again, you merged these changes 4 days ago but I do not know I cannot see the new version of consumption and also my recent changes. Any suggestion here?

@annatisch
Copy link
Member

@parisa-naeimi - I'm not sure I understand - your changes have been merged here:
https://github.com/Azure/azure-rest-api-specs/tree/master/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01

Or did you mean your changes in each specific language SDK?

@parisa-naeimi
Copy link
Contributor Author

When I go to this link for consumption rp https://docs.microsoft.com/en-us/rest/api/consumption/ I supposed to see the latest version which is 2018-10-01 but I still see the previous version which is 2018-08-31. It does not seem right?

@annatisch
Copy link
Member

I don't think the updated API docs are automatic.
Please reach out to the docs team for further info:
https://github.com/Azure/adx-documentation-pr

@parisa-naeimi
Copy link
Contributor Author

@annatisch I have done this before and always after merge I used to see update automatically.

@annatisch
Copy link
Member

I do not know how API docs are generated from swagger specs - please reach out to the docs team.

@parisa-naeimi
Copy link
Contributor Author

@annatisch looks like I need to reach out to them since it is a version change. Thank you for the help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants