fix(discovery_v1): update status model

watson-developer-cloud · Sep 10, 2021 · bb69a7e · bb69a7e
1 parent f4579b4
commit bb69a7e
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 33 deletions.
diff --git a/discovery/v1.ts b/discovery/v1.ts
@@ -3792,9 +3792,8 @@ class DiscoveryV1 extends BaseService {
    * @param {CredentialDetails} [params.credentialDetails] - Object containing details of the stored credentials.
    *
    * Obtain credentials for your source from the administrator of the source.
-   * @param {string} [params.status] - The current status of this set of credentials. `connected` indicates that the
-   * credentials are available to use with the source configuration of a collection. `invalid` refers to the credentials
-   * (for example, the password provided has expired) and must be corrected before they can be used with a collection.
+   * @param {StatusDetails} [params.status] - Object that contains details about the status of the authentication
+   * process.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
    * @returns {Promise<DiscoveryV1.Response<DiscoveryV1.Credentials>>}
    */
@@ -3934,9 +3933,8 @@ class DiscoveryV1 extends BaseService {
    * @param {CredentialDetails} [params.credentialDetails] - Object containing details of the stored credentials.
    *
    * Obtain credentials for your source from the administrator of the source.
-   * @param {string} [params.status] - The current status of this set of credentials. `connected` indicates that the
-   * credentials are available to use with the source configuration of a collection. `invalid` refers to the credentials
-   * (for example, the password provided has expired) and must be corrected before they can be used with a collection.
+   * @param {StatusDetails} [params.status] - Object that contains details about the status of the authentication
+   * process.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
    * @returns {Promise<DiscoveryV1.Response<DiscoveryV1.Credentials>>}
    */
@@ -5413,11 +5411,8 @@ namespace DiscoveryV1 {
      *  Obtain credentials for your source from the administrator of the source.
      */
     credentialDetails?: CredentialDetails;
-    /** The current status of this set of credentials. `connected` indicates that the credentials are available to
-     *  use with the source configuration of a collection. `invalid` refers to the credentials (for example, the
-     *  password provided has expired) and must be corrected before they can be used with a collection.
-     */
-    status?: CreateCredentialsConstants.Status | string;
+    /** Object that contains details about the status of the authentication process. */
+    status?: StatusDetails;
     headers?: OutgoingHttpHeaders;
   }
 
@@ -5431,11 +5426,6 @@ namespace DiscoveryV1 {
       WEB_CRAWL = 'web_crawl',
       CLOUD_OBJECT_STORAGE = 'cloud_object_storage',
     }
-    /** The current status of this set of credentials. `connected` indicates that the credentials are available to use with the source configuration of a collection. `invalid` refers to the credentials (for example, the password provided has expired) and must be corrected before they can be used with a collection. */
-    export enum Status {
-      CONNECTED = 'connected',
-      INVALID = 'invalid',
-    }
   }
 
   /** Parameters for the `getCredentials` operation. */
@@ -5466,11 +5456,8 @@ namespace DiscoveryV1 {
      *  Obtain credentials for your source from the administrator of the source.
      */
     credentialDetails?: CredentialDetails;
-    /** The current status of this set of credentials. `connected` indicates that the credentials are available to
-     *  use with the source configuration of a collection. `invalid` refers to the credentials (for example, the
-     *  password provided has expired) and must be corrected before they can be used with a collection.
-     */
-    status?: UpdateCredentialsConstants.Status | string;
+    /** Object that contains details about the status of the authentication process. */
+    status?: StatusDetails;
     headers?: OutgoingHttpHeaders;
   }
 
@@ -5484,11 +5471,6 @@ namespace DiscoveryV1 {
       WEB_CRAWL = 'web_crawl',
       CLOUD_OBJECT_STORAGE = 'cloud_object_storage',
     }
-    /** The current status of this set of credentials. `connected` indicates that the credentials are available to use with the source configuration of a collection. `invalid` refers to the credentials (for example, the password provided has expired) and must be corrected before they can be used with a collection. */
-    export enum Status {
-      CONNECTED = 'connected',
-      INVALID = 'invalid',
-    }
   }
 
   /** Parameters for the `deleteCredentials` operation. */
@@ -5777,11 +5759,8 @@ namespace DiscoveryV1 {
      *  Obtain credentials for your source from the administrator of the source.
      */
     credential_details?: CredentialDetails;
-    /** The current status of this set of credentials. `connected` indicates that the credentials are available to
-     *  use with the source configuration of a collection. `invalid` refers to the credentials (for example, the
-     *  password provided has expired) and must be corrected before they can be used with a collection.
-     */
-    status?: string;
+    /** Object that contains details about the status of the authentication process. */
+    status?: StatusDetails;
   }
 
   /** Object containing array of credential definitions. */
@@ -6819,6 +6798,14 @@ namespace DiscoveryV1 {
     next_crawl?: string;
   }
 
+  /** Object that contains details about the status of the authentication process. */
+  export interface StatusDetails {
+    /** Indicates whether the credential is accepted by the target data source. */
+    authentication?: boolean;
+    /** If `authentication` is `false`, a message describes why the authentication was unsuccessful. */
+    error_message?: string;
+  }
+
   /** An object defining a single tokenizaion rule. */
   export interface TokenDictRule {
     /** The string to tokenize. */

diff --git a/test/unit/discovery.v1.test.js b/test/unit/discovery.v1.test.js
@@ -4890,12 +4890,18 @@ describe('DiscoveryV1', () => {
         secret_access_key: 'testString',
       };
 
+      // StatusDetails
+      const statusDetailsModel = {
+        authentication: true,
+        error_message: 'testString',
+      };
+
       test('should pass the right params to createRequest', () => {
         // Construct the params object for operation createCredentials
         const environmentId = 'testString';
         const sourceType = 'box';
         const credentialDetails = credentialDetailsModel;
-        const status = 'connected';
+        const status = statusDetailsModel;
         const params = {
           environmentId: environmentId,
           sourceType: sourceType,
@@ -5067,13 +5073,19 @@ describe('DiscoveryV1', () => {
         secret_access_key: 'testString',
       };
 
+      // StatusDetails
+      const statusDetailsModel = {
+        authentication: true,
+        error_message: 'testString',
+      };
+
       test('should pass the right params to createRequest', () => {
         // Construct the params object for operation updateCredentials
         const environmentId = 'testString';
         const credentialId = 'testString';
         const sourceType = 'box';
         const credentialDetails = credentialDetailsModel;
-        const status = 'connected';
+        const status = statusDetailsModel;
         const params = {
           environmentId: environmentId,
           credentialId: credentialId,