Skip to content

Project Search API #2355

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

Closed
Kapeli opened this issue Aug 5, 2016 · 2 comments
Closed

Project Search API #2355

Kapeli opened this issue Aug 5, 2016 · 2 comments

Comments

@Kapeli
Copy link

Kapeli commented Aug 5, 2016

Is there any API to search for projects by name? If not, could this be added?

Alternatively, is it ok if I cache the list of projects (as returned by https://read-the-docs.readthedocs.io/en/latest/api.html#projects) on my servers and implement my own search?

This is related to: #662 (comment).

@berkerpeksag
Copy link
Member

If I read https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/restapi/views/search_views.py correctly, it's not possible to search for projects by name. You'll need to provide both q and project (project slug) parameters. Perhaps we can make project_search to search for project name or slug.

(Note that API v1 is being replaced by API v2.)

@humitos
Copy link
Member

humitos commented May 28, 2017

@Kapeli you can search project by name using this endpoint:

http "https://readthedocs.org/api/v2/search/project/?q=turtle"

I'm closing this issue since I think it's solved. Please, re open if you consider.

@humitos humitos closed this as completed May 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants