Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit 04d45fb

Browse files
committed
Readme updated
1 parent 7133ae8 commit 04d45fb

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,23 @@ Currently, the following languages/frameworks are supported:
3636
- instantiating models
3737
- sending to endpoints
3838
- receiving from endpoints
39-
- Type hints for all model inputs
40-
- Type hints for accessing properties in object instances so some_val in some_val = some_inst['someKey'] will have the correct type hint
41-
- Type hints for accessing array items in array instances so some_val in some_val = array_inst[0] will have the correct type hint
42-
- Endpoints have input and response type hints
39+
- Type hints on
40+
- all model inputs in `__new__`
41+
- accessing properties in object instances so some_val in some_val = some_inst['someKey'] will have the correct type hint
42+
- accessing array items in array instances so some_val in some_val = array_inst[0] will have the correct type hint
43+
- endpoint inputs + response
44+
- Format support for: int32, int64, float, double, binary, date, datetime, uuid
45+
- Invalid (in python) property names supported like from, 1var, hi-there etc in
46+
- schema property names
47+
- endpoint parameter names
4348
- Openapi spec inline schemas supported at any depth
4449
- If needed, validation of some json schema keywords can be deactivated via a configuration class
4550
- Payload values are not coerced when validated, so a datetime value can pass other validations that describe the payload only as type string
4651
- String transmission of numbers supported with type: string, format: number, value can be accessed as a Decimal with inst.as_decimal_oapg
47-
- Format support for: int32, int64, float, double, binary, date, datetime
4852
- Multiple content types supported for request and response bodies
4953
- Endpoint response always also includes the urllib3.HTTPResponse
5054
- Endpoint response deserialization can be skipped with the skip_deserialization argument
51-
- Invalid (in python) property names supported like self, from etc
55+
- Validated payload instances subclass all validated schemas so no need to run validate twice, just use isinstance(some_inst, SomeSchemaClass)
5256

5357
And many more!
5458
- [Docs for the python generator](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator/blob/master/docs/generators/python.md)

0 commit comments

Comments
 (0)