Skip to content

Instantly share code, notes, and snippets.

@bolubee101
Last active October 13, 2021 08:16
Show Gist options
  • Select an option

  • Save bolubee101/557d21ce3642d89d23b6fbf971fa0fca to your computer and use it in GitHub Desktop.

Select an option

Save bolubee101/557d21ce3642d89d23b6fbf971fa0fca to your computer and use it in GitHub Desktop.
Proposed standard for Search endpoint for Zuri. Implemented on goals plugin

The request is shaped as such, following the get request format that has been followed by the plugin

api/v1/search?search=searchparams&orgid=orgid&page=page&limit=limit

{
status,
message,
prev: 'link to previous search page',
next: 'link to next search page',
count: 'total number of searches',
totalDocumentsonpage: 'total number of documents on page',
result:[]
}

The standard is in line with search teams standard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment