-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
080bb43
commit a54bf02
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
layout: default | ||
title: Nostr People Search | ||
description: Job to search for profiles based on a prompt | ||
--- | ||
|
||
# Input | ||
Text to be included in the search | ||
|
||
# Output | ||
|
||
A `content` JSON-stringified list of tags. Tags SHOULD be `p`. | ||
|
||
# Params | ||
|
||
* `max_results`: Maximum number of events to return (Optional parameter) | ||
|
||
# How clients can use this | ||
|
||
Clients can ask a Search DVM to return profiles based on certain filters. | ||
|
||
|
||
# Example | ||
|
||
#### Request | ||
```json | ||
{ | ||
"content": "", | ||
|
||
"kind": 5303, | ||
"tags": | ||
[ | ||
[ "i", "Jack", "text" ], | ||
["param","max_results","500"] | ||
] | ||
} | ||
``` | ||
|
||
#### Response | ||
```json | ||
{ | ||
"kind": 6303, | ||
"content": ' | ||
[ "p", "<...>" ], | ||
[ "p", "<...>" ], | ||
[ "p", "<...>" ], | ||
[ "p", "<...>" ] | ||
' | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters