TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 15:37:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix the example docs related to set execution api (actions) (#10359)

Browse Source 
# Which Problems Are Solved

Fix docs related to Actions V2 SetExecution API
[endpoint](https://zitadel.com/docs/apis/resources/action_service_v2/action-service-set-execution)

# How the Problems Are Solved

The examples are updated

# Additional Changes
N/A

# Additional Context
- Closes #10320
This commit is contained in:
Gayathri Vijayan
2025-07-31 10:50:17 +02:00
committed by Stefan Benz
parent 819b82e525
commit 01c02d7807
10 changed files with 17 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/guides/integrate/actions/testing-event.md
View File

@@ -103,9 +103,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-function-manipulation.md
View File

@@ -129,9 +129,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-function.md
View File

@@ -107,9 +107,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-request-manipulation.md
View File

@@ -154,9 +154,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-request-signature.md
View File

@@ -114,9 +114,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-request.md
View File

@@ -107,9 +107,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-response-manipulation.md
View File

@@ -173,9 +173,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

4
docs/docs/guides/integrate/actions/testing-response.md
View File

@@ -107,9 +107,7 @@ curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/actions/executions' \
} }
}, },
"targets": [ "targets": [
{ "<TargetID returned>"
"target": "<TargetID returned>"
}
] ]
}' }'
``` ```

31
docs/docs/guides/integrate/actions/usage.md
View File

@@ -406,17 +406,11 @@ If you then have a call on `/zitadel.user.v2.UserService/UpdateHumanUser` the fo
And if you use a different service, for example `zitadel.session.v2.SessionService`, then the `all` Execution would still be used. And if you use a different service, for example `zitadel.session.v2.SessionService`, then the `all` Execution would still be used.
### Targets and Includes ### Targets
:::info An execution can contain only a list of Targets, and Targets are comma separated string values.
Includes are limited to 3 levels, which mean that include1->include2->include3 is the maximum for now.
If you have feedback to the include logic, or a reason why 3 levels are not enough, please open [an issue on github](https://github.com/zitadel/zitadel/issues) or [start a discussion on github](https://github.com/zitadel/zitadel/discussions)/[start a topic on discord](https://zitadel.com/chat)
:::
An execution can not only contain a list of Targets, but also Includes. Here's an example of a Target defined on a service (e.g. `zitadel.user.v2.UserService`)
The Includes can be defined in the Execution directly, which means you include all defined Targets by a before set Execution.
If you define 2 Executions as follows:
```json ```json
{ {
@@ -426,13 +420,12 @@ If you define 2 Executions as follows:
} }
}, },
"targets": [ "targets": [
{ "<TargetID1>"
"target": "<TargetID1>"
}
] ]
} }
``` ```
Here's an example of a Target defined on a method (e.g. `/zitadel.user.v2.UserService/AddHumanUser`)
```json ```json
{ {
"condition": { "condition": {
@@ -441,21 +434,13 @@ If you define 2 Executions as follows:
} }
}, },
"targets": [ "targets": [
{ "<TargetID2>",
"target": "<TargetID2>" "<TargetID1>"
},
{
"include": {
"request": {
"service": "zitadel.user.v2.UserService"
}
}
}
] ]
} }
``` ```
The called Targets on "/zitadel.user.v2.UserService/AddHumanUser" would be, in order: The called Targets on `/zitadel.user.v2.UserService/AddHumanUser` would be, in order:
1. `<TargetID2>` 1. `<TargetID2>`
2. `<TargetID1>` 2. `<TargetID1>`

2
proto/zitadel/action/v2beta/action_service.proto
View File

@@ -675,7 +675,7 @@ message SetExecutionRequest {
// Ordered list of targets called during the execution. // Ordered list of targets called during the execution.
repeated string targets = 2; repeated string targets = 2;
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
example: "{\"condition\":{\"request\":{\"method\":\"zitadel.session.v2.SessionService/ListSessions\"}},\"targets\":[{\"target\":\"69629026806489455\"}]}"; example: "{\"condition\":{\"request\":{\"method\":\"zitadel.session.v2.SessionService/ListSessions\"}},\"targets\":[\"69629026806489455\"]}";
}; };
} }