feat: Custom message files (#1992)

* feat: add get custom message text to admin api

* feat: read custom message texts from files

* feat: get languages in apis

* feat: get languages in apis

* feat: get languages in apis

* feat: pr feedback

* feat: docs

* feat: merge main
This commit is contained in:
Fabi
2021-07-13 07:13:39 +02:00
committed by GitHub
parent 7ebf0333c3
commit 03a38fbf1c
40 changed files with 1108 additions and 245 deletions

View File

@@ -20,6 +20,18 @@ It respondes as soon as ZITADEL started
GET: /healthz
### GetSupportedLanguages
> **rpc** GetSupportedLanguages([GetSupportedLanguagesRequest](#getsupportedlanguagesrequest))
[GetSupportedLanguagesResponse](#getsupportedlanguagesresponse)
Returns the default languages
GET: /languages
### IsOrgUnique
> **rpc** IsOrgUnique([IsOrgUniqueRequest](#isorguniquerequest))
@@ -658,7 +670,19 @@ it impacts all organisations without a customised policy
> **rpc** GetDefaultInitMessageText([GetDefaultInitMessageTextRequest](#getdefaultinitmessagetextrequest))
[GetDefaultInitMessageTextResponse](#getdefaultinitmessagetextresponse)
Returns the custom text for initial message
Returns the default text for initial message (translation file)
GET: /text/default/message/init/{language}
### GetCustomInitMessageText
> **rpc** GetCustomInitMessageText([GetCustomInitMessageTextRequest](#getcustominitmessagetextrequest))
[GetCustomInitMessageTextResponse](#getcustominitmessagetextresponse)
Returns the custom text for initial message (overwritten in eventstore)
@@ -685,7 +709,19 @@ The Following Variables can be used:
> **rpc** GetDefaultPasswordResetMessageText([GetDefaultPasswordResetMessageTextRequest](#getdefaultpasswordresetmessagetextrequest))
[GetDefaultPasswordResetMessageTextResponse](#getdefaultpasswordresetmessagetextresponse)
Returns the custom text for password reset message
Returns the default text for password reset message (translation file)
GET: /text/deafult/message/passwordreset/{language}
### GetCustomPasswordResetMessageText
> **rpc** GetCustomPasswordResetMessageText([GetCustomPasswordResetMessageTextRequest](#getcustompasswordresetmessagetextrequest))
[GetCustomPasswordResetMessageTextResponse](#getcustompasswordresetmessagetextresponse)
Returns the custom text for password reset message (overwritten in eventstore)
@@ -712,7 +748,19 @@ The Following Variables can be used:
> **rpc** GetDefaultVerifyEmailMessageText([GetDefaultVerifyEmailMessageTextRequest](#getdefaultverifyemailmessagetextrequest))
[GetDefaultVerifyEmailMessageTextResponse](#getdefaultverifyemailmessagetextresponse)
Returns the custom text for verify email message
Returns the default text for verify email message (translation files)
GET: /text/default/message/verifyemail/{language}
### GetCustomVerifyEmailMessageText
> **rpc** GetCustomVerifyEmailMessageText([GetCustomVerifyEmailMessageTextRequest](#getcustomverifyemailmessagetextrequest))
[GetCustomVerifyEmailMessageTextResponse](#getcustomverifyemailmessagetextresponse)
Returns the custom text for verify email message (overwritten in eventstore)
@@ -739,6 +787,18 @@ The Following Variables can be used:
> **rpc** GetDefaultVerifyPhoneMessageText([GetDefaultVerifyPhoneMessageTextRequest](#getdefaultverifyphonemessagetextrequest))
[GetDefaultVerifyPhoneMessageTextResponse](#getdefaultverifyphonemessagetextresponse)
Returns the default text for verify phone message (translation file)
GET: /text/default/message/verifyphone/{language}
### GetCustomVerifyPhoneMessageText
> **rpc** GetCustomVerifyPhoneMessageText([GetCustomVerifyPhoneMessageTextRequest](#getcustomverifyphonemessagetextrequest))
[GetCustomVerifyPhoneMessageTextResponse](#getcustomverifyphonemessagetextresponse)
Returns the custom text for verify phone message
@@ -766,7 +826,19 @@ The Following Variables can be used:
> **rpc** GetDefaultDomainClaimedMessageText([GetDefaultDomainClaimedMessageTextRequest](#getdefaultdomainclaimedmessagetextrequest))
[GetDefaultDomainClaimedMessageTextResponse](#getdefaultdomainclaimedmessagetextresponse)
Returns the custom text for domain claimed message
Returns the default text for domain claimed message (translation file)
GET: /text/default/message/domainclaimed/{language}
### GetCustomDomainClaimedMessageText
> **rpc** GetCustomDomainClaimedMessageText([GetCustomDomainClaimedMessageTextRequest](#getcustomdomainclaimedmessagetextrequest))
[GetCustomDomainClaimedMessageTextResponse](#getcustomdomainclaimedmessagetextresponse)
Returns the custom text for domain claimed message (overwritten in eventstore)
@@ -1171,6 +1243,50 @@ This is an empty response
### GetCustomDomainClaimedMessageTextRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| language | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### GetCustomDomainClaimedMessageTextResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| custom_text | zitadel.text.v1.MessageCustomText | - | |
### GetCustomInitMessageTextRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| language | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### GetCustomInitMessageTextResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| custom_text | zitadel.text.v1.MessageCustomText | - | |
### GetCustomLoginTextsRequest
@@ -1216,6 +1332,72 @@ This is an empty response
### GetCustomPasswordResetMessageTextRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| language | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### GetCustomPasswordResetMessageTextResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| custom_text | zitadel.text.v1.MessageCustomText | - | |
### GetCustomVerifyEmailMessageTextRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| language | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### GetCustomVerifyEmailMessageTextResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| custom_text | zitadel.text.v1.MessageCustomText | - | |
### GetCustomVerifyPhoneMessageTextRequest
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| language | string | - | string.min_len: 1<br /> string.max_len: 200<br /> |
### GetCustomVerifyPhoneMessageTextResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| custom_text | zitadel.text.v1.MessageCustomText | - | |
### GetDefaultDomainClaimedMessageTextRequest
@@ -1567,6 +1749,23 @@ This is an empty request
### GetSupportedLanguagesRequest
This is an empty request
### GetSupportedLanguagesResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| languages | repeated string | - | |
### HealthzRequest
This is an empty request

View File

@@ -19,6 +19,18 @@ title: zitadel/auth.proto
GET: /healthz
### GetSupportedLanguages
> **rpc** GetSupportedLanguages([GetSupportedLanguagesRequest](#getsupportedlanguagesrequest))
[GetSupportedLanguagesResponse](#getsupportedlanguagesresponse)
Returns the default languages
GET: /languages
### GetMyUser
> **rpc** GetMyUser([GetMyUserRequest](#getmyuserrequest))
@@ -646,6 +658,23 @@ the request parameters are read from the token-header
### GetSupportedLanguagesRequest
This is an empty request
### GetSupportedLanguagesResponse
This is an empty response
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| languages | repeated string | - | |
### HealthzRequest
This is an empty request

View File

@@ -43,6 +43,18 @@ Returns some needed settings of the IAM (Global Organisation ID, Zitadel Project
GET: /iam
### GetSupportedLanguages
> **rpc** GetSupportedLanguages([GetSupportedLanguagesRequest](#getsupportedlanguagesrequest))
[GetSupportedLanguagesResponse](#getsupportedlanguagesresponse)
Returns the default languages
GET: /languages
### GetUserByID
> **rpc** GetUserByID([GetUserByIDRequest](#getuserbyidrequest))
@@ -4282,6 +4294,23 @@ This is an empty request
### GetSupportedLanguagesRequest
This is an empty request
### GetSupportedLanguagesResponse
| Field | Type | Description | Validation |
| ----- | ---- | ----------- | ----------- |
| languages | repeated string | - | |
### GetUserByIDRequest