fix(uipath-insights): document the gated ConfigError envelope on alert reads [IN-13526] - #2966
Draft
celestinryf wants to merge 1 commit into
Draft
fix(uipath-insights): document the gated ConfigError envelope on alert reads [IN-13526]#2966celestinryf wants to merge 1 commit into
celestinryf wants to merge 1 commit into
Conversation
…t reads Since cli#3765 the CLI answers ConfigError/configuration_error when a deployment does not serve the alert routes (they are feature-gated to Cloud and Dedicated SaaS), and cli#3924 extends that to alert-history list and get-metrics. The guide had no branch for that envelope, and its 404 playbook sent agents to check-entitlement, which answers the same envelope on those deployments. Adds the ConfigError outcome row, Rule 14 saying what the envelope means and to stop, and a Rule 7 pointer for the get-404 flow. Guide-only edit; front matter untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related to IN-13526 (uipath-insights skill) and IN-13522 (alert-history commands). Companion to UiPath/cli#3924; do not merge before that PR reaches
mainand republishes@uipath/cli@dev, since until then the guide describes an envelope the shipped alert-history commands do not emit.What
alerts-reads-guide.mdgets the gated-surface envelope it never documented: aConfigErrorrow in the outcome table, Rule 14 saying aConfigErrornaming the Cloud and Dedicated SaaS feature gate means the deployment does not serve alerts (check-entitlementanswers the same envelope, so running it to confirm proves nothing), and a pointer on Rule 7 so thealerts get404 flow terminates instead of looping.Why
Since cli#3765 the CLI answers
Result: "ConfigError"/ErrorCode: "configuration_error"on gated deployments foralerts listandcheck-entitlement, and cli#3924 extends that toalert-history listandget-metrics. The guide had no branch for that envelope, so an agent on Automation Suite or Service Fabric had no way to read it, and the guide's own 404 playbook sent it to a command that reproduces the same envelope.Verification
Ran:
skills:validate(27 skills, both flavors),skills:build,skills:check-links(all 6,557 links resolve),hooks/validate-skill-descriptions.sh,check-skill-status.py,check-task-driver.py,check-skills-sh.py, andcheck-cli-verbs.pyon the edited guide at 0 High and 0 Medium. Front matter is untouched, so the activation gate eval is not triggered. Not run: the alerts smoke eval, which needs the cli half in@uipath/cli@dev.