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

Latest commit

 

History

History
30 lines (29 loc) · 2.16 KB

migration_3_0_0.md

File metadata and controls

30 lines (29 loc) · 2.16 KB

Migration v2.0.0 to v3.0.0

  • DynamicSchema classes are no longer produced, all schemas are validated, but only one schema class produces output classes for instantiation. Instances no longer subclass all validated schemas.
    • the schema that is used is the first schema that is checked
    • so if you depended on .methodName access on a oneOf schema, that will no longer work
    • instead use instance['methodName'] access
    • so if you depended on isinstance(instance SomeOneOfSchema) instead check that the instance contains the needed oneOf properties that you are trying to use
  • SomeSchema.new no longer validates payloads
    • instead use SomeSchema.validate or SomeSchemaDict.new
  • SomeSchema.Schema_ inner class has been moved to the class SomeSchema
    • so if you need to access openapi schema info, use SomeSchema
    • so if you depended on SomeSchema.SOME_ENUM, update it to SomeSchema.enums.SOME_ENUM
  • instance.get_item_ methods have been removed to reduce amount of generated code
    • optional properties are now generated as @property methods
    • so one can use instance.someProp OR instance.get('someProp', schemas.unset)
  • instance methods as_date_, as_datetime_, as_decimal_, as_uuid_ have been changed to functions and moved into the schemas module
    • now that python primitives are returned from validation for str/int/float/bool/None, custom methods could not be provided for those instances
    • so instead update your code to use schemas.as_date/as_datetime/as_decimal/as_uuid
  • Output classes are only written for json schema type object (dict) and array (tuple) types
    • so if you depended on boolean/null/string/number instances being an instance of a Schema class update your code to handle the primitive values instead
  • NoneClass instances no longer returned from schema validation, None returned instead
    • so update your code to handle None values
  • BoolClass instances no longer returned from schema validation, True/False returned instead
    • so update you code to handle bool values
  • Decimal instances are no longer returned for type integer or type number schemas, int or float values are returned
    • so update your code to use the int or float values