logos-messaging-rest-api/api-spec/adminapi_peers_relay_on_shard.yaml

31 lines
795 B
YAML

get:
tags:
- admin
summary: Get peers by service
description: Returns information about relay peers in node's gossip network for a specific shard.
operationId: getRelayPeersByShard
parameters:
- in: path
name: shardId
required: true
schema:
type: integer
format: uint16
description: ID of the shard to retrieve information for
responses:
'200':
description: Successful service peers response
content:
application/json:
schema:
$ref: "./schemas/apitypes.yaml#/PeersOfShard"
'400':
description: Invalid argument.
content:
text/plain:
type: string
'500':
description: Internal server error.
content:
text/plain:
type: string