Skip to content

Commit 04b08f3

Browse files
committed
fix: Updated the Summary Documents and Version bump
1 parent 4b2b05f commit 04b08f3

26 files changed

+644
-639
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## [v0.1.12](https://github.com/contentstack/contentstack-management-dotnet/tree/v0.1.12)
4+
- Fix
5+
- Fix the Delivery Token URL
6+
- Made the Summary More Readable
7+
38
## [v0.1.11](https://github.com/contentstack/contentstack-management-dotnet/tree/v0.1.11)
49
- Feat
510
- Add support for custom Http client and IHttpClientFactory

Contentstack.Management.Core/ContentstackClient.cs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class ContentstackClient : IContentstackClient
3535
private HttpClient _httpClient;
3636
private bool _disposed = false;
3737

38-
private string Version => "0.1.11";
38+
private string Version => "0.1.12";
3939
private string xUserAgent => $"contentstack-management-dotnet/{Version}";
4040
#endregion
4141

@@ -59,10 +59,10 @@ public class ContentstackClient : IContentstackClient
5959
/// <pre><code>
6060
/// var options = new ContentstackClientOptions()
6161
/// {
62-
/// Host = &quot;&lt;API_HOST&gt;&quot;,
63-
/// Authtoken = &quot;&lt;AUTHTOKEN&gt;&quot;
62+
/// Host = "<API_HOST>",
63+
/// Authtoken = "<AUTHTOKEN>"
6464
/// }
65-
/// ContentstackClient client = new ContentstackClient(new OptionsWrapper&lt;ContentstackClientOptions&gt;(options));
65+
/// ContentstackClient client = new ContentstackClient(new OptionsWrapper<ContentstackClientOptions>(options));
6666
/// </code></pre>
6767
/// </example>
6868
public ContentstackClient(IOptions<ContentstackClientOptions> contentstackOptions)
@@ -116,7 +116,7 @@ public ContentstackClient(ContentstackClientOptions contentstackOptions) :
116116
/// <param name="proxyCredentials">Credentials to use with a proxy.</param>
117117
/// <example>
118118
/// <pre><code>
119-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
119+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
120120
/// </code></pre>
121121
/// </example>
122122
public ContentstackClient(
@@ -283,7 +283,7 @@ private void ThrowIfDisposed()
283283
/// </summary>
284284
/// <example>
285285
/// <pre><code>
286-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
286+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
287287
/// User user = client.User();
288288
/// </code></pre>
289289
/// </example>
@@ -300,8 +300,8 @@ public User User()
300300
/// <param name="uid">Organization uid.</param>
301301
/// <example>
302302
/// <pre><code>
303-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
304-
/// Organization organization = client.Organization(&quot;&lt;ORG_UID&gt;&quot;);
303+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
304+
/// Organization organization = client.Organization("<ORG_UID>");
305305
/// </code></pre>
306306
/// </example>
307307
/// <returns>The <see cref="Models.Organization" />.</returns>
@@ -318,8 +318,8 @@ public Organization Organization(string uid = null)
318318
/// <param name="managementToken">Stack Management token </param>
319319
/// <example>
320320
/// <pre><code>
321-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
322-
/// Stack Stack = client.Stack(&quot;&lt;API_KEY&gt;&quot;);
321+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
322+
/// Stack Stack = client.Stack("<API_KEY>");
323323
/// </code></pre>
324324
/// </example>
325325
/// <returns>The <see cref="Models.Stack" />.</returns>
@@ -336,8 +336,8 @@ public Stack Stack(string apiKey = null, string managementToken = null, string b
336336
/// <param name="token">The optional 2FA token.</param>
337337
/// <example>
338338
/// <pre><code>
339-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
340-
/// NetworkCredential credentials = new NetworkCredential(&quot;&lt;EMAIL&gt;&quot;, &quot;&lt;PASSWORD&gt;&quot;);
339+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
340+
/// NetworkCredential credentials = new NetworkCredential("<EMAIL>", "<PASSWORD>");
341341
/// ContentstackResponse contentstackResponse = client.Login(credentials);
342342
/// </code></pre>
343343
/// </example>
@@ -357,8 +357,8 @@ public ContentstackResponse Login(ICredentials credentials, string token = null)
357357
/// <param name="token">The optional 2FA token.</param>
358358
/// <example>
359359
/// <pre><code>
360-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
361-
/// NetworkCredential credentials = new NetworkCredential(&quot;&lt;EMAIL&gt;&quot;, &quot;&lt;PASSWORD&gt;&quot;);
360+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
361+
/// NetworkCredential credentials = new NetworkCredential("<EMAIL>", "<PASSWORD>");
362362
/// ContentstackResponse contentstackResponse = await client.LoginAsync(credentials);
363363
/// </code></pre>
364364
/// </example>
@@ -398,7 +398,7 @@ internal void ThrowIfNotLoggedIn()
398398
/// <param name="authtoken">The optional authroken in case user want to logout.</param>
399399
/// <example>
400400
/// <pre><code>
401-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
401+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
402402
/// ContentstackResponse contentstackResponse = client.Logout();
403403
/// </code></pre>
404404
/// </example>
@@ -416,7 +416,7 @@ public ContentstackResponse Logout(string authtoken = null)
416416
/// <param name="authtoken">The optional authroken in case user want to logout.</param>
417417
/// <example>
418418
/// <pre><code>
419-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
419+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
420420
/// ContentstackResponse contentstackResponse = await client.LogoutAsync();
421421
/// </code></pre>
422422
/// </example>
@@ -435,7 +435,7 @@ public Task<ContentstackResponse> LogoutAsync(string authtoken = null)
435435
/// </summary>
436436
/// <example>
437437
/// <pre><code>
438-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
438+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
439439
/// ContentstackResponse contentstackResponse = client.GetUser();
440440
/// </code></pre>
441441
/// </example>
@@ -454,7 +454,7 @@ public ContentstackResponse GetUser(ParameterCollection collection = null)
454454
/// </summary>
455455
/// <example>
456456
/// <pre><code>
457-
/// ContentstackClient client = new ContentstackClient(&quot;&lt;AUTHTOKEN&gt;&quot;, &quot;&lt;API_HOST&gt;&quot;);
457+
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
458458
/// ContentstackResponse contentstackResponse = await client.GetUserAsync();
459459
/// </code></pre>
460460
/// </example>

0 commit comments

Comments
 (0)