Request for Collibra Integration Library v1.1.10 Javadoc (Complete API Documentation Artefact)
Summary: Grant Rollerson sought access to the complete API documentation of the Collibra Integration Library v1.1.10, preferring an offline artifact such as a Javadoc JAR or a bundled HTML/PDF, due to the impracticality of exporting the documentation directly from the Javadoc web interface. Brody Murray responded by acknowledging the request and mentioned that the documentation team is considering hosting Javadoc bundles for download in the future while providing an interim solution. Grant Rollerson expanded on the need for this documentation, outlining its value for AI-driven agents, including structured, machine-readable knowledge for AI, and deeper insights into the platform capabilities than REST API documentation. The discussion also included the significance of such documentation for workflow automation, troubleshooting, and governance process automation within an AI-driven architecture.
I raised this as a Support Ticket but was told instead to pop it up here. Can Product help?
Description
I am seeking access to the complete API documentation for the Collibra Integration Library (target version: v1.1.10), equivalent to the content currently exposed via the Javadoc interface:
Specifically, I require the full documentation set covering all packages, classes, and descendants (i.e. everything under the Overview / Package / Class hierarchy).
Current Challenge
The Javadoc is currently only accessible via the web interface.
Exporting or printing the entire documentation (including all descendant class pages) from the browser is not practical due to:
the large number of pages (hundreds)
limitations of the interface (no bulk export capability)
Request
I am seeking access to a full offline documentation artefact, rather than navigating or exporting the web interface, specifically:
Javadoc JAR (
*-javadoc.jar), ora bundled HTML/PDF export of the full API documentation
covering all packages, classes, and descendants exposed in the Javadoc.
Purpose
The documentation is required for:
training AI Agents
offline access and review
comprehensive understanding of all available APIs
avoiding manual navigation/export of individual pages
Grant Rollerson
OP3 months ago · Edited📄 Use Case: Value of Collibra Java API Documentation for AI‑Driven Agents
1. Context and Objective
This document outlines the value of the Collibra Java API documentation (e.g.
collibra-java-docs-2026.05) for enabling and enhancing AI agents operating within a data governance ecosystem.The Java documentation provides a comprehensive, structured reference of Collibra’s internal APIs, including:
Core platform APIs (
com.collibra.dgc.core.api.*)Workflow APIs
Catalog APIs
DTOs and request builders
Supporting components such as notifications and file management
Examples within the documentation include interfaces such as:
WorkflowInstanceApi,WorkflowTaskApi,WorkflowDefinitionApi[publicsector.com]DataSetApiandColumnApifor catalog interactions [package-summary | HTML]FileApifor content management [NotificationBuilder | HTML]NotificationBuilderfor workflow-based communications [developer....llibra.com]2. Why This Documentation Is Valuable for AI Agents
2.1 Structured, Machine-Readable Knowledge
The documentation is delivered as Javadoc HTML, which is:
Highly structured (packages, classes, methods, parameters)
Consistent across modules
Rich in semantic meaning (API intent, usage patterns)
This structure allows AI agents to:
Parse API capabilities programmatically
Understand relationships between classes, DTOs, and services
Build an internal “knowledge graph” of Collibra functionality
2.2 Deep Visibility Into Platform Capabilities
Unlike REST API documentation (which focuses on external endpoints), the Java docs expose:
Internal service layers
Workflow execution capabilities
Platform-native operations not always visible via REST
For example:
Workflow APIs expose lifecycle operations such as starting, completing, or finding workflow instances [docs.celigo.com]
Catalog APIs expose relationships between datasets, columns, and data elements [package-summary | HTML]
👉 This gives AI agents deeper operational awareness of the platform.
2.3 Enables Context-Aware Assistance
With access to these docs, an AI agent can:
Translate business requirements into correct API usage
Recommend the most appropriate API (Java vs REST vs Import)
Generate accurate workflow logic or automation guidance
Examples:
Suggest using
WorkflowTaskApifor task automationRecommend
NotificationBuilderfor user alerts in workflows [developer....llibra.com]Identify risks such as deprecated methods in
FileApi[NotificationBuilder | HTML]2.4 Improves Accuracy and Reduces Hallucination Risk
AI agents without structured documentation may:
Guess API names or capabilities
Provide incomplete or incorrect recommendations
By grounding responses in:
Real class definitions
Method signatures
DTO structures
…the Java docs:
Reduce ambiguity
Improve factual correctness
Increase user trust in AI-generated guidance
2.5 Supports Advanced Use Cases
The availability of Java API documentation enables AI agents to support:
✅ Workflow Design and Automation
Identify correct APIs for starting workflows, completing tasks, or retrieving workflow data
Recommend best practices for BPMN integration
✅ Governance Process Automation
Suggest programmatic enforcement of governance rules
Enable dynamic assignment, validation, and approval flows
✅ Platform Troubleshooting
Detect misused APIs or incorrect DTO configurations
Provide debugging insights based on method behaviour
✅ Integration Guidance
Help users decide between:
Java APIs (internal workflows)
REST APIs (external integrations)
Import APIs (bulk ingestion)
3. Role in AI-Driven Governance Architecture
The Java documentation becomes a foundational knowledge layer in an AI-enabled Collibra ecosystem:
This allows AI agents to:
Act as intelligent translators between business users and technical APIs
Provide real-time guidance within workflows, integrations, and platform configuration
Enable self-service governance at scale
4. Key Differentiation vs REST API Documentation
Aspect >> Java API Docs >> REST API Docs
Scope | Internal platform capabilities | External integration endpoints
Depth | High (classes, DTOs, workflows) | Moderate (endpoint-based)
Use case | Workflow scripting, internal automation | Integration with external systems
Value for AI | High (rich semantic structure) | Complementary (execution layer)
👉 Both are important, but Java docs provide deeper contextual understanding.
5. Observations and Opportunities for Collibra
Based on this use case, there are opportunities to further enhance AI adoption:
🔹 1. AI-Optimised Documentation
Provide machine-readable formats (e.g. JSON, OpenAPI for Java APIs)
Include semantic metadata (use cases, lifecycle stages, dependencies)
🔹 2. Cross-Linking Between API Types
Explicit mapping between:
Java APIs ↔ REST endpoints
DTOs ↔ API payloads
🔹 3. Usage Guidance and Patterns
Embed “when to use this API” guidance directly in documentation
Provide best-practice patterns for workflows vs integrations
🔹 4. AI Integration Support
Official support for AI agents consuming Collibra docs
Example prompts or scenarios for AI-assisted governance
6. Conclusion
The Collibra Java API documentation represents a high-value asset for AI-driven data governance because it:
Provides deep, structured insight into platform capabilities
Enables accurate, context-aware recommendations
Bridges the gap between technical APIs and business use cases
Reduces risk of incorrect automation or misuse
Supports scalable, AI-assisted governance models
In an increasingly AI-enabled enterprise landscape, this documentation is not just a developer resource—it becomes a core enabler of intelligent, automated governance.
Brody Murray
·3 months agoHi Grant,
Thank you for raising this with us. Our documentation team are investigating a future enhancement to the product documentation page, where we can host javadoc bundles directly for download.
We are tracking this internally for a long-term solution, however I have provided you the javadoc for 2026.05 in the interim. Please feel free to reach out if you need anything further.