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.

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

Enhance apirequest to allow setting http-header #459

Merged
merged 2 commits into from
May 22, 2021
Merged

Enhance apirequest to allow setting http-header #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8a8d50
Allow to set headers to APIRequest for PATCH if needs IF-MATCH
May 20, 2021
bd26e89
respect that http header keys are most of the times not case sensitiv…
May 21, 2021
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
3 changes: 2 additions & 1 deletion src/sdk/PnP.Core/Model/Base/BaseDataModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,8 @@ public async Task<ApiRequestResponse> ExecuteRequestAsync(ApiRequest request)
{
ExecuteRequestApiCall = true,
SkipCollectionClearing = true,
RawRequest = true
RawRequest = true,
Headers= request.Headers
}
, request.HttpMethod).ConfigureAwait(false);

Expand Down
11 changes: 9 additions & 2 deletions src/sdk/PnP.Core/Services/Core/ApiCall.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace PnP.Core.Services
/// </summary>
internal struct ApiCall
{
internal ApiCall(string request, ApiType apiType, string jsonBody = null, string receivingProperty = null, bool loadPages = false)
internal ApiCall(string request, ApiType apiType, string jsonBody = null, string receivingProperty = null, bool loadPages = false, Dictionary<string, string> headers = null)
{
Type = apiType;
Request = request;
Expand All @@ -29,9 +29,10 @@ internal ApiCall(string request, ApiType apiType, string jsonBody = null, string
LoadPages = loadPages;
SkipCollectionClearing = false;
ExecuteRequestApiCall = false;
Headers = headers;
}

internal ApiCall(List<Core.CSOM.Requests.IRequest<object>> csomRequests, string receivingProperty = null)
internal ApiCall(List<Core.CSOM.Requests.IRequest<object>> csomRequests, string receivingProperty = null, Dictionary<string, string> headers=null)
{
Request = null;
Type = ApiType.CSOM;
Expand All @@ -51,6 +52,7 @@ internal ApiCall(List<Core.CSOM.Requests.IRequest<object>> csomRequests, string
LoadPages = false;
SkipCollectionClearing = false;
ExecuteRequestApiCall = false;
Headers = headers;
}

/// <summary>
Expand Down Expand Up @@ -146,5 +148,10 @@ internal ApiCall(List<Core.CSOM.Requests.IRequest<object>> csomRequests, string
/// Flag that indicates this ApiCall was issued from an ExecuteRequest method
/// </summary>
internal bool ExecuteRequestApiCall { get; set; }

/// <summary>
/// Http-Headers for Request
/// </summary>
internal Dictionary<string, string> Headers { get; set; }
}
}
12 changes: 10 additions & 2 deletions src/sdk/PnP.Core/Services/Core/ApiRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Net.Http;
using System.Collections.Generic;
using System.Net.Http;

namespace PnP.Core.Services
{
Expand All @@ -15,12 +16,14 @@ public class ApiRequest
/// <param name="type"><see cref="ApiRequestType"/> of the request</param>
/// <param name="request">Actual API call to issue</param>
/// <param name="body">Optional body of the request</param>
public ApiRequest(HttpMethod httpMethod, ApiRequestType type, string request, string body)
/// <param name="headers">Optional for the request</param>
public ApiRequest(HttpMethod httpMethod, ApiRequestType type, string request, string body, Dictionary<string,string>headers=null)
{
HttpMethod = httpMethod;
Type = type;
Request = request;
Body = body;
Headers = headers;
}

/// <summary>
Expand Down Expand Up @@ -51,5 +54,10 @@ public ApiRequest(ApiRequestType type, string request): this(HttpMethod.Get, typ
/// The optional payload/body of the API call to execute
/// </summary>
public string Body { get; set; }

/// <summary>
/// The optional headers of the API call to execute - for example IF-Match for PATCH Request
/// </summary>
public Dictionary<string, string> Headers { get; }
}
}
16 changes: 16 additions & 0 deletions src/sdk/PnP.Core/Services/Core/BatchClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,6 +771,22 @@ private Tuple<string, string> BuildMicrosoftGraphBatchRequestContent(Batch batch
};
};

if(request.ApiCall.Headers!=null)
{
foreach(var key in request.ApiCall.Headers.Keys)
{
string existingKey = graphRequest.Headers.Keys.FirstOrDefault(k => k.Equals(key, StringComparison.InvariantCultureIgnoreCase));
if (string.IsNullOrWhiteSpace(existingKey))
{
graphRequest.Headers.Add(key, request.ApiCall.Headers[key]);
}
else
{
graphRequest.Headers[existingKey] = request.ApiCall.Headers[key];
}
}
}

graphRequests.Requests.Add(graphRequest);

#if DEBUG
Expand Down