Skip to content

Commit e98b0e0

Browse files
committed
add workflows to metadata API
Signed-off-by: Fabian Martinez <[email protected]>
1 parent 83b5e09 commit e98b0e0

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

daprdocs/content/en/reference/api/metadata_api.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ The metadata API returns information related to Dapr's connection to the app. Th
4040
### Scheduler connection details
4141
Information related to the connection to one or more scheduler hosts.
4242

43+
### Workflow API runtime details
44+
Information related to the Workflow API runtime details.
45+
4346
### Attributes
4447

4548
The metadata API allows you to store additional attribute information in the format of key-value pairs. These are ephemeral in-memory and are not persisted if a sidecar is reloaded. This information should be added at the time of a sidecar creation (for example, after the application has started).
@@ -86,6 +89,7 @@ httpEndpoints | [Metadata API Response HttpEndpoint](#metadataapirespon
8689
subscriptions | [Metadata API Response Subscription](#metadataapiresponsesubscription)[] | A json encoded array of pub/sub subscriptions metadata.
8790
appConnectionProperties| [Metadata API Response AppConnectionProperties](#metadataapiresponseappconnectionproperties) | A json encoded object of app connection properties.
8891
scheduler | [Metadata API Response Scheduler](#metadataapiresponsescheduler) | A json encoded object of scheduler connection properties.
92+
workflows | [Metadata API Response Workflows](#metadataapiresponseworkflows) | A json encoded object of workflows runtime properties
8993

9094
<a id="metadataapiresponseactor"></a>**Metadata API Response Registered Actor**
9195

@@ -152,6 +156,11 @@ Name | Type | Description
152156
---- | ---- | -----------
153157
connected_addresses | string[] | List of strings representing the addresses of the conntected scheduler hosts.
154158

159+
<a id="metadataapiresponseworkflows"></a>**Metadata API Response Workflows**
160+
161+
Name | Type | Description
162+
---- | ---- | -----------
163+
connectedWorkers | integer | Number of connected workflow workers.
155164

156165
### Examples
157166

@@ -232,6 +241,9 @@ curl http://localhost:3500/v1.0/metadata
232241
"10.244.0.48:50006",
233242
"10.244.0.49:50006"
234243
]
244+
},
245+
"workflows": {
246+
"connectedWorkers": 1
235247
}
236248
}
237249
```
@@ -362,6 +374,9 @@ Get the metadata information to confirm your custom attribute was added:
362374
"10.244.0.48:50006",
363375
"10.244.0.49:50006"
364376
]
377+
},
378+
"workflows": {
379+
"connectedWorkers": 1
365380
}
366381
}
367382
```

0 commit comments

Comments
 (0)