Skip to navigation
Schemas

sourceIntegration

Information about the source integration for this screenshot, enabling upload of changed files back to the source CMS. Set automatically during test resolution for files from integrations.

Referenced In

Fields

FieldTypeDescriptionDefault
typestringRequired. The type of integration. Currently supported: ‘heretto’. Additional types may be added in the future.

Accepted values: heretto		—
integrationNamestringRequired. The name of the integration configuration in the config file. Used to look up authentication credentials.—
fileIdstringOptional. The unique identifier (UUID) of the file in the source CMS. If not provided, the file will be looked up by path.—
filePathstringOptional. The path of the file in the source CMS. Used for lookup if fileId is not available.—
contentPathstringOptional. The local path to the file that references this source. Used for resolving relative paths.—

Examples

{
  "type": "heretto",
  "integrationName": "my-heretto",
  "fileId": "8f3ed200-cbba-11e1-ac51-c82a1446d15c",
  "filePath": "/db/organizations/example/repositories/docs/images/screenshot.png"
}
{
  "type": "heretto",
  "integrationName": "my-heretto",
  "filePath": "images/screenshot.png",
  "contentPath": "/tmp/doc-detective/heretto_abc123/topic.dita"
}