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

Restrict complex objects in path & query params in Wirespec syntax #318

Open
nsmnds opened this issue Jan 17, 2025 · 0 comments
Open

Restrict complex objects in path & query params in Wirespec syntax #318

nsmnds opened this issue Jan 17, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@nsmnds
Copy link
Contributor

nsmnds commented Jan 17, 2025

Currently a user can define complex types in path or query params. This can lead to (unwanted) constructs like:

type Todo {
  name: String,
  isDone: Boolean
}

endpoint CreateTodo POST /todos/{todo: Todo} -> {
  201 -> Unit
}

There are also use cases where it makes more sense, for example for pagination parameters which then be re-used across endpoints. However we see this as an edge-case if we would support this the complexity of the serializers would explode.

Therefore we've decided to restrict this in the syntax.

@nsmnds nsmnds added the enhancement New feature or request label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant