Generate an OpenAPI spec from a Knowledge Model

OpenaAPI spec of Knowledge Model

SecurityBearerAuth or ApiKeyAuth

Request

path Parameters

km_id

required

string

Example: open-purchase-requisition.purchase-requisition-km

query Parameters

curated

boolean

Example: curated=false

Responses

200

OpenAPI Spec

400

Bad Request.

401

Unauthorized access.

403

Forbidden.

404

The specified resource was not found

429

Too Many Requests.

500

Internal Server Error.

503

Service Unavailable.

get/api/knowledge-models/{km_id}/spec

Request samples

curl
JavaScript
Java
Python
PHP

Response samples

application/json

{"openapi": "string",
"info": {"title": "string",
"description": "string",
"termsOfService": "../dictionary",
"contact": {"name": "string",
"url": "../dictionary"
},
"version": "string",
"x-audience": "EX"
},
"servers": [{"url": "string"
}
],
"security": [{"property1": ["string"
],
"property2": ["string"
]
}
],
"paths": { },
"components": {"schemas": {"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": ["string"
],
"enum": [null
],
"type": "array",
"not": { },
"allOf": [{ }
],
"oneOf": [{ }
],
"anyOf": [{ }
],
"items": { },
"properties": {"property1": { },
"property2": { }
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"example": null
}
}
}