Skip to content

Add suggested type name changes to iothub swagger #12296

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
Merged
merged 5 commits into from
May 27, 2020
Merged

Add suggested type name changes to iothub swagger #12296

merged 5 commits into from
May 27, 2020

Conversation

@timtay-microsoft
Copy link
Member

@timtay-microsoft timtay-microsoft commented May 26, 2020

These suggested name changes were hightlighted in onenote. I also included the name change around the CloudToDeviceMethod type which was not captured in that onenote but that we discussed in an API review

@timtay-microsoft
Copy link
Member Author

timtay-microsoft commented May 26, 2020

Note that this PR does not change the names of the fields expected in the swagger. It only changes the definition names. As such, this isn't a breaking change for the service as the http payloads are unaffected

bikamani
bikamani reviewed May 26, 2020
View reviewed changes
sdk/iot/Azure.Iot.Hub.Service/src/swagger/iothubservice_modified.json
},
"cloudToDeviceMethod": {
"$ref": "#/definitions/CloudToDeviceMethod",
"$ref": "#/definitions/CloudToDeviceMethodRequest",
Copy link
Contributor

@bikamani bikamani May 26, 2020

Choose a reason for hiding this comment

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

Where is the definition for CloudToDeviceMethodRequest?

Copy link
Member Author

@timtay-microsoft timtay-microsoft May 26, 2020

Choose a reason for hiding this comment

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

Looks like I missed changing it. I'll push the fix for that

@bikamani
Copy link
Contributor

bikamani commented May 26, 2020

These suggested name changes were hightlighted in onenote. I also included the name change around the CloudToDeviceMethod type which was not captured in that onenote but that we discussed in an API review

Few others to take a look at renaming would be:
JobProperties --> This is only used for for import export jobs v1
RegistryStatistics --> DeviceStatistics

@timtay-microsoft
Copy link
Member Author

timtay-microsoft commented May 26, 2020

@bikamani do you have a suggested rename for JobProperties?

@bikamani
Copy link
Contributor

bikamani commented May 26, 2020

JobProperties

ImportExportJobPropeties is one suggestion, could seem longer but clarifies what is it for.

@timtay-microsoft
Copy link
Member Author

timtay-microsoft commented May 26, 2020

JobProperties

ImportExportJobPropeties is one suggestion, could seem longer but clarifies what is it for.

I like it, since it clarifies that the properties aren't relevant to scheduled jobs. I can change it to this

@timtay-microsoft timtay-microsoft merged commit ec64b3e into feature/IoT-Hub May 27, 2020
@timtay-microsoft timtay-microsoft deleted the feature/iot/timtay/swaggerNameChanges branch May 27, 2020 17:37
vinagesh pushed a commit that referenced this pull request Jun 9, 2020
@timtay-microsoft @vinagesh
Add suggested type name changes to iothub swagger (#12296)
952359b
azabbasi added a commit that referenced this pull request Jun 29, 2020
@azabbasi @abhipsaMisra
@vinagesh @timtay-microsoft @bikamani
Merge IoT-Hub into master. (#13086)
99f68bc 
* feat(hub): Creating a new feature branch with swagger and generated files

* fix(doc): Fix markdown for API design doc (#11690)

* swagger(iothub): Adding overrides for type names (#12026)

* fix(tests): Fix project reference for the test framework (#12053)

* fix(hub): Fix property accessibility issue (#12055)

* Fix API categories for iothub service client (#12087)

* swagger(iothub): Swagger comment changes (#12149)

* fix(iot): Regenerate iothub PL after rebase from master

* refactor(iot): Remove unnecessary custom code

This class only existed to make the DigitalTwinClient internal, but now all generated clients are internal by default

* Swagger changes for Iot Hub (#12218)

* Revert swagger back to what is currently deployed

This swagger should never be hand edited. We can update it only when service accepts the changes

* Add composite swagger file with all suggested changes for service to make

read only, required params, and comment refactors. OperationId changes will go in here, too

* Regenerate PL with the currently deployed swagger

* Update models to rename CloudToDeviceMethod and CloudToDeviceMethodResult  (#12240)

* Modules API design (#12188)

* Add IoTHub Devices subclient APIs

* Swagger changes for Client grouping (#12245)

* Add suggested type name changes to iothub swagger (#12296)

* Service Client CL and client grouping (#12323)

* Small API design comments fix

* feat(autorest): Generated clients from autorest after sync with master

* Add implementation for Devices APIs (#12611)

* (feat): Implement Modules client (#12673)

* feat(tests): Add test infrastructure and setup.ps1 for local setup (#12719)

* Add test infrastructure and setup

* Add common files, remove specific sub (#12722)

* fix(swagger): Fix IotHub swagger descriptions (#12695)

* fix(pipeline): Update setup script to call test-resources ARM template directly (#12775)

* feat(samples): Samples project skeleton (#12787)

* IoT hub service client authentication via connection string (#12731)

* feat(e2e-tests): Add initial setup for E2E tests

* feat(iot-service): Add authentication via connection string

* fix(iot-service): Fix merge conflict in infrastructure setup file (#12803)

Co-authored-by: Abhipsa Misra <[email protected]>

* feat(tests): Changes to fix tests and make sure we can run them successfully. (#12819)

* Start recording tests and add intial Session recording (#12827)

* feat(samples): Initial CREATE/DELETE sample for ModuleI (#12850)

* feat(samples): Finish Modules samples (#12989)

* feat(e2e): Devices E2E tests (#12997)

* Update the logic for ETags and preconditions (#13046)

* Fix the CI and test pipelines. (#13091)

Co-authored-by: abhipds <[email protected]>
Co-authored-by: Abhipsa Misra <[email protected]>
Co-authored-by: vinagesh <[email protected]>
Co-authored-by: timtay-microsoft <[email protected]>
Co-authored-by: bikamani <[email protected]>
Co-authored-by: Sindhu Nagesh <[email protected]>
Co-authored-by: Abhipsa Misra <[email protected]>
prmathur-microsoft pushed a commit that referenced this pull request Jul 7, 2020
@timtay-microsoft @prmathur-microsoft
Add suggested type name changes to iothub swagger (#12296)
6b8d1f8
prmathur-microsoft pushed a commit that referenced this pull request Jul 8, 2020
@azabbasi @abhipsaMisra
@vinagesh @timtay-microsoft @bikamani @prmathur-microsoft
Merge IoT-Hub into master. (#13086)
8f86573 
* feat(hub): Creating a new feature branch with swagger and generated files

* fix(doc): Fix markdown for API design doc (#11690)

* swagger(iothub): Adding overrides for type names (#12026)

* fix(tests): Fix project reference for the test framework (#12053)

* fix(hub): Fix property accessibility issue (#12055)

* Fix API categories for iothub service client (#12087)

* swagger(iothub): Swagger comment changes (#12149)

* fix(iot): Regenerate iothub PL after rebase from master

* refactor(iot): Remove unnecessary custom code

This class only existed to make the DigitalTwinClient internal, but now all generated clients are internal by default

* Swagger changes for Iot Hub (#12218)

* Revert swagger back to what is currently deployed

This swagger should never be hand edited. We can update it only when service accepts the changes

* Add composite swagger file with all suggested changes for service to make

read only, required params, and comment refactors. OperationId changes will go in here, too

* Regenerate PL with the currently deployed swagger

* Update models to rename CloudToDeviceMethod and CloudToDeviceMethodResult  (#12240)

* Modules API design (#12188)

* Add IoTHub Devices subclient APIs

* Swagger changes for Client grouping (#12245)

* Add suggested type name changes to iothub swagger (#12296)

* Service Client CL and client grouping (#12323)

* Small API design comments fix

* feat(autorest): Generated clients from autorest after sync with master

* Add implementation for Devices APIs (#12611)

* (feat): Implement Modules client (#12673)

* feat(tests): Add test infrastructure and setup.ps1 for local setup (#12719)

* Add test infrastructure and setup

* Add common files, remove specific sub (#12722)

* fix(swagger): Fix IotHub swagger descriptions (#12695)

* fix(pipeline): Update setup script to call test-resources ARM template directly (#12775)

* feat(samples): Samples project skeleton (#12787)

* IoT hub service client authentication via connection string (#12731)

* feat(e2e-tests): Add initial setup for E2E tests

* feat(iot-service): Add authentication via connection string

* fix(iot-service): Fix merge conflict in infrastructure setup file (#12803)

Co-authored-by: Abhipsa Misra <[email protected]>

* feat(tests): Changes to fix tests and make sure we can run them successfully. (#12819)

* Start recording tests and add intial Session recording (#12827)

* feat(samples): Initial CREATE/DELETE sample for ModuleI (#12850)

* feat(samples): Finish Modules samples (#12989)

* feat(e2e): Devices E2E tests (#12997)

* Update the logic for ETags and preconditions (#13046)

* Fix the CI and test pipelines. (#13091)

Co-authored-by: abhipds <[email protected]>
Co-authored-by: Abhipsa Misra <[email protected]>
Co-authored-by: vinagesh <[email protected]>
Co-authored-by: timtay-microsoft <[email protected]>
Co-authored-by: bikamani <[email protected]>
Co-authored-by: Sindhu Nagesh <[email protected]>
Co-authored-by: Abhipsa Misra <[email protected]>
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-net that referenced this pull request Jan 27, 2021
CodeGen from PR 12296 in Azure/azure-rest-api-specs
3415bda 
Add Azure WebPubSub data-plane api (Azure#12296)

* Add Azure WebPubSub data-plane api

* fix version mismatch

* Fix build failure

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

Reviewers

@AlexGhiondea AlexGhiondea Awaiting requested review from AlexGhiondea

3 more reviewers

@barustum barustum barustum approved these changes

@azabbasi azabbasi azabbasi approved these changes

@bikamani bikamani bikamani approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@timtay-microsoft @bikamani @barustum @azabbasi