Page last modified 00:11, 19 Mar 2009 by MaxM
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
Overview
public. Search the Deki index
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| constraint | string? | Additional search constraint (ex: language:en-us AND type:wiki) default: none |
| q | string | lucene search string |
| sortby | {score, title, date, size, wordcount}? | Sort field. Prefix value with '-' to sort descending. default: score |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Ok | 200 | The request completed successfully |
Message Format
Output:
Content-type=application/json
Implementation Notes
Refer here for more information on the Lucene search string format.
Refer here for more information about OpenSearch. Refer here for more information about OpenSearch suggestions.
Code Samples
The following code example finds the OpenSearch suggestions for title "Subpage_1":
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("site", "opensearch", "suggestions").With("q", "Subpage_1").Get();
Sample response:
["subpage_1", ["Subpage 1"]]
- Tag page
- What links here
Images 0
You must login to post a comment.