review: Added deprecation notice to the encoding property in the IZow…

…eUSSTreeNode interface Signed-off-by: zFernand0 <[email protected]>
zowe · Aug 6, 2024 · e732689 · e732689
1 parent f5f10f4
commit e732689
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/packages/zowe-explorer-api/CHANGELOG.md b/packages/zowe-explorer-api/CHANGELOG.md
@@ -39,11 +39,13 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
 - Added the `onVaultUpdate` VSCode event to notify extenders when credentials are updated on the OS vault by other applications. [#2994](https://github.com/zowe/zowe-explorer-vscode/pull/2994)
 - Added the `onCredMgrsUpdate` VSCode event to notify extenders when the local PC's credential manager has been updated by other applications. [#2994](https://github.com/zowe/zowe-explorer-vscode/pull/2994)
 - **LTS Breaking:** Updated most function signatures for exported programmatic interfaces. Changes make developing with the Zowe Explorer API more efficient for extenders by showing which properties they can expect when calling our APIs. [#2952](https://github.com/zowe/zowe-explorer-vscode/issues/2952)
+
   - Updated `IApiExplorerExtender.ts`, see changes below:
     - Allowed `reloadProfiles` and `initForZowe` to be synchronous methods (non-breaking)
   - Updated `MainframeInteraction.ts`, see changes below:
     - Modified `getStatus` to add `string` type to the optional parameter `profileType`
   - Updated `IZoweTree.ts`, see changes below:
+
     - Modified `checkCurrentProfile(node: IZoweTreeNode);` to return `Validation.IValidationProfile | Promise<Validation.IValidationProfile>`
     - Modified `getSearchHistory()` to return `string[]`
     - Modified `getAllLoadedItems()` to return `IZoweTreeNode[] | Promise<IZoweTreeNode[]>`
@@ -61,31 +63,32 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
       - `removeFavorite`
       - `removeFavProfile`
       - `onDidChangeConfiguration`
-      - `flipState` *synchronous - no `Promise` returned*
+      - `flipState` _synchronous - no `Promise` returned_
       - `rename`
       - `open`
       - `copy`
       - `paste`
       - `delete`
-      - `setItem` *synchronous - no `Promise` returned*
+      - `setItem` _synchronous - no `Promise` returned_
       - `saveSearch`
       - `saveFile`
       - `refreshPS`
       - `uploadDialog`
       - `filterPrompt`
-      - `addSearchHistory` *synchronous - no `Promise` returned*
-      - `deleteSession` *synchronous - no `Promise` returned*
+      - `addSearchHistory` _synchronous - no `Promise` returned_
+      - `deleteSession` _synchronous - no `Promise` returned_
       - `updateFavorites`
       - `renameFavorite`
-      - `addFileHistory` *synchronous - no `Promise` returned*
-      - `removeFileHistory` *synchronous - no `Promise` returned*
+      - `addFileHistory` _synchronous - no `Promise` returned_
+      - `removeFileHistory` _synchronous - no `Promise` returned_
       - `renameNode`
       - `openItemFromPath`
       - `addDsTemplate`
       - `pollData`
       - `openWithEncoding`
 
     **Note**: Developers should not expect a value to be returned from the methods above (breaking)
+
   - Updated `IZoweTreeNode.ts`, see changes below:
     - Modified `rename?(newNamePath: string);` to return `Promise<IZosFilesResponse>`
     - Developers should not be expecting output from the following methods:

diff --git a/packages/zowe-explorer-api/src/tree/IZoweTreeNode.ts b/packages/zowe-explorer-api/src/tree/IZoweTreeNode.ts
@@ -254,7 +254,12 @@ export interface IZoweUSSTreeNode extends IZoweTreeNode {
     shortLabel?: string;
 
     /**
-     * Encoding indicator.
+     * @deprecated Please use `setEncoding` and `getEncoding` instead.
+     *
+     * Remote encoding of the USS file
+     *
+     * * `null` = user selected z/OS default codepage
+     * * `undefined` = user did not specify
      */
     encoding?: string;