Skip to content

Commit

Permalink
adjust links for npmjs
Browse files Browse the repository at this point in the history
Signed-off-by: adam-wolfe <[email protected]>
  • Loading branch information
adam-wolfe committed Dec 18, 2024
1 parent 09bb653 commit 1374f9e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/zowe-explorer-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities.

Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions.
Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](/packages/zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions.

The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access.

Expand All @@ -21,9 +21,9 @@ The `/profiles` module has no dependency to VS Code and could be used in Zowe CL
import { ZoweExplorerApi } from "@zowe/zowe-explorer-api/lib/profiles";
```

The main API provided by the `/profiles` module is called `ZoweExplorerApi`. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in [packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpApi.ts](../zowe-explorer-ftp-extension/src/ZoweExplorerFtpApi.ts). The `/profiles` module itself contains Zowe Explorer's default implementation using z/OSMF in [packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts](./src/profiles/ZoweExplorerZosmfApi.ts)
The main API provided by the `/profiles` module is called `ZoweExplorerApi`. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in [packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts](/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts). The `/profiles` module itself contains Zowe Explorer's default implementation using z/OSMF in [packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts](/packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts)

Zowe Explorer itself exports a `IApiRegisterClient` object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in [packages/zowe-explorer-ftp-extension/src/extension.ts](../zowe-explorer-ftp-extension/src/extension.ts). To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's `package.json` must contain
Zowe Explorer itself exports a `IApiRegisterClient` object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in [packages/zowe-explorer-ftp-extension/src/extension.ts](/packages/zowe-explorer-ftp-extension/src/extension.ts). To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's `package.json` must contain

```json
"extensionDependencies": [
Expand Down Expand Up @@ -51,4 +51,4 @@ See this [special extension document](https://github.com/zowe/zowe-explorer-vsco

Extensibility API for Zowe Explorer is part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/zowe-explorer-vscode). You find the sources there in the `/packages/zowe-explorer-api` sub-folder.

To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/zowe-explorer-vscode/issues) after reviewing the [API Roadmap item](https://github.com/zowe/zowe-explorer-vscode/issues/837).
To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/zowe-explorer-vscode/issues).

0 comments on commit 1374f9e

Please sign in to comment.