Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
41f25ce
Upgrade to version 2.0.0 (#13)
knish-99 Apr 23, 2026
a306082
chore: trigger versioning
knish-99 Apr 23, 2026
cb407e4
Update version 1.0.0 -> 2.0.0
semantic-release-bot Apr 23, 2026
9811196
chore(release): 2.0.0 release notes
semantic-release-bot Apr 23, 2026
cb7219e
chore: enable workflow_call documentation publish
knish-99 Apr 24, 2026
e5e721a
[skip ci] dph documentation update, docs(api): updated DPH documentat…
Greeshma-Rajendran May 6, 2026
eb97115
docs(api): Fixed documentation warnings
Greeshma-Rajendran May 8, 2026
3b2da9f
chore: updated secrets
Greeshma-Rajendran May 8, 2026
f6995e0
chore: updated secrets
Greeshma-Rajendran May 11, 2026
fb9f088
chore: updated secrets
Greeshma-Rajendran May 11, 2026
ab28d18
Merge branch 'fix_dph_doc_warnings' into DPH_doc_warning_fixes
Greeshma-Rajendran May 11, 2026
a48601f
removing changes
Greeshma-Rajendran May 11, 2026
e232d4a
chore : adding DCO
Greeshma-Rajendran May 11, 2026
b1917e0
chore(release): 1.0.0 release notes
semantic-release-bot Mar 17, 2026
d459a00
[skip ci] documentation update (#4)
knish-99 Mar 25, 2026
06c2ded
[skip ci] Enable publish on workflow dispatch (#5)
knish-99 Mar 25, 2026
8594bd8
Perf: Sync from enterprise 4e91aee (via .ignore) on 2026-04-17 (#7)
knish-99 Apr 21, 2026
e40250e
chore: Sync with enterprise (manual) on 2026-04-21 (#8)
knish-99 Apr 21, 2026
af35947
chore: fix semantic release build (#9)
knish-99 Apr 21, 2026
0423492
chore: use push for semantic-release and update action versions (#10)
knish-99 Apr 22, 2026
1b1e9c5
Update version 1.0.0 -> 2.0.0
semantic-release-bot Apr 22, 2026
507f69a
chore(release): 2.0.0-rc.1 release notes
semantic-release-bot Apr 22, 2026
8b2c9ff
chore: enable rc versions (#12)
knish-99 Apr 23, 2026
bf6079a
chore: trigger versioning
knish-99 Apr 23, 2026
da6144b
Update version 1.0.0 -> 2.0.0
semantic-release-bot Apr 23, 2026
777ce8d
chore(release): 2.0.0 release notes
semantic-release-bot Apr 23, 2026
68edc59
chore: enable workflow_call documentation publish
knish-99 Apr 24, 2026
b102de5
[skip ci] dph documentation update, docs(api): updated DPH documentat…
Greeshma-Rajendran May 6, 2026
3dd9fdf
docs(api): Fixed documentation warnings
Greeshma-Rajendran May 8, 2026
cedccef
chore: updated secrets
Greeshma-Rajendran May 8, 2026
042bd42
chore: updated secrets
Greeshma-Rajendran May 11, 2026
d33695c
chore: updated secrets
Greeshma-Rajendran May 11, 2026
387ec32
removing changes
Greeshma-Rajendran May 11, 2026
4eddaae
chore : adding DCO
Greeshma-Rajendran May 11, 2026
d0e5fe6
Merge branch 'DPH_doc_warning_fixes' of https://github.com/IBM/data-i…
Greeshma-Rajendran May 11, 2026
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
62 changes: 61 additions & 1 deletion .secrets.baseline
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"files": "^.secrets.baseline$",
"lines": null
},
"generated_at": "2026-04-09T04:39:13Z",
"generated_at": "2026-05-11T09:05:52Z",
"plugins_used": [
{
"name": "AWSKeyDetector"
Expand Down Expand Up @@ -301,6 +301,66 @@
"verified_result": null
}
],
"docs/chapters/05_dph_services/overview.rst": [
{
"hashed_secret": "45d676e7c6ab44cf4b8fa366ef2d8fccd3e6d6e6",
"is_secret": false,
"is_verified": false,
"line_number": 123,
"type": "Secret Keyword",
"verified_result": null
}
],
"docs/chapters/05_dph_services/usage_guide.rst": [
{
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
"is_secret": false,
"is_verified": false,
"line_number": 63,
"type": "Secret Keyword",
"verified_result": null
}
],
"docs/chapters/06_odcs_generator/collibra_integration.rst": [
{
"hashed_secret": "564e340cd48437d2dfe876ee154cc99dc4d0d137",
"is_secret": false,
"is_verified": false,
"line_number": 97,
"type": "Secret Keyword",
"verified_result": null
}
],
"docs/chapters/06_odcs_generator/examples.rst": [
{
"hashed_secret": "564e340cd48437d2dfe876ee154cc99dc4d0d137",
"is_secret": false,
"is_verified": false,
"line_number": 61,
"type": "Secret Keyword",
"verified_result": null
}
],
"docs/chapters/06_odcs_generator/index.rst": [
{
"hashed_secret": "564e340cd48437d2dfe876ee154cc99dc4d0d137",
"is_secret": false,
"is_verified": false,
"line_number": 93,
"type": "Secret Keyword",
"verified_result": null
}
],
"docs/chapters/06_odcs_generator/informatica_integration.rst": [
{
"hashed_secret": "564e340cd48437d2dfe876ee154cc99dc4d0d137",
"is_secret": false,
"is_verified": false,
"line_number": 77,
"type": "Secret Keyword",
"verified_result": null
}
],
"examples/auth_provider_usage.py": [
{
"hashed_secret": "df5cc5832dc34a455c18662ac84587ea19cf2435",
Expand Down
68 changes: 68 additions & 0 deletions docs/api/data_product_recommender/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
..
Copyright 2026 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

.. _api_data_product_recommender:

Data Product Recommender Reference
===================================

Class reference for the Data Product Recommender module.

Core Classes
------------

.. currentmodule:: wxdi.data_product_recommender.recommender

.. autoclass:: DataProductRecommender
:members:
:undoc-members:
:show-inheritance:

Platform Parsers
----------------

.. currentmodule:: wxdi.data_product_recommender.platforms

.. autoclass:: SnowflakeQueryParser
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: DatabricksQueryParser
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: BigQueryQueryParser
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: WatsonxDataQueryParser
:members:
:undoc-members:
:show-inheritance:

Base Classes
------------

.. currentmodule:: wxdi.data_product_recommender.base

.. autoclass:: QueryLogParser
:members:
:undoc-members:
:show-inheritance:

.. Made with Bob
34 changes: 34 additions & 0 deletions docs/api/dph_services/core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
..
Copyright 2026 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

.. _api_dph_services_core:

Core Classes
============

Main service class and data models for Data Product Hub Services.

DphV1 Service
-------------

.. currentmodule:: wxdi.dph_services

.. autoclass:: DphV1
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

.. Made with Bob
43 changes: 43 additions & 0 deletions docs/api/dph_services/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
..
Copyright 2026 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

.. _api_dph_services:

DPH Services API
================

API reference for the Data Product Hub Services module.

.. toctree::
:maxdepth: 2

core

Main Service Class
------------------

The DphV1 class provides access to all Data Product Hub Services operations.
For detailed API reference including all methods, see :ref:`api_dph_services_core`.

.. currentmodule:: wxdi.dph_services

.. autoclass:: DphV1
:members:
:undoc-members:
:show-inheritance:
:special-members: __init__
:no-index:

.. Made with Bob
33 changes: 33 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ This API reference documentation is auto-generated from the source code docstrin

common/index
dq_validator/index
dph_services/index
odcs_generator/index
data_product_recommender/index

Module Organization
-------------------
Expand All @@ -50,6 +53,36 @@ In-memory data quality validation:
* :ref:`REST API Providers<api_dq_validator_providers>` - IBM Cloud Pak for Data integration
* :ref:`Result Consolidation<api_dq_validator_results>` - Result aggregation and analysis

DPH Services Module
~~~~~~~~~~~~~~~~~~~

Data Product Hub API client:

* :ref:`DphV1 Service<api_dph_services>` - Main service class for Data Product Hub operations
* Container, data product, draft, release, and domain management
* Contract terms and template operations
* Asset visualization

ODCS Generator Module
~~~~~~~~~~~~~~~~~~~~~

Generate Open Data Contract Standard files:

* :ref:`Collibra Integration<api_odcs_generator>` - CollibraClient and ODCSGenerator classes
* :ref:`Informatica Integration<api_odcs_generator>` - InformaticaClient and ODCSGenerator classes
* ODCS v3.1.0 compliant YAML generation
* Command-line and Python interfaces

Data Product Recommender Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Query log analysis tool for data product recommendations:

* :ref:`DataProductRecommender<api_data_product_recommender>` - Core recommendation engine
* Platform-specific query log parsers (Snowflake, Databricks, BigQuery, watsonx.data)
* Scoring and ranking algorithms
* CLI and Python interfaces

Navigation Tips
---------------

Expand Down
48 changes: 48 additions & 0 deletions docs/api/odcs_generator/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
..
Copyright 2026 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

.. _api_odcs_generator:

ODCS Generator Reference
========================

Class reference for the ODCS Generator module.

Collibra Integration
--------------------

.. currentmodule:: wxdi.odcs_generator.generate_odcs_from_collibra

.. autoclass:: CollibraClient
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: ODCSGenerator
:members:
:undoc-members:
:show-inheritance:

Informatica Integration
-----------------------

.. currentmodule:: wxdi.odcs_generator.generate_odcs_from_informatica

.. autoclass:: InformaticaClient
:members:
:undoc-members:
:show-inheritance:

.. Made with Bob
Loading