Skip to content

Commit

Permalink
Update yaml examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ramya18101 committed Dec 16, 2024
1 parent be6d84a commit c15dd54
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/resource-specific-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The Deploy CLI's own client grant is intentionally not exported nor configurable
## Prompts

Multilingual custom text prompts follow a particular hierarchy. Under the root-level `prompts` resource property is a proprietary `customText` property that is used to bundle custom text translations with other prompts settings. Underneath `customText` is the two-character language code. Thirdly is the prompt ID, followed by the screen ID, followed by text ID.

RenderSettings of a prompt-screen follow a particular hierarchy. Under the root-level `prompts` we store `screenRenderers` property that is used to configure the rendering settings of a given prompt & screen. Thirdly is the prompt Name, followed by the screen Name mapped to the respective renderer configs file. Refer [more](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) on this.

**Hierarchy**
Expand Down
16 changes: 16 additions & 0 deletions examples/yaml/tenant.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,19 @@ triggers:
post-user-registration: []
pre-user-registration: []
send-phone-message: []

prompts:
customText:
en:
login-id:
login-id:
invalid-email-format: Email is not valid.
enable_ulp_wcag_compliance: false
identifier_first: false
partials: {}
screenRenderers:
- signup-id:
signup-id: ./prompts/screenRenderSettings/signup-id_signup-id.json
- login-passwordless:
login-passwordless-email-code: ./prompts/screenRenderSettings/login-passwordless_login-passwordless-email-code.json
login-passwordless-sms-otp: ./prompts/screenRenderSettings/login-passwordless_login-passwordless-sms-otp.json
2 changes: 1 addition & 1 deletion test/context/directory/prompts.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ describe('#directory context prompts', () => {
const repoDir = path.join(testDataDir, 'directory', 'prompts');
createDir(repoDir, files);

const settingsDir = path.join(repoDir,constants.PROMPTS_DIRECTORY, 'screenRenderSettings');
const settingsDir = path.join(repoDir,constants.PROMPTS_DIRECTORY, constants.PROMPTS_SCREEN_RENDER_DIRECTORY);
createDir(settingsDir, settingsfiles);

const partialsDir = path.join(
Expand Down

0 comments on commit c15dd54

Please sign in to comment.