Skip to content

Modules API design #12188

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

Merged
azabbasi merged 7 commits into from
May 22, 2020
Merged

Modules API design #12188

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5ef4347
Modules API design
azabbasi May 19, 2020
570c1b0
Update comments
azabbasi May 19, 2020
6378a07
Update comments
azabbasi May 20, 2020
f957894
Update API docs
azabbasi May 21, 2020
f0fca06
Update more comments
azabbasi May 21, 2020
ef65138
Update method request model names
azabbasi May 21, 2020
dd1d687
Update more comments
azabbasi May 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update comments
  • Loading branch information
@azabbasi
azabbasi committed May 21, 2020
commit 6378a075e11861a3821b25f7885d5f484ca000b9
12 changes: 6 additions & 6 deletions sdk/iot/Azure.Iot.Hub.Service/src/API Design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ APIs for managing module identities, module twins, and querying modules
public class Modules
{
/// <summary>
/// Create a module.
/// Create a device module.
/// </summary>
/// <param name="moduleIdentity">The module to create.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns></returns>
public virtual async Task<Response<ModuleIdentity>> CreateIdentityAsync(ModuleIdentity moduleIdentity, CancellationToken cancellationToken);
public virtual async Task<Response<ModuleIdentity>> CreateIdentityAsync(ModuleIdentity moduleIdentity, CancellationToken cancellationToken = default);

/// <summary>
/// Get a single device.
/// Get a single device module.
/// </summary>
/// <param name="deviceId">The unique identifier of the device that contains the module.</param>
/// <param name="moduleId">The unique identifier of the module to get.</param>
Expand All @@ -79,7 +79,7 @@ public class Modules
public virtual async AsyncPageable<ModuleIdentity> GetIdentitiesAsync(string deviceId, CancellationToken cancellationToken = default);

/// <summary>
/// Update a module.
/// Update a device module.
/// </summary>
/// <param name="moduleIdentity">The module to update.</param>
/// <param name="ifMatch">A string representing a weak ETag for this module, as per RFC7232. The update operation is performed
Expand All @@ -90,7 +90,7 @@ public class Modules
public virtual async Task<Response<ModuleIdentity>> UpdateIdentityAsync(ModuleIdentity moduleIdentity, string ifMatch = null, CancellationToken cancellationToken = default);

/// <summary>
/// Delete a single module.
/// Delete a single device module.
/// </summary>
/// <param name="deviceId">The unique identifier of the device that contains the module.</param>
/// <param name="moduleId">The unique identifier of the module to get.</param>
Expand All @@ -108,7 +108,7 @@ public class Modules
/// <param name="moduleId">The unique identifier of the device module.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The retrieved module twin.</returns>
public virtual async Task<Response<TwinData>> GetTwinAsync(string deviceId, string moduleId, CancellationToken cancellationToken);
public virtual async Task<Response<TwinData>> GetTwinAsync(string deviceId, string moduleId, CancellationToken cancellationToken = default);

/// <summary>
/// List a set of module twins.
Expand Down