Skip to content
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.

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

Add DatabaseVulnerabilityAssessments swagger #3275

Merged
merged 9 commits into from
Jul 27, 2018
Merged

Add DatabaseVulnerabilityAssessments swagger #3275

merged 9 commits into from
Jul 27, 2018

Conversation

ggildin
Copy link
Contributor

@ggildin ggildin commented Jun 20, 2018

The put api is updated.
A new parameter is added to its body properties storageAccountAccessKey.
storageContainerSasKey isn't required anymore, but the user must to specified one of the following parameters:
storageContainerSasKey
or
storageAccountAccessKey

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

The put api is updated.
A new parameter is added to its body properties storageAccountAccessKey.
storageContainerSasKey isn't required anymore, but the user must to specified one of the following parameters:
storageContainerSasKey
or
storageAccountAccessKey
@AutorestCI
Copy link

AutorestCI commented Jun 20, 2018

Automation for azure-sdk-for-python

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

@AutorestCI
Copy link

AutorestCI commented Jun 20, 2018

Automation for azure-sdk-for-java

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

@AutorestCI
Copy link

AutorestCI commented Jun 20, 2018

Automation for azure-sdk-for-ruby

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

@AutorestCI
Copy link

AutorestCI commented Jun 20, 2018

Automation for azure-sdk-for-go

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

Command: dep ensure
Finished with return code 1
and output:

grouped write of manifest, lock and vendor: error while writing out vendor tree: failed to write dep tree: failed to export golang.org/x/text: failed to fetch source for https://go.googlesource.com/text: unable to get repository: Cloning into '/tmp/tmpdvcqqc9a/pkg/dep/sources/https---go.googlesource.com-text'...
fatal: unable to access 'https://go.googlesource.com/text/': Failed to connect to go.googlesource.com port 443: Connection timed out
: command failed: [git clone --recursive -v --progress https://go.googlesource.com/text /tmp/tmpdvcqqc9a/pkg/dep/sources/https---go.googlesource.com-text]: exit status 128

@AutorestCI
Copy link

AutorestCI commented Jun 20, 2018

Automation for azure-sdk-for-node

A PR has been created for you:
Azure/azure-sdk-for-node#3081

@jaredmoo
Copy link
Contributor

Please look at travis CI failures

@jaredmoo
Copy link
Contributor

Are api-versions other than 2017-10 affected?

@lmazuel lmazuel added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 20, 2018
@ggildin
Copy link
Contributor Author

ggildin commented Jun 21, 2018

Hi.

  1. I took a look on CI failures and fixed them.
  2. Since it only add an optional (exclusive or) parameter, we don't think that a new api version is required. It doesn't break any user

@lmazuel
Copy link
Member

lmazuel commented Jun 21, 2018

@ggildin @jaredmoo The new file isn't plugged into any tags, is this on purpose?

@jaredmoo
Copy link
Contributor

Let me rephrase my question. Here you are adding api-version 2017-10, but does api-version 2017-03 or earlier also contain the change?

add storageContainerPath to properties as optional parameters
@ggildin
Copy link
Contributor Author

ggildin commented Jun 24, 2018

@yaakoviyun

@@ -261,12 +271,44 @@
}
}
},
"Resource": {
Copy link
Member

Choose a reason for hiding this comment

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

please remove

"DatabaseVulnerabilityAssessment": {
"description": "A database vulnerability assessment.",
"type": "object",
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
"$ref": "#/definitions/ProxyResource"
Copy link
Member

Choose a reason for hiding this comment

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

put

  •      "$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
    

]
},
"storageAccountAccessKey": {
"description": "Specifies the identifier key of the auditing storage account. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.",
"type": "string",
"x-ms-mutability": [
"create",
Copy link
Member

Choose a reason for hiding this comment

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

  •        "create",
    
  •        "update"?
    

The put api is updated.
A new parameter is added to its body properties storageAccountAccessKey.
storageContainerSasKey isn't required anymore, but the user must to specified one of the following parameters:
storageContainerSasKey
or
storageAccountAccessKey
@ggildin
Copy link
Contributor Author

ggildin commented Jun 24, 2018

Hi.

  1. I synced with @yaakoviyun, we don't want to exposed at frontend a new version of the api. So I removed the swagger file for 2017-10-01 versions. (The auth generated tool generated them).
  2. I updated the 2017-03-01 version files.
  3. After this changes no swagger file is added, so no tag updating is required.
  4. Regards Travis error - The failure is due to breaking change. Required field has been changed to be optional. As @jaredmoo and me talked in the CR, this is only a minor change and is acceptable.
    Do I have any way to exclude this failure? @ravbhatnagar and @lmazuel - What is your opinion?

@ravbhatnagar
Copy link
Contributor

Looks good.

@ravbhatnagar ravbhatnagar added 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 Jun 27, 2018
@jaredmoo
Copy link
Contributor

@ggildin
Copy link
Contributor Author

ggildin commented Jun 28, 2018

@jaredmoo - We talked on it. It due to moved one field to be optional.

clean databaseVulnerabilityAssessmentScans
@ggildin
Copy link
Contributor Author

ggildin commented Jul 24, 2018

Hi @ravbhatnagar and @jaredmoo - our API id deployed world wide. Could you merge this pull request?
Thanks

@jaredmoo
Copy link
Contributor

There is still model validation error: https://travis-ci.org/Azure/azure-rest-api-specs/jobs/397699547

@ggildin
Copy link
Contributor Author

ggildin commented Jul 25, 2018

fixed

@lmazuel
Copy link
Member

lmazuel commented Jul 25, 2018

@jaredmoo That's a preview Swagger, signed-of by ARM, and changes look good me. Once you think it's done, let me know and I merge the Pr.
Thanks!

@lmazuel lmazuel merged commit 1a1da8d into Azure:master Jul 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

6 participants