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

search endpoint #289

Closed
fasterthanlime opened this issue Dec 20, 2015 · 14 comments
Closed

search endpoint #289

fasterthanlime opened this issue Dec 20, 2015 · 14 comments

Comments

@fasterthanlime
Copy link
Collaborator

Separate endpoints for users, tags, and games:

/api/1/search/games?q=TERM

etc. — so we can run concurrent queries

all paginated

games format is well-defined already

tags you can pretty much dump the model (description if there is one, etc.)

users, same as what there is in user fields in game response?

@fasterthanlime
Copy link
Collaborator Author

feel free to break down in separate issues

@leafo
Copy link
Member

leafo commented Dec 20, 2015

  • why paginated? do we ever get valuable results past the top 30?
  • why separate endpoints? it will probably be much faster to mimic the web with one search endpoint

@fasterthanlime
Copy link
Collaborator Author

do we ever get valuable results past the top 30?

yes because our current ranking could, uh, use some improvement. look at how jimsterling is doing itch.io tasty, he's definitely going past page 1

there's "targeted" searches where you're looking for 1 game, in which case it should definitely be in top 10 (first google page), and larger searches where you want everything that has to do with "word X" (yes, tags and categories and whatever exist but people use search for everything nowadays and I don't think they're wrong)

why separate endpoints? it will probably be much faster to mimic the web with one search endpoint

so we can paginate those separately? they're separate DB queries anyway.

@leafo
Copy link
Member

leafo commented Dec 20, 2015

I do agree that our current search isn't the best. For topic searches we should be figuring out how to get people to the respective topic page, the browsing experience will always be better. For direct matches there should never be more than a handful of relevant results so pagination is less important.

@leafo
Copy link
Member

leafo commented Dec 21, 2015

@Mrmaxmeier
Copy link

Currently /api/1/me/search/games requires an api key via cookie.
Could you move it to /api/1/<key>/me/search/games or add something like /api/1/search/games without requiring an api key?

@fasterthanlime
Copy link
Collaborator Author

@Mrmaxmeier /me is a fragment you can use instead of your api key :)

@fasterthanlime
Copy link
Collaborator Author

@Mrmaxmeier so the real endpoint is /api/1/<key>/search/games

@Mrmaxmeier
Copy link

@fasterthanlime whoops, I should've tried that.

@fasterthanlime
Copy link
Collaborator Author

@Mrmaxmeier if you're working on search functionality in your fork, can you open an early PR so we can discuss it in the open and minimize duplicated effort ?

@Mrmaxmeier
Copy link

@fasterthanlime sure, opened it in itchio/itch #231

@fasterthanlime
Copy link
Collaborator Author

API has game & creator search, I consider this closed.

(For now!)

@Enissay
Copy link

Enissay commented May 26, 2016

@fasterthanlime a link please ?

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

4 participants