Schemas
ImportRequestPostPayload
{"archive": "string","parent": 123,"type": "openapi","match_components": "false","generate_hazard": "false","ignore_warnings": "false","zendesk_category": "123","openapi_languages": [["javascript","php"]],"openapi_maxdepth": 3}
Properties
Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
archive | string(binary) | false | none | The archive file to import. |
parent | integer | false | none | The ID of the target folder to import content into. |
type | string | false | none | The import type. |
match_components | boolean | false | none | When importing content the system can try to match content to already existing content. Check this option if you want Paligo to perform such a matching. |
generate_hazard | boolean | false | none | When selected, admonitions (notes, warnings, etc) will be imported as separate components. These are then reused in the parent component. |
ignore_warnings | boolean | false | none | When selected, warning messages about uploaded XML are ignored. Only use this if there are issues. |
zendesk_category | string | false | none | The Zendesk category if importing from Zendesk. |
openapi_languages | [string] | false | none | Snippet languages to generate when importing OpenAPI. |
openapi_maxdepth | integer | false | none | The maximum depth to show for schema examples when importing OpenAPI. |
Enumerated Values
Property | Value |
|---|---|
type | paligo |
type | db5 |
type | db4 |
type | xhtml |
type | confluence |
type | dita |
type | flare |
type | helpandmanual |
type | docx |
type | authorit |
type | zendesk |
type | openapi |