Autodocs: Updates for pydantic models
Metadata
Current evaluation
Documentation task has two concrete goals: one charmcraft.yaml schema and alphabetised schema entries. Schema generation now exists, but ordering and autodoc integration remain unverified.
Suggested action: keep open
Reason: lengau (maintainer) explicitly recorded both action items and the documentation rationale, so this is a valid, scoped enhancement that should stay open. Commit b4aee1e9 (#2183) adds tools/schema.py and schema/charmcraft.json, but the generator does not explicitly sort the schema and the issue has no recorded follow-up, leaving the alphabetisation requirement unresolved.
Evaluated by: mr-cal-bot
Issue body
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
30
Quick Win:
14
Complexity:
35
Confidence:
82
Actionability:
72
|
keep open | Documentation task has two concrete goals: one charmcraft.yaml schema and alphabetised schema entries. Schema generation now exists, but ordering and autodoc integration remain unverified. | |
| qwen/qwen3.6-35b-a3b |
Impact:
40
Quick Win:
26
Complexity:
20
Confidence:
85
Actionability:
80
|
close resolved | Issue requested creating a single charmcraft.yaml schema and alphabetizing schema items for better autodocs. A single JSON schema is now auto-generated from pydantic models via tools/schema.py and stored in schema/charmcraft.json. The $defs appear alphabetized. | |
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
17
Staleness:
55
Complexity:
15
Confidence:
72
Support Request:
0
|
needs triage | Tracking issue for two action items: create a single charmcraft.yaml schema (done via PR #2183) and alphabetize schema items (not done). No labels, comments, or assignee; no activity for ~12.5 months. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
90
Complexity:
20
Confidence:
90
Support Request:
5
|
needs triage | Request to consolidate charmcraft.yaml schema into a single file and alphabetize items to improve auto-generated documentation. Currently unlabelled, inactive for over a year, and awaiting implementation. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
20
Confidence:
75
Support Request:
10
|
needs triage | Task to consolidate charmcraft.yaml schema into a single pydantic model and alphabetize items for better autodocs. Currently unlabelled, inactive for over a year, and awaiting maintainer triage. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
95
Complexity:
15
Confidence:
80
Support Request:
5
|
needs triage | Request to consolidate charmcraft.yaml schema into a single definition and alphabetize items to improve auto-generated documentation. Currently unlabelled and inactive for over a year. |
Update history
No update history recorded yet.
Related work
-
Related To:
craft-application#662
(confidence 95%)
Open companion work explicitly adds reference documentation for Pydantic models.
-
Related To:
craft-archives#118
(confidence 82%)
Related Pydantic model cleanup may affect the model layout used for generated documentation.
-
Likely Fixed By:
charmcraft#2183
(confidence 78%)
Adds schema generation, the stored charmcraft.json schema, and CI validation; this directly addresses the single-schema portion but does not establish that ordering is complete.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #118 Make Pydantic models more idiomatic | craft-archives | open | Pydantic 2 modernization and schema-enabling model metadata now appear implemented through later cleanup and model-documentation changes, despite the issue remaining open. |