Skip to content

Commit 118a15e

Browse files
author
David R. Williamson
committed
Update notes for service default API version
1 parent b82812f commit 118a15e

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

iothub/service/src/ClientApiVersionHelper.cs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,21 @@
44
namespace Microsoft.Azure.Devices
55
{
66
/// <summary>
7-
/// Holds the API version numbers required in data-plane calls to the service
7+
/// Holds the API version numbers required in data-plane calls to the service for <see cref="RegistryManager"/>,
8+
/// <see cref="ServiceClient"/>, and <see cref="JobClient"/>.
89
/// </summary>
910
internal class ClientApiVersionHelper
1011
{
1112
private const string ApiVersionQueryPrefix = "api-version=";
1213
private const string ApiVersionDefault = "2021-04-12";
1314

1415
/// <summary>
15-
/// The default API version to use for all data-plane service calls
16+
/// The default API version query string parameter to use for all data-plane service calls in <see cref="RegistryManager"/>,
17+
/// <see cref="ServiceClient"/>, and <see cref="JobClient"/>.
1618
/// </summary>
1719
public const string ApiVersionQueryString = ApiVersionQueryPrefix + ApiVersionDefault;
20+
21+
// For DigitalTwinClient which has an autorest-generated protocol layer, the API version is specified at generation time.
22+
// To update that API version, follow the instructions at ./DigitalTwin/readme.md.
1823
}
1924
}

0 commit comments

Comments
 (0)