Use another endpoint

Author: stsewd

docs/server-side-search.rst

@@ -69,13 +69,13 @@ API
 ---
 
 Search is exposed through our API that's proxied from the domain where your docs are being served.
-This is ``https://docs.readthedocs.io/_/api/v2/docsearch`` for the ``docs`` project, for example.
+This is ``https://docs.readthedocs.io/_/api/v2/search`` for the ``docs`` project, for example.
 
 .. warning::
 
    This API isn't stable yet, some small things may change in the future.
 
-.. http:get:: /_/api/v2/docsearch/
+.. http:get:: /_/api/v2/search/
 
    Return a list of search results for a project,
    including results from its :doc:`/subprojects`.
@@ -112,12 +112,12 @@ This is ``https://docs.readthedocs.io/_/api/v2/docsearch`` for the ``docs`` proj
 
       .. code-tab:: bash
 
-         $ curl "https://docs.readthedocs.io/_/api/v2/docsearch/?project=docs&version=latest&q=server%20side%20search"
+         $ curl "https://docs.readthedocs.io/_/api/v2/search/?project=docs&version=latest&q=server%20side%20search"
 
       .. code-tab:: python
 
          import requests
-         URL = 'https://docs.readthedocs.io/_/api/v2/docsearch/'
+         URL = 'https://docs.readthedocs.io/_/api/v2/search/'
          params = {
             'q': 'server side search',
             'project': 'docs',
@@ -132,7 +132,7 @@ This is ``https://docs.readthedocs.io/_/api/v2/docsearch`` for the ``docs`` proj
 
       {
           "count": 41,
-          "next": "https://docs.readthedocs.io/api/v2/docsearch/?page=2&project=read-the-docs&q=server+side+search&version=latest",
+          "next": "https://docs.readthedocs.io/api/v2/search/?page=2&project=read-the-docs&q=server+side+search&version=latest",
           "previous": null,
           "results": [
               {
@@ -164,8 +164,8 @@ This is ``https://docs.readthedocs.io/_/api/v2/docsearch`` for the ``docs`` proj
                      {
                         "type": "domain",
                         "role": "http:get",
-                        "name": "/_/api/v2/docsearch/",
-                        "id": "get--_-api-v2-docsearch-",
+                        "name": "/_/api/v2/search/",
+                        "id": "get--_-api-v2-search-",
                         "content": "Retrieve search results for docs",
                         "highlights": {
                            "name": [""],

readthedocs/api/v2/proxied_urls.py

@@ -14,6 +14,7 @@
 api_footer_urls = [
     url(r'footer_html/', ProxiedFooterHTML.as_view(), name='footer_html'),
     url(r'docsearch/$', ProxiedPageSearchAPIView.as_view(), name='doc_search'),
+    url(r'search/$', ProxiedPageSearchAPIView.as_view(new_api=True), name='search_api'),
 ]
 
 urlpatterns = api_footer_urls

readthedocs/core/static-src/core/js/doc-embed/search.js

@@ -49,9 +49,9 @@ function attach_elastic_search_query_sphinx(data) {
         var search_def = $.Deferred();
         var search_url = document.createElement('a');
 
-        search_url.href = data.proxied_api_host + '/api/v2/docsearch/';
+        search_url.href = data.proxied_api_host + '/api/v2/search/';
         search_url.search = '?q=' + $.urlencode(query) + '&project=' + project +
-                            '&version=' + version + '&language=' + language + '&new-api=true';
+                            '&version=' + version + '&language=' + language;
 
         search_def
             .then(function (data) {
@@ -273,9 +273,9 @@ function attach_elastic_search_query_mkdocs(data) {
         var search_def = $.Deferred();
 
         var search_url = document.createElement('a');
-        search_url.href = data.proxied_api_host + '/api/v2/docsearch/';
+        search_url.href = data.proxied_api_host + '/api/v2/search/';
         search_url.search = '?q=' + encodeURIComponent(query) + '&project=' + project +
-                            '&version=' + version + '&language=' + language + '&new-api=true';
+                            '&version=' + version + '&language=' + language;
 
         search_def
             .then(function (data) {

readthedocs/core/static/core/js/readthedocs-doc-embed.js

@@ -194,9 +194,9 @@ class PageSearchAPIView(GenericAPIView):
     - project
     - version
 
-    Optional params:
+    Optional params from the view:
 
-    - new-api (true/false): make use of the new stable API.
+    - new_api (true/false): Make use of the new stable API.
       Defaults to false. Remove after a couple of days/weeks
       and always use the new API.
 
@@ -209,6 +209,7 @@ class PageSearchAPIView(GenericAPIView):
     http_method_names = ['get']
     permission_classes = [IsAuthorizedToViewVersion]
     pagination_class = SearchPagination
+    new_api = False
 
     def _get_project(self):
         cache_key = '_cached_project'
@@ -371,7 +372,7 @@ def get_queryset(self):
         return queryset
 
     def get_serializer_class(self):
-        if self.request.query_params.get('new-api', 'false') == 'true':
+        if self.new_api:
             return PageSearchSerializer
         return OldPageSearchSerializer
 

readthedocs/search/api.py

@@ -33,11 +33,9 @@ def setup_method(self, method):
         # This reverse needs to be inside the ``setup_method`` method because from
         # the Corporate site we don't define this URL if ``-ext`` module is not
         # installed
-        self.url = reverse('doc_search')
+        self.url = reverse('search_api')
 
     def get_search(self, api_client, search_params):
-        # TODO: remove once the api is stable
-        search_params['new-api'] = 'true'
         return api_client.get(self.url, search_params)
 
     @pytest.mark.parametrize('page_num', [0, 1])

readthedocs/search/tests/test_api.py

@@ -20,7 +20,7 @@ def setup_class(cls):
         # This reverse needs to be inside the ``setup_class`` method because from
         # the Corporate site we don't define this URL if ``-ext`` module is not
         # installed
-        cls.url = reverse('doc_search')
+        cls.url = reverse('search_api')
 
     def test_search_query_recorded_when_results_not_zero(self, api_client):
         """Test if search query is recorded in a database when a search is made."""

readthedocs/search/tests/test_search_tasks.py

@@ -51,6 +51,7 @@
     url(r'^api/v2/', include('readthedocs.api.v2.urls')),
     # Keep the `doc_search` at root level, so the test does not fail for other API
     url(r'^api/v2/docsearch/$', PageSearchAPIView.as_view(), name='doc_search'),
+    url(r'^api/v2/search/$', PageSearchAPIView.as_view(new_api=True), name='search_api'),
     url(
         r'^api-auth/',
         include('rest_framework.urls', namespace='rest_framework')