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 "filterX or groups" on OpenApi #571

Open
jtoberling opened this issue Sep 1, 2019 · 1 comment
Open

Support for "filterX or groups" on OpenApi #571

jtoberling opened this issue Sep 1, 2019 · 1 comment
Assignees

Comments

@jtoberling
Copy link

As far as I see V2 also supports "or filter groups" via parameter filterX but OpenApi currently displays V1 like "filter" possibility.

Would it be possible to implement V2 filterX groups on OpenAPI as an enhancement?

I see two possible ways:

  • Add filter1, filter2 ... besides standard "filter" generated API and describe on docs how to use,
  • Implement OpenAPI free-form query parameter

I would be happy to implement - but which should be the preferred? Or should be this feature discarded in upstream? Or did I miss something and there is already a way on OpenApi to specify these groups?

@mevdschee mevdschee self-assigned this Sep 1, 2019
@mevdschee
Copy link
Owner

mevdschee commented Sep 1, 2019

Thank you for reaching out.

Would it be possible to implement V2 filterX groups on OpenAPI as an enhancement?

I don't think OAS supports such structures.

I would be happy to implement

That is great!

  • but which should be the preferred?

I think the "OpenAPI free-form query parameter" is not suitable as it is way too "free".

So I feel "adding filter1, filter2, besides standard filter" is the best option.

But I'm afraid that when you add all options it will be too verbose.

Or should be this feature discarded in upstream?

What do you mean by that?

Or did I miss something and there is already a way on OpenApi to specify these groups?

Not that I'm aware of.

jonasborn added a commit to jonasborn/php-crud-api that referenced this issue Jul 16, 2023
jonasborn added a commit to jonasborn/php-crud-api that referenced this issue Jul 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants