Extra keys when generating models

[gk12277]

Hi,
Is it possible to add extra keys and values when generating models form jsonschema.

eg:

---
"$schema": http://json-schema.org/draft-07/schema#
title: Person
type: object
properties:
  firstName:
    type: string
    description: The person's first name.

Using this schema I generated models

# generated by datamodel-codegen:
#   filename:  person.yaml
#   timestamp: 2021-04-22T11:25:47+00:00

from __future__ import annotations

from typing import Optional

from pydantic import BaseModel, Field


class Person(BaseModel):
    firstName: Optional[str] = Field(None, description="The person's first name.")

Is there a way to specify key1, key2 and values in my schema so that the model is generated as below
eg:

firstName: Optional[str] = Field(
        None, 
        description="The person's first name.", 
        key1={"a":"a1", "b":"b1"}, 
        key2="aaaa"
   )

[koxudaxi]

Hi @gk12277

Is it possible to add extra keys and values when generating models form jsonschema.

the short answer is no.

Is there a way to specify key1, key2 and values in my schema so that the model is generated as below

Where are key1, key2?
Did you expect this schema?

"$schema": http://json-schema.org/draft-07/schema#
title: Person
type: object
properties:
  firstName:
    type: string
    description: The person's first name.
    key1: 
      a: a1
      b: b1
    key2: aaaa

I can add an option of CLI to pass extra keys to the field.
For example

$ datamodel-codegen --input input.json --extra-keys key1 key2

What do you think about it?

[gk12277]

Hey, @koxudaxi Thanks for the quick response 😄 .

Yes, an option like this would be great. Also since any key, can be added how about also adding an option like --include-all-keys which adds all keys to Field by default.

Also,
JSON Schema draft 2019-09 provides an option to create identifiable vocabularies
https://github.com/json-schema-org/json-schema-vocabularies. Support for this in the future will be quite useful.

[koxudaxi]

@gk12277

Yes, an option like this would be great. Also since any key, can be added how about also adding > an option like --include-all-keys which adds all keys to Field by default.

we should exclude reserved key like alias 🤔

I have not checked JSON Schema draft 2019-09 yet 😅

I will implement --include-all-keys or --extra-keys in first step.
Thank you very much.

[koxudaxi]

@gk12277
I have pushed a new version as 0.11.2.
This version has new options.

  --field-extra-keys FIELD_EXTRA_KEYS [FIELD_EXTRA_KEYS ...]
                        Add extra keys to field parameters
  --field-include-all-keys
                        Add all keys to field parameters

Would you please check it?

[gk12277]

Thanks @koxudaxi
Tried it. Works like a charm 😄 .