Skip to content

Commit e1aa326

Browse files
committed
Update schemas
1 parent a8725fa commit e1aa326

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

contracts/reflect/schema/raw/query.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -325,23 +325,23 @@
325325
]
326326
},
327327
"GrpcQuery": {
328-
"description": "Queries the chain using a grpc query. This allows to query information that is not exposed in our API. The chain needs to whitelist the supported queries. The drawback of this query is that you have to handle the protobuf encoding and decoding yourself.\n\nThe returned data is protobuf encoded. The protobuf type depends on the query.",
328+
"description": "Queries the chain using a grpc query. This allows to query information that is not exposed in our API. The chain needs to allowlist the supported queries. The drawback of this query is that you have to handle the protobuf encoding and decoding yourself.\n\nThe returned data is protobuf encoded. The protobuf type depends on the query.\n\nTo find the path, as well as the request and response types, you can query the chain's gRPC endpoint using a tool like [grpcurl](https://github.com/fullstorydev/grpcurl).",
329329
"type": "object",
330330
"required": [
331331
"data",
332332
"path"
333333
],
334334
"properties": {
335335
"data": {
336-
"description": "The expected protobuf message type (not any), binary encoded",
336+
"description": "The expected protobuf message type (not [Any](https://protobuf.dev/programming-guides/proto3/#any)), binary encoded",
337337
"allOf": [
338338
{
339339
"$ref": "#/definitions/Binary"
340340
}
341341
]
342342
},
343343
"path": {
344-
"description": "The fully qualified service path used for routing, eg. \"custom/cosmos_sdk.x.bank.v1.Query/QueryBalance\"",
344+
"description": "The fully qualified endpoint path used for routing. It follows the format `/service_path/method_name`, eg. \"/cosmos.authz.v1beta1.Query/Grants\"",
345345
"type": "string"
346346
}
347347
}
@@ -492,6 +492,7 @@
492492
},
493493
{
494494
"description": "A Stargate query is encoded the same way as abci_query, with path and protobuf encoded request data. The format is defined in [ADR-21](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-021-protobuf-query-encoding.md). The response is protobuf encoded data directly without a JSON response wrapper. The caller is responsible for compiling the proper protobuf definitions for both requests and responses.",
495+
"deprecated": true,
495496
"type": "object",
496497
"required": [
497498
"stargate"
@@ -513,7 +514,7 @@
513514
]
514515
},
515516
"path": {
516-
"description": "this is the fully qualified service path used for routing, eg. custom/cosmos_sdk.x.bank.v1.Query/QueryBalance",
517+
"description": "this is the fully qualified service path used for routing, eg. \"/cosmos_sdk.x.bank.v1.Query/QueryBalance\"",
517518
"type": "string"
518519
}
519520
}

contracts/reflect/schema/reflect.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1328,23 +1328,23 @@
13281328
]
13291329
},
13301330
"GrpcQuery": {
1331-
"description": "Queries the chain using a grpc query. This allows to query information that is not exposed in our API. The chain needs to whitelist the supported queries. The drawback of this query is that you have to handle the protobuf encoding and decoding yourself.\n\nThe returned data is protobuf encoded. The protobuf type depends on the query.",
1331+
"description": "Queries the chain using a grpc query. This allows to query information that is not exposed in our API. The chain needs to allowlist the supported queries. The drawback of this query is that you have to handle the protobuf encoding and decoding yourself.\n\nThe returned data is protobuf encoded. The protobuf type depends on the query.\n\nTo find the path, as well as the request and response types, you can query the chain's gRPC endpoint using a tool like [grpcurl](https://github.com/fullstorydev/grpcurl).",
13321332
"type": "object",
13331333
"required": [
13341334
"data",
13351335
"path"
13361336
],
13371337
"properties": {
13381338
"data": {
1339-
"description": "The expected protobuf message type (not any), binary encoded",
1339+
"description": "The expected protobuf message type (not [Any](https://protobuf.dev/programming-guides/proto3/#any)), binary encoded",
13401340
"allOf": [
13411341
{
13421342
"$ref": "#/definitions/Binary"
13431343
}
13441344
]
13451345
},
13461346
"path": {
1347-
"description": "The fully qualified service path used for routing, eg. \"custom/cosmos_sdk.x.bank.v1.Query/QueryBalance\"",
1347+
"description": "The fully qualified endpoint path used for routing. It follows the format `/service_path/method_name`, eg. \"/cosmos.authz.v1beta1.Query/Grants\"",
13481348
"type": "string"
13491349
}
13501350
}
@@ -1495,6 +1495,7 @@
14951495
},
14961496
{
14971497
"description": "A Stargate query is encoded the same way as abci_query, with path and protobuf encoded request data. The format is defined in [ADR-21](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/adr-021-protobuf-query-encoding.md). The response is protobuf encoded data directly without a JSON response wrapper. The caller is responsible for compiling the proper protobuf definitions for both requests and responses.",
1498+
"deprecated": true,
14981499
"type": "object",
14991500
"required": [
15001501
"stargate"
@@ -1516,7 +1517,7 @@
15161517
]
15171518
},
15181519
"path": {
1519-
"description": "this is the fully qualified service path used for routing, eg. custom/cosmos_sdk.x.bank.v1.Query/QueryBalance",
1520+
"description": "this is the fully qualified service path used for routing, eg. \"/cosmos_sdk.x.bank.v1.Query/QueryBalance\"",
15201521
"type": "string"
15211522
}
15221523
}

0 commit comments

Comments
 (0)