docs(iblai-analytics): reground the skill in the live OpenAPI schema#13
Open
xyzeem wants to merge 1 commit into
Open
docs(iblai-analytics): reground the skill in the live OpenAPI schema#13xyzeem wants to merge 1 commit into
xyzeem wants to merge 1 commit into
Conversation
Rewrite iblai-analytics to document only endpoints reachable at api.iblai.app/dm/... (registered in ibl-data-manager urls.py) and treat the live OpenAPI schema at https://api.iblai.app/dm/api/docs/schema/?format=json as the contract for URLs, params, enums, and response shapes. Covers 24 endpoints across /api/analytics/* (mentor, catalog, time-on-platform) and /api/reports/platforms/{platform_key}/*. Analyst-shaped groupings: Overview, Costs, Users & engagement, Topics & conversations, Transcripts, Sessions & ratings, Course, Program, Pathway & skill, Per-learner drill-down, Time-on-platform. RBAC cites the public role names Ibl.Analytics/CanViewAnalytics/action, Ibl.Analytics/Core/read, Ibl.Analytics/Mentors/read, and Ibl.Analytics/Reports/read. Adds references/schema.md with the fetch, refresh, and drift-check routine, and references/analytics-schema.json as a filtered offline snapshot. All three files use the {dm_url} anchor (= https://api.iblai.app/dm) so the skill reads consistently with its iblai/vibe UI companion.
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
2 participants
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.
The
iblai-analyticsskill previously mixed accurate endpoints with URLs that never resolved against Data Manager and quoted Django permission class names in an audience-facing document. This PR rewrites it so every URL, parameter, and RBAC role name is grounded in the source repo, and elevates the live OpenAPI schema athttps://api.iblai.app/dm/api/docs/schema/?format=jsonto the contract: the skill's prose is orientation, and the schema wins on any disagreement.The rewrite covers 24 endpoints across
/api/analytics/*(13 mentor analytics endpoints, 5 catalog analytics endpoints for courses, programs, pathways, and skills, and 2 time-on-platform endpoints) and/api/reports/platforms/{platform_key}/*(the async POST-poll-download lifecycle for Data Reports). Endpoints group by analyst intent — Overview, Costs, Users & engagement, Topics & conversations, Transcripts, Sessions & ratings, Course / Program / Pathway & skill analytics, Per-learner drill-down, and Time-on-platform. RBAC uses the public role namesIbl.Analytics/CanViewAnalytics/action,Ibl.Analytics/Core/read,Ibl.Analytics/Mentors/read, andIbl.Analytics/Reports/read, verified against the source-of-truth action definitions.A new
references/schema.mdships the fetch, refresh, and drift-check routine, andreferences/analytics-schema.json(128 KB) is a filtered snapshot of the live schema for offline bootstrap. Both files, along withSKILL.md, use the{dm_url}anchor (=https://api.iblai.app/dm) so the skill reads consistently with itsiblai/vibeUI companion.