Files
discoursejs/docs/sdk/models/operations/searchrequest.md

25 KiB
Raw Blame History

SearchRequest

Example Usage

import { SearchRequest } from "@lukehagar/discoursejs/sdk/models/operations";

let value: SearchRequest = {
  page: 1,
  q: "api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic",
};

Fields

Field Type Required Description Example
page number N/A 1
q string The query string needs to be url encoded and is made up of the following options:
- Search term. This is just a string. Usually it would be the first item in the query.
- @<username>: Use the @ followed by the username to specify posts by this user.
- #<category>: Use the # followed by the category slug to search within this category.
- tags:: api,solved or for posts that have all the specified tags api+solved.
- before:: yyyy-mm-dd
- after:: yyyy-mm-dd
- order:: latest, likes, views, latest_topic
- assigned:: username (without @)
- in:: title, likes, personal, messages, seen, unseen, posted, created, watching, tracking, bookmarks, assigned, unassigned, first, pinned, wiki
- with:: images
- status:: open, closed, public, archived, noreplies, single_user, solved, unsolved
- group:: group_name or group_id
- group_messages:: group_name or group_id
- min_posts:: 1
- max_posts:: 10
- min_views:: 1
- max_views:: 10

If you are using cURL you can use the -G and the --data-urlencode flags to encode the query:

<br/>curl -i -sS -X GET -G "http://localhost:4200/search.json" \<br/>--data-urlencode 'q=wordpress @scossar #fun after:2020-01-01'<br/>
api @blake #support tags:api after:2021-06-04 in:unseen in:open order:latest_topic