Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Tracked by #2070
gejohnston opened this issue Mar 8, 2024 · 1 comment
Open
Tracked by #2070

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

gejohnston opened this issue Mar 8, 2024 · 1 comment
Labels
enhancement New feature or request new The issue wasn't triaged yet priority-medium Not functioning - next quarter if capacity permits

Comments

@gejohnston
Copy link
Member

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.

@gejohnston gejohnston added enhancement New feature or request priority-medium Not functioning - next quarter if capacity permits new The issue wasn't triaged yet labels Mar 8, 2024
Copy link

github-actions bot commented Mar 8, 2024

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.

@adam-wolfe adam-wolfe mentioned this issue Apr 11, 2024
23 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request new The issue wasn't triaged yet priority-medium Not functioning - next quarter if capacity permits
Projects
Status: Medium Priority
Development

No branches or pull requests

1 participant