@zowe/zowe-explorer-api
TypeScript icon, indicating that this package has built-in type declarations

3.2.1 • Public • Published

Extensibility API for Zowe Explorer

version downloads

Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the Zowe Explorer VS Code extension with alternative z/OS interaction protocols and new capabilities. These capabilities are built for use in (and alongside) Zowe Explorer, and include: tree view management, Zowe profiles and security assistance, UI functions and logging utilities.

The following kinds of extensions can be certified as compliant for Zowe Explorer. Check out the v3 Conformance Program for the specific criteria.

Extension offerings need to comply with the General requirements category along with at least one of the other following categories.

  1. General requirements: VS Code extensions that utilize Zowe Explorer resources in any way must meet all general requirements.
  2. Leverage team configuration: An extension that accesses Zowe Explorer's profile cache to utilize or manage profiles.
  3. Data Provider: An extension that provides an alternative profile type for a different z/OS communication protocol for one or more Zowe Explorer views.
  4. Menus: An extension that contributes menus to Zowe Explorer tree views and/or accesses contextual information from the trees.

Examples of extenders of the Zowe Explorer VS Code extension include the IBM z/OS FTP for Zowe Explorer and IBM CICS for Zowe Explorer VS Code extension, as well as several commercial extensions.

For more information about extending Zowe Explorer via the Extensibility API for Zowe Explorer, check out the Extending Zowe Explorer wiki page.

Providing feedback or help contributing

Extensibility API for Zowe Explorer is part of the Zowe Explorer monorepo on Github. You find the sources there in the /packages/zowe-explorer-api sub-folder.

To submit a bug report or enhancement request, open an issue in the Zowe Explorer repository.

Readme

Keywords

none

Package Sidebar

Install

npm i @zowe/zowe-explorer-api

Weekly Downloads

620

Version

3.2.1

License

EPL-2.0

Unpacked Size

619 kB

Total Files

187

Last publish

Collaborators

  • joe_winchester
  • zowerobot
  • markackertbroadcom