Reorganized sql readme.md and extracted Java section to a separate file. #4892

hovsepm · 2018-12-11T18:28:38Z

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

openapi-portal-comment · 2018-12-11T18:28:40Z

If you're a MSFT employee, click this link
to view this PR's validation status on our new OpenAPI Hub spec management tool.

AutorestCI · 2018-12-11T18:30:24Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

AutorestCI · 2018-12-11T18:30:24Z

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

AutorestCI · 2018-12-11T18:31:29Z

Automation for azure-sdk-for-js

Nothing to generate for azure-sdk-for-js

AutorestCI · 2018-12-11T18:33:29Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

azuresdkci · 2018-12-11T18:34:38Z

Can one of the admins verify this patch?

AutorestCI · 2018-12-11T18:35:48Z

Automation for azure-sdk-for-java

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

hovsepm · 2018-12-11T18:42:03Z

@sarangan12 please hold off merge until @jianghaolu and @jaredmoo sign-off.

AutorestCI · 2018-12-11T18:50:45Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

jaredmoo · 2018-12-11T20:39:33Z

It looks like you're doing multi-version, is that right? In that case I think you should use the package-pure-* tags. The purpose of package-composite is to have only 1 version of each api, but multi-version allows you to use all versions of each api.

hovsepm · 2018-12-11T21:00:21Z

@jaredmoo The idea is to generate multi-api java client based on SQL composite v3 tag. In the existing readme.md there are already package-pure-* tags sections that contain (in some cases) more swagger documents than composite v3. e.g. Tag: package-pure-2014-04 contains 29 swaggers while composite v3 tag uses only 15. Is there any reason why v3 does not include the rest? If non - I can definitely remove new tags and just use existing -pure- tags.

jaredmoo · 2018-12-11T21:07:19Z

package-composite-v3 does not contain all documents because .NET doesn't support multi-version, so we only pick the latest of each API. This is why it doesn't have all 2014 documents for example, because many of those APIs now have later versions that package-composite chooses instead.

…e.md

hovsepm · 2018-12-12T04:37:21Z

@jaredmoo thanks for explanation. I've reworked the PR and now java multi-version uses -pure- tags. Please take a look.

openapi-portal-comment · 2018-12-12T05:26:51Z

If you're a MSFT employee, click this link
to view this PR's validation status on our new OpenAPI Hub spec management tool.

…3-preview

jaredmoo · 2018-12-12T06:59:34Z

specification/sql/resource-manager/readme.java.md

+
+APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end.
+
+These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-03-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }`


Please explain in tag description how it is different from other tags :) What was the problem with dataWarehouseUserActivities.json ?

@jaredmoo investigating :) for some reason it is hitting autorest exception - https://github.com/Azure/azure-rest-api-specs/runs/40229948 . I'm trying to isolate the error. Error message does not make sense :(

@jaredmoo ok I found the issue. The problem is that in 2017-03-01-preview\dataWarehouseUserActivities.json operationIds are named as dataWarehouseUserActivities and there is actually model definition which contain model with the name dataWarehouseUserActivities and that creates generation collision. Fortunately for java multi-api generation I can add a directive to rename dataWarehouseUserActivities type to dataWarehouseUserActivity and get everything generated.

@jaredmoo I think that model should be renamed inside swagger. Why is it in plural form? it does not seems to contain any array or lists of objects.

Ok, adding directive sounds awesome so that we don't need to add a new tag.

The reason it's plural is that it represents the aggregate status of recent activities, not just a single activity per resource. This collision is unfortunate, we could have renamed it on initial checkin if we knew about this problem :( but I want to maintain backcompat.

jaredmoo

Thank you!

jaredmoo · 2018-12-12T20:25:45Z

specification/sql/resource-manager/readme.java.md

+### Tag: package-pure-2017-03-preview and java
+
+These settings apply only when `--tag=package-pure-2017-03-preview --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.


Comment about directive would be nice for future readers to understand the context.

…le. (Azure#4892) * Reorganized sql readme.md and extracted Java section to a separate file. * Addressed review feedback by using -pure- version tags from the readme.md * fixed couple of typos. * Removed DataWarehouseUserActivities file from tag package-pure-2017-03-preview * Fixed autorest error on model generation

Reorganized sql readme.md and extracted Java section to a separate file.

7adce01

hovsepm requested review from jaredmoo and jianghaolu December 11, 2018 18:28

kpajdzik added the review label Dec 11, 2018

AutorestCI mentioned this pull request Dec 11, 2018

[AutoPR sql/resource-manager] Reorganized sql readme.md and extracted Java section to a separate file. Azure/azure-sdk-for-java#2768

Merged

azuresdkci assigned sarangan12 Dec 11, 2018

azuresdkci requested a review from sarangan12 December 11, 2018 18:40

Addressed review feedback by using -pure- version tags from the readm…

93f2764

…e.md

fixed couple of typos.

b2d751b

hovsepm closed this Dec 12, 2018

hovsepm reopened this Dec 12, 2018

kpajdzik added review and removed review labels Dec 12, 2018

Removed DataWarehouseUserActivities file from tag package-pure-2017-0…

4b4b9ee

…3-preview

jaredmoo reviewed Dec 12, 2018

View reviewed changes

Fixed autorest error on model generation

fc25ee2

jaredmoo approved these changes Dec 12, 2018

View reviewed changes

hovsepm removed the request for review from sarangan12 December 12, 2018 22:21

hovsepm assigned hovsepm and unassigned sarangan12 Dec 12, 2018

hovsepm requested review from anuchandy and jianghaolu and removed request for jianghaolu December 12, 2018 22:22

anuchandy approved these changes Dec 12, 2018

View reviewed changes

hovsepm merged commit 9abb96f into Azure:master Dec 12, 2018

kpajdzik removed the review label Dec 12, 2018


		APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end.

		These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-03-01-preview\ -File \| Resolve-Path -Relative \| % { " - $_".Replace("\", "/") }`

Reorganized sql readme.md and extracted Java section to a separate file. #4892

Reorganized sql readme.md and extracted Java section to a separate file. #4892

Uh oh!

Conversation

hovsepm commented Dec 11, 2018

Latest improvements:

Contribution checklist:

ARM API Review Checklist

Uh oh!

openapi-portal-comment bot commented Dec 11, 2018

Uh oh!

AutorestCI commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-ruby

Uh oh!

AutorestCI commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-js

Uh oh!

AutorestCI commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

azuresdkci commented Dec 11, 2018

Uh oh!

AutorestCI commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-java

Uh oh!

hovsepm commented Dec 11, 2018

Uh oh!

AutorestCI commented Dec 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

jaredmoo commented Dec 11, 2018

Uh oh!

hovsepm commented Dec 11, 2018

Uh oh!

jaredmoo commented Dec 11, 2018

Uh oh!

hovsepm commented Dec 12, 2018

Uh oh!

openapi-portal-comment bot commented Dec 12, 2018

Uh oh!

jaredmoo Dec 12, 2018

Choose a reason for hiding this comment

Uh oh!

hovsepm Dec 12, 2018

Choose a reason for hiding this comment

Uh oh!

hovsepm Dec 12, 2018

Choose a reason for hiding this comment

Uh oh!

jaredmoo Dec 12, 2018

Choose a reason for hiding this comment

Uh oh!

jaredmoo left a comment

Choose a reason for hiding this comment

Uh oh!

jaredmoo Dec 12, 2018

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

AutorestCI commented Dec 11, 2018 •

edited

Loading

AutorestCI commented Dec 11, 2018 •

edited

Loading

AutorestCI commented Dec 11, 2018 •

edited

Loading

AutorestCI commented Dec 11, 2018 •

edited

Loading

AutorestCI commented Dec 11, 2018 •

edited

Loading

AutorestCI commented Dec 11, 2018 •

edited

Loading