Skip to content

Commit

Permalink
Added missing doc to deprecated request method
Browse files Browse the repository at this point in the history
  • Loading branch information
sacOO7 committed Sep 27, 2023
1 parent e0f018c commit 9e7b0d9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/IO.Ably.Shared/AblyRest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,16 @@ internal async Task<HttpPaginatedResponse> HttpPaginatedRequestInternal(Paginate
return await ExecuteHttpPaginatedRequest(request, requestParams, HttpPaginatedRequestInternal);
}

/// <summary>
/// Make a generic HTTP request against an endpoint representing a collection
/// of some type; this is to provide a forward compatibility path for new APIs.
/// </summary>
/// <param name="method">http method.</param>
/// <param name="path">the path component of the resource URI.</param>
/// <param name="requestParams">(optional; may be null): any parameters to send with the request; see API-specific documentation.</param>
/// <param name="body">(optional; may be null): RequestBody encoded into a JToken. It will be sent as a json object.</param>
/// <param name="headers">(optional; may be null): any additional headers to send; see API-specific documentation.</param>
/// <returns>a page of results.</returns>
[Obsolete("Use RequestV2 instead")]
public async Task<HttpPaginatedResponse> Request(string method, string path, Dictionary<string, string> requestParams = null, JToken body = null, Dictionary<string, string> headers = null)
{
Expand Down

0 comments on commit 9e7b0d9

Please sign in to comment.