github.com/rpdict/ponzu@v0.10.1-0.20190226054626-477f29d6bf5e/docs/build/HTTP-APIs/Search/index.html (about)

     1  
     2  <!DOCTYPE html>
     3  <html lang="en" class="no-js">
     4    <head>
     5      
     6        <meta charset="utf-8">
     7        <meta name="viewport" content="width=device-width,initial-scale=1">
     8        
     9        
    10        
    11        
    12          <link rel="shortcut icon" href="../../assets/images/favicon.png">
    13        
    14        <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.6.1">
    15      
    16      
    17        
    18          <title>Full-text Search HTTP API</title>
    19        
    20      
    21      
    22        <script src="../../assets/javascripts/modernizr-56ade86843.js"></script>
    23      
    24      
    25        <link rel="stylesheet" href="../../assets/stylesheets/application-4d0d3f2fbf.css">
    26        
    27          <link rel="stylesheet" href="../../assets/stylesheets/application-f78e5cb881.palette.css">
    28        
    29      
    30      
    31        
    32          
    33          
    34          
    35          <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
    36          <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
    37        
    38        <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
    39      
    40      
    41      
    42    </head>
    43    
    44    
    45    
    46    
    47      <body data-md-color-primary="grey" data-md-color-accent="light-blue">
    48    
    49      <svg class="md-svg">
    50        <defs>
    51          
    52          
    53            <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
    54          
    55        </defs>
    56      </svg>
    57      <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
    58      <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
    59      <label class="md-overlay" data-md-component="overlay" for="drawer"></label>
    60      
    61        <header class="md-header" data-md-component="header">
    62    <nav class="md-header-nav md-grid">
    63      <div class="md-flex">
    64        <div class="md-flex__cell md-flex__cell--shrink">
    65          
    66            <a href="../.." title="Ponzu" class="md-logo md-header-nav__button">
    67              <img src="../../images/logo.png" width="24" height="24">
    68            </a>
    69          
    70        </div>
    71        <div class="md-flex__cell md-flex__cell--shrink">
    72          <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
    73        </div>
    74        <div class="md-flex__cell md-flex__cell--stretch">
    75          <span class="md-flex__ellipsis md-header-nav__title">
    76            
    77              
    78                
    79                  <span class="md-header-nav__parent">
    80                    HTTP APIs
    81                  </span>
    82                
    83              
    84              Search
    85            
    86          </span>
    87        </div>
    88        <div class="md-flex__cell md-flex__cell--shrink">
    89          
    90            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
    91            
    92  <div class="md-search" data-md-component="search">
    93    <label class="md-search__overlay" for="search"></label>
    94    <div class="md-search__inner">
    95      <form class="md-search__form" name="search">
    96        <input type="text" class="md-search__input" name="query" required placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
    97        <label class="md-icon md-search__icon" for="search"></label>
    98        <button type="reset" class="md-icon md-search__icon" data-md-component="reset">close</button>
    99      </form>
   100      <div class="md-search__output">
   101        <div class="md-search__scrollwrap" data-md-scrollfix>
   102          <div class="md-search-result" data-md-component="result">
   103            <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
   104              Type to start searching
   105            </div>
   106            <ol class="md-search-result__list"></ol>
   107          </div>
   108        </div>
   109      </div>
   110    </div>
   111  </div>
   112          
   113        </div>
   114        <div class="md-flex__cell md-flex__cell--shrink">
   115          <div class="md-header-nav__source">
   116            
   117              
   118  
   119  
   120    
   121  
   122  
   123    <a href="https://github.com/rpdict/ponzu" title="Go to repository" class="md-source" data-md-source="github">
   124      
   125        <div class="md-source__icon">
   126          <svg viewBox="0 0 24 24" width="24" height="24">
   127            <use xlink:href="#github" width="24" height="24"></use>
   128          </svg>
   129        </div>
   130      
   131      <div class="md-source__repository">
   132        ponzu-cms/ponzu
   133      </div>
   134    </a>
   135  
   136            
   137          </div>
   138        </div>
   139      </div>
   140    </nav>
   141  </header>
   142      
   143      <div class="md-container">
   144        
   145        
   146        <main class="md-main">
   147          <div class="md-main__inner md-grid" data-md-component="container">
   148            
   149              
   150                <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
   151                  <div class="md-sidebar__scrollwrap">
   152                    <div class="md-sidebar__inner">
   153                      <nav class="md-nav md-nav--primary" data-md-level="0">
   154    <label class="md-nav__title md-nav__title--site" for="drawer">
   155      
   156        <i class="md-logo md-nav__button">
   157          <img src="../../images/logo.png">
   158        </i>
   159      
   160      Ponzu
   161    </label>
   162    
   163      <div class="md-nav__source">
   164        
   165  
   166  
   167    
   168  
   169  
   170    <a href="https://github.com/rpdict/ponzu" title="Go to repository" class="md-source" data-md-source="github">
   171      
   172        <div class="md-source__icon">
   173          <svg viewBox="0 0 24 24" width="24" height="24">
   174            <use xlink:href="#github" width="24" height="24"></use>
   175          </svg>
   176        </div>
   177      
   178      <div class="md-source__repository">
   179        ponzu-cms/ponzu
   180      </div>
   181    </a>
   182  
   183      </div>
   184    
   185    <ul class="md-nav__list" data-md-scrollfix>
   186      
   187        
   188        
   189        
   190  
   191  
   192    <li class="md-nav__item">
   193      <a href="../.." title="Home" class="md-nav__link">
   194        Home
   195      </a>
   196    </li>
   197  
   198      
   199        
   200        
   201        
   202  
   203  
   204    <li class="md-nav__item md-nav__item--nested">
   205      
   206        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
   207      
   208      <label class="md-nav__link" for="nav-2">
   209        CLI
   210      </label>
   211      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   212        <label class="md-nav__title" for="nav-2">
   213          CLI
   214        </label>
   215        <ul class="md-nav__list" data-md-scrollfix>
   216          
   217          
   218            
   219            
   220            
   221  
   222  
   223    <li class="md-nav__item">
   224      <a href="../../CLI/General-Usage/" title="General Usage" class="md-nav__link">
   225        General Usage
   226      </a>
   227    </li>
   228  
   229          
   230            
   231            
   232            
   233  
   234  
   235    <li class="md-nav__item">
   236      <a href="../../CLI/Generating-References/" title="Generating References" class="md-nav__link">
   237        Generating References
   238      </a>
   239    </li>
   240  
   241          
   242        </ul>
   243      </nav>
   244    </li>
   245  
   246      
   247        
   248        
   249        
   250  
   251  
   252    <li class="md-nav__item md-nav__item--nested">
   253      
   254        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
   255      
   256      <label class="md-nav__link" for="nav-3">
   257        Content
   258      </label>
   259      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   260        <label class="md-nav__title" for="nav-3">
   261          Content
   262        </label>
   263        <ul class="md-nav__list" data-md-scrollfix>
   264          
   265          
   266            
   267            
   268            
   269  
   270  
   271    <li class="md-nav__item">
   272      <a href="../../Content/An-Overview/" title="An Overview" class="md-nav__link">
   273        An Overview
   274      </a>
   275    </li>
   276  
   277          
   278            
   279            
   280            
   281  
   282  
   283    <li class="md-nav__item">
   284      <a href="../../Content/Extending-Content/" title="Extending Content" class="md-nav__link">
   285        Extending Content
   286      </a>
   287    </li>
   288  
   289          
   290        </ul>
   291      </nav>
   292    </li>
   293  
   294      
   295        
   296        
   297        
   298  
   299  
   300    <li class="md-nav__item md-nav__item--nested">
   301      
   302        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
   303      
   304      <label class="md-nav__link" for="nav-4">
   305        Form Fields
   306      </label>
   307      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   308        <label class="md-nav__title" for="nav-4">
   309          Form Fields
   310        </label>
   311        <ul class="md-nav__list" data-md-scrollfix>
   312          
   313          
   314            
   315            
   316            
   317  
   318  
   319    <li class="md-nav__item">
   320      <a href="../../Form-Fields/HTML-Inputs/" title="HTML Inputs" class="md-nav__link">
   321        HTML Inputs
   322      </a>
   323    </li>
   324  
   325          
   326        </ul>
   327      </nav>
   328    </li>
   329  
   330      
   331        
   332        
   333        
   334  
   335    
   336  
   337  
   338    <li class="md-nav__item md-nav__item--active md-nav__item--nested">
   339      
   340        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
   341      
   342      <label class="md-nav__link" for="nav-5">
   343        HTTP APIs
   344      </label>
   345      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   346        <label class="md-nav__title" for="nav-5">
   347          HTTP APIs
   348        </label>
   349        <ul class="md-nav__list" data-md-scrollfix>
   350          
   351          
   352            
   353            
   354            
   355  
   356  
   357    <li class="md-nav__item">
   358      <a href="../Content/" title="Content" class="md-nav__link">
   359        Content
   360      </a>
   361    </li>
   362  
   363          
   364            
   365            
   366            
   367  
   368  
   369    <li class="md-nav__item">
   370      <a href="../File-Metadata/" title="File Metadata" class="md-nav__link">
   371        File Metadata
   372      </a>
   373    </li>
   374  
   375          
   376            
   377            
   378            
   379  
   380    
   381  
   382  
   383    <li class="md-nav__item md-nav__item--active">
   384      
   385      <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc">
   386      
   387      
   388        <label class="md-nav__link md-nav__link--active" for="toc">
   389          Search
   390        </label>
   391      
   392      <a href="./" title="Search" class="md-nav__link md-nav__link--active">
   393        Search
   394      </a>
   395      
   396        
   397  <nav class="md-nav md-nav--secondary">
   398    
   399    
   400    
   401      <label class="md-nav__title" for="toc">Table of contents</label>
   402      <ul class="md-nav__list" data-md-scrollfix>
   403        
   404          <li class="md-nav__item">
   405    <a href="#endpoints" title="Endpoints" class="md-nav__link">
   406      Endpoints
   407    </a>
   408    
   409      <nav class="md-nav">
   410        <ul class="md-nav__list">
   411          
   412            <li class="md-nav__item">
   413    <a href="#search-content" title="Search Content" class="md-nav__link">
   414      Search Content
   415    </a>
   416    
   417      <nav class="md-nav">
   418        <ul class="md-nav__list">
   419          
   420            <li class="md-nav__item">
   421    <a href="#sample-response" title="Sample Response" class="md-nav__link">
   422      Sample Response
   423    </a>
   424    
   425  </li>
   426          
   427        </ul>
   428      </nav>
   429    
   430  </li>
   431          
   432        </ul>
   433      </nav>
   434    
   435  </li>
   436        
   437        
   438        
   439      </ul>
   440    
   441  </nav>
   442      
   443    </li>
   444  
   445          
   446        </ul>
   447      </nav>
   448    </li>
   449  
   450      
   451        
   452        
   453        
   454  
   455  
   456    <li class="md-nav__item md-nav__item--nested">
   457      
   458        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
   459      
   460      <label class="md-nav__link" for="nav-6">
   461        Interfaces
   462      </label>
   463      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   464        <label class="md-nav__title" for="nav-6">
   465          Interfaces
   466        </label>
   467        <ul class="md-nav__list" data-md-scrollfix>
   468          
   469          
   470            
   471            
   472            
   473  
   474  
   475    <li class="md-nav__item">
   476      <a href="../../Interfaces/API/" title="API" class="md-nav__link">
   477        API
   478      </a>
   479    </li>
   480  
   481          
   482            
   483            
   484            
   485  
   486  
   487    <li class="md-nav__item">
   488      <a href="../../Interfaces/Editor/" title="Editor" class="md-nav__link">
   489        Editor
   490      </a>
   491    </li>
   492  
   493          
   494            
   495            
   496            
   497  
   498  
   499    <li class="md-nav__item">
   500      <a href="../../Interfaces/Format/" title="Format" class="md-nav__link">
   501        Format
   502      </a>
   503    </li>
   504  
   505          
   506            
   507            
   508            
   509  
   510  
   511    <li class="md-nav__item">
   512      <a href="../../Interfaces/Item/" title="Item" class="md-nav__link">
   513        Item
   514      </a>
   515    </li>
   516  
   517          
   518            
   519            
   520            
   521  
   522  
   523    <li class="md-nav__item">
   524      <a href="../../Interfaces/Search/" title="Search" class="md-nav__link">
   525        Search
   526      </a>
   527    </li>
   528  
   529          
   530        </ul>
   531      </nav>
   532    </li>
   533  
   534      
   535        
   536        
   537        
   538  
   539  
   540    <li class="md-nav__item md-nav__item--nested">
   541      
   542        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
   543      
   544      <label class="md-nav__link" for="nav-7">
   545        Ponzu Addons
   546      </label>
   547      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   548        <label class="md-nav__title" for="nav-7">
   549          Ponzu Addons
   550        </label>
   551        <ul class="md-nav__list" data-md-scrollfix>
   552          
   553          
   554            
   555            
   556            
   557  
   558  
   559    <li class="md-nav__item">
   560      <a href="../../Ponzu-Addons/Creating-Addons/" title="Creating Addons" class="md-nav__link">
   561        Creating Addons
   562      </a>
   563    </li>
   564  
   565          
   566            
   567            
   568            
   569  
   570  
   571    <li class="md-nav__item">
   572      <a href="../../Ponzu-Addons/Using-Addons/" title="Using Addons" class="md-nav__link">
   573        Using Addons
   574      </a>
   575    </li>
   576  
   577          
   578        </ul>
   579      </nav>
   580    </li>
   581  
   582      
   583        
   584        
   585        
   586  
   587  
   588    <li class="md-nav__item md-nav__item--nested">
   589      
   590        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
   591      
   592      <label class="md-nav__link" for="nav-8">
   593        Quickstart
   594      </label>
   595      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   596        <label class="md-nav__title" for="nav-8">
   597          Quickstart
   598        </label>
   599        <ul class="md-nav__list" data-md-scrollfix>
   600          
   601          
   602            
   603            
   604            
   605  
   606  
   607    <li class="md-nav__item">
   608      <a href="../../Quickstart/Overview/" title="Overview" class="md-nav__link">
   609        Overview
   610      </a>
   611    </li>
   612  
   613          
   614        </ul>
   615      </nav>
   616    </li>
   617  
   618      
   619        
   620        
   621        
   622  
   623  
   624    <li class="md-nav__item md-nav__item--nested">
   625      
   626        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
   627      
   628      <label class="md-nav__link" for="nav-9">
   629        References
   630      </label>
   631      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   632        <label class="md-nav__title" for="nav-9">
   633          References
   634        </label>
   635        <ul class="md-nav__list" data-md-scrollfix>
   636          
   637          
   638            
   639            
   640            
   641  
   642  
   643    <li class="md-nav__item">
   644      <a href="../../References/Overview/" title="Overview" class="md-nav__link">
   645        Overview
   646      </a>
   647    </li>
   648  
   649          
   650        </ul>
   651      </nav>
   652    </li>
   653  
   654      
   655        
   656        
   657        
   658  
   659  
   660    <li class="md-nav__item md-nav__item--nested">
   661      
   662        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
   663      
   664      <label class="md-nav__link" for="nav-10">
   665        Running Backups
   666      </label>
   667      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   668        <label class="md-nav__title" for="nav-10">
   669          Running Backups
   670        </label>
   671        <ul class="md-nav__list" data-md-scrollfix>
   672          
   673          
   674            
   675            
   676            
   677  
   678  
   679    <li class="md-nav__item">
   680      <a href="../../Running-Backups/Backups/" title="Backups" class="md-nav__link">
   681        Backups
   682      </a>
   683    </li>
   684  
   685          
   686        </ul>
   687      </nav>
   688    </li>
   689  
   690      
   691        
   692        
   693        
   694  
   695  
   696    <li class="md-nav__item md-nav__item--nested">
   697      
   698        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11">
   699      
   700      <label class="md-nav__link" for="nav-11">
   701        System Configuration
   702      </label>
   703      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   704        <label class="md-nav__title" for="nav-11">
   705          System Configuration
   706        </label>
   707        <ul class="md-nav__list" data-md-scrollfix>
   708          
   709          
   710            
   711            
   712            
   713  
   714  
   715    <li class="md-nav__item">
   716      <a href="../../System-Configuration/Settings/" title="Settings" class="md-nav__link">
   717        Settings
   718      </a>
   719    </li>
   720  
   721          
   722        </ul>
   723      </nav>
   724    </li>
   725  
   726      
   727        
   728        
   729        
   730  
   731  
   732    <li class="md-nav__item md-nav__item--nested">
   733      
   734        <input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12">
   735      
   736      <label class="md-nav__link" for="nav-12">
   737        System Deployment
   738      </label>
   739      <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
   740        <label class="md-nav__title" for="nav-12">
   741          System Deployment
   742        </label>
   743        <ul class="md-nav__list" data-md-scrollfix>
   744          
   745          
   746            
   747            
   748            
   749  
   750  
   751    <li class="md-nav__item">
   752      <a href="../../System-Deployment/Docker/" title="Docker" class="md-nav__link">
   753        Docker
   754      </a>
   755    </li>
   756  
   757          
   758            
   759            
   760            
   761  
   762  
   763    <li class="md-nav__item">
   764      <a href="../../System-Deployment/SysV-Style/" title="SysV Style" class="md-nav__link">
   765        SysV Style
   766      </a>
   767    </li>
   768  
   769          
   770        </ul>
   771      </nav>
   772    </li>
   773  
   774      
   775    </ul>
   776  </nav>
   777                    </div>
   778                  </div>
   779                </div>
   780              
   781              
   782                <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
   783                  <div class="md-sidebar__scrollwrap">
   784                    <div class="md-sidebar__inner">
   785                      
   786  <nav class="md-nav md-nav--secondary">
   787    
   788    
   789    
   790      <label class="md-nav__title" for="toc">Table of contents</label>
   791      <ul class="md-nav__list" data-md-scrollfix>
   792        
   793          <li class="md-nav__item">
   794    <a href="#endpoints" title="Endpoints" class="md-nav__link">
   795      Endpoints
   796    </a>
   797    
   798      <nav class="md-nav">
   799        <ul class="md-nav__list">
   800          
   801            <li class="md-nav__item">
   802    <a href="#search-content" title="Search Content" class="md-nav__link">
   803      Search Content
   804    </a>
   805    
   806      <nav class="md-nav">
   807        <ul class="md-nav__list">
   808          
   809            <li class="md-nav__item">
   810    <a href="#sample-response" title="Sample Response" class="md-nav__link">
   811      Sample Response
   812    </a>
   813    
   814  </li>
   815          
   816        </ul>
   817      </nav>
   818    
   819  </li>
   820          
   821        </ul>
   822      </nav>
   823    
   824  </li>
   825        
   826        
   827        
   828      </ul>
   829    
   830  </nav>
   831                    </div>
   832                  </div>
   833                </div>
   834              
   835            
   836            <div class="md-content">
   837              <article class="md-content__inner md-typeset">
   838                
   839                  
   840                  
   841                    <h1>Search</h1>
   842                  
   843                  <p>Ponzu provides a read-only HTTP API to search the contents of your system's database. 
   844  Full-text search is made possible by the use of <a href="http://blevesearch.com">Bleve</a>, 
   845  which handles the indexing and querying. </p>
   846  <hr />
   847  <h3 id="endpoints">Endpoints<a class="headerlink" href="#endpoints" title="Permanent link">&para;</a></h3>
   848  <h4 id="search-content">Search Content<a class="headerlink" href="#search-content" title="Permanent link">&para;</a></h4>
   849  <p><kbd>GET</kbd> <code>/api/search?type=&lt;Type&gt;&amp;q=&lt;Query String&gt;</code></p>
   850  <div class="admonition warning">
   851  <p class="admonition-title">Search must be enabled individually for each Content type</p>
   852  <ul>
   853  <li>Search is not on by default to protect your data in case it shouldn't be indexed and published via the API.</li>
   854  <li><code>SearchMapping()</code> is implemented with default mapping (ideal for 99% of use cases). </li>
   855  <li>To enable search, add a <code>IndexContent() bool</code> method to your content type and return <code>true</code> (default implementation returns false).</li>
   856  </ul>
   857  </div>
   858  <ul>
   859  <li>
   860  <p><code>&lt;Type&gt;</code> must implement <a href="../../Interfaces/Search/#searchsearchable">db.Searchable</a></p>
   861  </li>
   862  <li>
   863  <p>Search is currently limited to single <code>&lt;Type&gt;</code> per request</p>
   864  </li>
   865  <li>
   866  <p><code>&lt;Query String&gt;</code> documentation here: <a href="http://www.blevesearch.com/docs/Query-String-Query/">Bleve Docs - Query String</a></p>
   867  </li>
   868  <li>
   869  <p>Search results are formatted exactly the same as standard Content API calls, so you don't need to change your client data model  </p>
   870  </li>
   871  <li>
   872  <p>Search handler will respect other interface implementations on your content, including: </p>
   873  <ul>
   874  <li><a href="https://godoc.org/github.com/rpdict/ponzu/system/item#Hideable"><code>item.Hideable</code></a></li>
   875  <li><a href="https://godoc.org/github.com/rpdict/ponzu/system/item#Omittable"><code>item.Omittable</code></a> </li>
   876  <li><a href="https://godoc.org/github.com/rpdict/ponzu/system/item#Pushable"><code>item.Pushable</code></a> <em>(Note: only the first search result will be pushed)</em></li>
   877  </ul>
   878  </li>
   879  </ul>
   880  <h5 id="sample-response">Sample Response<a class="headerlink" href="#sample-response" title="Permanent link">&para;</a></h5>
   881  <div class="codehilite"><pre><span></span><span class="p">{</span>
   882    <span class="s2">&quot;data&quot;</span><span class="o">:</span> <span class="p">[</span>
   883      <span class="p">{</span>
   884          <span class="s2">&quot;uuid&quot;</span><span class="o">:</span> <span class="s2">&quot;024a5797-e064-4ee0-abe3-415cb6d3ed18&quot;</span><span class="p">,</span>
   885          <span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span>
   886          <span class="s2">&quot;slug&quot;</span><span class="o">:</span> <span class="s2">&quot;item-id-024a5797-e064-4ee0-abe3-415cb6d3ed18&quot;</span><span class="p">,</span> <span class="c1">// customizable</span>
   887          <span class="s2">&quot;timestamp&quot;</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span> <span class="c1">// milliseconds since Unix epoch</span>
   888          <span class="s2">&quot;updated&quot;</span><span class="o">:</span> <span class="mi">1493926453826</span><span class="p">,</span>
   889          <span class="c1">// your content data...,</span>
   890      <span class="p">}</span>
   891    <span class="p">]</span>
   892  <span class="p">}</span>
   893  </pre></div>
   894                  
   895                    
   896                  
   897                
   898                
   899                  
   900                
   901              </article>
   902            </div>
   903          </div>
   904        </main>
   905        
   906          
   907  <footer class="md-footer">
   908    
   909      <div class="md-footer-nav">
   910        <nav class="md-footer-nav__inner md-grid">
   911          
   912            <a href="../File-Metadata/" title="File Metadata" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
   913              <div class="md-flex__cell md-flex__cell--shrink">
   914                <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
   915              </div>
   916              <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
   917                <span class="md-flex__ellipsis">
   918                  <span class="md-footer-nav__direction">
   919                    Previous
   920                  </span>
   921                  File Metadata
   922                </span>
   923              </div>
   924            </a>
   925          
   926          
   927            <a href="../../Interfaces/API/" title="API" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
   928              <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
   929                <span class="md-flex__ellipsis">
   930                  <span class="md-footer-nav__direction">
   931                    Next
   932                  </span>
   933                  API
   934                </span>
   935              </div>
   936              <div class="md-flex__cell md-flex__cell--shrink">
   937                <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
   938              </div>
   939            </a>
   940          
   941        </nav>
   942      </div>
   943    
   944    <div class="md-footer-meta md-typeset">
   945      <div class="md-footer-meta__inner md-grid">
   946        <div class="md-footer-copyright">
   947          
   948          powered by
   949          <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
   950          and
   951          <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
   952            Material for MkDocs</a>
   953        </div>
   954        
   955          
   956    <div class="md-footer-social">
   957      
   958      <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
   959      
   960        <a href="https://github.com/rpdict" class="md-footer-social__link fa fa-github"></a>
   961      
   962        <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a>
   963      
   964    </div>
   965  
   966        
   967      </div>
   968    </div>
   969  </footer>
   970        
   971      </div>
   972      
   973        <script src="../../assets/javascripts/application-6b599127bc.js"></script>
   974        <script>app.initialize({url:{base:"../.."}})</script>
   975        
   976      
   977      
   978        
   979        <script>!function(e,t,a,n,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-98609560-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
   980        
   981      
   982    </body>
   983  </html>