search

zowe / zowe-cli

Zowe CLI
Eclipse Public License 2.0
108 stars 85 forks source link

V3: Mark non-consumer Zowe CLI SDK APIs as @internal #2083

Closed gejohnston closed 2 weeks ago

gejohnston commented 3 months ago

Is your feature or enhancement request related to a problem or limitation? Please describe

Many APIs are public so that they can be used by other SDK classes. However, once public, those APIs cannot be modified without introducing a breaking change. This can cause significant technical debt to build up leading into a new major Zowe release, such as postponed modifications, duplicated functions, deprecation and later removal.

Describe your enhancement idea

Review the SDK APIs and mark functions that are not intended to be used by external consumers as @internal. Such modifications will be a breaking change, so this work would have to be done before the release of Zowe V3.

If consumers request that an @internal function be made externally available, that action could be taken at any later time, since that action would NOT be a breaking change.

Describe alternatives you've considered

Provide any additional context

Marked as a medium priority since it either must be done before Zowe V3 or postponed for years.

github-actions[bot] commented 3 months ago

Thank you for raising this enhancement request. The community has 90 days to vote on it. If the enhancement receives at least 5 upvotes, it is added to our development backlog. If it receives fewer votes, the issue is closed.

github-actions[bot] commented 3 weeks ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

awharn commented 2 weeks ago

Completed as part of #2159