Skip to content

Commit 21a17a8

Browse files
cs-rajcs-raj
authored
Merge pull request #105 from contentstack/fix/DX-3105
Fix: Changed the Summary
2 parents fc41202 + f9b1e74 commit 21a17a8

File tree

8 files changed

+437
-437
lines changed

8 files changed

+437
-437
lines changed

‎Contentstack.Core/ContentstackClient.cs

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ private string _Url
6565
/// <code>
6666
/// var options = new ContentstackOptions()
6767
/// {
68-
/// ApiKey = &quot;api_key&quot;,
69-
/// DeliveryToken = &quot;delivery_token&quot;
70-
/// Environment = &quot;environment&quot;
68+
/// ApiKey = "api_key",
69+
/// DeliveryToken = "delivery_token"
70+
/// Environment = "environment"
7171
/// }
7272
/// ContentstackClient stack = new ContentstackClient(options);
73-
/// ContentType contentType = stack.ContentType(&quot;contentType_name&quot;);
73+
/// ContentType contentType = stack.ContentType("contentType_name");
7474
/// </code>
7575
/// </example>
7676
public ContentstackClient(IOptions<ContentstackOptions> options)
@@ -161,8 +161,8 @@ public ContentstackClient(ContentstackOptions options) :
161161
/// <param name="environment">Environment name</param>
162162
/// <example>
163163
/// <code>
164-
/// ContentstackClient stack = new ContentstackClient(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
165-
/// ContentType contentType = stack.ContentType(&quot;contentType_name&quot;);
164+
/// ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "environment");
165+
/// ContentType contentType = stack.ContentType("contentType_name");
166166
/// </code>
167167
/// </example>
168168
public ContentstackClient(string apiKey, string deliveryToken, string environment, string host = null, ContentstackRegion region = ContentstackRegion.US, string version = null, int? timeout = null, WebProxy proxy = null) :
@@ -267,7 +267,7 @@ internal void SetConfig(Config cnfig)
267267
/// <returns>Current instance of Asset, this will be useful for a chaining calls.</returns>
268268
/// <example>
269269
/// <code>
270-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
270+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
271271
/// Asset asset = stack.Asset();
272272
/// </code>
273273
/// </example>
@@ -285,8 +285,8 @@ internal Asset Asset()
285285
/// </summary>
286286
/// <example>
287287
/// <code>
288-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
289-
/// var param = new Dictionary&lt;string, object&gt;();
288+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
289+
/// var param = new Dictionary<string, object>();
290290
/// param.Add("include_global_field_schema",true);
291291
/// param.Add("limit", 10);
292292
/// param.Add("skip", 10);
@@ -401,8 +401,8 @@ private async Task<JObject> GetLivePreviewData()
401401
/// <returns>Current instance of ContentType, this will be useful for a chaining calls.</returns>
402402
/// <example>
403403
/// <code>
404-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
405-
/// ContentType contentType = stack.ContentType(&quot;contentType_name&quot;);
404+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
405+
/// ContentType contentType = stack.ContentType("contentType_name");
406406
/// </code>
407407
/// </example>
408408
public ContentType ContentType(String contentTypeName)
@@ -434,8 +434,8 @@ public GlobalFieldQuery GlobalFieldQuery()
434434
/// <returns>Current instance of Asset, this will be useful for a chaining calls.</returns>
435435
/// <example>
436436
/// <code>
437-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
438-
/// Asset asset = stack.Asset(&quot;asset_uid&quot;);
437+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
438+
/// Asset asset = stack.Asset("asset_uid");
439439
/// </code>
440440
/// </example>
441441
public Asset Asset(String Uid)
@@ -450,7 +450,7 @@ public Asset Asset(String Uid)
450450
/// <returns>Current instance of Asset, this will be useful for a chaining calls.</returns>
451451
/// <example>
452452
/// <code>
453-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
453+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
454454
/// AssetLibrary assetLibrary = stack.AssetLibrary();
455455
/// </code>
456456
/// </example>
@@ -466,7 +466,7 @@ public AssetLibrary AssetLibrary()
466466
/// <returns>Current instance of Taxonomy, this will be useful for a chaining calls.</returns>
467467
/// <example>
468468
/// <code>
469-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
469+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
470470
/// Taxonomy taxonomy = stack.Taxonomy();
471471
/// </code>
472472
/// </example>
@@ -482,7 +482,7 @@ public Taxonomy Taxonomies()
482482
/// <returns>Version</returns>
483483
/// <example>
484484
/// <code>
485-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
485+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
486486
/// String url = stack.GetVersion();
487487
/// </code>
488488
/// </example>
@@ -497,7 +497,7 @@ public string GetVersion()
497497
/// <returns>stack application key</returns>
498498
/// <example>
499499
/// <code>
500-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
500+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
501501
/// String url = stack.GetApplicationKey();
502502
/// </code>
503503
/// </example>
@@ -519,7 +519,7 @@ public LivePreviewConfig GetLivePreviewConfig()
519519
/// <returns>access token</returns>
520520
/// <example>
521521
/// <code>
522-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
522+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
523523
/// String accessToken = stack.GetAccessToken();
524524
/// </code>
525525
/// </example>
@@ -534,7 +534,7 @@ public string GetAccessToken()
534534
/// <returns>stack environment</returns>
535535
/// <example>
536536
/// <code>
537-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
537+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
538538
/// String environment = stack.GetEnvironment();
539539
/// </code>
540540
/// </example>
@@ -549,8 +549,8 @@ public string GetEnvironment()
549549
/// <param name="key">key to be remove from header</param>
550550
/// <example>
551551
/// <code>
552-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
553-
/// stack.RemoveHeader(&quot;custom_header_key&quot;);
552+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
553+
/// stack.RemoveHeader("custom_header_key");
554554
/// </code>
555555
/// </example>
556556
public void RemoveHeader(string key)
@@ -567,8 +567,8 @@ public void RemoveHeader(string key)
567567
/// <param name="value">header value against given header name.</param>
568568
/// <example>
569569
/// <code>
570-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
571-
/// stack.SetHeader(&quot;custom_key&quot;, &quot;custom_value&quot;);
570+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
571+
/// stack.SetHeader("custom_key", "custom_value");
572572
/// </code>
573573
/// </example>
574574
public void SetHeader(string key, string value)
@@ -588,7 +588,7 @@ public void SetHeader(string key, string value)
588588
/// <param name="query">Query parameter containing hash and content type UID </param>
589589
/// <example>
590590
/// <code>
591-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
591+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
592592
/// stack.LivePreviewQuery(query);
593593
/// </code>
594594
/// </example>
@@ -641,8 +641,8 @@ public async Task LivePreviewQueryAsync(Dictionary<string, string> query)
641641
/// <param name="StartFrom">Start from.</param>
642642
/// <example>
643643
/// <code>
644-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
645-
/// stack.SyncRecursiveLanguage(&quot;SyncType&quot;, &quot;Locale&quot;);
644+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
645+
/// stack.SyncRecursiveLanguage("SyncType", "Locale");
646646
/// </code>
647647
/// </example>
648648
public async Task<SyncStack> SyncRecursive(String Locale = null, SyncType SyncType = SyncType.All, string ContentTypeUid = null, DateTime? StartFrom = null)
@@ -659,8 +659,8 @@ public async Task<SyncStack> SyncRecursive(String Locale = null, SyncType SyncTy
659659
/// <param name="paginationToken">Pagination token.</param>
660660
/// <example>
661661
/// <code>
662-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
663-
/// stack.SyncPaginationTokenn(&quot;pagination_token&quot;);
662+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
663+
/// stack.SyncPaginationTokenn("pagination_token");
664664
/// </code>
665665
/// </example>
666666

@@ -676,8 +676,8 @@ public async Task<SyncStack> SyncPaginationToken(string paginationToken)
676676
/// <param name="SyncToken">Sync token.</param>
677677
/// <example>
678678
/// <code>
679-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
680-
/// stack.SyncToken(&quot;sync_token&quot;);
679+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
680+
/// stack.SyncToken("sync_token");
681681
/// </code>
682682
/// </example>
683683
public async Task<SyncStack> SyncToken(string SyncToken)

‎Contentstack.Core/Models/Asset.cs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -214,10 +214,10 @@ public void SetHeader(string key, string value)
214214
/// <returns>Current instance of Entry, this will be useful for a chaining calls.</returns>
215215
/// <example>
216216
/// <code>
217-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
218-
/// Asset asset = stack.Asset(&quot;asset_uid&quot;);
217+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
218+
/// Asset asset = stack.Asset("asset_uid");
219219
/// asset.IncludeFallback();
220-
/// asset.Fetch&lt;Product&gt;().ContinueWith((assetResult) =&gt; {
220+
/// asset.Fetch<Product>().ContinueWith((assetResult) => {
221221
/// //Your callback code.
222222
/// });
223223
/// </code>
@@ -236,10 +236,10 @@ public Asset IncludeFallback()
236236
/// <returns>Current instance of Asset, this will be useful for a chaining calls.</returns>
237237
/// <example>
238238
/// <code>
239-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
240-
/// Asset asset = stack.Asset(&quot;asset_uid&quot;);
239+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
240+
/// Asset asset = stack.Asset("asset_uid");
241241
/// asset.IncludeMetadata();
242-
/// asset.Fetch&lt;Product&gt;().ContinueWith((assetResult) =&gt; {
242+
/// asset.Fetch<Product>().ContinueWith((assetResult) => {
243243
/// //Your callback code.
244244
/// });
245245
/// </code>
@@ -264,10 +264,10 @@ public Asset IncludeMetadata()
264264
/// <returns>Current instance of Entry, this will be useful for a chaining calls.</returns>
265265
/// <example>
266266
/// <code>
267-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
268-
/// Asset asset = stack.Asset(&quot;asset_uid&quot;);
267+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
268+
/// Asset asset = stack.Asset("asset_uid");
269269
/// asset.IncludeBranch();
270-
/// asset.Fetch&lt;Product&gt;().ContinueWith((assetResult) =&gt; {
270+
/// asset.Fetch<Product>().ContinueWith((assetResult) => {
271271
/// //Your callback code.
272272
/// });
273273
/// </code>
@@ -285,10 +285,10 @@ public Asset IncludeBranch()
285285
/// <returns>Current instance of Asset, this will be useful for a chaining calls.</returns>
286286
/// <example>
287287
/// <code>
288-
/// ContentstackClient stack = new ContentstackClinet(&quot;api_key&quot;, &quot;delivery_token&quot;, &quot;environment&quot;);
289-
/// Asset asset = stack.Asset(&quot;asset_uid&quot;);
288+
/// ContentstackClient stack = new ContentstackClinet("api_key", "delivery_token", "environment");
289+
/// Asset asset = stack.Asset("asset_uid");
290290
/// asset.AddParam("include_branch", "true");
291-
/// asset.Fetch&lt;Product&gt;().ContinueWith((assetResult) =&gt; {
291+
/// asset.Fetch<Product>().ContinueWith((assetResult) => {
292292
/// //Your callback code.
293293
/// });
294294
/// </code>

0 commit comments

Comments
 (0)