Make tool JSON schemas consistent (#31756)

Make the order of array items consistent using sorted()
This commit is contained in:
Matt 2024-07-02 20:00:42 +01:00 committed by GitHub
parent 82486e5995
commit cd0935dd55
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions

View file

@ -80,7 +80,7 @@ def _parse_type_hint(hint: str) -> Dict:
return_dict = subtypes[0]
elif all(isinstance(subtype["type"], str) for subtype in subtypes):
# A union of basic types can be expressed as a list in the schema
return_dict = {"type": [subtype["type"] for subtype in subtypes]}
return_dict = {"type": sorted([subtype["type"] for subtype in subtypes])}
else:
# A union of more complex types requires "anyOf"
return_dict = {"anyOf": subtypes}

View file

@ -137,7 +137,7 @@ class JsonSchemaGeneratorTest(unittest.TestCase):
"properties": {
"x": {
"type": "array",
"items": {"type": "array", "items": {"type": ["string", "integer"]}},
"items": {"type": "array", "items": {"type": ["integer", "string"]}},
"description": "The input",
}
},
@ -455,13 +455,13 @@ class JsonSchemaGeneratorTest(unittest.TestCase):
},
"y": {
"type": "array",
"items": {"type": ["string", "integer"]},
"items": {"type": ["integer", "string"]},
"nullable": True,
"description": "The second input. It's a big list with a single-line description.",
},
"z": {
"type": "array",
"prefixItems": [{"type": ["string", "integer"]}, {"type": "string"}],
"prefixItems": [{"type": ["integer", "string"]}, {"type": "string"}],
"description": "The third input. It's some kind of tuple with a default arg.",
},
},