You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- each eligible location contributes one (`1`) to `expected_examples`, regardless of whether the location supports both _example_ and _examples_ fields from an OpenAPI perspective.
310
+
- multiple _examples_ defined inside an _examples_ array MUST not increase `present_examples` beyond `1`.
311
+
312
+
313
+
304
314
If `expected_examples = 0`, the value MUST be `1.0`.
305
315
306
316
#### Example Validity (example_validity)
@@ -366,8 +376,8 @@ ARAX evaluates whether an API is semantically interpretable by AI systems—spec
|`summary_coverage`| MUST represent presence of concise summaries across operations/tags/info. |[coverage](#coverage-normalisation)|
370
-
|`description_coverage`| MUST represent descriptive completeness across applicable API elements. |[coverage](#coverage-normalisation)|
379
+
|`summary_coverage`| MUST represent presence of concise summaries across specification objects with a `summary` field (e.g.,operations/tags/info etc). |[coverage](#coverage-normalisation)|
380
+
|`description_coverage`| MUST represent descriptive completeness across applicable API specification objects with a `description` field. |[coverage](#coverage-normalisation)|
371
381
|`type_specificity`| MUST quantify richness of datatype modelling. |[weighted categorical](#weighted-categorical-normalisation)|
372
382
|`policy_presence`| SHOULD represent inclusion of SLA/rate-limit/policy metadata. |[coverage](#coverage-normalisation)|
373
383
|`error_standardization`| SHOULD favour structured error formats (RFC 9457/7807). |[coverage](#coverage-normalisation)|
@@ -381,12 +391,16 @@ ARAX evaluates whether an API is semantically interpretable by AI systems—spec
-`describable_elements` MUST take into account every specification object with a `description` field.
415
+
398
416
##### Example
399
417
400
418
```text
401
419
description_coverage = 0.82
402
420
403
-
# 82% of info objects, operations, schemas, and parameters include descriptions
421
+
# 82% of info objects, operations, schemas, parameters etc. include a description
404
422
```
405
423
406
424
#### Type Specificity (type_specificity)
@@ -822,7 +840,7 @@ The scoring framework does NOT hide unsafe APIs, but we apply a risk-aware disco
822
840
823
841
#### Descriptive Richness (descriptive_richness)
824
842
825
-
The descriptive_richness signal evaluates the semantic value of textual descriptions within an API description. It measures whether descriptions are sufficiently clear and detailed for AI systems to infer purpose, behaviour, and domain context.
843
+
The `descriptive_richness` signal evaluates the semantic value of textual descriptions within an API description. It measures whether descriptions are sufficiently clear and detailed for AI systems to infer purpose, behaviour, and domain context.
826
844
827
845
Applies to all describable elements, including but not limited to:
0 commit comments