Azure stack deployment resource provider admin open api specification #7561

viananth · 2019-10-21T18:52:34Z

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-sdkautomation · 2019-10-21T18:52:38Z

In Testing, Please Ignore

[Logs] (Generated from 710a9c7, Iteration 6)

No readme.md specification configuration files were found that are associated with the files modified in this pull request.

azuresdkci · 2019-10-21T19:32:44Z

Can one of the admins verify this patch?

AutorestCI · 2019-10-21T20:43:19Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

lirenhe · 2019-10-22T02:09:29Z

@viananth, please fix those code check errors in Avocado and ModelValidation.

lirenhe · 2019-10-24T02:11:41Z

@viananth, please fix those code check errors in Avocado and ModelValidation.

@lirenhe We are having an issue with representing JToken format. Could you please help how we should specify in the spec?
error : operationId: ActionPlanOperations_Get scenario: Gets the specified action plan operation source: response responseCode: '200' severity: 0 code: INVALID_TYPE details: code: INVALID_TYPE params: - string - object message: Expected type string but found type object path: properties/outputs title: '#/definitions/ActionPlanOperationAdminProperties/properties/outputs' description: The action plan operation outputs in JToken format position: line: 162 column: 20 url: >- specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json directives: {} jsonUrl: >- specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/ActionPlanOperations/Get.json jsonPath: $.properties.outputs

@viananth, I will take a look

lirenhe · 2019-10-24T02:25:41Z

@viananth, wrong click to remove your comments. Could you leave this issue for now and fix other problems first?

bganapa · 2019-10-24T04:07:23Z

@lirenhe I posted the question on Teams Channel....
Is there a precedence on how to specify JToken parameter in swagger object model?We have specified the type as string in for the JToken param. The Oav validate-example fails as the example is not matching to the defined type string while it is expecting object

lirenhe · 2019-10-24T06:44:27Z

@lirenhe I posted the question on Teams Channel....
Is there a precedence on how to specify JToken parameter in swagger object model?We have specified the type as string in for the JToken param. The Oav validate-example fails as the example is not matching to the defined type string while it is expecting object

@bganapa , thanks for sharing the detailed information, we will investigate this issue.

nickzhums · 2019-10-24T08:44:54Z

@lirenhe I posted the question on Teams Channel....
Is there a precedence on how to specify JToken parameter in swagger object model?We have specified the type as string in for the JToken param. The Oav validate-example fails as the example is not matching to the defined type string while it is expecting object

@bganapa I took a look at your issue, if you are asking how to specify the "type" of a JToken parameter, you can try using "object" instead of "string". Please refer to the following link:
Azure/oav#78
I modified your JToken parameters locally from "string" to "object" and it passed the validation. Let us know if it works and please comment if you have further questions.

AutorestCI · 2019-10-29T17:46:11Z

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

viananth · 2019-10-29T18:20:09Z

@lirenhe I have this avocado failure, where as it fails to resolve $(this-folder) for one json but resolves the same for other json files. I can't repro this on my local dev machine. Seems like an issue in the build. Could you pls take a look?

error: 

code: NO_JSON_FILE_FOUND

message: The JSON file is not found but it is referenced from the readme file.

readMeUrl: >-

  /home/vsts/work/1/c93b354fd9c14905bb574a8834c4d69b/specification/azsadmin/resource-manager/deployment/readme.md

level: Error

jsonUrl: >-

  /home/vsts/work/1/c93b354fd9c14905bb574a8834c4d69b/specification/azsadmin/resource-manager/deployment/$(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json

viananth · 2019-10-29T22:05:39Z

I fixed the Model validation errors and it doesn't repro on my dev machine. Not sure why CI is still complaining about it:

 error : 

operationId: FileContainers_Create

scenario: Creates a new product package.

source: response

responseCode: '200'

severity: 0

code: OBJECT_ADDITIONAL_PROPERTIES

details:

  code: OBJECT_ADDITIONAL_PROPERTIES

  params:

    - 'properties '

  message: 'Additional properties not allowed: properties '


  path: ''

  title: '#/definitions/FileContainer'

  description: File container entity.

  position:

    line: 163

    column: 26

  url: >-

    specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json

  directives: {}

  jsonPosition:

    line: 16

    column: 15

  jsonUrl: >-

    specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json

  jsonPath: ''

PhoenixHe-NV · 2019-10-30T06:28:24Z

/azp run

azure-pipelines · 2019-10-30T06:28:41Z

Azure Pipelines successfully started running 2 pipeline(s).

.../deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json

...esource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json

...resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json

lirenhe · 2019-11-01T06:08:05Z

I fixed the Model validation errors and it doesn't repro on my dev machine. Not sure why CI is still complaining about it:
error :

operationId: FileContainers_Create

scenario: Creates a new product package.

source: response

responseCode: '200'

severity: 0

code: OBJECT_ADDITIONAL_PROPERTIES

details:

code: OBJECT_ADDITIONAL_PROPERTIES

params:
- 'properties '
message: 'Additional properties not allowed: properties '

path: ''

title: '#/definitions/FileContainer'

description: File container entity.

position:
line: 163

column: 26
url: >-
specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json
directives: {}

jsonPosition:
line: 16

column: 15
jsonUrl: >-
specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json
jsonPath: ''

The model validation failed because you added additional space in the property name and value

ruowan · 2019-11-01T06:45:54Z

For avocado error, currently avocado don't support ${ths-folder} feature. So you can ignore avocado validation errors which contains '${this-folder}' path. I will update avocado to support the feature in next version.

...resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json

lirenhe · 2019-11-04T05:36:44Z

It would be good if you could also fix the code style issue reported by 'PrettierCheck'

viananth · 2019-11-04T22:23:57Z

It would be good if you could also fix the code style issue reported by 'PrettierCheck'

@lirenhe I fixed the prettier check issues, still the CI is reporting the same. I fixed all the examples as well.

D:\github\azure-rest-api-specs>prettier -c ./specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/*.*

Checking formatting...
All matched files use Prettier code style!

lirenhe · 2019-11-05T08:14:59Z

...in/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json

+        ],
+        "responses": {
+          "200": {
+            "description": "OK",


I think you need to add 'default' in each response, you could refer this as an example: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/DatabaseSchema.json

Prettier Check passed now. It was failing because I had to rebase from master.
@lirenhe Everything looks good now except the known avocado issue. We don't need the "default" value for each response. Could you please merge if it looks good otherwise? Thanks!

Fixes from PR build Fix action type for action plan operation Add response body for operations list example

Fix model validation errors Fix model validation errors. Fix model validation errors

lirenhe · 2019-11-06T04:39:41Z

@viananth, please wait for ARM team to signoff this PR then I could merge it.

bganapa · 2019-11-06T04:55:00Z

@lirenhe This is for AZURESTACK Admin API surface. This does not get deployed to azure. We have our internal AZURESTACK review process and it has already gone through that process.

These specs never go through ARM Team sign off. You can look at any PRs for changes under https://github.com/Azure/azure-rest-api-specs/tree/master/specification/azsadmin/resource-manager

lirenhe · 2019-11-06T07:33:45Z

@lirenhe This is for AZURESTACK Admin API surface. This does not get deployed to azure. We have our internal AZURESTACK review process and it has already gone through that process.
These specs never go through ARM Team sign off. You can look at any PRs for changes under https://github.com/Azure/azure-rest-api-specs/tree/master/specification/azsadmin/resource-manager

I checked your last PR #7591, it still requires ARM sign off. As you have this PR reviewed in your internal process, I will merge it.

bganapa · 2019-11-06T18:00:57Z

@lirenhe Thanks for pointing out the last PR. I am pinging the PR owner offline to loop us in.

viananth requested review from sarathys and bganapa October 21, 2019 18:52

azuresdkci assigned lirenhe Oct 21, 2019

azuresdkci requested a review from lirenhe October 21, 2019 18:54

lirenhe added Changes Required WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed Changes Required labels Oct 22, 2019

Azure deleted a comment from viananth Oct 24, 2019

lirenhe reviewed Nov 1, 2019

View reviewed changes

.../deployment/Microsoft.Deployment.Admin/preview/2019-01-01/examples/FileContainer/Create.json Outdated Show resolved Hide resolved

lirenhe reviewed Nov 1, 2019

View reviewed changes

...esource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json Show resolved Hide resolved

lirenhe reviewed Nov 1, 2019

View reviewed changes

...resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json Outdated Show resolved Hide resolved

ruowan mentioned this pull request Nov 1, 2019

support ${this-folder} feature Azure/avocado#50

Closed

lirenhe reviewed Nov 4, 2019

View reviewed changes

...resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json Outdated Show resolved Hide resolved

lirenhe removed the Changes Required label Nov 4, 2019

lirenhe reviewed Nov 5, 2019

View reviewed changes

viananth and others added 3 commits November 5, 2019 13:12

Azure stack deployment resource provider admin open api specification

8d6d1c4

Fixes from PR build Fix action type for action plan operation Add response body for operations list example

adding string type for etag

23e0acc

Fix model validation errors Fix model validation errors. Fix model validation errors

Prettier fix

28ed00d

viananth force-pushed the drpadmin2 branch from 8cb077e to 28ed00d Compare November 5, 2019 21:13

Prettier fix

2e41df7

lirenhe approved these changes Nov 6, 2019

View reviewed changes

bganapa approved these changes Nov 6, 2019

View reviewed changes

lirenhe removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 6, 2019

yungezz merged commit abf6236 into Azure:master Nov 6, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Azure stack deployment resource provider admin open api specification #7561

Azure stack deployment resource provider admin open api specification #7561

viananth commented Oct 21, 2019 •

edited by bganapa

Loading

openapi-sdkautomation bot commented Oct 21, 2019 •

edited

Loading

azuresdkci commented Oct 21, 2019

AutorestCI commented Oct 21, 2019 •

edited

Loading

lirenhe commented Oct 22, 2019

lirenhe commented Oct 24, 2019 •

edited

Loading

lirenhe commented Oct 24, 2019

bganapa commented Oct 24, 2019

lirenhe commented Oct 24, 2019

nickzhums commented Oct 24, 2019

AutorestCI commented Oct 29, 2019 •

edited

Loading

viananth commented Oct 29, 2019

viananth commented Oct 29, 2019

PhoenixHe-NV commented Oct 30, 2019

azure-pipelines bot commented Oct 30, 2019

lirenhe commented Nov 1, 2019

ruowan commented Nov 1, 2019 •

edited

Loading

lirenhe commented Nov 4, 2019

viananth commented Nov 4, 2019

lirenhe Nov 5, 2019

viananth Nov 5, 2019

lirenhe commented Nov 6, 2019

bganapa commented Nov 6, 2019

lirenhe commented Nov 6, 2019

bganapa commented Nov 6, 2019

Azure stack deployment resource provider admin open api specification #7561

Azure stack deployment resource provider admin open api specification #7561

Conversation

viananth commented Oct 21, 2019 • edited by bganapa Loading

Latest improvements:

Contribution checklist:

ARM API Review Checklist

openapi-sdkautomation bot commented Oct 21, 2019 • edited Loading

In Testing, Please Ignore

[Logs] (Generated from 710a9c7, Iteration 6)

azuresdkci commented Oct 21, 2019

AutorestCI commented Oct 21, 2019 • edited Loading

Automation for azure-sdk-for-go

lirenhe commented Oct 22, 2019

lirenhe commented Oct 24, 2019 • edited Loading

lirenhe commented Oct 24, 2019

bganapa commented Oct 24, 2019

lirenhe commented Oct 24, 2019

nickzhums commented Oct 24, 2019

AutorestCI commented Oct 29, 2019 • edited Loading

Automation for azure-sdk-for-python

viananth commented Oct 29, 2019

viananth commented Oct 29, 2019

PhoenixHe-NV commented Oct 30, 2019

azure-pipelines bot commented Oct 30, 2019

lirenhe commented Nov 1, 2019

ruowan commented Nov 1, 2019 • edited Loading

lirenhe commented Nov 4, 2019

viananth commented Nov 4, 2019

lirenhe Nov 5, 2019

Choose a reason for hiding this comment

viananth Nov 5, 2019

Choose a reason for hiding this comment

lirenhe commented Nov 6, 2019

bganapa commented Nov 6, 2019

lirenhe commented Nov 6, 2019

bganapa commented Nov 6, 2019

viananth commented Oct 21, 2019 •

edited by bganapa

Loading

openapi-sdkautomation bot commented Oct 21, 2019 •

edited

Loading

AutorestCI commented Oct 21, 2019 •

edited

Loading

lirenhe commented Oct 24, 2019 •

edited

Loading

AutorestCI commented Oct 29, 2019 •

edited

Loading

ruowan commented Nov 1, 2019 •

edited

Loading