Usage
Options
string
required
The exact path or a Glob pattern to the definition file or files. Each definition file must be a YAML or JSON file containing model definitions.
- Example single file path:
definition/models.json - Example Glob pattern:
'definition/**/*.yml'
string
required
The target environment for which the types are generated. This option specifies the target SDK and version, ensuring
that the output is compatible with the chosen environment. See the list of available targets here.
string
required
The path to the output file.
string
The base class from which all the generated Python models will extend. The base class must extend
pydantic.BaseModel and the option must be provided in the format x.y.ModelName. If this option is not provided, the generated models will extend from pydantic.BaseModel.Example values:custom.MyModela.b.c.MyCustomModel
string
default:"UNDEFINED"
The name of the sentinel value used to indicate that a field should be missing from a given object. This is generated
as a variable alongside your model definitions.
int
default:2
Indentation or tab width for the generated code.
boolean
default:false
Whether to enable debug logs.
Targets
firebase-admin@6: For Python projects that rely on the Firebase Admin Python SDK (v6).