Conversation
Chat-log analysis of the docs assistant showed customers repeatedly asking for API call chains (e.g. checking access profile provisioning status, extending a grant's expiration) that aren't covered by any single endpoint reference page. Adds a cookbook-style page walking through these chains, with a few steps flagged for engineering verification before wider review. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Verified against the OpenAPI spec:
- The provisioning-status search body used taskTypes: ["TASK_TYPE_GRANT"],
but taskTypes is an array of TaskType objects, not strings — fixed to
{ "grant": {} }. Also added grantOutcomes filtering, since a closed task
can be denied/errored/cancelled, not just successfully granted.
- The grant-expiration steps searched a nonexistent
.../entitlements/{id}/search-grants endpoint. Replaced with the real
POST /api/v1/search/app_users lookup, since update-grant-duration only
needs an app_user_id, not a grant ID.
- Resolved the risk-level and automation-execution-state verification
flags from the spec: riskLevelValueId is a field on the entitlement,
set via the standard entitlement update call; automation execution
state has a full enum (DONE/ERROR/TERMINATE are terminal, WAITING/
PAUSED_BY_CIRCUIT_BREAKER need manual resolution).
- Left the service-principal-as-app-owner flag in place — the spec
genuinely doesn't say either way, so it still needs an engineer.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Collaborator
Author
|
Re-reviewed this against the live OpenAPI spec and pushed fixes in 5096640 — flagging here since this has been open a while without review. Fixed (would have failed for anyone following the doc):
Resolved directly from the spec (no longer needs verification):
Still open: whether a service principal can be set as an app owner via Everything else in the page checked out against the spec as originally drafted. |
This branch was successfully deployed
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
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.
Summary
conductorone-api/common-tasks.mdx, a cookbook page covering API tasks that require chaining 2+ calls (e.g. adding an entitlement to an access profile, checking provisioning status, extending/removing a grant's expiration, executing an automation and checking its result).docs.json, afterpagination.Review notes
Several steps are marked with
<Warning>callouts as Needs verification — these are our best reconstruction from the API reference, not confirmed against a live tenant:taskTypes/taskStatessemantics for counting access profile provisioning completion.statevalues.Requesting review from someone on the sales engineering team to confirm/correct these before this goes out more broadly.
Test plan