Knowledge
POST
/api/v1/workspaces/{workspaceId}/knowledge/sites/{siteId}/api-versions/import
Scope knowledge:write
Import an OpenAPI 3 document from text or a public URL into an API documentation site. Each operation becomes a page, and a fragment is stored per version. Article text you already wrote is kept.
Pfad
siteIdPflicht
string (uuid)
Knowledge site identifier.
workspaceIdPflicht
string
Workspace that owns the resource.
Request
application/json · ImportKnowledgeApiRequestDto
label
string
Label.
spec
string
OpenAPI document as JSON or YAML. Provide this or a URL.
url
string
Public URL of an OpenAPI document. Provide this or a document.
setDefault
boolean
Whether set default is set.
Antworten
200KnowledgeApiImportResultDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Knowledge API import result.
versionId
string (uuid)
Identifier of the version.
label
string
Label.
isDefault
boolean
Whether this is default.
pagesCreated
integer (int32)
Pages created.
fragmentsUpdated
integer (int32)
Fragments updated.
hiddenInVersion
integer (int32)
Hidden in version.
warnings
string[]
Warnings.