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.

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

Improve API documentation and add DeviceSecurityGroups to stable API #7047

Merged
merged 39 commits into from
Sep 9, 2019
Merged

Improve API documentation and add DeviceSecurityGroups to stable API #7047

merged 39 commits into from
Sep 9, 2019

Conversation

hagba
Copy link
Contributor

@hagba hagba commented Aug 27, 2019 •
edited
Loading

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
Copy link

openapi-sdkautomation bot commented Aug 27, 2019 •
edited
Loading

In Testing, Please Ignore

[Logs] (Generated from e5b2100, Iteration 34)

Failed .NET: test-repo-billy/azure-sdk-for-net [Logs] [Diff]
In-Progress Go: test-repo-billy/azure-sdk-for-go [Logs] [Diff]
  • In-Progress preview/security/mgmt/v1.0 [Logs]
  • In-Progress preview/security/mgmt/v2.0 [Logs]
  • In-Progress preview/security/mgmt/v3.0 [Logs]
Succeeded Python: test-repo-billy/azure-sdk-for-python [Logs] [Diff]
Failed JavaScript: test-repo-billy/azure-sdk-for-js [Logs] [Diff]

@azuresdkci azuresdkci requested a review from mmyyrroonn August 27, 2019 08:57
@AutorestCI AutorestCI mentioned this pull request Aug 27, 2019
Merged
@AutorestCI
Copy link

AutorestCI commented Aug 27, 2019 •
edited
Loading

Automation for azure-sdk-for-python

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

@AutorestCI AutorestCI mentioned this pull request Aug 27, 2019
Merged
@AutorestCI
Copy link

AutorestCI commented Aug 27, 2019 •
edited
Loading

Automation for azure-sdk-for-go

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

@mmyyrroonn mmyyrroonn added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 27, 2019
@mmyyrroonn
Copy link
Contributor

@hagba Hello. Please solve the conflicts first and then it will trigger CI.

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Aug 27, 2019
Merged
hagba and others added 8 commits August 27, 2019 20:18
@hagba
Copy link
Contributor Author

hagba commented Sep 3, 2019 via email

KrisBash
KrisBash suggested changes Sep 4, 2019
View reviewed changes
Copy link
Contributor

@KrisBash KrisBash left a comment

Choose a reason for hiding this comment

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

A few minor comments. Thanks

...ion/security/resource-manager/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json
}
}
},
"/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName}": {
Copy link
Contributor

Choose a reason for hiding this comment

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

If this extension resource only extends IOT hub resources, a more explicit path can be specified rather than '/{resourceId}'.

...ion/security/resource-manager/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json
"readOnly": true,
"description": "The description of the custom alert."
},
"isEnabled": {
Copy link
Contributor

Choose a reason for hiding this comment

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

For all 'isEnabled' booleans: a string enum (with modelAsString=true) is a more futureproof way to achieve the same. That is, if you define this as 'state: (enabled|disabled)' you can more easily add tertiary states in the future without a breaking type change. It's worth considering whether you will ever have other states.

@KrisBash KrisBash added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 4, 2019
KrisBash
KrisBash approved these changes Sep 6, 2019
View reviewed changes
Copy link
Contributor

@KrisBash KrisBash left a comment

Choose a reason for hiding this comment

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

Comments are non-blocking. Will sign off

@KrisBash KrisBash added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 6, 2019
@mmyyrroonn
Copy link
Contributor

@raych1 Hello. Please help confirm this suppression. e5b2100

@mmyyrroonn
Copy link
Contributor

@raych1 Thanks for help.

@mmyyrroonn mmyyrroonn merged commit 3aa66e4 into Azure:master Sep 9, 2019
@hagba
Copy link
Contributor Author

hagba commented Sep 9, 2019 via email

@amiramit amiramit mentioned this pull request Sep 19, 2019
Merged
isra-fel pushed a commit to Azure/azure-sdk-for-net that referenced this pull request Sep 20, 2019
@amiramit @isra-fel
Azure Security Center - Added support for IoT security endpoints (#7623)
802dfb7 
ink to the spec review PR: Azure/azure-rest-api-specs#7047
leniatgh pushed a commit to leniatgh/azure-rest-api-specs that referenced this pull request May 13, 2022
@qinqingxu
Qinqiang add new attributes (Azure#7047)
0592682 
* Add new attribute for the resource

* Align the format for the same property

* Fix the issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nschonni nschonni nschonni left review comments

@KrisBash KrisBash KrisBash approved these changes

@mmyyrroonn mmyyrroonn mmyyrroonn approved these changes

Assignees

@mmyyrroonn mmyyrroonn

Labels
ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@hagba @AutorestCI @mmyyrroonn @azuresdkci @nschonni @KrisBash @raych1