Skip to content

Commit 89d5b9c

Browse files
mesutoezdilthockin
authored andcommitted
fix: correct stale actor_id field references in api-guide gRPC docs
1 parent 6168ad3 commit 89d5b9c

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/api-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -239,22 +239,22 @@ The Substrate Control Plane (`ate-api-server`) exposes a gRPC interface for mana
239239
#### `CreateActor`
240240
Registers a new logical actor in the system.
241241
* **Request:** `CreateActorRequest`
242-
* `actor_id`: Unique identifier (DNS-1123 label).
242+
* `actor_ref`: `ActorRef` (atespace and actor ID, ID must be a DNS-1123 label).
243243
* `actor_template_namespace`: Namespace of the `ActorTemplate`.
244244
* `actor_template_name`: Name of the `ActorTemplate`.
245245
* **Response:** `CreateActorResponse` containing the initialized `Actor` object.
246246

247247
#### `ResumeActor`
248248
Activates a suspended actor by restoring it onto a physical worker.
249249
* **Request:** `ResumeActorRequest`
250-
* `actor_id`: ID of the actor to resume.
250+
* `actor_ref`: `ActorRef` of the actor to resume.
251251
* `boot`: (Optional) If `true`, bypasses snapshots and performs a cold boot.
252252
* **Response:** `ResumeActorResponse` containing the updated `Actor` object (including the physical `worker_ip`).
253253

254254
#### `SuspendActor`
255255
Hibernate a running actor, capturing its current RAM and disk state into a snapshot.
256256
* **Request:** `SuspendActorRequest`
257-
* `actor_id`: ID of the actor to suspend.
257+
* `actor_ref`: `ActorRef` of the actor to suspend.
258258
* **Response:** `SuspendActorResponse` containing the `Actor` object in `STATUS_SUSPENDED`.
259259

260260
#### `DeleteActor`

0 commit comments

Comments
 (0)