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

docs: add invalid information to member requests (#9858)

Browse Source 
# Which Problems Are Solved

Misleading information on member endpoint requests.

# How the Problems Are Solved

Add comment to member endpoint requests that the request is invalid if
no roles are provided.

# Additional Changes

None

# Additional Context

Closes #9415

Co-authored-by: Fabienne Bühler <fabienne@zitadel.com>
This commit is contained in:
Stefan Benz
2025-05-07 15:59:02 +02:00
committed by GitHub
parent 898366c537
commit c6aa6385b6
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
proto/zitadel/management.proto
View File

@@ -9209,7 +9209,7 @@ message AddOrgMemberRequest {
repeated string roles = 2 [ repeated string roles = 2 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "[\"ORG_OWNER\"]"; example: "[\"ORG_OWNER\"]";
description: "If no roles are provided the user won't have any rights" description: "If no roles are provided the user won't have any rights, so the member definition will be regarded as invalid."
} }
]; ];
} }
@@ -9222,7 +9222,7 @@ message UpdateOrgMemberRequest {
repeated string roles = 2 [ repeated string roles = 2 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "[\"IAM_OWNER\"]"; example: "[\"IAM_OWNER\"]";
description: "If no roles are provided the user won't have any rights" description: "If no roles are provided the user won't have any rights, so the member definition will be regarded as invalid."
} }
]; ];
} }
@@ -9643,7 +9643,7 @@ message AddProjectMemberRequest {
repeated string roles = 3 [ repeated string roles = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "[\"PROJECT_OWNER\"]"; example: "[\"PROJECT_OWNER\"]";
description: "If no roles are provided the user won't have any rights" description: "If no roles are provided the user won't have any rights, so the member definition will be regarded as invalid."
} }
]; ];
} }
@@ -9658,7 +9658,7 @@ message UpdateProjectMemberRequest {
repeated string roles = 3 [ repeated string roles = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "[\"PROJECT_OWNER\"]"; example: "[\"PROJECT_OWNER\"]";
description: "If no roles are provided the user won't have any rights" description: "If no roles are provided the user won't have any rights, so the member definition will be regarded as invalid."
} }
]; ];
} }
@@ -10313,7 +10313,7 @@ message AddProjectGrantMemberRequest {
repeated string roles = 4 [ repeated string roles = 4 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "[\"PROJECT_GRANT_OWNER\"]"; example: "[\"PROJECT_GRANT_OWNER\"]";
description: "If no roles are provided the user won't have any rights" description: "If no roles are provided the user won't have any rights, so the member definition will be regarded as invalid."
} }
]; ];
} }
@@ -10337,7 +10337,7 @@ message UpdateProjectGrantMemberRequest {
repeated string roles = 4 [ repeated string roles = 4 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "[\"PROJECT_GRANT_OWNER\"]"; example: "[\"PROJECT_GRANT_OWNER\"]";
description: "If no roles are provided the user won't have any rights" description: "If no roles are provided the user won't have any rights, so the member definition will be regarded as invalid."
} }
]; ];
} }