79 lines
2.1 KiB
JSON
79 lines
2.1 KiB
JSON
{
|
|
"timestamp": "2025-07-24T07:16:17.845544",
|
|
"summary": {
|
|
"total": 3,
|
|
"by_severity": {
|
|
"warning": 1,
|
|
"error": 1,
|
|
"info": 1
|
|
}
|
|
},
|
|
"errors": [
|
|
{
|
|
"id": "MISSING_INFO_DESCRIPTION",
|
|
"title": "Missing API Description",
|
|
"description": "API description helps users understand the purpose of your API.",
|
|
"severity": "warning",
|
|
"category": "bestPractice",
|
|
"location": {
|
|
"json_path": "info.description",
|
|
"line": null,
|
|
"column": null,
|
|
"snippet": null
|
|
},
|
|
"suggestions": [
|
|
{
|
|
"description": "Add a description explaining what your API does",
|
|
"code_example": "\"description\": \"This API provides user management functionality\"",
|
|
"documentation_url": null
|
|
}
|
|
],
|
|
"related_errors": [],
|
|
"timestamp": "2025-07-24T07:16:17.842816"
|
|
},
|
|
{
|
|
"id": "EMPTY_PATHS",
|
|
"title": "Empty Paths Object",
|
|
"description": "OpenAPI document must contain at least one path.",
|
|
"severity": "error",
|
|
"category": "validation",
|
|
"location": {
|
|
"json_path": "paths",
|
|
"line": null,
|
|
"column": null,
|
|
"snippet": null
|
|
},
|
|
"suggestions": [
|
|
{
|
|
"description": "Add at least one API endpoint",
|
|
"code_example": "\"/users\": { \"get\": { \"responses\": { \"200\": { \"description\": \"Success\" } } } }",
|
|
"documentation_url": null
|
|
}
|
|
],
|
|
"related_errors": [],
|
|
"timestamp": "2025-07-24T07:16:17.842917"
|
|
},
|
|
{
|
|
"id": "NO_OPERATION_TAGS",
|
|
"title": "No Operation Tags",
|
|
"description": "Consider using tags to organize your API operations.",
|
|
"severity": "info",
|
|
"category": "bestPractice",
|
|
"location": {
|
|
"json_path": "paths",
|
|
"line": null,
|
|
"column": null,
|
|
"snippet": null
|
|
},
|
|
"suggestions": [
|
|
{
|
|
"description": "Add tags to operations",
|
|
"code_example": "\"tags\": [\"users\"]",
|
|
"documentation_url": null
|
|
}
|
|
],
|
|
"related_errors": [],
|
|
"timestamp": "2025-07-24T07:16:17.843223"
|
|
}
|
|
]
|
|
} |