remanso-jetstream/docs/Remanso Jetstream API/search/Owner-scoped full-text fuzzy search.bru

meta {
  name: Owner-scoped full-text fuzzy search
  type: http
  seq: 2
}

get {
  url: {{baseUrl}}/:did/search
  body: none
  auth: bearer
}

params:query {
  q: 
  ~cursor: 
  ~limit: 
}

params:path {
  did: did:plc:4m3kouplb7s7xozjd3whinvl
}

auth:bearer {
  token: {{token}}
}

example {
  name: 200 Response
  description: A page of search hits for the caller's DID.
  
  request: {
    url: {{baseUrl}}/:did/search
    method: GET
    mode: none
    params:query: {
      q: 
      ~cursor: 
      ~limit: 
    }
  
    params:path: {
      did: 
    }
  }
  
  response: {
    headers: {
      Content-Type: application/json
    }
  
    status: {
      code: 200
      text: OK
    }
  
    body: {
      type: json
      content: '''
        {
          "results": [
            {
              "did": "",
              "rkey": "",
              "title": "",
              "snippet": "",
              "score": 0,
              "publishedAt": ""
            }
          ],
          "cursor": ""
        }
      '''
    }
  }
}

example {
  name: 400 Response
  description: Malformed input.
  
  request: {
    url: {{baseUrl}}/:did/search
    method: GET
    mode: none
    params:query: {
      q: 
      ~cursor: 
      ~limit: 
    }
  
    params:path: {
      did: 
    }
  }
  
  response: {
    headers: {
      Content-Type: application/json
    }
  
    status: {
      code: 400
      text: Bad Request
    }
  
    body: {
      type: json
      content: '''
        {
          "error": ""
        }
      '''
    }
  }
}

example {
  name: 401 Response
  description: Missing or invalid bearer token.
  
  request: {
    url: {{baseUrl}}/:did/search
    method: GET
    mode: none
    params:query: {
      q: 
      ~cursor: 
      ~limit: 
    }
  
    params:path: {
      did: 
    }
  }
  
  response: {
    headers: {
      Content-Type: application/json
    }
  
    status: {
      code: 401
      text: Unauthorized
    }
  
    body: {
      type: json
      content: '''
        {
          "error": ""
        }
      '''
    }
  }
}

example {
  name: 403 Response
  description: Token is valid but the caller is not authorized for this resource.
  
  request: {
    url: {{baseUrl}}/:did/search
    method: GET
    mode: none
    params:query: {
      q: 
      ~cursor: 
      ~limit: 
    }
  
    params:path: {
      did: 
    }
  }
  
  response: {
    headers: {
      Content-Type: application/json
    }
  
    status: {
      code: 403
      text: Forbidden
    }
  
    body: {
      type: json
      content: '''
        {
          "error": ""
        }
      '''
    }
  }
}