Initial Work on Documentation
This commit is contained in:
46
docs/source/usage.string.rst
Normal file
46
docs/source/usage.string.rst
Normal file
@@ -0,0 +1,46 @@
|
||||
String Type
|
||||
=================
|
||||
|
||||
The String type has the following supported properties:
|
||||
|
||||
- maxLength: Maximum length of the string.
|
||||
- minLength: Minimum length of the string.
|
||||
- pattern: Regular expression pattern that the string must match.
|
||||
- format: A string format that can be used to validate the string (e.g., "email", "uri").
|
||||
|
||||
And the additional generic properties:
|
||||
|
||||
- default: Default value for the string.
|
||||
- description: Description of the string field.
|
||||
|
||||
|
||||
Examples
|
||||
-----------------
|
||||
|
||||
1. Basic String with maxLength and minLength:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from jambo import SchemaConverter
|
||||
|
||||
|
||||
schema = {
|
||||
"title": "StringExample",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"email": {
|
||||
"type": "string",
|
||||
"minLength": 5,
|
||||
"maxLength": 50,
|
||||
},
|
||||
},
|
||||
"required": ["email"],
|
||||
}
|
||||
|
||||
Model = SchemaConverter.build(schema)
|
||||
|
||||
obj = Model(email="this_is_a_valid_string")
|
||||
print(obj)
|
||||
# Output: StringExample(email='this_is_a_valid_string')
|
||||
|
||||
2. String with pattern and format:
|
||||
Reference in New Issue
Block a user