Skip to content

Commit 03a6a93

Browse files
apaparazzi0329apaparazzi0329
committed
refactor(cc,discov1,lt,pi,ta,vr): only comment changes
1 parent bdd0baa commit 03a6a93

File tree

8 files changed

+56
-49
lines changed

8 files changed

+56
-49
lines changed

‎compare-comply/v1.ts

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2018, 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,18 +15,23 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-8d569e8f-20201103-112432
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
2424
import { Authenticator, BaseService, getAuthenticatorFromEnvironment, getMissingParams, UserOptions } from 'ibm-cloud-sdk-core';
2525
import { getSdkHeaders } from '../lib/common';
2626

2727
/**
28-
* IBM Watson™ Compare and Comply analyzes governing documents to provide details about critical aspects of the
29-
* documents.
28+
* IBM Watson™ Compare and Comply is discontinued. Existing instances are supported until 30 November 2021, but as
29+
* of 1 December 2020, you can't create instances. Any instance that exists on 30 November 2021 will be deleted.
30+
* Consider migrating to Watson Discovery Premium on IBM Cloud for your Compare and Comply use cases. To start the
31+
* migration process, visit [https://ibm.biz/contact-wdc-premium](https://ibm.biz/contact-wdc-premium).
32+
* {: deprecated}
33+
*
34+
* Compare and Comply analyzes governing documents to provide details about critical aspects of the documents.
3035
*/
3136

3237
class CompareComplyV1 extends BaseService {
@@ -45,7 +50,7 @@ class CompareComplyV1 extends BaseService {
4550
* @param {Object} options - Options for the service.
4651
* @param {string} options.version - Release date of the version of the API you want to use. Specify dates in
4752
* YYYY-MM-DD format. The current version is `2018-10-15`.
48-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.compare-comply.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
53+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
4954
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5055
* @param {string} [options.serviceName] - The name of the service to configure
5156
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎discovery/v1.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2017, 2020.
2+
* (C) Copyright IBM Corp. 2017, 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-153403
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
@@ -47,7 +47,7 @@ class DiscoveryV1 extends BaseService {
4747
* @param {Object} options - Options for the service.
4848
* @param {string} options.version - Release date of the version of the API you want to use. Specify dates in
4949
* YYYY-MM-DD format. The current version is `2019-04-30`.
50-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.discovery.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
50+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
5151
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5252
* @param {string} [options.serviceName] - The name of the service to configure
5353
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set
@@ -1775,7 +1775,7 @@ class DiscoveryV1 extends BaseService {
17751775
* towards field values closer to the current date. When a **number** type field is specified, returned results are
17761776
* biased towards higher field values. This parameter cannot be used in the same query as the **sort** parameter.
17771777
* @param {boolean} [params.spellingSuggestions] - When `true` and the **natural_language_query** parameter is used,
1778-
* the **natural_languge_query** parameter is spell checked. The most likely correction is retunred in the
1778+
* the **natural_languge_query** parameter is spell checked. The most likely correction is returned in the
17791779
* **suggested_query** field of the response (if one exists).
17801780
*
17811781
* **Important:** this parameter is only valid when using the Cloud Pak version of Discovery.
@@ -4190,7 +4190,7 @@ namespace DiscoveryV1 {
41904190
*/
41914191
bias?: string;
41924192
/** When `true` and the **natural_language_query** parameter is used, the **natural_languge_query** parameter is
4193-
* spell checked. The most likely correction is retunred in the **suggested_query** field of the response (if one
4193+
* spell checked. The most likely correction is returned in the **suggested_query** field of the response (if one
41944194
* exists).
41954195
*
41964196
* **Important:** this parameter is only valid when using the Cloud Pak version of Discovery.

‎language-translator/v3.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2018, 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-8d569e8f-20201103-112432
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
@@ -47,7 +47,7 @@ class LanguageTranslatorV3 extends BaseService {
4747
* @param {Object} options - Options for the service.
4848
* @param {string} options.version - Release date of the version of the API you want to use. Specify dates in
4949
* YYYY-MM-DD format. The current version is `2018-05-01`.
50-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.language-translator.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
50+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
5151
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5252
* @param {string} [options.serviceName] - The name of the service to configure
5353
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎personality-insights/v3.ts

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2017, 2020.
2+
* (C) Copyright IBM Corp. 2017, 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,23 +15,25 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-8d569e8f-20201103-112432
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
2424
import { Authenticator, BaseService, getAuthenticatorFromEnvironment, getMissingParams, UserOptions } from 'ibm-cloud-sdk-core';
2525
import { getSdkHeaders } from '../lib/common';
2626

2727
/**
28-
* IBM® will begin sunsetting IBM Watson™ Personality Insights on 1 December 2020. For a period of one year
29-
* from this date, you will still be able to use Watson Personality Insights. However, as of 1 December 2021, the
30-
* offering will no longer be available.<br/><br/>As an alternative, we encourage you to consider migrating to IBM
31-
* Watson&trade; Natural Language Understanding, a service on IBM Cloud&reg; that uses deep learning to extract data and
32-
* insights from text such as keywords, categories, sentiment, emotion, and syntax to provide insights for your business
33-
* or industry. For more information, see [About Natural Language
34-
* Understanding](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-about).
28+
* IBM Watson&trade; Personality Insights is discontinued. Existing instances are supported until 1 December 2021, but
29+
* as of 1 December 2020, you cannot create new instances. Any instance that exists on 1 December 2021 will be
30+
* deleted.<br/><br/>No direct replacement exists for Personality Insights. However, you can consider using [IBM
31+
* Watson&trade; Natural Language
32+
* Understanding](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-about)
33+
* on IBM Cloud&reg; as part of a replacement analytic workflow for your Personality Insights use cases. You can use
34+
* Natural Language Understanding to extract data and insights from text, such as keywords, categories, sentiment,
35+
* emotion, and syntax. For more information about the personality models in Personality Insights, see [The science
36+
* behind the service](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-science).
3537
* {: deprecated}
3638
*
3739
* The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise
@@ -67,7 +69,7 @@ class PersonalityInsightsV3 extends BaseService {
6769
* @param {Object} options - Options for the service.
6870
* @param {string} options.version - Release date of the version of the API you want to use. Specify dates in
6971
* YYYY-MM-DD format. The current version is `2017-10-13`.
70-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.personality-insights.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
72+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
7173
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
7274
* @param {string} [options.serviceName] - The name of the service to configure
7375
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎test/unit/discovery.v1.test.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -4524,7 +4524,7 @@ describe('DiscoveryV1', () => {
45244524
const eventDataModel = {
45254525
environment_id: 'testString',
45264526
session_token: 'testString',
4527-
client_timestamp: '2019-01-01T12:00:00',
4527+
client_timestamp: '2019-01-01T12:00:00.000Z',
45284528
display_rank: 38,
45294529
collection_id: 'testString',
45304530
document_id: 'testString',
@@ -4667,8 +4667,8 @@ describe('DiscoveryV1', () => {
46674667
describe('positive tests', () => {
46684668
test('should pass the right params to createRequest', () => {
46694669
// Construct the params object for operation getMetricsQuery
4670-
const startTime = '2019-01-01T12:00:00';
4671-
const endTime = '2019-01-01T12:00:00';
4670+
const startTime = '2019-01-01T12:00:00.000Z';
4671+
const endTime = '2019-01-01T12:00:00.000Z';
46724672
const resultType = 'document';
46734673
const params = {
46744674
startTime: startTime,
@@ -4722,8 +4722,8 @@ describe('DiscoveryV1', () => {
47224722
describe('positive tests', () => {
47234723
test('should pass the right params to createRequest', () => {
47244724
// Construct the params object for operation getMetricsQueryEvent
4725-
const startTime = '2019-01-01T12:00:00';
4726-
const endTime = '2019-01-01T12:00:00';
4725+
const startTime = '2019-01-01T12:00:00.000Z';
4726+
const endTime = '2019-01-01T12:00:00.000Z';
47274727
const resultType = 'document';
47284728
const params = {
47294729
startTime: startTime,
@@ -4777,8 +4777,8 @@ describe('DiscoveryV1', () => {
47774777
describe('positive tests', () => {
47784778
test('should pass the right params to createRequest', () => {
47794779
// Construct the params object for operation getMetricsQueryNoResults
4780-
const startTime = '2019-01-01T12:00:00';
4781-
const endTime = '2019-01-01T12:00:00';
4780+
const startTime = '2019-01-01T12:00:00.000Z';
4781+
const endTime = '2019-01-01T12:00:00.000Z';
47824782
const resultType = 'document';
47834783
const params = {
47844784
startTime: startTime,
@@ -4832,8 +4832,8 @@ describe('DiscoveryV1', () => {
48324832
describe('positive tests', () => {
48334833
test('should pass the right params to createRequest', () => {
48344834
// Construct the params object for operation getMetricsEventRate
4835-
const startTime = '2019-01-01T12:00:00';
4836-
const endTime = '2019-01-01T12:00:00';
4835+
const startTime = '2019-01-01T12:00:00.000Z';
4836+
const endTime = '2019-01-01T12:00:00.000Z';
48374837
const resultType = 'document';
48384838
const params = {
48394839
startTime: startTime,

‎tone-analyzer/v3.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2017, 2020.
2+
* (C) Copyright IBM Corp. 2017, 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-8d569e8f-20201103-112432
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
@@ -51,7 +51,7 @@ class ToneAnalyzerV3 extends BaseService {
5151
* @param {Object} options - Options for the service.
5252
* @param {string} options.version - Release date of the version of the API you want to use. Specify dates in
5353
* YYYY-MM-DD format. The current version is `2017-09-21`.
54-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.tone-analyzer.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
54+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
5555
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5656
* @param {string} [options.serviceName] - The name of the service to configure
5757
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎visual-recognition/v3.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2017, 2020.
2+
* (C) Copyright IBM Corp. 2017, 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-153403
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
@@ -49,7 +49,7 @@ class VisualRecognitionV3 extends BaseService {
4949
* @param {Object} options - Options for the service.
5050
* @param {string} options.version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD
5151
* format. The current version is `2018-03-19`.
52-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.visual-recognition.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
52+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
5353
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5454
* @param {string} [options.serviceName] - The name of the service to configure
5555
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎visual-recognition/v4.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2019, 2020.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-153403
18+
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210507-162723
1919
*/
20-
20+
2121

2222
import * as extend from 'extend';
2323
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
@@ -50,7 +50,7 @@ class VisualRecognitionV4 extends BaseService {
5050
* @param {Object} options - Options for the service.
5151
* @param {string} options.version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD
5252
* format. The current version is `2019-02-11`.
53-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://api.us-south.visual-recognition.watson.cloud.ibm.com'). The base url may differ between IBM Cloud regions.
53+
* @param {string} [options.serviceUrl] - The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
5454
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5555
* @param {string} [options.serviceName] - The name of the service to configure
5656
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

0 commit comments

Comments
 (0)