Skip to content

Commit 1832ae9

Browse files
Aryamanz29claude
andcommitted
docs: add full asset model docs (260+ classes) with organized nav
- Generate 26 per-category pages covering all assets in __PYATLAN_ASSETS__: Core, Glossary, Access Control, SQL, Snowflake, Databricks, NoSQL, Streaming, Cloud Storage, dbt, Orchestration, Microsoft BI, Tableau, Looker, Other BI Tools, Data Quality, Data Mesh, AI/ML, API, Data Modeling & Semantic, SAP, Salesforce, Cognite, AWS SageMaker, Other Connectors, Other - Add generate_asset_docs.py script for future regeneration - Update mkdocs.yml nav with top-level "Asset Models" section - Build time: ~21s Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 329dab3 commit 1832ae9

30 files changed

Lines changed: 2421 additions & 71 deletions

docs/api/assets.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

docs/api/assets/access-control.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Access Control
2+
3+
## AccessControl
4+
5+
::: pyatlan.model.assets.core.access_control.AccessControl
6+
7+
## AuthPolicy
8+
9+
::: pyatlan.model.assets.core.auth_policy.AuthPolicy
10+
11+
## Persona
12+
13+
::: pyatlan.model.assets.core.persona.Persona
14+
15+
## Stakeholder
16+
17+
::: pyatlan.model.assets.core.stakeholder.Stakeholder
18+
19+
## StakeholderTitle
20+
21+
::: pyatlan.model.assets.core.stakeholder_title.StakeholderTitle
22+
23+
## Purpose
24+
25+
::: pyatlan.model.assets.purpose.Purpose
26+
27+
## BusinessPolicy
28+
29+
::: pyatlan.model.assets.business_policy.BusinessPolicy
30+
31+
## BusinessPolicyException
32+
33+
::: pyatlan.model.assets.business_policy_exception.BusinessPolicyException
34+
35+
## BusinessPolicyIncident
36+
37+
::: pyatlan.model.assets.business_policy_incident.BusinessPolicyIncident
38+
39+
## BusinessPolicyLog
40+
41+
::: pyatlan.model.assets.business_policy_log.BusinessPolicyLog
42+
43+
## AuthService
44+
45+
::: pyatlan.model.assets.auth_service.AuthService

docs/api/assets/ai.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AI / ML
2+
3+
## AI
4+
5+
::: pyatlan.model.assets.core.a_i.AI
6+
7+
## AIModel
8+
9+
::: pyatlan.model.assets.core.a_i_model.AIModel
10+
11+
## AIModelVersion
12+
13+
::: pyatlan.model.assets.core.a_i_model_version.AIModelVersion
14+
15+
## AIApplication
16+
17+
::: pyatlan.model.assets.core.a_i_application.AIApplication
18+
19+
## DatabricksAIModelContext
20+
21+
::: pyatlan.model.assets.core.databricks_a_i_model_context.DatabricksAIModelContext
22+
23+
## DatabricksAIModelVersion
24+
25+
::: pyatlan.model.assets.core.databricks_a_i_model_version.DatabricksAIModelVersion
26+
27+
## SnowflakeAIModelContext
28+
29+
::: pyatlan.model.assets.core.snowflake_a_i_model_context.SnowflakeAIModelContext
30+
31+
## SnowflakeAIModelVersion
32+
33+
::: pyatlan.model.assets.core.snowflake_a_i_model_version.SnowflakeAIModelVersion

docs/api/assets/api.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# API
2+
3+
## API
4+
5+
::: pyatlan.model.assets.a_p_i.API
6+
7+
## APISpec
8+
9+
::: pyatlan.model.assets.a_p_i_spec.APISpec
10+
11+
## APIQuery
12+
13+
::: pyatlan.model.assets.a_p_i_query.APIQuery
14+
15+
## APIObject
16+
17+
::: pyatlan.model.assets.a_p_i_object.APIObject
18+
19+
## APIPath
20+
21+
::: pyatlan.model.assets.a_p_i_path.APIPath
22+
23+
## APIField
24+
25+
::: pyatlan.model.assets.a_p_i_field.APIField

docs/api/assets/cloud-storage.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Cloud Storage
2+
3+
## S3
4+
5+
::: pyatlan.model.assets.s3.S3
6+
7+
## S3Bucket
8+
9+
::: pyatlan.model.assets.s3_bucket.S3Bucket
10+
11+
## S3Prefix
12+
13+
::: pyatlan.model.assets.s3_prefix.S3Prefix
14+
15+
## S3Object
16+
17+
::: pyatlan.model.assets.s3_object.S3Object
18+
19+
## ADLS
20+
21+
::: pyatlan.model.assets.a_d_l_s.ADLS
22+
23+
## ADLSAccount
24+
25+
::: pyatlan.model.assets.a_d_l_s_account.ADLSAccount
26+
27+
## ADLSContainer
28+
29+
::: pyatlan.model.assets.a_d_l_s_container.ADLSContainer
30+
31+
## ADLSObject
32+
33+
::: pyatlan.model.assets.a_d_l_s_object.ADLSObject
34+
35+
## GCS
36+
37+
::: pyatlan.model.assets.g_c_s.GCS
38+
39+
## GCSBucket
40+
41+
::: pyatlan.model.assets.g_c_s_bucket.GCSBucket
42+
43+
## GCSObject
44+
45+
::: pyatlan.model.assets.g_c_s_object.GCSObject
46+
47+
## ObjectStore
48+
49+
::: pyatlan.model.assets.object_store.ObjectStore
50+
51+
## AWS
52+
53+
::: pyatlan.model.assets.a_w_s.AWS
54+
55+
## Google
56+
57+
::: pyatlan.model.assets.google.Google
58+
59+
## Azure
60+
61+
::: pyatlan.model.assets.azure.Azure
62+
63+
## Cloud
64+
65+
::: pyatlan.model.assets.cloud.Cloud

docs/api/assets/cognite.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Cognite
2+
3+
## Cognite
4+
5+
::: pyatlan.model.assets.cognite.Cognite
6+
7+
## CogniteAsset
8+
9+
::: pyatlan.model.assets.cognite_asset.CogniteAsset
10+
11+
## CogniteEvent
12+
13+
::: pyatlan.model.assets.cognite_event.CogniteEvent
14+
15+
## Cognite3DModel
16+
17+
::: pyatlan.model.assets.cognite3_d_model.Cognite3DModel
18+
19+
## CogniteSequence
20+
21+
::: pyatlan.model.assets.cognite_sequence.CogniteSequence
22+
23+
## CogniteTimeSeries
24+
25+
::: pyatlan.model.assets.cognite_time_series.CogniteTimeSeries
26+
27+
## CogniteFile
28+
29+
::: pyatlan.model.assets.cognite_file.CogniteFile

docs/api/assets/core.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Core Base Classes
2+
3+
## Referenceable
4+
5+
::: pyatlan.model.assets.core.referenceable.Referenceable
6+
7+
## Asset
8+
9+
::: pyatlan.model.assets.core.asset.Asset
10+
11+
## Catalog
12+
13+
::: pyatlan.model.assets.core.catalog.Catalog
14+
15+
## Namespace
16+
17+
::: pyatlan.model.assets.core.namespace.Namespace
18+
19+
## Folder
20+
21+
::: pyatlan.model.assets.core.folder.Folder
22+
23+
## Resource
24+
25+
::: pyatlan.model.assets.core.resource.Resource
26+
27+
## Process
28+
29+
::: pyatlan.model.assets.core.process.Process
30+
31+
## ColumnProcess
32+
33+
::: pyatlan.model.assets.core.column_process.ColumnProcess
34+
35+
## BIProcess
36+
37+
::: pyatlan.model.assets.core.b_i_process.BIProcess
38+
39+
## FlowDataset
40+
41+
::: pyatlan.model.assets.core.flow_dataset.FlowDataset
42+
43+
## FlowField
44+
45+
::: pyatlan.model.assets.core.flow_field.FlowField
46+
47+
## Flow
48+
49+
::: pyatlan.model.assets.core.flow.Flow
50+
51+
## FlowReusableUnit
52+
53+
::: pyatlan.model.assets.core.flow_reusable_unit.FlowReusableUnit
54+
55+
## FlowControlOperation
56+
57+
::: pyatlan.model.assets.core.flow_control_operation.FlowControlOperation
58+
59+
## FlowDatasetOperation
60+
61+
::: pyatlan.model.assets.core.flow_dataset_operation.FlowDatasetOperation
62+
63+
## FlowFieldOperation
64+
65+
::: pyatlan.model.assets.core.flow_field_operation.FlowFieldOperation
66+
67+
## Tag
68+
69+
::: pyatlan.model.assets.core.tag.Tag
70+
71+
## SchemaRegistry
72+
73+
::: pyatlan.model.assets.core.schema_registry.SchemaRegistry
74+
75+
## SchemaRegistrySubject
76+
77+
::: pyatlan.model.assets.core.schema_registry_subject.SchemaRegistrySubject
78+
79+
## IndistinctAsset
80+
81+
::: pyatlan.model.assets.core.indistinct_asset.IndistinctAsset

docs/api/assets/data-mesh.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Data Mesh
2+
3+
## DataMesh
4+
5+
::: pyatlan.model.assets.core.data_mesh.DataMesh
6+
7+
## DataDomain
8+
9+
::: pyatlan.model.assets.core.data_domain.DataDomain
10+
11+
## DataProduct
12+
13+
::: pyatlan.model.assets.core.data_product.DataProduct

0 commit comments

Comments
 (0)