Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Commit

Permalink
Merge pull request #10110 from EOSIO/bdj__get_kv_table_rows-documenta…
Browse files Browse the repository at this point in the history
…tion_EPE-813

Fixed get_kv_table_rows documentation to match the current code behavior.
  • Loading branch information
brianjohnson5972 authored Mar 9, 2021
2 parents 24f4b8f + 505e9a2 commit 573bdf4
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions plugins/chain_api_plugin/chain.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -573,34 +573,48 @@ paths:
description: The name of primary or secondary index
encode_type:
type: string ( 'bytes' for arbitray binary index value )
description: Type of key specified by index_position (for example - `uint64_t` or `name`)
description: Encoding type to use for index_value, lower_bound, and upper_bound. Valid values are "bytes", "string", "name", "dec", or "hex"'. If not provided, the appropriate value based on the index_name's abi indicated type, for integers "dec" is the default. "bytes" are encoded as hexidecimal strings and can be used for any type of field. Example values for each type "bytes" => "0000000000000e1a", "string" => "Some value!", "name" => "eosio", "dec" => "3610", and "hex" => "e1a".
index_value:
type: string
description: index value used for point query encoded as 'encode_type'
description: Index value used for point query encoded as 'encode_type'. Cannot be used with either lower_bound or upper_bound.
lower_bound:
type: string
description: lower bound index value for ranged query. Query result includes rows specified with lower_bound
description: Lower bound index value for ranged query. Query result includes rows specified with lower_bound. Cannot be used with index_value. If index_value and lower_bound are not provided, then lower_bound is defaulted to be the lowest value in the table for that index_name.
upper_bound:
type: string
description: upper bound index value for ranged query. Query result doesn't include rows specified with upper_bound
description: Upper bound index value for ranged query. Query result includes rows specified with upper_bound. Cannot be used with index_value. If index_value and upper_bound are not provided, then upper_bound is defaulted to be the highest value in the table for that index_name.
limit:
type: integer
description: Limit number of results returned.
description: Limit number of results returned
format: int32
reverse:
type: boolean
description: Reverse the order of returned results
show_payer:
type: boolean
description: Provide the ram payer for each row
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
required:
- rows
properties:
rows:
type: array
items: {}
more:
type: boolean
description: Indicates if the entire request was not fulfilled and a subsequent query must be performed. If more is True, then "next_key" and "next_key_bytes" will be provided.
next_key:
type: string
description: Indicates the value to provide for next query to retrieve the next range of rows to complete the query. The original query should be reused, but substituting next_key's value for lower_bound, if reverse is False or not provided, otherwise it should be substituted for upper_bound.
next_key_bytes:
type: string
description: This is the same value as next_key except encoded as "bytes". It can be used in the same way, except the original query would also need its encode_type replaced with "bytes".

/abi_json_to_bin:
post:
Expand Down

0 comments on commit 573bdf4

Please sign in to comment.