mukan-core/docs/static/openapi.json

{"id":"mukan","consumes":["application/json"],"produces":["application/json"],"swagger":"2.0","info":{"description":"Chain mukan REST API","title":"HTTP API Console","contact":{"name":"mukan"},"version":"version not set"},"paths":{"/mukan/mukan/v1/params":{"get":{"tags":["Query"],"summary":"Parameters queries the parameters of the module.","operationId":"MukanQuery_Params","responses":{"200":{"description":"A successful response.","schema":{"$ref":"#/definitions/mukan.mukan.v1.QueryParamsResponse"}},"default":{"description":"An unexpected error response.","schema":{"$ref":"#/definitions/google.rpc.Status"}}}}},"/mukan/poj/v1/miner_state":{"get":{"tags":["Query"],"operationId":"MukanQuery_MinerStateAll","parameters":[{"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.","name":"pagination.key","in":"query"},{"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.","name":"pagination.offset","in":"query"},{"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.","name":"pagination.limit","in":"query"},{"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.","name":"pagination.count_total","in":"query"},{"type":"boolean","description":"reverse is set to true if results are to be returned in the descending order.","name":"pagination.reverse","in":"query"}],"responses":{"200":{"description":"A successful response.","schema":{"$ref":"#/definitions/mukan.poj.v1.QueryAllMinerStateResponse"}},"default":{"description":"An unexpected error response.","schema":{"$ref":"#/definitions/google.rpc.Status"}}}}},"/mukan/poj/v1/miner_state/{address}":{"get":{"tags":["Query"],"summary":"Queries a list of MinerState items.","operationId":"MukanQuery_MinerState","parameters":[{"type":"string","name":"address","in":"path","required":true}],"responses":{"200":{"description":"A successful response.","schema":{"$ref":"#/definitions/mukan.poj.v1.QueryGetMinerStateResponse"}},"default":{"description":"An unexpected error response.","schema":{"$ref":"#/definitions/google.rpc.Status"}}}}},"/mukan/poj/v1/params":{"get":{"tags":["Query"],"summary":"Parameters queries the parameters of the module.","operationId":"MukanQuery_ParamsMixin7","responses":{"200":{"description":"A successful response.","schema":{"$ref":"#/definitions/mukan.poj.v1.QueryParamsResponse"}},"default":{"description":"An unexpected error response.","schema":{"$ref":"#/definitions/google.rpc.Status"}}}}},"/mukan/qpos/v1/params":{"get":{"tags":["Query"],"summary":"Parameters queries the parameters of the module.","operationId":"MukanQuery_ParamsMixin11","responses":{"200":{"description":"A successful response.","schema":{"$ref":"#/definitions/mukan.qpos.v1.QueryParamsResponse"}},"default":{"description":"An unexpected error response.","schema":{"$ref":"#/definitions/google.rpc.Status"}}}}}},"definitions":{"cosmos.base.query.v1beta1.PageRequest":{"description":"message SomeRequest {\n         Foo some_parameter = 1;\n         PageRequest pagination = 2;\n }","type":"object","title":"PageRequest is to be embedded in gRPC request messages for efficient\npagination. Ex:","properties":{"count_total":{"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.","type":"boolean"},"key":{"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.","type":"string","format":"byte"},"limit":{"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.","type":"string","format":"uint64"},"offset":{"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.","type":"string","format":"uint64"},"reverse":{"description":"reverse is set to true if results are to be returned in the descending order.","type":"boolean"}}},"cosmos.base.query.v1beta1.PageResponse":{"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 }","type":"object","properties":{"next_key":{"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.","type":"string","format":"byte"},"total":{"type":"string","format":"uint64","title":"total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"}}},"google.protobuf.Any":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"google.rpc.Status":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"details":{"type":"array","items":{"type":"object","$ref":"#/definitions/google.protobuf.Any"}},"message":{"type":"string"}}},"mukan.mukan.v1.Params":{"description":"Params defines the parameters for the module.","type":"object"},"mukan.mukan.v1.QueryParamsResponse":{"description":"QueryParamsResponse is response type for the Query/Params RPC method.","type":"object","properties":{"params":{"description":"params holds all the parameters of this module.","$ref":"#/definitions/mukan.mukan.v1.Params"}}},"mukan.poj.v1.MinerState":{"description":"MinerState defines the state of a miner in the PoJ module.","type":"object","properties":{"address":{"type":"string"},"consecutive_wins":{"type":"string","format":"int64"},"cooldown_until":{"type":"string","format":"int64"},"streak_count":{"type":"string","format":"int64"}}},"mukan.poj.v1.Params":{"description":"Params defines the parameters for the module.","type":"object","properties":{"base_reward":{"type":"string","format":"int64"},"blocks_per_epoch":{"type":"string","format":"int64"},"erkin_address":{"type":"string"},"macro_cooldown":{"type":"string","format":"int64"},"macro_streak_limit":{"type":"string","format":"int64"},"micro_cooldown":{"type":"string","format":"int64"},"min_reward":{"type":"string","format":"int64"},"mining_difficulty":{"type":"string","format":"uint64"},"mukan_address":{"type":"string"},"toruk_address":{"type":"string"}}},"mukan.poj.v1.QueryAllMinerStateResponse":{"type":"object","properties":{"miner_state":{"type":"array","items":{"type":"object","$ref":"#/definitions/mukan.poj.v1.MinerState"}},"pagination":{"$ref":"#/definitions/cosmos.base.query.v1beta1.PageResponse"}}},"mukan.poj.v1.QueryGetMinerStateResponse":{"type":"object","properties":{"miner_state":{"$ref":"#/definitions/mukan.poj.v1.MinerState"}}},"mukan.poj.v1.QueryParamsResponse":{"description":"QueryParamsResponse is response type for the Query/Params RPC method.","type":"object","properties":{"params":{"description":"params holds all the parameters of this module.","$ref":"#/definitions/mukan.poj.v1.Params"}}},"mukan.qpos.v1.Params":{"description":"Params defines the parameters for the module.","type":"object"},"mukan.qpos.v1.QueryParamsResponse":{"description":"QueryParamsResponse is response type for the Query/Params RPC method.","type":"object","properties":{"params":{"description":"params holds all the parameters of this module.","$ref":"#/definitions/mukan.qpos.v1.Params"}}}},"tags":[{"name":"Query"},{"name":"Msg"}]}