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

Update digital twin method headers to clarify that create APIs behave like createOrUpdate APIs #16017

Merged
merged 2 commits into from
Oct 16, 2020
Merged
Changes from all commits
Commits
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
18 changes: 12 additions & 6 deletions sdk/digitaltwins/Azure.DigitalTwins.Core/src/DigitalTwinsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,8 @@ public virtual Response<string> GetDigitalTwin(string digitalTwinId, GetDigitalT
}

/// <summary>
/// Creates a digital twin asynchronously.
/// Creates a digital twin asynchronously. If the provided digital twin Id is already in use, then this will attempt to replace the existing digital twin
drwill-ms marked this conversation as resolved.
Show resolved Hide resolved
/// with the provided digital twin.
/// </summary>
/// <param name="digitalTwinId">The Id of the digital twin.</param>
/// <param name="digitalTwin">The application/json digital twin to create.</param>
Expand Down Expand Up @@ -215,7 +216,8 @@ public virtual Task<Response<string>> CreateDigitalTwinAsync(string digitalTwinI
}

/// <summary>
/// Creates a digital twin synchronously.
/// Creates a digital twin synchronously. If the provided digital twin Id is already in use, then this will attempt to replace the existing digital twin
/// with the provided digital twin.
/// </summary>
/// <param name="digitalTwinId">The Id of the digital twin.</param>
/// <param name="digitalTwin">The application/json digital twin to create.</param>
Expand Down Expand Up @@ -819,7 +821,8 @@ public virtual Response DeleteRelationship(string digitalTwinId, string relation
}

/// <summary>
/// Creates a relationship on a digital twin asynchronously.
/// Creates a relationship on a digital twin asynchronously. If the provided relationship Id is already in use, this will attempt to replace the
/// existing relationship with the provided relationship.
/// </summary>
/// <param name="digitalTwinId">The Id of the source digital twin.</param>
/// <param name="relationshipId">The Id of the relationship which is being created.</param>
Expand Down Expand Up @@ -864,7 +867,8 @@ public virtual Task<Response<string>> CreateRelationshipAsync(string digitalTwin
}

/// <summary>
/// Creates a relationship on a digital twin synchronously.
/// Creates a relationship on a digital twin synchronously. If the provided relationship Id is already in use, this will attempt to replace the
/// existing relationship with the provided relationship.
/// </summary>
/// <param name="digitalTwinId">The Id of the source digital twin.</param>
/// <param name="relationshipId">The Id of the relationship to delete.</param>
Expand Down Expand Up @@ -1620,7 +1624,8 @@ public virtual Response<EventRoute> GetEventRoute(string eventRouteId, GetEventR
}

/// <summary>
/// Creates an event route asynchronously.
/// Creates an event route asynchronously. If the provided event route Id is already in use, then this will attempt to replace the existing
/// event route with the provided event route.
/// </summary>
/// <param name="eventRouteId">The Id of the event route to create.</param>
/// <param name="eventRoute">The event route data containing the endpoint and optional filter.</param>
Expand Down Expand Up @@ -1651,7 +1656,8 @@ public virtual Task<Response> CreateEventRouteAsync(string eventRouteId, EventRo
}

/// <summary>
/// Creates an event route synchronously.
/// Creates an event route synchronously. If the provided event route Id is already in use, then this will attempt to replace the existing
/// event route with the provided event route.
/// </summary>
/// <param name="eventRouteId">The Id of the event route to create.</param>
/// <param name="eventRoute">The event route data containing the endpoint and optional filter.</param>
Expand Down