refactor(ClustersClient): rename credentialId parameter to clusterId#568
Open
CalvinMagezi wants to merge 10 commits intomicrosoft:mainfrom
Open
refactor(ClustersClient): rename credentialId parameter to clusterId#568CalvinMagezi wants to merge 10 commits intomicrosoft:mainfrom
CalvinMagezi wants to merge 10 commits intomicrosoft:mainfrom
Conversation
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.23 to 4.18.1. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.23...4.18.1) --- updated-dependencies: - dependency-name: lodash dependency-version: 4.18.1 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>
Bumps [handlebars](https://github.com/handlebars-lang/handlebars.js) from 4.7.8 to 4.7.9. - [Release notes](https://github.com/handlebars-lang/handlebars.js/releases) - [Changelog](https://github.com/handlebars-lang/handlebars.js/blob/v4.7.9/release-notes.md) - [Commits](handlebars-lang/handlebars.js@v4.7.8...v4.7.9) --- updated-dependencies: - dependency-name: handlebars dependency-version: 4.7.9 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>
Bumps [lodash](https://github.com/lodash/lodash) to 4.18.1 and updates ancestor dependency [@microsoft/api-extractor](https://github.com/microsoft/rushstack/tree/HEAD/apps/api-extractor). These dependencies need to be updated together. Updates `lodash` from 4.17.23 to 4.18.1 - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.23...4.18.1) Updates `@microsoft/api-extractor` from 7.52.8 to 7.58.1 - [Changelog](https://github.com/microsoft/rushstack/blob/main/apps/api-extractor/CHANGELOG.md) - [Commits](https://github.com/microsoft/rushstack/commits/@microsoft/api-extractor_v7.58.1/apps/api-extractor) --- updated-dependencies: - dependency-name: lodash dependency-version: 4.18.1 dependency-type: indirect - dependency-name: "@microsoft/api-extractor" dependency-version: 7.58.1 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com>
…mprove setup instructions
…ns, multi-platform stubs (microsoft#565)
Renames the `credentialId` parameter to `clusterId` in: - `ClustersClient.exists()` and `ClustersClient.deleteClient()` (~6 occurrences) - `ClusterSession.initNewSession()` parameter and JSDoc The parameter has always referred to a cluster identifier, not a credential object. This is a pure cosmetic rename with no logic changes. Closes microsoft#567
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #567
This PR renames the
credentialIdparameter toclusterIdin two files:src/documentdb/ClustersClient.ts—exists()anddeleteClient()methods (~6 occurrences)src/documentdb/ClusterSession.ts—initNewSession()method signature and JSDocThe parameter has always represented a cluster identifier, not a credential object. The old name was a source of confusion since it implied something credential-related. This aligns the parameter name with what the JSDoc already called it (
clusterId).Changes
Testing
No functional changes — existing tests continue to pass without modification.