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

Schema parameter not really optional #2575

Closed
gejohnston opened this issue Nov 15, 2023 · 2 comments · Fixed by #2659
Closed

Schema parameter not really optional #2575

gejohnston opened this issue Nov 15, 2023 · 2 comments · Fixed by #2659
Assignees
Labels
dev-docs documentation delivered by developer enhancement New feature or request priority-high Production outage - this quarter or at least next quarter v3

Comments

@gejohnston
Copy link
Member

Is your feature request related to a problem? Please describe.

When a ZE extension uses an existing API to register its profile types, a 'schema' parameter is identified as optional. Unless that 'schema' parameter is specified, the ZE extension cannot later retrieve its profiles.

Describe the solution you'd like

Clarify the API requirements.

Describe alternatives you've considered

  • Make the schema parameter required.
  • If there are legitimate use-cases for not supplying the 'schema' parameter, document the API to identify when and why the caller should supply a 'schema' parameter.

Additional context

@gejohnston gejohnston added the enhancement New feature or request label Nov 15, 2023
Copy link

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

@zFernand0 zFernand0 added the dev-docs documentation delivered by developer label Nov 16, 2023
@JillieBeanSim JillieBeanSim added this to the v3 pre-releases milestone Jan 5, 2024
@JillieBeanSim
Copy link
Contributor

adding v3 label since change from optional to required will be a breaking change but agree it should be done

@JTonda JTonda added the priority-high Production outage - this quarter or at least next quarter label Jan 9, 2024
@JTonda JTonda moved this from New Issues to High Priority in Zowe Explorer for VS Code Jan 9, 2024
@JillieBeanSim JillieBeanSim self-assigned this Jan 11, 2024
@JillieBeanSim JillieBeanSim moved this from High Priority to In Progress in Zowe Explorer for VS Code Jan 11, 2024
@JillieBeanSim JillieBeanSim linked a pull request Jan 12, 2024 that will close this issue
16 tasks
@github-project-automation github-project-automation bot moved this from In Progress to Closed in Zowe Explorer for VS Code Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-docs documentation delivered by developer enhancement New feature or request priority-high Production outage - this quarter or at least next quarter v3
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants