Skip to content

Schema updates for Heretto integration #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hawkeyexl merged 7 commits into from
Dec 16, 2025
Merged

Schema updates for Heretto integration #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
109e2f0
First pass at Heretto integration
hawkeyexl Dec 3, 2025
5c6e874
Wording change
hawkeyexl Dec 3, 2025
abdee65
Remove Heretto integration's fileId. It's now inferred.
hawkeyexl Dec 5, 2025
b033a26
Add .env to .gitignore and update Heretto integration schemas with ex…
hawkeyexl Dec 5, 2025
a06b84e
Added senarioName to heretto integration
hawkeyexl Dec 13, 2025
45a33d4
Update Heretto integration descriptions to use "scenario" instead of …
hawkeyexl Dec 14, 2025
6014c8d
Updated apiToken format
hawkeyexl Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions dist/schemas/config_v3.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8486,6 +8486,52 @@
}
},
"title": "Doc Detective Orchestration API"
},
"heretto": {
"type": "array",
"description": "Configuration for Heretto CMS integrations. Each entry specifies a Heretto instance and a scenario to build and test.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"organizationId",
"username",
"apiToken"
],
"properties": {
"name": {
"type": "string",
"description": "Unique identifier for this Heretto integration. Used in logs and results."
},
"organizationId": {
"type": "string",
"description": "The organization subdomain used to access Heretto CCMS (e.g., 'thunderbird' for thunderbird.heretto.com)."
},
"username": {
"type": "string",
"description": "Heretto CCMS username (email address) for API authentication."
},
"apiToken": {
"format": "password",
"minLength": 1,
"type": "string",
"description": "API token generated in Heretto CCMS for authentication. See https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication#ariaid-title3"
},
"scenarioName": {
"type": "string",
"description": "Name of the scenario to build and test.",
"default": "Doc Detective"
},
"outputPath": {
"type": "string",
"description": "Local path where Heretto content was downloaded. Set automatically during processing.",
"readOnly": true
}
},
"title": "Heretto CMS integration"
},
"title": "Heretto CMS integrations"
}
},
"title": "Integrations options"
Expand Down Expand Up @@ -16159,6 +16205,21 @@
},
{
"crawl": true
},
{
"processDitaMaps": true
},
{
"integrations": {
"heretto": [
{
"name": "example",
"organizationId": "your-organization-id",
"username": "your-username",
"apiToken": "your-api-token"
}
]
}
}
]
}
61 changes: 61 additions & 0 deletions dist/schemas/resolvedTests_v3.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8499,6 +8499,52 @@
}
},
"title": "Doc Detective Orchestration API"
},
"heretto": {
"type": "array",
"description": "Configuration for Heretto CMS integrations. Each entry specifies a Heretto instance and a scenario to build and test.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"organizationId",
"username",
"apiToken"
],
"properties": {
"name": {
"type": "string",
"description": "Unique identifier for this Heretto integration. Used in logs and results."
},
"organizationId": {
"type": "string",
"description": "The organization subdomain used to access Heretto CCMS (e.g., 'thunderbird' for thunderbird.heretto.com)."
},
"username": {
"type": "string",
"description": "Heretto CCMS username (email address) for API authentication."
},
"apiToken": {
"format": "password",
"minLength": 1,
"type": "string",
"description": "API token generated in Heretto CCMS for authentication. See https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication#ariaid-title3"
},
"scenarioName": {
"type": "string",
"description": "Name of the scenario to build and test.",
"default": "Doc Detective"
},
"outputPath": {
"type": "string",
"description": "Local path where Heretto content was downloaded. Set automatically during processing.",
"readOnly": true
}
},
"title": "Heretto CMS integration"
},
"title": "Heretto CMS integrations"
}
},
"title": "Integrations options"
Expand Down Expand Up @@ -16172,6 +16218,21 @@
},
{
"crawl": true
},
{
"processDitaMaps": true
},
{
"integrations": {
"heretto": [
{
"name": "example",
"organizationId": "your-organization-id",
"username": "your-username",
"apiToken": "your-api-token"
}
]
}
}
]
},
Expand Down
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 61 additions & 0 deletions src/schemas/output_schemas/config_v3.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8486,6 +8486,52 @@
}
},
"title": "Doc Detective Orchestration API"
},
"heretto": {
"type": "array",
"description": "Configuration for Heretto CMS integrations. Each entry specifies a Heretto instance and a scenario to build and test.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"organizationId",
"username",
"apiToken"
],
"properties": {
"name": {
"type": "string",
"description": "Unique identifier for this Heretto integration. Used in logs and results."
},
"organizationId": {
"type": "string",
"description": "The organization subdomain used to access Heretto CCMS (e.g., 'thunderbird' for thunderbird.heretto.com)."
},
"username": {
"type": "string",
"description": "Heretto CCMS username (email address) for API authentication."
},
"apiToken": {
"format": "password",
"minLength": 1,
"type": "string",
"description": "API token generated in Heretto CCMS for authentication. See https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication#ariaid-title3"
},
"scenarioName": {
"type": "string",
"description": "Name of the scenario to build and test.",
"default": "Doc Detective"
},
"outputPath": {
"type": "string",
"description": "Local path where Heretto content was downloaded. Set automatically during processing.",
"readOnly": true
}
},
"title": "Heretto CMS integration"
},
"title": "Heretto CMS integrations"
}
},
"title": "Integrations options"
Expand Down Expand Up @@ -16159,6 +16205,21 @@
},
{
"crawl": true
},
{
"processDitaMaps": true
},
{
"integrations": {
"heretto": [
{
"name": "example",
"organizationId": "your-organization-id",
"username": "your-username",
"apiToken": "your-api-token"
}
]
}
}
]
}
61 changes: 61 additions & 0 deletions src/schemas/output_schemas/resolvedTests_v3.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8499,6 +8499,52 @@
}
},
"title": "Doc Detective Orchestration API"
},
"heretto": {
"type": "array",
"description": "Configuration for Heretto CMS integrations. Each entry specifies a Heretto instance and a scenario to build and test.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"organizationId",
"username",
"apiToken"
],
"properties": {
"name": {
"type": "string",
"description": "Unique identifier for this Heretto integration. Used in logs and results."
},
"organizationId": {
"type": "string",
"description": "The organization subdomain used to access Heretto CCMS (e.g., 'thunderbird' for thunderbird.heretto.com)."
},
"username": {
"type": "string",
"description": "Heretto CCMS username (email address) for API authentication."
},
"apiToken": {
"format": "password",
"minLength": 1,
"type": "string",
"description": "API token generated in Heretto CCMS for authentication. See https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication#ariaid-title3"
},
"scenarioName": {
"type": "string",
"description": "Name of the scenario to build and test.",
"default": "Doc Detective"
},
"outputPath": {
"type": "string",
"description": "Local path where Heretto content was downloaded. Set automatically during processing.",
"readOnly": true
}
},
"title": "Heretto CMS integration"
},
"title": "Heretto CMS integrations"
}
},
"title": "Integrations options"
Expand Down Expand Up @@ -16172,6 +16218,21 @@
},
{
"crawl": true
},
{
"processDitaMaps": true
},
{
"integrations": {
"heretto": [
{
"name": "example",
"organizationId": "your-organization-id",
"username": "your-username",
"apiToken": "your-api-token"
}
]
}
}
]
},
Expand Down
Loading