New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add swagger for ACE provisioning GSM sevice, the related APIs can be used for ManagementPartner management #2285

Merged

jianghaolu merged 12 commits into Azure:master from jeffrey-ACE-zz:current

Jan 25, 2018

Contributor

jeffrey-ACE-zz commented Jan 18, 2018 •

edited by azuresdkci

Loading

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.

jeffrey-ace added 7 commits

December 14, 2017 13:55


          add new specification for ACE provisioning GSM, add the GetPartner ap…

b0d879a

…i first, will add another 3 api later


          fix the description and data format for gsm swagger

b178363


          update gsm samples

0f754fa


          add more operations and samples for gsm

27fd1b5


          Fix syntax error

5be13e3


          Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

608d9de

…into current


          Cannot have multiple operations with the same operationId, so update …

c798eeb

…the second Partner_Get to PartnerNoId_Get

azuresdkci assigned marstr

marstr changed the base branch from current to master

January 18, 2018 21:32

marstr added the Reassign label

Member

marstr commented Jan 18, 2018

I've updated the target branch to conform to the policy changes that were made in late December 2017.

Other than that, I need to reassign this to load balance a little.

azuresdkci removed the Reassign label

azuresdkci assigned jianghaolu and unassigned marstr

Contributor

jianghaolu commented Jan 19, 2018

@jeffrey-ace While I'm reviewing, please note that we introduced stable and preview sub-folders here: https://github.com/Azure/azure-rest-api-specs#news. Please move your changes into the corresponding sub-folder.

The review will be published soon.

jianghaolu added the WaitForARMFeedback label

jeffrey-ace added 2 commits

January 19, 2018 15:03


          add preview sub folder

aedb00d


          Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

fe89f0d

…into current

Contributor Author

jeffrey-ACE-zz commented Jan 19, 2018

Added preview sub folder. thank you

jeffrey-ACE-zz closed this

jeffrey-ACE-zz reopened this

jianghaolu suggested changes

View reviewed changes

specification/gsm/resource-manager/readme.md Outdated

+              ``` yaml $(tag) == 'package-2018-02'
+              input-file:
+              - Microsoft.ManagementPartner\2018-02-01\gsm.json

Contributor

jianghaolu Jan 19, 2018

Please use forward slashes.

Contributor Author

jeffrey-ACE-zz Jan 20, 2018

Fixed, thank you

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                    "put": {
+                      "summary": "Add a specific `Partner`.",
+                      "description": "Add a management partner for the objectId and tenantId.",
+                      "operationId": "Partner_Put",

Contributor

jianghaolu Jan 19, 2018

Rename this to "CreateOrUpdate" to keep it consistent.

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                      }
+                    }
+                  },
+                  "ManagementPartnerState": {

Contributor

jianghaolu Jan 19, 2018

Please add "description".

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                      }
+                    }
+                  },
+                  "PartnerProperties": {

Contributor

jianghaolu Jan 19, 2018

Please add "description".

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                      "Deleted"
+                    ]
+                  },
+                  "ErrorResponseCode": {

Contributor

jianghaolu Jan 19, 2018

Please add "description" for the type.

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                  "OperationList": {
+                    "type": "object",
+                    "properties": {
+                      "value": {

Contributor

jianghaolu Jan 19, 2018

Please add "description".

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                  },
+                  "OperationResponse": {
+                    "type": "object",
+                    "properties": {

Contributor

jianghaolu Jan 19, 2018

Please add "description" for all the properties.

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                  },
+                  "OperationDisplay": {
+                    "type": "object",
+                    "properties": {

Contributor

jianghaolu Jan 19, 2018

Please add "description" for all properties.

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                  },
+                  "PartnerProperties": {
+                    "type": "object",
+                    "properties": {

Contributor

jianghaolu Jan 19, 2018

Please provide more useful descriptions for the properties.

specification/gsm/resource-manager/Microsoft.ManagementPartner/2018-02-01/gsm.json Outdated

+                      "operationId": "PartnerNoId_Get",
+                      "x-ms-examples": {
+                        "GetPartnerDetails": {
+                          "$ref": "./examples/GetPartnerDetails.json"

Contributor

jianghaolu Jan 19, 2018

This example is not valid for this operation - "partnerId" is not a parameter here.

Contributor

jianghaolu commented Jan 19, 2018

The reviews are collapsed - "show outdated" button should show my comments. Thanks!

AutorestCI commented Jan 19, 2018

Was unable to find SDK Azure/azure-sdk-for-python PR for this closed PR.

AutorestCI mentioned this pull request

Automatic PR of restapi_auto_jeffrey-ACE_current into master Azure/azure-sdk-for-python#1808

Closed


          add descriptions for all the properties, updated samples and other fix

dd31206

Contributor Author

jeffrey-ACE-zz commented Jan 22, 2018

@jianghaolu, thanks for you review, fixed all your comments, can you please take a look?

Contributor

ravbhatnagar commented Jan 23, 2018

@jeffrey-ace - is this a new RP? Apologies but I dont understand the scenarios and so will not be able to do a meaningful review from ARM side. Please set up a skype call and include folks from Azure API review board - @NiklasGustafsson @johanste @david justice.

Contributor Author

jeffrey-ACE-zz commented Jan 23, 2018

@ravbhatnagar we already had a skype meeting with Simon Davies, can you please sync with him or add him as a reviewer too?

Contributor

jianghaolu commented Jan 23, 2018

Hi @jeffrey-ace After fixing the forward slash CI is able to report more issues. I'll be publishing them in a moment.

jianghaolu suggested changes

View reviewed changes

...r/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetails-NoPartnerId.json Outdated

+                        "partnerId": "123456",
+                        "tenantId": "1b1121dd-6900-412a-af73-e8d44f81e1c1",
+                        "objectId": "aa67f786-0552-423e-8849-244ed12bf581",
+                        "version": 3,

Contributor

jianghaolu Jan 23, 2018

Version is defined as a string - same in other examples..

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json Outdated

+                    "put": {
+                      "summary": "Create a specific `Partner`.",
+                      "description": "Create a management partner for the objectId and tenantId.",
+                      "operationId": "Partner_Put",

Contributor

jianghaolu Jan 23, 2018

The name should be "Create" or "CreateOrUpdate", in 1st case "Patch" should also be named "Update"

Contributor Author

jeffrey-ACE-zz Jan 23, 2018

Sorry, what should be changed to "Create",
Partner_Put should be changed to Parnter_Create?

Contributor

jianghaolu Jan 23, 2018

Yes - sorry for the confusion

Contributor Author

jeffrey-ACE-zz Jan 23, 2018

thanks, will update

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json

+                    "description": "this is the management partner operations response",
+                    "x-ms-azure-resource": true,
+                    "properties": {
+                      "etag": {

Contributor

jianghaolu Jan 23, 2018

Description missing.

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json

+                    "type": "object",
+                    "description": "this is the management partner operations error",
+                    "properties": {
+                      "error": {

Contributor

jianghaolu Jan 23, 2018

Description missing.

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json

+                    "type": "object",
+                    "description": "this is the extended error info",
+                    "properties": {
+                      "code": {

Contributor

jianghaolu Jan 23, 2018

Description still missing for "error" and "message"

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json

+                    "type": "object",
+                    "description": "this is the management partner operations list",
+                    "properties": {
+                      "value": {

Contributor

jianghaolu Jan 23, 2018

Description missing.

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json

+                  "OperationResponse": {
+                    "type": "object",
+                    "description": "this is the management partner operations response",
+                    "properties": {

Contributor

jianghaolu Jan 23, 2018

Descriptions are still missing for these properties.

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json

+                  "OperationDisplay": {
+                    "description": "this is the management partner operation",
+                    "type": "object",
+                    "properties": {

Contributor

jianghaolu Jan 23, 2018

Description still missing for these properties.

Contributor Author

jeffrey-ACE-zz Jan 23, 2018

@jianghaolu fixed all the issues, can you please help check


          Add more descriptions and fix operation names

6ac1208

jianghaolu approved these changes

View reviewed changes

jianghaolu requested a review from simongdavies

January 24, 2018 19:56

simongdavies reviewed

View reviewed changes

specification/gsm/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/gsm.json Outdated

+                    }
+                  },
+                  "/providers/Microsoft.ManagementPartner/partners": {
+                    "get": {

Member

simongdavies Jan 25, 2018

Why are there 2 gets for partner one with and without the id? In the case of the one without the partner Id why is this not a list?

Contributor Author

jeffrey-ACE-zz Jan 25, 2018

@simongdavies you are right, we only need one get operation, the partner is optional. Delete the one without partner id. Can you please approve


          Remove the get operation without partner id

100c5ba

simongdavies approved these changes

View reviewed changes

simongdavies added ARMSignedOff and removed WaitForARMFeedback labels

jeffrey-ACE-zz closed this

AutorestCI commented Jan 25, 2018

Was unable to find SDK Azure/azure-sdk-for-go PR for this closed PR.

AutorestCI commented Jan 25, 2018

Was unable to find SDK Azure/azure-sdk-for-python PR for this closed PR.

azuresdkciprbot commented Jan 25, 2018

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/gsm/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.

jeffrey-ACE-zz reopened this

azuresdkciprbot commented Jan 25, 2018

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/gsm/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.

jeffrey-ACE-zz mentioned this pull request

Add new sdk for ACE provisioning GSM, the sdk can be used to do partner management Azure/azure-sdk-for-net#4019

Merged

9 tasks

Contributor Author

jeffrey-ACE-zz commented Jan 25, 2018

Code review is approved, can you please help merge?

jianghaolu merged commit 679502c into Azure:master

AutorestCI commented Jan 25, 2018

This commit was treated and no generation was made for Python

AutorestCI commented Jan 25, 2018

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

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/github_tools.py", line 28, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 180, in rest_handle_action
    return rest_pull_close(body, github_con, restapi_repo, sdk_pr_target_repo, sdkbase)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 306, in rest_pull_close
    rest_pr.create_issue_comment("Was unable to create SDK %s PR for this closed PR.", sdkid)
TypeError: create_issue_comment() takes 2 positional arguments but 3 were given

AutorestCI commented Jan 25, 2018

This commit was treated and no generation was made for Python

AutorestCI commented Jan 25, 2018

Swagger to SDK encountered an error: (Azure/azure-sdk-for-python)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/github_tools.py", line 28, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 180, in rest_handle_action
    return rest_pull_close(body, github_con, restapi_repo, sdk_pr_target_repo, sdkbase)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 306, in rest_pull_close
    rest_pr.create_issue_comment("Was unable to create SDK %s PR for this closed PR.", sdkid)
TypeError: create_issue_comment() takes 2 positional arguments but 3 were given

AutorestCI commented Jan 25, 2018

No modification for AutorestCI/azure-sdk-for-ruby

AutorestCI commented Jan 25, 2018

No modification for AutorestCI/azure-sdk-for-python

1 similar comment

AutorestCI commented Jan 25, 2018

No modification for AutorestCI/azure-sdk-for-python

AutorestCI commented Jan 25, 2018

No modification for AutorestCI/azure-sdk-for-ruby

jeffrey-ACE-zz mentioned this pull request

Add managementpartner sdk Azure/azure-sdk-for-python#1899

Merged

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

Labels