{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Cosmos SDK cosmos.base.query Schemas", "description": "JSON Schema definitions for the cosmos.base.query module of the Cosmos SDK gRPC-gateway REST API.", "definitions": { "cosmos.base.query.v1beta1.PageRequest": { "type": "object", "properties": { "key": { "type": "string", "format": "byte", "description": "key is a value returned in PageResponse.next_key to begin\nquerying the next page most efficiently. Only one of offset or key\nshould be set." }, "offset": { "type": "string", "format": "uint64", "description": "offset is a numeric offset that can be used when key is unavailable.\nIt is less efficient than using key. Only one of offset or key should\nbe set." }, "limit": { "type": "string", "format": "uint64", "description": "limit is the total number of results to be returned in the result page.\nIf left empty it will default to a value to be set by each app." }, "countTotal": { "type": "boolean", "description": "count_total is set to true to indicate that the result set should include\na count of the total number of items available for pagination in UIs.\ncount_total is only respected when offset is used. It is ignored when key\nis set." }, "reverse": { "type": "boolean", "description": "reverse is set to true if results are to be returned in the descending order." } }, "description": "message SomeRequest {\n Foo some_parameter = 1;\n PageRequest pagination = 2;\n }", "title": "PageRequest is to be embedded in gRPC request messages for efficient\npagination. Ex:" }, "cosmos.base.query.v1beta1.PageResponse": { "type": "object", "properties": { "nextKey": { "type": "string", "format": "byte", "description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results." }, "total": { "type": "string", "format": "uint64", "title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise" } }, "description": "PageResponse is to be embedded in gRPC response messages where the\ncorresponding request message has used PageRequest.\n\n message SomeResponse {\n repeated Bar results = 1;\n PageResponse page = 2;\n }" } } }