Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
Charts
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
魏国强
Charts
Commits
984c5c2e
Unverified
Commit
984c5c2e
authored
Jul 13, 2021
by
Waqar Ahmed
Committed by
GitHub
Jul 13, 2021
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #91 from truenas/NAS-111270
Document string schema custom attributes
parents
da288150
76546b7a
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
28 additions
and
0 deletions
+28
-0
docs/schema/string.md
docs/schema/string.md
+28
-0
No files found.
docs/schema/string.md
0 → 100644
View file @
984c5c2e
## String Schema
#### Example of string schema options:
```
schema:
type: string
private: true
min_length: 5
max_length: 12
valid_chars: "[a-zA-Z0-9]$"
```
Following attributes can be added to string schema to enforce validation when a chart release is being created/edited:
`min_length`
is an integer field which adds validation to ensure value provided for this variable is at least the specified
characters.
`max_length`
is an integer field which adds validation to ensure value provided for this variable is at max the specified
characters.
`private`
is a boolean field which when set by chart maintainer, will result in the value of the variable not being
shown to the user in the UI. This is useful for sensitive fields like password where a dummy character is placed for
each character provided for this string in the UI.
`valid_chars`
is a string field which chart maintainer can specify to provide a regex to enforce that the value provided
for the variable should conform to a pattern. TrueNAS Scale will use python3 regex (https://docs.python.org/3/library/re.html)
syntax to enforce
`valid_chars`
.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment