NotificationsYou must be signed in to change notification settings
Fork2.2k
Star24.6k

Always include`additionalProperties: True` for arbitrary dictionary schemas#11392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

Viicos merged 1 commit intopydantic:mainfromaustinyu:addition-properties-true-json-schema

Feb 7, 2025

Merged

Always include`additionalProperties: True` for arbitrary dictionary schemas#11392

Viicos merged 1 commit intopydantic:mainfromaustinyu:addition-properties-true-json-schema

Feb 7, 2025

Conversation

Copy link

Contributor

austinyu commentedFeb 5, 2025•
edited by Viicos
Loading

Change Summary

For following example, an extraadditionalProperties: True will be added to the existing json schema.

fromtypingimportAnyfrompydanticimportBaseModelclassModel(BaseModel):conditions:dict[str,Any]after=Model.model_json_schema()before= {"properties": {"conditions": {"title":"Conditions","type":"object"}},"required": ["conditions"],"title":"Model","type":"object",}assertafter== {"properties": {"conditions": {"additionalProperties":True,"title":"Conditions","type":"object",        }    },"required": ["conditions"],"title":"Model","type":"object",}

The same rule will be applied to all fields of the following model.

fromtypingimportAnyfromtypingimportDictfrompydanticimportBaseModelclassModel(BaseModel):ex3:dictex1:dict[str,Any]ex2:dict[Any,Any]ex4:Dictex5:Dict[str,Any]ex6:Dict[Any,Any]after=Model.model_json_schema()assertafter== {"properties": {"ex3": {"additionalProperties":True,"title":"Ex3","type":"object"},"ex1": {"additionalProperties":True,"title":"Ex1","type":"object"},"ex2": {"additionalProperties":True,"title":"Ex2","type":"object"},"ex4": {"additionalProperties":True,"title":"Ex4","type":"object"},"ex5": {"additionalProperties":True,"title":"Ex5","type":"object"},"ex6": {"additionalProperties":True,"title":"Ex6","type":"object"},    },"required": ["ex3","ex1","ex2","ex4","ex5","ex6"],"title":"Model","type":"object",}

Related issue number

fix#11318

Checklist

The pull request title is a good summary of the changes - it will be used in the changelog
Unit tests for the changes exist
Tests pass on CI
Documentation reflects the changes where applicable
My PR is ready to review,please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer:@sydney-runkle