Skip to content

Commit fca2cbc

Browse files
chore(spec): grammar fix and clarification on normalised_schema_depth
1 parent faf076e commit fca2cbc

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/specification/spec.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ An API with strong DXJ SHOULD be predictable and pleasant for both human develop
288288

289289
| Signal | Description | Normalisation Rule |
290290
| ---------------- | -------------------- | ---------------------------- |
291-
| `example_density` | MUST presence of examples across eligible locations. | [coverage](#coverage-normalisation) |
291+
| `example_density` | MUST indicate presence of examples across eligible locations. | [coverage](#coverage-normalisation) |
292292
| `example_validity` | MUST show schema-conformance of examples. | [coverage](#coverage-normalisation) |
293293
| `doc_clarity` | MUST quantify linguistic clarity of summaries and descriptions. | [min-max inverted](#minmax-inverted-normalisation) |
294294
| `response_coverage` | MUST indicate presence of meaningful success and error responses. | [coverage](#coverage-normalisation) |
@@ -393,7 +393,7 @@ summary_coverage = summaries_present / summaries_expected
393393

394394
Where:
395395

396-
- `summaries_expected` MUST take into account every specification object with `summary` field.
396+
- `summaries_expected` MUST take into account every specification object with `summary` fixed field.
397397

398398
##### Example
399399

@@ -411,7 +411,7 @@ description_coverage = described_elements / describable_elements
411411

412412
Where:
413413

414-
- `describable_elements` MUST take into account every specification object with a `description` field.
414+
- `describable_elements` MUST take into account every specification object with a `description` fixed field.
415415

416416
##### Example
417417

@@ -556,7 +556,7 @@ Where:
556556

557557
##### Normalised Schema Depth (normalised_schema_depth)
558558

559-
A normalised indicator of schema nesting and structure depth across request/response bodies.
559+
A normalised indicator of schema nesting and structure depth across all schemas.
560560

561561
Agent reasoning difficulty can be correlated to object depth, degree of polymorphism, and highly nested schemas.
562562

0 commit comments

Comments
 (0)