fix(api): use organization instead of organisation (#6720)

* fix(api): use organization instead of organisation

* fix test

* docs: add deprecation notice

* remove validation
This commit is contained in:
Livio Spring
2023-10-13 15:37:35 +03:00
committed by GitHub
parent 27e03120dc
commit 95889cf576
11 changed files with 79 additions and 19 deletions

View File

@@ -3763,7 +3763,7 @@ service AdminService {
// Activates the "LoginDefaultOrg" feature by setting the flag to "true"
// This is irreversible!
// Once activated, the login UI will use the settings of the default org (and not from the instance) if not organisation context is set
// Once activated, the login UI will use the settings of the default org (and not from the instance) if not organization context is set
rpc ActivateFeatureLoginDefaultOrg(ActivateFeatureLoginDefaultOrgRequest) returns (ActivateFeatureLoginDefaultOrgResponse) {
option (google.api.http) = {
put: "/features/login_default_org"

View File

@@ -6806,7 +6806,7 @@ service ManagementService {
};
}
// Add a new Azure AD identity provider in the organisation
// Add a new Azure AD identity provider in the organization
rpc AddAzureADProvider(AddAzureADProviderRequest) returns (AddAzureADProviderResponse) {
option (google.api.http) = {
post: "/idps/azure"
@@ -6824,7 +6824,7 @@ service ManagementService {
};
}
// Change an existing Azure AD identity provider in the organisation
// Change an existing Azure AD identity provider in the organization
rpc UpdateAzureADProvider(UpdateAzureADProviderRequest) returns (UpdateAzureADProviderResponse) {
option (google.api.http) = {
put: "/idps/azure/{id}"

View File

@@ -8,6 +8,7 @@ import "google/protobuf/timestamp.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
import "validate/validate.proto";
// Deprecated: use Organization
message Organisation {
oneof org {
string org_id = 1;
@@ -15,6 +16,13 @@ message Organisation {
}
}
message Organization {
oneof org {
string org_id = 1;
string org_domain = 2;
}
}
message RequestContext {
oneof resource_owner {
string org_id = 1;

View File

@@ -48,7 +48,7 @@ message GrantedProject {
];
string granted_org_name = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
example: "\"Some Organisation\""
example: "\"Some Organization\""
}
];
repeated string granted_role_keys = 4 [

View File

@@ -73,9 +73,15 @@ message UserFactor {
description: "\"display name of the checked user\"";
}
];
// deprecated: use organization_id, will be remove before GA (https://github.com/zitadel/zitadel/issues/6718)
string organisation_id = 5 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "\"organisation id of the checked user\"";
description: "\"organization id of the checked user; deprecated: use organization_id\"";
}
];
string organization_id = 6 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "\"organization id of the checked user\"";
}
];
}

View File

@@ -119,7 +119,7 @@ service UserService {
option (zitadel.protoc_gen_zitadel.v2.options) = {
auth_option: {
permission: "user.write"
org_field: "organisation"
org_field: "organization"
}
http_response: {
success_code: 201
@@ -655,7 +655,13 @@ message AddHumanUserRequest{
example: "\"minnie-mouse\"";
}
];
zitadel.object.v2beta.Organisation organisation = 3;
// deprecated: use organization (if both are set, organization will take precedence)
zitadel.object.v2beta.Organisation organisation = 3 [
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
description: "deprecated: use organization (if both are set, organization will take precedence)"
}
];
zitadel.object.v2beta.Organization organization = 11;
SetHumanProfile profile = 4 [
(validate.rules).message.required = true,
(google.api.field_behavior) = REQUIRED