Problem
(This is assuming I get the metrics field implemented)
Let's say the metrics field reports:
"metrics": {
"operations_total": 12,
"operations_missing_descriptions": 7,
"parameters_total": 15,
"parameters_missing_descriptions": 5
}
And the issues list is capped at 5-8 issues. A user may want to actually see where all 12 missing operations are.
Current Behavior
This behavior isn't implemented yet.
Proposed Solution
If a user runs smartdoc check [file] --verbose, they would see all issues in the issues array.
Why This Might Solve the Problem
Give users all the issues instead of 5-8 so they can dig into the issues if they want.
Success Criteria
{
"status": "issues_found",
"metrics": {
"operations_total_count": 12,
"operations_missing_descriptions_count": 7
},
"issues": [
{
"path": "POST /orders operation description",
"issue": "Operation description is empty.",
"action": "Add a concise, user-facing description..."
},
{
"path": "GET /orders/{orderId} 200 response description",
"issue": "200 response description is empty.",
"action": "Provide a brief description..."
},
{
"path": "DELETE /orders/{orderId} orderId parameter description",
"issue": "Path parameter 'orderId' has an empty description.",
"action": "Document the parameter..."
}
// …all other issues
],
"recommendations": [...]
}
Risks / Tradeoffs (Optional)
I would probably need to find some way to make sure the LLM is told to report ALL issues. Prompt wrangling.
Out of Scope/Constraints
N/A
Problem
(This is assuming I get the metrics field implemented)
Let's say the metrics field reports:
And the issues list is capped at 5-8 issues. A user may want to actually see where all 12 missing operations are.
Current Behavior
This behavior isn't implemented yet.
Proposed Solution
If a user runs
smartdoc check [file] --verbose, they would see all issues in theissuesarray.Why This Might Solve the Problem
Give users all the issues instead of 5-8 so they can dig into the issues if they want.
Success Criteria
{ "status": "issues_found", "metrics": { "operations_total_count": 12, "operations_missing_descriptions_count": 7 }, "issues": [ { "path": "POST /orders operation description", "issue": "Operation description is empty.", "action": "Add a concise, user-facing description..." }, { "path": "GET /orders/{orderId} 200 response description", "issue": "200 response description is empty.", "action": "Provide a brief description..." }, { "path": "DELETE /orders/{orderId} orderId parameter description", "issue": "Path parameter 'orderId' has an empty description.", "action": "Document the parameter..." } // …all other issues ], "recommendations": [...] }Risks / Tradeoffs (Optional)
I would probably need to find some way to make sure the LLM is told to report ALL issues. Prompt wrangling.
Out of Scope/Constraints
N/A