Method get_union_of_schemas

pydantic/json_schema.py:1290–1324

Returns the JSON Schema representation for the union of the provided JSON Schemas. The result depends on the configured `'union_format'`. Args: schemas: The list of JSON Schemas to be included in the union. Returns: The JSON Schema representing the

(self, schemas: list[JsonSchemaValue])

        return self.get_union_of_schemas(generated)

    def get_union_of_schemas(self, schemas: list[JsonSchemaValue]) -> JsonSchemaValue:
        """Returns the JSON Schema representation for the union of the provided JSON Schemas.

        The result depends on the configured `'union_format'`.

        Args:
            schemas: The list of JSON Schemas to be included in the union.

        Returns:
            The JSON Schema representing the union of schemas.
        """
        if self.union_format == 'primitive_type_array':
            types: list[str] = []
            for schema in schemas:
                schema_types: list[str] | str | None = schema.get('type')
                if schema_types is None:
                    # No type, meaning it can be a ref or an empty schema.
                    break
                if not isinstance(schema_types, list):
                    schema_types = [schema_types]
                if not all(t in _PRIMITIVE_JSON_SCHEMA_TYPES for t in schema_types):
                    break
                if len(schema) != 1:
                    # We only want to include types that don't have any constraints. For instance,
                    # if `schemas = [{'type': 'string', 'maxLength': 3}, {'type': 'string', 'minLength': 5}]`,
                    # we don't want to produce `{'type': 'string', 'maxLength': 3, 'minLength': 5}`.
                    # Same if we have some metadata (e.g. `title`) on a specific union member, we want to preserve it.
                    break

                types.extend(schema_types)
            else:
                # If we got there, all the schemas where valid to be used with the `'primitive_type_array` format
                return {'type': list(dict.fromkeys(types))}

        return self.get_flattened_anyof(schemas)

    def tagged_union_schema(self, schema: core_schema.TaggedUnionSchema) -> JsonSchemaValue:
        """Generates a JSON schema that matches a schema that allows values matching any of the given schemas, where