rhodecode-enterprise-ce Files · docs/api/methods/search-methods.rst

artifacts: expose a special auth-token based artifacts download urls....

artifacts: expose a special auth-token based artifacts download urls. This will allow sharing download to external locations used new generated artifact download tokens. This feature allows also serving downloads using secret urls with all the fancy logic of our auth tokens.

marcink - - Load All Authors

File last commit:

r3693:f470fd2e new-ui


                r4003:09f31efc

default

Download file

             search-methods.rst
        
                    35 lines
            
             | 1.1 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / api / methods / search-methods.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        marcink
    
docs: updated documentation structure

              r3693
            
      .. _search-methods-ref:

      search methods

      ==============

      search 

      ------

      .. py:function:: search(apiuser, search_query, search_type, page_limit=<Optional:10>, page=<Optional:1>, search_sort=<Optional:'newfirst'>, repo_name=<Optional:None>, repo_group_name=<Optional:None>)

         Fetch Full Text Search results using API.

         :param apiuser: This is filled automatically from the |authtoken|.

         :type apiuser: AuthUser

         :param search_query: Search query.

         :type search_query: str

         :param search_type: Search type. The following are valid options:

             * commit

             * content

             * path

         :type search_type: str

         :param page_limit: Page item limit, from 1 to 500. Default 10 items.

         :type page_limit: Optional(int)

         :param page: Page number. Default first page.

         :type page: Optional(int)

         :param search_sort: Search sort order. Default newfirst. The following are valid options:

             * newfirst

             * oldfirst

         :type search_sort: Optional(str)

         :param repo_name: Filter by one repo. Default is all.

         :type repo_name: Optional(str)

         :param repo_group_name: Filter by one repo group. Default is all.

         :type repo_group_name: Optional(str)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

marcink docs: updated documentation structure	r3693	.. _search-methods-ref:

		search methods
		==============

		search
		------

		.. py:function:: search(apiuser, search_query, search_type, page_limit=<Optional:10>, page=<Optional:1>, search_sort=<Optional:'newfirst'>, repo_name=<Optional:None>, repo_group_name=<Optional:None>)

		Fetch Full Text Search results using API.

		:param apiuser: This is filled automatically from the \|authtoken\|.
		:type apiuser: AuthUser
		:param search_query: Search query.
		:type search_query: str
		:param search_type: Search type. The following are valid options:
		* commit
		* content
		* path
		:type search_type: str
		:param page_limit: Page item limit, from 1 to 500. Default 10 items.
		:type page_limit: Optional(int)
		:param page: Page number. Default first page.
		:type page: Optional(int)
		:param search_sort: Search sort order. Default newfirst. The following are valid options:
		* newfirst
		* oldfirst
		:type search_sort: Optional(str)
		:param repo_name: Filter by one repo. Default is all.
		:type repo_name: Optional(str)
		:param repo_group_name: Filter by one repo group. Default is all.
		:type repo_group_name: Optional(str)