Class: Weft::SearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/weft/generated/api/search_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SearchApi

Returns a new instance of SearchApi.



19
20
21
 
# File 'lib/weft/generated/api/search_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/weft/generated/api/search_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_curated_marketplace_contract(digest, operation_id, opts = {}) ⇒ CuratedMarketplaceContract

Get a curated marketplace operation contract Public, content-addressed detail document linked from compact hosted-MCP search results. A matching document is cacheable for one year and immutable. The digest is the SHA-256 of the canonical JSON document. Every reviewed endpoint includes its request and response evidence; asynchronous endpoints also include the authored submit-and-poll lifecycle, identity-header reuse, terminal states, and known gaps.

Parameters:

  • digest (String)
  • operation_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/weft/generated/api/search_api.rb', line 28

def get_curated_marketplace_contract(digest, operation_id, opts = {})
  data, _status_code, _headers = get_curated_marketplace_contract_with_http_info(digest, operation_id, opts)
  data
end

#get_curated_marketplace_contract_with_http_info(digest, operation_id, opts = {}) ⇒ Array<(CuratedMarketplaceContract, Integer, Hash)>

Get a curated marketplace operation contract Public, content-addressed detail document linked from compact hosted-MCP search results. A matching document is cacheable for one year and immutable. The digest is the SHA-256 of the canonical JSON document. Every reviewed endpoint includes its request and response evidence; asynchronous endpoints also include the authored submit-and-poll lifecycle, identity-header reuse, terminal states, and known gaps.

Parameters:

  • digest (String)
  • operation_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CuratedMarketplaceContract, Integer, Hash)>) —

    CuratedMarketplaceContract data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/weft/generated/api/search_api.rb', line 39

def get_curated_marketplace_contract_with_http_info(digest, operation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchApi.get_curated_marketplace_contract ...'
  end
  # verify the required parameter 'digest' is set
  if @api_client.config.client_side_validation && digest.nil?
    fail ArgumentError, "Missing the required parameter 'digest' when calling SearchApi.get_curated_marketplace_contract"
  end
  pattern = Regexp.new(/^[0-9a-f]{64}$/)
  if @api_client.config.client_side_validation && digest !~ pattern
    fail ArgumentError, "invalid value for 'digest' when calling SearchApi.get_curated_marketplace_contract, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'operation_id' is set
  if @api_client.config.client_side_validation && operation_id.nil?
    fail ArgumentError, "Missing the required parameter 'operation_id' when calling SearchApi.get_curated_marketplace_contract"
  end
  pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
  if @api_client.config.client_side_validation && operation_id !~ pattern
    fail ArgumentError, "invalid value for 'operation_id' when calling SearchApi.get_curated_marketplace_contract, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/contracts/curated-marketplace/{digest}/{operation_id}.json'.sub('{' + 'digest' + '}', CGI.escape(digest.to_s)).sub('{' + 'operation_id' + '}', CGI.escape(operation_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CuratedMarketplaceContract'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SearchApi.get_curated_marketplace_contract",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#get_curated_marketplace_contract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(search_request, opts = {}) ⇒ SearchResponse

Search the Weft index Semantic search over the Weft index of paid agent resources. The request body is the weft-search-platform /v1/search contract: a free-text query, optional max_results, and optional structured filters (price / price_atomic / type / protocol — the canonical FilterSpec v1 vocabulary, vendored verbatim from the platform). Price is a dual representation of one constraint: price in USD decimal strings (the reasoning form) XOR price_atomic in integer micro-USD (the settlement form) — mutually exclusive, set at most one. Account-scoped: the bearer token must be a buyer-scoped API key, an OAuth token carrying search, or a pending or claimed wbt_* bootstrap bearer. Pending bootstrap access uses an anonymous bootstrap identity; after claim, the promoted bearer uses its bound User. Rejection, cancellation, expiry, and revocation end bootstrap search. Bootstrap search is limited to 60 requests per credential and 120 per IP each hour before native credential promotion. Response negotiation: Accept: application/json (default) returns the structured envelope; Accept: text/markdown returns a rendered Markdown digest of the same results — useful for piping into a chat UI or LLM prompt.

Parameters:

  • search_request (SearchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



106
107
108
109
 
# File 'lib/weft/generated/api/search_api.rb', line 106

def search(search_request, opts = {})
  data, _status_code, _headers = search_with_http_info(search_request, opts)
  data
end

#search_with_http_info(search_request, opts = {}) ⇒ Array<(SearchResponse, Integer, Hash)>

Search the Weft index Semantic search over the Weft index of paid agent resources. The request body is the weft-search-platform `/v1/search` contract: a free-text `query`, optional `max_results`, and optional structured `filters` (price / price_atomic / type / protocol — the canonical FilterSpec v1 vocabulary, vendored verbatim from the platform). Price is a dual representation of one constraint: `price` in USD decimal strings (the reasoning form) XOR `price_atomic` in integer micro-USD (the settlement form) — mutually exclusive, set at most one. Account-scoped: the bearer token must be a buyer-scoped API key, an OAuth token carrying `search`, or a pending or claimed `wbt_*` bootstrap bearer. Pending bootstrap access uses an anonymous bootstrap identity; after claim, the promoted bearer uses its bound User. Rejection, cancellation, expiry, and revocation end bootstrap search. Bootstrap search is limited to 60 requests per credential and 120 per IP each hour before native credential promotion. Response negotiation: `Accept: application/json` (default) returns the structured envelope; `Accept: text/markdown` returns a rendered Markdown digest of the same results — useful for piping into a chat UI or LLM prompt.

Parameters:

  • search_request (SearchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SearchResponse, Integer, Hash)>) —

    SearchResponse data, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/weft/generated/api/search_api.rb', line 116

def search_with_http_info(search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SearchApi.search ...'
  end
  # verify the required parameter 'search_request' is set
  if @api_client.config.client_side_validation && search_request.nil?
    fail ArgumentError, "Missing the required parameter 'search_request' when calling SearchApi.search"
  end
  # resource path
  local_var_path = '/api/v1/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/markdown']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(search_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"SearchApi.search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SearchApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end