ci should not pass when new fields are added in GO structs but json schema is not corresponding changed

[caozhuozi]

Currently, when a contributor add a new field in the ModelConfig but forget to change the json schema, CI will not catch it.

[caozhuozi]

/assign

[caozhuozi]

After thinking more deeply about the question, I realized the situation is much more complex than I initially thought.
The ultimate goal—or the ideal solution—is to generate a JSON Schema from Go structs.

This reminded me of how Kubernetes generates OpenAPI schemas (although in our case, it's JSON Schema) from Go types. Kubernetes built the gengo library specifically for this purpose.

Let me briefly explain how it works, to give a rough idea of why this process is complex:
When defining Kubernetes kind structs in Go, developers can add special comment annotations like // +required to a field. The gengo library parses the Go source code into an Abstract Syntax Tree (AST), analyzes these annotations, and uses them to generate the corresponding schema metadata—for example, mapping // +required comment to a "required" field in the schema.

Of course, we could implement something similar in Modelpack. However, this would introduce additional complexity to the current codebase. I don't think the effort is justified if the only benefit is CI enhancement.

cc: @tarilabs @sabre1041

[tarilabs]

it's an interesting point @caozhuozi thank you for bringing this up; I wonder if we want to settle for "code-first approach" eg as you describe, use Go struct as the reference, then export json schema, or "contract-first approach" eg we maintain the json schema as the reference, and export go struct or else as required. I would urge to consider these options as a community, personally I'm fine either way, for as long as we also publish simultaneously both Go struct and json schema

[aftersnow]

For AI ecosystem, maybe we need also to provide Python APIs.

[tarilabs]

For AI ecosystem, maybe we need also to provide Python APIs.

agree, also noticed this: oras-project/oras-py#216

[aftersnow]

How about using pydantic to generate Python/Go struct? @caozhuozi