specs changes for azure databox ga #3885

sojain · 2018-09-12T16:12:17Z

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

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

Currently raised against preview, once signed off will move it to stable

AutorestCI · 2018-09-12T16:12:43Z

Automation for azure-sdk-for-python

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

AutorestCI · 2018-09-12T16:16:03Z

Automation for azure-sdk-for-ruby

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

AutorestCI · 2018-09-12T16:18:30Z

Automation for azure-sdk-for-java

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

Command: bundle install && rake arm:regen_all_profiles['azure_mgmt_databox']
Finished with return code 10
and output:

Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Could not locate Gemfile

AutorestCI · 2018-09-12T16:18:30Z

Automation for azure-sdk-for-node

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

AutorestCI · 2018-09-12T16:19:51Z

Automation for azure-sdk-for-go

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

azuresdkci · 2018-09-12T16:36:50Z

Can one of the admins verify this patch?

anuchandy

in general modelAsString:false has extensibility constrain, i.e. if service introduce a new value for the enum in the same api-version then SDKs can break. If we are not anticipating any new values in the current api-version then we are good here otherwise keep modelAsString:false. (for the discriminator specific enums you can keep modelAsString:false).

specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json

anuchandy · 2018-09-12T22:57:57Z

@ravbhatnagar please take a look, this is preview feature additions. Also need your input on linked access refer this.

anuchandy · 2018-09-12T23:00:51Z

@sojain between you will need to update your readme file to have tags, like below:

DataBox

see https://aka.ms/autorest

This is the AutoRest configuration file for DataBox.

Getting Started

To build the SDK for DataBox, simply Install AutoRest and in this folder, run:

autorest

To see additional help and options, run:

autorest --help

Configuration

Basic Information

These are the global settings for the DataBox API.

openapi-type: arm
tag: package-2018-01

Tag: package-2018-01

These settings apply only when --tag=package-2018-01 is specified on the command line.

input-file:
- Microsoft.DataBox\preview\2018-01-01\databox.json

Suppression

directive:
  - suppress:
    - R2016 #to suppress (PatchBodyParametersSchema/R2016/RPCViolation)
    - R2062 #to suppress (XmsResourceInPutResponse/R2062/RPCViolation)

Code Generation

Swagger to SDK

This section describes what SDK should be generated by the automatic system.
This is not used by Autorest itself.

swagger-to-sdk:
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-node

C#

These settings apply only when --csharp is specified on the command line.
Please also specify --csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>.

csharp:
  azure-arm: true
  license-header: MICROSOFT_MIT_NO_VERSION
  namespace: Microsoft.Azure.Management.DataBox
  output-folder: $(csharp-sdks-folder)/DataBox/Management.DataBox/Generated
  clear-output-folder: true

Go

These settings apply only when --go is specified on the command line.

go:
  license-header: MICROSOFT_APACHE_NO_VERSION
  namespace: databox
  clear-output-folder: true

Go multi-api

batch:
  - tag: package-2018-01

Tag: package-2018-01 and go

Please also specify --go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>.

output-folder: $(go-sdk-folder)/services/preview/databox/mgmt/2018-01-01/databox

Java

These settings apply only when --java is specified on the command line.
Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>.

java:
  azure-arm: true
  fluent: true
  namespace: com.microsoft.azure.management.databox
  license-header: MICROSOFT_MIT_NO_CODEGEN
  payload-flattening-threshold: 1
  output-folder: $(azure-libraries-for-java-folder)/databox

Java multi-api

batch:
  - tag: package-2018-01

Tag: package-2018-05 and java

These settings apply only when --tag=package-2018-01 --java is specified on the command line.
Please also specify --azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>.

java:
  namespace: com.microsoft.azure.management.databox.v2018_01_01
  output-folder: $(azure-libraries-for-java-folder)/databox/resource-manager/v2018_01_01
regenerate-manager: true
generate-interface: true

specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json

KrisBash

Even though this is a preview version, these changes need to correspond to a new API version to avoid breaking customers. Some of these deleted POST apis are actively being used, and a deprecation plan is advised.

1) Removing unnecessary fields 2) Correctly populating modelasstring as modelasextensible 3) adding descriptions for enum

sojain · 2018-09-14T10:44:01Z

@anuchandy , i have taken most of the comments and also the readme update, however post that build is not working, can you help me in finding the root cause

Looks like there was a space issue, fixed it

2) Moving to stable folder

anuchandy · 2018-09-17T14:32:13Z

@sojain I've created readme file for databox here https://raw.githubusercontent.com/anuchandy/sample-readme/master/readme.md which includes settings for all languages. Can you try this?

anuchandy · 2018-09-17T16:10:38Z

@sojain you also need sdks for all languages right? the readme contains entries for C# and Go only. The link i shared contains entries for all languages.

sojain · 2018-09-17T16:29:33Z

@anuchandy , thanks for sharing this.

This failed with
Command: bundle install && rake arm:regen_all_profiles['azure_mgmt_databox']
Finished with return code 10
and output:
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Could not locate Gemfile

It works if I remove bundle command, any suggestions. Also just fo rmy knowledge did you some tool to generate the readme.md

anuchandy · 2018-09-17T16:57:42Z

@lmazuel the readme's swagger-to-sdk section looks like below:

swagger-to-sdk:
  - repo: azure-sdk-for-python
  - repo: azure-sdk-for-node
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-ruby
  - repo: azure-sdk-for-java
    after_scripts:
      - bundle install && rake arm:regen_all_profiles['azure_mgmt_databox']

The command bundle install && rake arm:regen_all_profiles['azure_mgmt_databox'] to generate the ruby sdk is failing with error

Command: bundle install && rake arm:regen_all_profiles['azure_mgmt_databox']
Finished with return code 10
and output:
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Could not locate Gemfile

Talked to @sarangan12 about this, he mentioned that this command shouldn't be run as a root user. Can you take a look and help here?

anuchandy · 2018-09-17T16:58:32Z

@sojain i manually author the readme, it's not generated.

sarangan12 · 2018-09-17T17:07:25Z

@anuchandy The error is expected. It is not because of the root user. The azure_mgmt_databox is a new gem which does not have a skeleton structure. So, it is failing. You can ignore this error

sojain · 2018-09-18T00:09:43Z

thanks @anuchandy for all the help, who can help me in closing this pull request given I have arm signoff

anuchandy · 2018-09-18T14:55:28Z

@sojain - is this api-version deployed to at least one production region? if yes, we're good to merge. let me know.

sojain · 2018-09-18T15:36:40Z

@anuchandy yes api version is deployed to all regions

sojain · 2018-09-19T00:07:29Z

@anuchandy, sorry to bother, but can you please help in completing this pull request, we have GA at ignite on 24th and hence the urgency

AutorestCI · 2018-09-19T01:27:47Z

Automation for azure-sdk-for-js

Nothing to generate for azure-sdk-for-js

specs changes for azure databox ga

49931f3

This was referenced Sep 12, 2018

[AutoPR databox/resource-manager] specs changes for azure databox ga Azure/azure-sdk-for-node#3588

Merged

[AutoPR databox/resource-manager] specs changes for azure databox ga Azure/azure-sdk-for-go#2680

Closed

azuresdkci assigned anuchandy Sep 12, 2018

azuresdkci requested a review from anuchandy September 12, 2018 16:35

anuchandy added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 12, 2018

anuchandy requested a review from ravbhatnagar September 12, 2018 22:22

anuchandy reviewed Sep 12, 2018

View reviewed changes

KrisBash added the ARMReviewInProgress label Sep 13, 2018

KrisBash reviewed Sep 13, 2018

View reviewed changes

specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json Show resolved Hide resolved

KrisBash suggested changes Sep 13, 2018

View reviewed changes

soumya-jain19 added 2 commits September 14, 2018 12:44

code review comments

c6e3d82

1) Removing unnecessary fields 2) Correctly populating modelasstring as modelasextensible 3) adding descriptions for enum

fixes to readme.md and readme.nodejs.md

347a832

1) Fixing readme.md for build

3651144

2) Moving to stable folder

updating readme to include sdk for all languages

080d60a

This was referenced Sep 17, 2018

[AutoPR databox/resource-manager] specs changes for azure databox ga Azure/azure-sdk-for-python#3360

Merged

[AutoPR databox/resource-manager] specs changes for azure databox ga Azure/azure-sdk-for-ruby#1647

Merged

KrisBash approved these changes Sep 17, 2018

View reviewed changes

KrisBash added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMReviewInProgress WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 17, 2018

anuchandy mentioned this pull request Sep 17, 2018

Ruby job for new RPs in azure-rest-api-specs repo fails Azure/azure-sdk-for-ruby#1648

Closed

Addition of optional list of sku names for filter while getting skuinfo

7f97382

AutorestCI mentioned this pull request Sep 18, 2018

[AutoPR databox/resource-manager] specs changes for azure databox ga Azure/azure-sdk-for-go#2724

Merged

anuchandy approved these changes Sep 19, 2018

View reviewed changes

anuchandy merged commit be799c3 into Azure:master Sep 19, 2018

sojain mentioned this pull request Sep 19, 2018

GA SDK for azure databox Azure/azure-sdk-for-net#4774

Merged

9 tasks

specs changes for azure databox ga #3885

specs changes for azure databox ga #3885

Uh oh!

Conversation

sojain commented Sep 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

AutorestCI commented Sep 12, 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 Sep 12, 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 Sep 12, 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!

AutorestCI commented Sep 12, 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!

AutorestCI commented Sep 12, 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 Sep 12, 2018

Uh oh!

anuchandy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anuchandy commented Sep 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anuchandy commented Sep 12, 2018

DataBox

Getting Started

Configuration

Basic Information

Tag: package-2018-01

Suppression

Code Generation

Swagger to SDK

C#

Go

Go multi-api

Tag: package-2018-01 and go

Java

Java multi-api

Tag: package-2018-05 and java

Uh oh!

Uh oh!

KrisBash left a comment

Choose a reason for hiding this comment

Uh oh!

sojain commented Sep 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anuchandy commented Sep 17, 2018

Uh oh!

anuchandy commented Sep 17, 2018

Uh oh!

sojain commented Sep 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anuchandy commented Sep 17, 2018

Uh oh!

anuchandy commented Sep 17, 2018

Uh oh!

sarangan12 commented Sep 17, 2018

Uh oh!

sojain commented Sep 12, 2018 •

edited

Loading

AutorestCI commented Sep 12, 2018 •

edited

Loading

AutorestCI commented Sep 12, 2018 •

edited

Loading

AutorestCI commented Sep 12, 2018 •

edited

Loading

AutorestCI commented Sep 12, 2018 •

edited

Loading

AutorestCI commented Sep 12, 2018 •

edited

Loading

anuchandy commented Sep 12, 2018 •

edited

Loading

sojain commented Sep 14, 2018 •

edited

Loading

sojain commented Sep 17, 2018 •

edited

Loading

AutorestCI commented Sep 19, 2018 •

edited

Loading