fix(formatting): update comments and fomatting changes

watson-developer-cloud · Sep 8, 2021 · 05c7a67 · 05c7a67
1 parent b16b165
commit 05c7a67
Show file tree

Hide file tree

Showing 50 changed files with 335 additions and 280 deletions.
diff --git a/src/IBM.Watson.Assistant.v1/AssistantService.cs b/src/IBM.Watson.Assistant.v1/AssistantService.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2018, 2021.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 */
 
 /**
-* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138
+* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 */
 
 using System.Collections.Generic;
@@ -4319,8 +4319,8 @@ public DetailedResponse<LogCollection> ListLogs(string workspaceId, string sort
         /// </summary>
         /// <param name="filter">A cacheable parameter that limits the results to those matching the specified filter.
         /// You must specify a filter query that includes a value for `language`, as well as a value for
-        /// `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. For more
-        /// information, see the
+        /// `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. These
+        /// required filters must be specified using the exact match (`::`) operator. For more information, see the
         /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).</param>
         /// <param name="sort">How to sort the returned log events. You can sort by **request_timestamp**. To reverse
         /// the sort order, prefix the parameter value with a minus sign (`-`). (optional)</param>

diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2018, 2020.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -47,7 +47,10 @@ public class RuntimeEntity
         [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)]
         public float? Confidence { get; set; }
         /// <summary>
-        /// Any metadata for the entity.
+        /// **Deprecated.** Any metadata for the entity.
+        ///
+        /// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information
+        /// about system entities recognized in the user input, see the `interpretation` property.
         /// </summary>
         [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)]
         public Dictionary<string, object> Metadata { get; set; }

diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2018, 2020.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -47,7 +47,10 @@ public class RuntimeEntity
         [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)]
         public float? Confidence { get; set; }
         /// <summary>
-        /// Any metadata for the entity.
+        /// **Deprecated.** Any metadata for the entity.
+        ///
+        /// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information
+        /// about system entities recognized in the user input, see the `interpretation` property.
         /// </summary>
         [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)]
         public Dictionary<string, object> Metadata { get; set; }

diff --git a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2020.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 */
 
 /**
-* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-123423
+* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
 */
 
 using System.Collections.Generic;
@@ -2364,7 +2364,7 @@ public DetailedResponse<DeleteDocumentResponse> DeleteDocument(string environmen
         /// are biased towards higher field values. This parameter cannot be used in the same query as the **sort**
         /// parameter. (optional)</param>
         /// <param name="spellingSuggestions">When `true` and the **natural_language_query** parameter is used, the
-        /// **natural_languge_query** parameter is spell checked. The most likely correction is retunred in the
+        /// **natural_languge_query** parameter is spell checked. The most likely correction is returned in the
         /// **suggested_query** field of the response (if one exists).
         ///
         /// **Important:** this parameter is only valid when using the Cloud Pak version of Discovery. (optional,
@@ -3061,7 +3061,7 @@ public DetailedResponse<QueryNoticesResponse> FederatedQueryNotices(string envir
         /// <param name="environmentId">The ID of the environment.</param>
         /// <param name="collectionId">The ID of the collection.</param>
         /// <param name="prefix">The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete
-        /// to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.</param>
+        /// to `hot`, `housing`, or `how`.</param>
         /// <param name="field">The field in the result documents that autocompletion suggestions are identified from.
         /// (optional)</param>
         /// <param name="count">The number of autocompletion suggestions to return. (optional)</param>

diff --git a/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs b/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2020.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -56,9 +56,9 @@ public class Enrichment
         ///  When using `natual_language_understanding`, the **options** object must contain Natural Language
         /// Understanding options.
         ///
-        ///  When using `elements` the **options** object must contain Element Classification options. Additionally,
-        /// when using the `elements` enrichment the configuration specified and files ingested must meet all the
-        /// criteria specified in [the
+        /// When using `elements` the **options** object must contain Element Classification options. Additionally, when
+        /// using the `elements` enrichment the configuration specified and files ingested must meet all the criteria
+        /// specified in [the
         /// documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification).
         /// </summary>
         [JsonProperty("enrichment", NullValueHandling = NullValueHandling.Ignore)]

diff --git a/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs b/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2019.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -86,7 +86,7 @@ public class LanguageEnumValue
         [JsonProperty("features", NullValueHandling = NullValueHandling.Ignore)]
         public NluEnrichmentFeatures Features { get; set; }
         /// <summary>
-        /// *For use with `elements` enrichments only.* The element extraction model to use. Models available are:
+        /// For use with `elements` enrichments only. The element extraction model to use. The only model available is
         /// `contract`.
         /// </summary>
         [JsonProperty("model", NullValueHandling = NullValueHandling.Ignore)]

diff --git a/src/IBM.Watson.Discovery.v1/Model/Notice.cs b/src/IBM.Watson.Discovery.v1/Model/Notice.cs
@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2017, 2019.
+* (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@ public class SeverityEnumValue
         /// `missing_model`, `unsupported_model`, `smart_document_understanding_failed_incompatible_field`,
         /// `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_internal_error`,
         /// `smart_document_understanding_failed_warning`, `smart_document_understanding_page_error`,
-        /// `smart_document_understanding_page_warning`. **Note:** This is not a complete list, other values might be
+        /// `smart_document_understanding_page_warning`. **Note:** This is not a complete list; other values might be
         /// returned.
         /// </summary>
         [JsonProperty("notice_id", NullValueHandling = NullValueHandling.Ignore)]
@@ -76,8 +76,8 @@ public class SeverityEnumValue
         [JsonProperty("query_id", NullValueHandling = NullValueHandling.Ignore)]
         public virtual string QueryId { get; private set; }
         /// <summary>
-        /// Ingestion or training step in which the notice occurred. Typical step values include: `classify_elements`,
-        /// `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list,
+        /// Ingestion or training step in which the notice occurred. Typical step values include:
+        /// `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list;
         /// other values might be returned.
         /// </summary>
         [JsonProperty("step", NullValueHandling = NullValueHandling.Ignore)]