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 = {}) ⇒ Hash

Check to see if a query string is valid.
#search_within(opts = {}) ⇒ Hash

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

Instance Method Details

#query_validation(opts = {}) ⇒ `Hash`

Check to see if a query string is valid

Parameters:

opts (Hash) (defaults to: {}) —

options hash of parameters

Options Hash (opts):

query (String) —

Query string
language (Array) —

Languages for query string

Returns:

(Hash) —

Query string validation results



11
12
13

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

def query_validation(opts = {})
  get 'query-validation', opts
end

#search_within(opts = {}) ⇒ `Hash`

Check to see if a search within query string is valid

Parameters:

opts (Hash) (defaults to: {}) —

options hash of parameters

Options Hash (opts):

query (String) —

Query string
language (Array) —

Languages for query string

Returns:

(Hash) —

Query string validation results



21
22
23

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

def search_within(opts = {})
  get 'query-validation/searchwithin', opts
end