feat(api): add comprehensive API collection for NowChess microservices
This commit is contained in:
@@ -0,0 +1,33 @@
|
|||||||
|
meta {
|
||||||
|
name: List Instances
|
||||||
|
type: http
|
||||||
|
seq: 1
|
||||||
|
}
|
||||||
|
|
||||||
|
get {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/instances
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Returns all known core instances from the in-memory registry.
|
||||||
|
Registry is populated via gRPC heartbeats from core instances.
|
||||||
|
|
||||||
|
Requires port-forward: kubectl port-forward svc/nowchess-coordinator 8086:8086 -n <namespace>
|
||||||
|
|
||||||
|
Response: InstanceMetadata[]
|
||||||
|
instanceId: string — unique instance ID
|
||||||
|
hostname: string
|
||||||
|
httpPort: int
|
||||||
|
grpcPort: int
|
||||||
|
subscriptionCount: int — active game subscriptions
|
||||||
|
localCacheSize: int
|
||||||
|
lastHeartbeat: string — ISO-8601 timestamp
|
||||||
|
state: string — "HEALTHY" | "DEAD"
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
meta {
|
||||||
|
name: List Instances
|
||||||
|
type: http
|
||||||
|
seq: 1
|
||||||
|
}
|
||||||
|
|
||||||
|
http {
|
||||||
|
method: GET
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/instances
|
||||||
|
auth: none
|
||||||
|
}
|
||||||
|
|
||||||
|
headers {
|
||||||
|
Accept: application/json
|
||||||
|
}
|
||||||
|
|
||||||
|
notes {
|
||||||
|
Returns all known core instances from the in-memory registry.
|
||||||
|
Registry is populated via gRPC heartbeats from core instances.
|
||||||
|
|
||||||
|
Response: InstanceMetadata[]
|
||||||
|
instanceId: string — unique instance ID
|
||||||
|
hostname: string
|
||||||
|
httpPort: int
|
||||||
|
grpcPort: int
|
||||||
|
subscriptionCount: int — number of active game subscriptions
|
||||||
|
localCacheSize: int
|
||||||
|
lastHeartbeat: string — ISO-8601 timestamp
|
||||||
|
state: string — "HEALTHY" | "DEAD"
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
meta {
|
||||||
|
name: Get Metrics
|
||||||
|
type: http
|
||||||
|
seq: 2
|
||||||
|
}
|
||||||
|
|
||||||
|
get {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/metrics
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Aggregate load metrics computed from the instance registry.
|
||||||
|
|
||||||
|
Requires port-forward: kubectl port-forward svc/nowchess-coordinator 8086:8086 -n <namespace>
|
||||||
|
|
||||||
|
Response: MetricsDto
|
||||||
|
totalInstances: int
|
||||||
|
healthyInstances: int
|
||||||
|
deadInstances: int
|
||||||
|
totalGames: int — sum of subscriptionCount across all instances
|
||||||
|
avgGamesPerCore: double
|
||||||
|
maxGamesPerCore: int
|
||||||
|
minGamesPerCore: int
|
||||||
|
instances: InstanceMetadata[]
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
meta {
|
||||||
|
name: Rebalance
|
||||||
|
type: http
|
||||||
|
seq: 3
|
||||||
|
}
|
||||||
|
|
||||||
|
post {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/rebalance
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Triggers a manual rebalance of game subscriptions across core instances.
|
||||||
|
Runs asynchronously — response does not wait for completion.
|
||||||
|
|
||||||
|
Requires port-forward: kubectl port-forward svc/nowchess-coordinator 8086:8086 -n <namespace>
|
||||||
|
|
||||||
|
Auto-rebalance runs every 30s (rebalance-interval), min 60s between runs
|
||||||
|
(rebalance-min-interval). Triggers when load deviation exceeds 20%
|
||||||
|
(max-deviation-percent).
|
||||||
|
|
||||||
|
Response: {"status": "rebalance_started"}
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
meta {
|
||||||
|
name: Failover
|
||||||
|
type: http
|
||||||
|
seq: 4
|
||||||
|
}
|
||||||
|
|
||||||
|
post {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/failover/{{instanceId}}
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
vars:pre-request {
|
||||||
|
instanceId: core-instance-1
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Triggers manual failover for a specific core instance.
|
||||||
|
Marks it DEAD and migrates its game subscriptions to healthy instances.
|
||||||
|
Runs asynchronously — response does not wait for completion.
|
||||||
|
|
||||||
|
Requires port-forward: kubectl port-forward svc/nowchess-coordinator 8086:8086 -n <namespace>
|
||||||
|
|
||||||
|
Path param: instanceId — from /instances response (instanceId field)
|
||||||
|
|
||||||
|
Response: {"status": "failover_started", "instanceId": "<id>"}
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
meta {
|
||||||
|
name: Scale Up
|
||||||
|
type: http
|
||||||
|
seq: 5
|
||||||
|
}
|
||||||
|
|
||||||
|
post {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/scale-up
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Triggers manual scale-up of core replicas via Kubernetes rollout.
|
||||||
|
Requires auto-scale-enabled=true and a reachable k8s API.
|
||||||
|
Respects scale-max-replicas (default: 10).
|
||||||
|
|
||||||
|
Requires port-forward: kubectl port-forward svc/nowchess-coordinator 8086:8086 -n <namespace>
|
||||||
|
|
||||||
|
Auto-scale triggers when avg load exceeds scale-up-threshold (default: 0.8).
|
||||||
|
|
||||||
|
Response: {"status": "scale_up_started"}
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
meta {
|
||||||
|
name: Scale Down
|
||||||
|
type: http
|
||||||
|
seq: 6
|
||||||
|
}
|
||||||
|
|
||||||
|
post {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/scale-down
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Triggers manual scale-down of core replicas via Kubernetes rollout.
|
||||||
|
Requires auto-scale-enabled=true and a reachable k8s API.
|
||||||
|
Respects scale-min-replicas (default: 2).
|
||||||
|
|
||||||
|
Requires port-forward: kubectl port-forward svc/nowchess-coordinator 8086:8086 -n <namespace>
|
||||||
|
|
||||||
|
Auto-scale triggers when avg load drops below scale-down-threshold (default: 0.3).
|
||||||
|
|
||||||
|
Response: {"status": "scale_down_started"}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
meta {
|
||||||
|
name: List Instances
|
||||||
|
type: http
|
||||||
|
seq: 1
|
||||||
|
}
|
||||||
|
|
||||||
|
get {
|
||||||
|
url: {{coordinatorBaseUrl}}/api/coordinator/instances
|
||||||
|
body: none
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
settings {
|
||||||
|
encodeUrl: true
|
||||||
|
timeout: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
docs {
|
||||||
|
Returns all known core instances from the in-memory registry.
|
||||||
|
Registry is populated via gRPC heartbeats from core instances.
|
||||||
|
|
||||||
|
Response: InstanceMetadata[]
|
||||||
|
instanceId: string — unique instance ID
|
||||||
|
hostname: string
|
||||||
|
httpPort: int
|
||||||
|
grpcPort: int
|
||||||
|
subscriptionCount: int — number of active game subscriptions
|
||||||
|
localCacheSize: int
|
||||||
|
lastHeartbeat: string — ISO-8601 timestamp
|
||||||
|
state: string — "HEALTHY" | "DEAD"
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
meta {
|
||||||
|
name: coordinator
|
||||||
|
seq: 6
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
meta {
|
||||||
|
name: Game WebSocket
|
||||||
|
type: ws
|
||||||
|
seq: 1
|
||||||
|
}
|
||||||
|
|
||||||
|
ws {
|
||||||
|
url: {{wsBaseUrl}}/api/board/game/{{gameId}}/ws
|
||||||
|
body: ws
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
headers {
|
||||||
|
Authorization: Bearer {{token}}
|
||||||
|
}
|
||||||
|
|
||||||
|
body:ws {
|
||||||
|
name: message 1
|
||||||
|
type: json
|
||||||
|
content: '''
|
||||||
|
{}
|
||||||
|
'''
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
meta {
|
||||||
|
name: User WebSocket
|
||||||
|
type: ws
|
||||||
|
seq: 2
|
||||||
|
}
|
||||||
|
|
||||||
|
ws {
|
||||||
|
url: {{wsBaseUrl}}/api/user/ws
|
||||||
|
body: ws
|
||||||
|
auth: inherit
|
||||||
|
}
|
||||||
|
|
||||||
|
headers {
|
||||||
|
Authorization: Bearer {{token}}
|
||||||
|
}
|
||||||
|
|
||||||
|
body:ws {
|
||||||
|
name: message 1
|
||||||
|
type: json
|
||||||
|
content: '''
|
||||||
|
{}
|
||||||
|
'''
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
meta {
|
||||||
|
name: ws
|
||||||
|
seq: 7
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user