v3 updates docs to correctly describe shemas + schema.validate input + output types

samples/client/3_0_3_unit_test/python/README.md

@@ -112,7 +112,7 @@ N schemas can be validated on the same payload.
 To allow multiple schemas to validate, the data must be stored using one base class whether or not
 a json schema format constraint exists in the schema.
 See te below accessors for string data:
-- type string + format: See .as_date_, .as_datetime_, .as_decimal_, .as_uuid_
+- type string + format: See .as_date, .as_datetime, .as_decimal, .as_uuid
 
 In json schema, type: number with no format validates both integers and floats,
 so int and float values are stored for type number.
@@ -131,7 +131,7 @@ For example the string payload '2023-12-20' is validates to both of these schema
   format: date
 ```
 Because of use cases like this, a datetime.date is allowed as an input to this schema, but the data
-is stored as a string, with a date accessor, instance.as_date_
+is stored as a string, with a date accessor, instance.as_date
 </details>
 
 ## Getting Started

samples/client/3_0_3_unit_test/python/docs/components/schema/_not.md

@@ -1,22 +1,28 @@
+# _Not
 unit_test_api.components.schema._not
-# Schema _Not
+```
+type: schemas.Schema
+```
 
-## Type Info
-Input Type | Accessed Type | Description | Notes
------------- | ------------- | ------------- | -------------
-dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |  |
+## validate method
+Input Type | Return Type | Notes
+------------ | ------------- | -------------
+dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |
 
 ## Composed Schemas (allOf/anyOf/oneOf/not)
 ## not
-Class Name | Input Type | Accessed Type | Description | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-[_not](#not2) | int | int |  |
+Schema Class | Input Type | Return Type
+------------ | ---------- | -----------
+[Not2](#not2) | int | int
 
 # Not2
+```
+type: schemas.Schema
+```
 
-## Type Info
-Input Type | Accessed Type | Description | Notes
------------- | ------------- | ------------- | -------------
-int | int |  |
+## validate method
+Input Type | Return Type | Notes
+------------ | ------------- | -------------
+int | int |
 
 [[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)

samples/client/3_0_3_unit_test/python/docs/components/schema/additionalproperties_allows_a_schema_which_should_validate.md

@@ -1,16 +1,59 @@
+# AdditionalpropertiesAllowsASchemaWhichShouldValidate
 unit_test_api.components.schema.additionalproperties_allows_a_schema_which_should_validate
-# Schema AdditionalpropertiesAllowsASchemaWhichShouldValidate
+```
+type: schemas.Schema
+```
 
-## Type Info
-Input Type | Accessed Type | Description | Notes
+## validate method
+Input Type | Return Type | Notes
+------------ | ------------- | -------------
+[AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput](#additionalpropertiesallowsaschemawhichshouldvalidatedictinput), [AdditionalpropertiesAllowsASchemaWhichShouldValidateDict](#additionalpropertiesallowsaschemawhichshouldvalidatedict) | [AdditionalpropertiesAllowsASchemaWhichShouldValidateDict](#additionalpropertiesallowsaschemawhichshouldvalidatedict) |
+
+## AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput
+```
+type: typing.Mapping[
+    str,
+    typing.Union[
+        typing.Union[
+            schemas.INPUT_TYPES_ALL,
+            schemas.OUTPUT_BASE_TYPES
+        ],
+        typing.Union[
+            schemas.INPUT_TYPES_ALL,
+            schemas.OUTPUT_BASE_TYPES
+        ],
+        bool,
+    ]
+]
+```
+Key | Type |  Description | Notes
 ------------ | ------------- | ------------- | -------------
-dict, schemas.immutabledict | schemas.immutabledict |  |
+**foo** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader |  | [optional]
+**bar** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader |  | [optional]
+**any_string_name** | bool | any string name can be used but the value must be the correct type | [optional]
+
+## AdditionalpropertiesAllowsASchemaWhichShouldValidateDict
+```
+base class: schemas.immutabledict[str, bool]
+
+```
+### __new__ method
+Keyword Argument | Type | Description | Notes
+---------------- | ---- | ----------- | -----
+**foo** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset |  | [optional]
+**bar** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset |  | [optional]
+**kwargs** | bool | any string name can be used but the value must be the correct type | [optional] typed value is accessed with the get_additional_property_ method
+
+### properties
+Property | Type | Description | Notes
+-------- | ---- | ----------- | -----
+**foo** | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset |  | [optional]
+**bar** | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset |  | [optional]
 
-## Dictionary Keys
-Key | Input Type | Accessed Type | Description | Notes
------------- | ------------- | ------------- | ------------- | -------------
-**foo** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |  | [optional]
-**bar** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |  | [optional]
-**any_string_name** | bool | bool | any string name can be used but the value must be the correct type | [optional]
+### methods
+Method | Input Type | Return Type | Notes
+------ | ---------- | ----------- | ------
+from_dict_ | [AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput](#additionalpropertiesallowsaschemawhichshouldvalidatedictinput), [AdditionalpropertiesAllowsASchemaWhichShouldValidateDict](#additionalpropertiesallowsaschemawhichshouldvalidatedict) | [AdditionalpropertiesAllowsASchemaWhichShouldValidateDict](#additionalpropertiesallowsaschemawhichshouldvalidatedict) | a constructor
+get_additional_property_ | str | bool, schemas.Unset | provides type safety for additional properties
 
 [[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)

samples/client/3_0_3_unit_test/python/docs/components/schema/additionalproperties_are_allowed_by_default.md

@@ -1,16 +1,46 @@
+# AdditionalpropertiesAreAllowedByDefault
 unit_test_api.components.schema.additionalproperties_are_allowed_by_default
-# Schema AdditionalpropertiesAreAllowedByDefault
+```
+type: schemas.Schema
+```
 
-## Type Info
-Input Type | Accessed Type | Description | Notes
+## validate method
+Input Type | Return Type | Notes
+------------ | ------------- | -------------
+[AdditionalpropertiesAreAllowedByDefaultDictInput](#additionalpropertiesareallowedbydefaultdictinput), [AdditionalpropertiesAreAllowedByDefaultDict](#additionalpropertiesareallowedbydefaultdict), str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [AdditionalpropertiesAreAllowedByDefaultDict](#additionalpropertiesareallowedbydefaultdict), str, float, int, bool, None, tuple, bytes, io.FileIO |
+
+## AdditionalpropertiesAreAllowedByDefaultDictInput
+```
+type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]
+```
+Key | Type |  Description | Notes
 ------------ | ------------- | ------------- | -------------
-dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |  |
+**foo** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader |  | [optional]
+**bar** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader |  | [optional]
+**any_string_name** | dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO | any string name can be used but the value must be the correct type | [optional]
+
+## AdditionalpropertiesAreAllowedByDefaultDict
+```
+base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]
+
+```
+### __new__ method
+Keyword Argument | Type | Description | Notes
+---------------- | ---- | ----------- | -----
+**foo** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset |  | [optional]
+**bar** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset |  | [optional]
+**kwargs** | schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO | any string name can be used but the value must be the correct type | [optional] typed value is accessed with the get_additional_property_ method
+
+### properties
+Property | Type | Description | Notes
+-------- | ---- | ----------- | -----
+**foo** | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset |  | [optional]
+**bar** | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset |  | [optional]
 
-## Dictionary Keys
-Key | Input Type | Accessed Type | Description | Notes
------------- | ------------- | ------------- | ------------- | -------------
-**foo** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |  | [optional]
-**bar** | dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO |  | [optional]
-**any_string_name** | dict, schemas.immutabledict, list, tuple, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | schemas.immutabledict, tuple, float, int, str, bytes, bool, None, FileIO | any string name can be used but the value must be the correct type | [optional]
+### methods
+Method | Input Type | Return Type | Notes
+------ | ---------- | ----------- | ------
+from_dict_ | [AdditionalpropertiesAreAllowedByDefaultDictInput](#additionalpropertiesareallowedbydefaultdictinput), [AdditionalpropertiesAreAllowedByDefaultDict](#additionalpropertiesareallowedbydefaultdict), str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [AdditionalpropertiesAreAllowedByDefaultDict](#additionalpropertiesareallowedbydefaultdict), str, float, int, bool, None, tuple, bytes, io.FileIO | a constructor
+get_additional_property_ | str | schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO, schemas.Unset }} | provides type safety for additional properties
 
 [[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)

samples/client/3_0_3_unit_test/python/docs/components/schema/additionalproperties_can_exist_by_itself.md

@@ -1,14 +1,39 @@
+# AdditionalpropertiesCanExistByItself
 unit_test_api.components.schema.additionalproperties_can_exist_by_itself
-# Schema AdditionalpropertiesCanExistByItself
+```
+type: schemas.Schema
+```
 
-## Type Info
-Input Type | Accessed Type | Description | Notes
+## validate method
+Input Type | Return Type | Notes
+------------ | ------------- | -------------
+[AdditionalpropertiesCanExistByItselfDictInput](#additionalpropertiescanexistbyitselfdictinput), [AdditionalpropertiesCanExistByItselfDict](#additionalpropertiescanexistbyitselfdict) | [AdditionalpropertiesCanExistByItselfDict](#additionalpropertiescanexistbyitselfdict) |
+
+## AdditionalpropertiesCanExistByItselfDictInput
+```
+type: typing.Mapping[
+    str,
+    bool,
+]
+```
+Key | Type |  Description | Notes
 ------------ | ------------- | ------------- | -------------
-dict, schemas.immutabledict | schemas.immutabledict |  |
+**any_string_name** | bool | any string name can be used but the value must be the correct type | [optional]
+
+## AdditionalpropertiesCanExistByItselfDict
+```
+base class: schemas.immutabledict[str, bool]
+
+```
+### __new__ method
+Keyword Argument | Type | Description | Notes
+---------------- | ---- | ----------- | -----
+**kwargs** | bool | any string name can be used but the value must be the correct type | [optional] typed value is accessed with the get_additional_property_ method
 
-## Dictionary Keys
-Key | Input Type | Accessed Type | Description | Notes
------------- | ------------- | ------------- | ------------- | -------------
-**any_string_name** | bool | bool | any string name can be used but the value must be the correct type | [optional]
+### methods
+Method | Input Type | Return Type | Notes
+------ | ---------- | ----------- | ------
+from_dict_ | [AdditionalpropertiesCanExistByItselfDictInput](#additionalpropertiescanexistbyitselfdictinput), [AdditionalpropertiesCanExistByItselfDict](#additionalpropertiescanexistbyitselfdict) | [AdditionalpropertiesCanExistByItselfDict](#additionalpropertiescanexistbyitselfdict) | a constructor
+get_additional_property_ | str | bool, schemas.Unset | provides type safety for additional properties
 
 [[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)