is_conformant bool | violation_count int64 | openapi_document string | violations list | validation_profile dict |
|---|---|---|---|---|
false | 1 | openapi: 3.0.3
info:
title: Shipment Tracking API
version: 2.4.0
paths:
/shipments:
get:
responses:
'200':
description: Shipment list returned
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
| [
{
"rule_id": "LOCAL-REF-RESOLVES",
"location": "/paths/~1shipments/get/responses/200/content/application~1json/schema/$ref",
"message": "The local reference points to a schema that is not defined in the document.",
"expected": "A reference resolving to an existing document node, such as #/components... | {
"target_openapi_version": "3.0.3",
"applicable_rules": [
{
"rule_id": "LOCAL-REF-RESOLVES",
"requirement": "Every local JSON Reference must resolve to a node present in the OpenAPI document.",
"severity": "error"
},
{
"rule_id": "OPERATION-RESPONSE-PRESENT",
"requirement"... |
false | 1 | openapi: 3.0.3
info:
title: Order Fulfillment API
version: 1.2.0
paths:
/orders/{orderId}:
get:
parameters:
- name: orderId
in: path
required: false
schema:
type: string
responses:
'200':
description: Order details returned
| [
{
"rule_id": "PATH-PARAM-REQUIRED",
"location": "/paths/~1orders~1{orderId}/get/parameters/0/required",
"message": "A path parameter must be marked as required.",
"expected": "true",
"actual": "false",
"severity": "error"
}
] | {
"target_openapi_version": "3.0.3",
"applicable_rules": [
{
"rule_id": "PATH-PARAM-REQUIRED",
"requirement": "Every parameter whose in value is path must have required set to true.",
"severity": "error"
},
{
"rule_id": "OPERATION-RESPONSE-PRESENT",
"requirement": "Each ope... |
true | 0 | openapi: 3.0.3
info:
title: Inventory Lookup API
version: 1.0.0
paths:
/inventory/{sku}:
get:
parameters:
- name: sku
in: path
required: true
schema:
type: string
responses:
'200':
description: Inventory item returned
co... | [] | {
"target_openapi_version": "3.0.3",
"applicable_rules": [
{
"rule_id": "INFO-TITLE-VERSION",
"requirement": "The info object must contain non-empty title and version values.",
"severity": "error"
},
{
"rule_id": "PATH-PARAM-REQUIRED",
"requirement": "Every parameter whose ... |
OpenAPI Specification Conformance Benchmark Dataset
This benchmark contains OpenAPI specification documents in YAML, their applicable validation rules, and annotations for conformance results, violation locations, and violation counts. It covers requirements such as schema definitions, references, and parameter declarations, enabling evaluation of a model's ability to detect and locate violations with verifiable results. Typical uses include automated conformance checks and quality assurance in API development platforms.
Technical Specifications
| Field | Type | Description |
|---|---|---|
| violations | array | The detected conformance violations and their locations in the OpenAPI document. |
| is_conformant | boolean | Whether the OpenAPI document satisfies all applicable validation requirements. |
| violation_count | integer | The total number of violations found in the OpenAPI document. |
| openapi_document | string | The source OpenAPI specification document in YAML format. |
| validation_profile | object | The source constraints and rules used to evaluate the OpenAPI document. |
Compliance Statement
| Authorization Type | CC-BY-NC-SA 4.0 (Attribution–NonCommercial–ShareAlike) |
| Commercial Use | Requires exclusive subscription or authorization contract (monthly or per-invocation charging) |
| Privacy and Anonymization | No PII, no real company names, simulated scenarios follow industry standards |
| Compliance System | Compliant with China's Data Security Law / EU GDPR / supports enterprise data access logs |
Source & Contact
- Downloads last month
- 2