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
Copy file name to clipboardExpand all lines: docs/publishing/overview-template.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,10 +98,12 @@ The framework works with OpenAPI 3.x and 2.x specifications. It's implementation
98
98
-**[Full Specification](specification.md)** — Complete technical specification with normative requirements
99
99
-**[Framework Repository](https://github.com/jentic/api-ai-readiness-framework)** — full source specification, contribution guidelines, and issue tracking
100
100
-**[Jentic Public APIs](https://github.com/jentic/jentic-public-apis)** — Collection of scored API specifications demonstrating the framework in practice
101
-
-**Blog Posts**:
102
-
-[Why Most APIs Fail in AI Systems and How to Fix It](https://thenewstack.io/why-most-apis-fail-in-ai-systems-and-how-to-fix-it/) (The New Stack)
103
-
-[Is Your OpenAPI AI-Ready?](https://jentic.com/blog/is-your-open-api-ai-ready) (Jentic)
104
-
-[Scoring APIs for AI](https://jentic.com/blog/scoring-apis-for-ai) (Jentic)
101
+
102
+
**Blog Posts**:
103
+
104
+
-[Why Most APIs Fail in AI Systems and How to Fix It](https://thenewstack.io/why-most-apis-fail-in-ai-systems-and-how-to-fix-it/) (The New Stack)
105
+
-[Is Your OpenAPI AI-Ready?](https://jentic.com/blog/is-your-open-api-ai-ready) (Jentic)
106
+
-[Scoring APIs for AI](https://jentic.com/blog/scoring-apis-for-ai) (Jentic)
Copy file name to clipboardExpand all lines: docs/specification/spec.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Jentic API AI-Readiness Framework (JAIRF) Specification
2
2
3
-
## Version 0.2.0
3
+
## Version 1.0.0
4
4
5
5
This document uses the key words MUST, MUST NOT, SHOULD, SHOULD NOT, and MAY as defined in [BCP 14](https://tools.ietf.org/html/bcp14)[RFC2119](https://tools.ietf.org/html/rfc2119)[RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here.
6
6
@@ -587,14 +587,20 @@ API usability for agents degrades as endpoint count grows — but only after a c
-`total_operations` is the count of unique forward-callable operations (method + path pairs). [Callbacks](https://spec.openapis.org/oas/v3.2.0.html#callback-object) and [webhooks](https://spec.openapis.org/oas/v3.2.0.html#oas-webhooks) MUST NOT be counted as endpoints.
596
-
-`endpoint_baseline` is set at `50`.
596
+
-Penalties begin at 50 operations and reach maximum at 200 operations, with linear interpolation between these thresholds.
597
597
598
+
Examples:
599
+
600
+
- 50 operations: 0% penalty (comfort zone boundary)
-`max_schema_depth` is the deepest nesting found across all schemas
615
-
-`depth_baseline` is set at `8`.
621
+
-`pct_schemas_exceeding` is the proportion of schemas exceeding the depth threshold:
622
+
pct_schemas_exceeding = count(schemas with depth > depth_baseline) / total_schemas
623
+
-`depth_baseline` is set at `18`
616
624
617
625
Schemas referenced by callbacks/webhooks MUST be included in `normalised_schema_depth`, because they contribute to the overall semantic model complexity.
618
626
627
+
The penalty is proportional to schema depth prevalence, not just maximum depth. An API where 1% of schemas exceed the threshold (outliers) receives 1% of the maximum penalty, while an API where 80% of schemas exceed (uniform complexity) receives 80% of the maximum penalty. This directly models agent operational experience. Agents encounter complexity proportional to its prevalence in the schema set, not based solely on the existence of a single deep schema.
628
+
629
+
Examples:
630
+
631
+
- 1% of schemas exceed threshold: 1% of max penalty applied (outlier case)
632
+
- 50% of schemas exceed threshold: 50% of max penalty applied
633
+
- 80% of schemas exceed threshold: 80% of max penalty applied (uniform complexity)
Copy file name to clipboardExpand all lines: package.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
{
2
2
"name": "api-ai-readiness-framework",
3
-
"version": "0.1.0",
3
+
"version": "1.0.0",
4
4
"description": "A technical specification for the Jentic API AI-Readiness Framework (JAIRF). Defines the signals, dimensions, scoring model, and normalisation rules used to evaluate how interpretable, operable, and trustworthy APIs are for AI systems and autonomous agents.",
0 commit comments