Understanding analysis categories and metricsΒΆ

There are five categories SmartDoc reports on:

  • Parameters

  • Requests

  • Responses

  • Operations

  • Schemas

Specifically, SmartDoc analyzes three metrics per category:

  • total: the total number of elements in a category

  • missing_descriptions: the number of elements missing descriptions

  • missing_fields: the number of elements missing required fields

The analysis returns categories as top-level keys (e.g. operations, paramters) with metrics inside each category:

"operations": {
    "total": 3,
    "missing_descriptions": 2,
    "missing_fields": 3
},