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

feat: add search operator and fields arguments #321

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dopry
Copy link
Collaborator

@dopry dopry commented Mar 8, 2023

Add parameters for search_operator and search_fields when search is enabled on a query.

@dopry dopry force-pushed the feat/search_operator-and-fields branch 3 times, most recently from c3397c7 to ca511f9 Compare March 10, 2023 16:45
@dopry dopry force-pushed the feat/search_operator-and-fields branch from ca511f9 to 33e8135 Compare May 2, 2023 14:21
@dopry dopry force-pushed the feat/search_operator-and-fields branch 2 times, most recently from 8fabb87 to 3bf9d79 Compare May 12, 2023 03:10
@dopry
Copy link
Collaborator Author

dopry commented May 12, 2023

@zerolab what documentation are you looking for here? I added some inline the graphql type definitions so it shows up in graphiql.

@dopry dopry force-pushed the feat/search_operator-and-fields branch from 3bf9d79 to 6c79caf Compare May 12, 2023 03:16
@dopry dopry changed the title WIP feat: add search operator and fields arguments feat: add search operator and fields arguments May 12, 2023
@zerolab
Copy link
Member

zerolab commented May 12, 2023

I was thinking developer docs (e.g. https://wagtail-grapple.readthedocs.io/en/latest/general-usage/model-types.html) so it is not buried in code

@dopry
Copy link
Collaborator Author

dopry commented May 12, 2023

Are we creating documentation for consumers of of grapple or for grapple devs? We do not have any docs on the shared GraphQL Structures that this impacts and none of the enable_* options to the QuerySetList constructor or PaginatedQuerySet are exposed via the Decorators. I would propose the we create a new issue to document the structures... I feel like we need to document structures and how they are related to the decorators and GraphqlTypes... My understanding is that the structures are effectively base types for all of the generated GraphQL Types... so documenting those should probably go into GraphQL types. The new section of docs feels like a fairly large task on it's own... How do you feel about deferring this documentation effort to a separate task.... I found the current docs pretty intimidating as a new user and quite confusing... There is a lot of assumption that I would know what a field was and what the plural, singular, and paginated modified mean...

@zerolab
Copy link
Member

zerolab commented May 12, 2023

We want docs for both consumers and devs. For example, as an implementer/user I would like to know that I can change the search operator

Now, my previous comment was me cheekily hoping to get that started here 🙈
Happy for a separate task. We do need to rehaul the documentation and add a few other things (https://github.com/torchbox/wagtail-grapple/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) so happy for that to be handled as a follow up

@dopry
Copy link
Collaborator Author

dopry commented May 12, 2023

Alright I'll work on tests next week. :)

allow for more specific search queries by specifying the search_operator
and search_fields.
@dopry dopry force-pushed the feat/search_operator-and-fields branch from 6c79caf to 54ef10e Compare May 12, 2023 17:06
@zerolab
Copy link
Member

zerolab commented Sep 4, 2023

@dopry are you still keen to pursue this? We need some test, then I can do a full review/local testing pass and get it in

@dopry
Copy link
Collaborator Author

dopry commented Sep 15, 2023

@zerolab I am, but I'm just getting back to work after summer break. It'll take me a few weeks at least to catch up on client work before I can take on any OSS work.

@dopry
Copy link
Collaborator Author

dopry commented Oct 5, 2023

still on my radar, I'm wrapping up some work on django-oauth-toolkit that is a higher priority for me, so maybe a week or two out still.

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

Successfully merging this pull request may close these issues.

None yet

2 participants