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

Support for query string parameters #1058

Closed
maurei opened this issue Sep 1, 2021 · 2 comments
Closed

Support for query string parameters #1058

maurei opened this issue Sep 1, 2021 · 2 comments
Labels

Comments

@maurei
Copy link
Member

maurei commented Sep 1, 2021

The current OpenApi integration does not support any query parameters. The task is to describe the standard JsonApiDotNetCore query features as query parameters in the OAS:

  • filtering
  • sorting
  • including
  • pagination
  • field selection

A first effort would be to add all parameters as string key-value pairs. So far two possible directions for a solution have been identified:

  • Instantiating a customized ControllerParameterDescriptor and adding it to ActionDescriptor.Parameters, using the metadata mechanism we have built in the core of the OpenApi integration.
  • Post-processing using a Swashbuckle IOperationFilter.
@maurei maurei added the OpenAPI label Sep 1, 2021
@bart-degreed bart-degreed changed the title Support for query parameters Support for query string parameters Sep 27, 2021
@bkoelman
Copy link
Member

bkoelman commented Sep 28, 2022

This should also take [AttrCapabilities] into account.

@bkoelman
Copy link
Member

Should take [DisableQueryString] on controllers into account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants