Skip to content

Commit 6fac701

Browse files
committed
refactor: in discovery, rename getSourceCredentials to getCredentials
update ibm-cloud-sdk-core, which renames `getCredentials` to `getServiceCredentials` BREAKING CHANGE: These method renames are breaking changes. Update the method names to migrate your code.
1 parent ec601c5 commit 6fac701

File tree

6 files changed

+132
-123
lines changed

6 files changed

+132
-123
lines changed

UPGRADE-4.0.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
- [Breaking changes]
33
- [Methods no longer return stream]
44
- [Error Handling Compatibility]
5+
- [Default Methods Compatibility]
56
- [Removed Services]
67
- [Constructor Compatibility]
78
- [Assistant Compatibility]
@@ -42,6 +43,9 @@ The object returned is of class `Error` and has the following properties:
4243

4344
If a request is made but no response is received (very rare), `error.body` will be an instance of [HTTP.ClientRequest](https://nodejs.org/api/http.html#http_class_http_clientrequest).
4445

46+
### Default Methods Compatibility
47+
- The method `getCredentials`, which formerly returned an object containing all user credentials (username, password, etc.), has been renamed to `getServiceCredentials`
48+
4549
### Removed Services
4650
The following services have been deprecated for an extended period of time and will no longer be supported in the SDK:
4751
- Dialog
@@ -57,6 +61,9 @@ The following services have been deprecated for an extended period of time and w
5761
- Parameter name changed: `export` -> `_export` (_All instances_)
5862

5963
### Discovery Compatibility
64+
#### getSourceCredentials
65+
- Method name changed: `getSourceCredentials` -> `getCredentials`
66+
6067
#### getEnvironments
6168
- Method name changed: `getEnvironments` -> `listEnvironments`
6269

discovery/v1-generated.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3822,14 +3822,14 @@ class DiscoveryV1 extends BaseService {
38223822
* @param {Function} [callback] - The callback that handles the response.
38233823
* @returns {NodeJS.ReadableStream|void}
38243824
*/
3825-
public getSourceCredentials(params: DiscoveryV1.GetSourceCredentialsParams, callback?: DiscoveryV1.Callback<DiscoveryV1.Credentials>): Promise<any> | void {
3825+
public getCredentials(params: DiscoveryV1.GetCredentialsParams, callback?: DiscoveryV1.Callback<DiscoveryV1.Credentials>): Promise<any> | void {
38263826
const _params = extend({}, params);
38273827
const _callback = callback;
38283828
const requiredParams = ['environment_id', 'credential_id'];
38293829

38303830
if (!_callback) {
38313831
return new Promise((resolve, reject) => {
3832-
this.getSourceCredentials(params, (err, bod, res) => {
3832+
this.getCredentials(params, (err, bod, res) => {
38333833
err ? reject(err) : _params.return_response ? resolve(res) : resolve(bod);
38343834
});
38353835
});
@@ -3845,7 +3845,7 @@ class DiscoveryV1 extends BaseService {
38453845
'credential_id': _params.credential_id
38463846
};
38473847

3848-
const sdkHeaders = getSdkHeaders('discovery', 'v1', 'getSourceCredentials');
3848+
const sdkHeaders = getSdkHeaders('discovery', 'v1', 'getCredentials');
38493849

38503850
const parameters = {
38513851
options: {
@@ -5253,8 +5253,8 @@ namespace DiscoveryV1 {
52535253
return_response?: boolean;
52545254
}
52555255

5256-
/** Parameters for the `getSourceCredentials` operation. */
5257-
export interface GetSourceCredentialsParams {
5256+
/** Parameters for the `getCredentials` operation. */
5257+
export interface GetCredentialsParams {
52585258
/** The ID of the environment. */
52595259
environment_id: string;
52605260
/** The unique identifier for a set of source credentials. */

0 commit comments

Comments
 (0)