Remove deprecated releaseConcurrency from wait.forToken() docs (#2477)

This commit is contained in:
Matt Aitken
2025-09-04 14:57:17 +01:00
committed by GitHub
parent 00d32ed4ee
commit e6586d3c1a
-18
View File
@@ -263,24 +263,6 @@ Wait for a token to be completed.
The token to wait for.
</ParamField>
<ParamField query="options" type="object" optional>
Options for the wait.
<Expandable title="properties">
<ParamField query="releaseConcurrency" type="boolean" optional>
If set to true, this will cause the waitpoint to release the current run from the queue's concurrency.
This is useful if you want to allow other runs to execute while waiting
Note: It's possible that this run will not be able to resume when the waitpoint is complete if this is set to true.
It will go back in the queue and will resume once concurrency becomes available.
The default is `false`.
</ParamField>
</Expandable>
</ParamField>
### returns
The `forToken` function returns a result object with the following properties: