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

Validate API inputs #477

Open
2 of 3 tasks
diego-aquino opened this issue Nov 17, 2024 · 0 comments
Open
2 of 3 tasks

Validate API inputs #477

diego-aquino opened this issue Nov 17, 2024 · 0 comments
Labels
feature New feature or request good first issue Good for newcomers
Milestone

Comments

@diego-aquino
Copy link
Member

Prerequisites

  • I confirm that none of the open issues match my proposal
  • I confirm that my proposal is not yet available in the latest version of Zimic (see the documentation and the releases)

Scope

Adds a new behavior

Compatibility

  • This is a breaking change

Context

Zimic does not fully validate the inputs of the public API, such as checking if the parameters are of the expected types. We currently rely mostly on TypeScript to report such problems to users. However, this allows invalid values to be passed at runtime, possibly causing unexpected behavior.

Feature description

Zimic should validate each input to make sure it is correct, either being of the correct type or part of an expected enum.

@diego-aquino diego-aquino added feature New feature or request needs triage labels Nov 17, 2024
@diego-aquino diego-aquino added good first issue Good for newcomers and removed needs triage labels Nov 17, 2024
@diego-aquino diego-aquino added this to the v0.19.0 milestone Nov 17, 2024
@diego-aquino diego-aquino moved this to To do in Zimic Nov 17, 2024
@diego-aquino diego-aquino modified the milestones: v0.19.0, v0.20.0, v0.21.0 Dec 5, 2024
@diego-aquino diego-aquino modified the milestones: v0.20.0, v0.19.0 Dec 29, 2024
@diego-aquino diego-aquino modified the milestones: v0.19.0, v0.20.0 Jan 5, 2025
@diego-aquino diego-aquino modified the milestones: v0.19.0, v0.20.0, v0.21.0 Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers
Projects
Status: To do
Development

No branches or pull requests

1 participant