Module: BWAPI::Client::QueryValidation

Included in:: BWAPI::Client

Defined in:: lib/bwapi/client/query_validation.rb

Overview

QueryValidation module for queryValidation endpoints

Instance Method Summary collapse

#query_validation(opts) ⇒ Hashie::Mash

Check to see if a query string is valid.
#search_within(opts) ⇒ Hashie::Mash

Check to see if a search within query string is valid.

Instance Method Details

#query_validation(opts) ⇒ `Hashie::Mash`

Check to see if a query string is valid

Parameters:

opts (Hash) —

options hash of parameters

Options Hash (opts):

query (String) —

Query string
language (Array) —

Languages for query string

Returns:

(Hashie::Mash) —

Query string validation results



12
13
14

# File 'lib/bwapi/client/query_validation.rb', line 12

def query_validation opts
  get "query-validation", opts
end

#search_within(opts) ⇒ `Hashie::Mash`

Check to see if a search within query string is valid

Parameters:

opts (Hash) —

options hash of parameters

Options Hash (opts):

query (String) —

Query string
language (Array) —

Languages for query string

Returns:

(Hashie::Mash) —

Query string validation results



22
23
24

# File 'lib/bwapi/client/query_validation.rb', line 22

def search_within opts
  get "query-validation/searchwithin", opts
end