path-query

Id

@typespec/openapi3/path-query

The OpenAPI v3 specification requires query parameters to be defined separately from the path. A @route whose path embeds a query string (e.g. /users?filter={filter}) cannot be represented and results in an error.

How to fix

Keep the @route path free of query parameters and declare them with @query, or use a URI template such as /users{?filter}.

Incorrect

@route("/users?filter={filter}")
op getUsers(filter: string): User[];

Correct

@route("/users")
op getUsers(@query filter?: string): User[];