[#6577] docs: fix param typo from 'type' to 'catalog_type' (#6634)

github-actions[bot] · AndreVale69 · jerryshao · web-flow · commit 7ea5ee537ea2 · 2025-03-07T14:44:18.000+08:00
### What changes were proposed in this pull request? Fix parameter typo for `create_catalog` function in `hadoop-catalog` fileset documentation and `manage-fileset` and `manage-model`. Change parameter typo from `type` to `catalog_type`. ### Why are the changes needed? Incorrect parameter name in the documentation. Fix: #6577 ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? None. Co-authored-by: AndreVale69 <57899285+AndreVale69@users.noreply.github.com> Co-authored-by: Jerry Shao <jerryshao@datastrato.com>
diff --git a/docs/hadoop-catalog-with-adls.md b/docs/hadoop-catalog-with-adls.md
@@ -110,7 +110,7 @@ adls_properties = {
 }
 
 adls_properties = gravitino_client.create_catalog(name="example_catalog",
-                                                  type=Catalog.Type.FILESET,
+                                                  catalog_type=Catalog.Type.FILESET,
                                                   provider="hadoop",
                                                   comment="This is a ADLS fileset catalog",
                                                   properties=adls_properties)
diff --git a/docs/hadoop-catalog-with-gcs.md b/docs/hadoop-catalog-with-gcs.md
@@ -105,7 +105,7 @@ gcs_properties = {
 }
 
 gcs_properties = gravitino_client.create_catalog(name="test_catalog",
-                                                 type=Catalog.Type.FILESET,
+                                                 catalog_type=Catalog.Type.FILESET,
                                                  provider="hadoop",
                                                  comment="This is a GCS fileset catalog",
                                                  properties=gcs_properties)
diff --git a/docs/hadoop-catalog-with-oss.md b/docs/hadoop-catalog-with-oss.md
@@ -114,7 +114,7 @@ oss_properties = {
 }
 
 oss_catalog = gravitino_client.create_catalog(name="test_catalog",
-                                              type=Catalog.Type.FILESET,
+                                              catalog_type=Catalog.Type.FILESET,
                                               provider="hadoop",
                                               comment="This is a OSS fileset catalog",
                                               properties=oss_properties)
diff --git a/docs/hadoop-catalog-with-s3.md b/docs/hadoop-catalog-with-s3.md
@@ -114,7 +114,7 @@ s3_properties = {
 }
 
 s3_catalog = gravitino_client.create_catalog(name="test_catalog",
-                                             type=Catalog.Type.FILESET,
+                                             catalog_type=Catalog.Type.FILESET,
                                              provider="hadoop",
                                              comment="This is a S3 fileset catalog",
                                              properties=s3_properties)
diff --git a/docs/manage-fileset-metadata-using-gravitino.md b/docs/manage-fileset-metadata-using-gravitino.md
@@ -87,7 +87,7 @@ Catalog catalog = gravitinoClient.createCatalog("catalog",
 ```python
 gravitino_client: GravitinoClient = GravitinoClient(uri="http://localhost:8090", metalake_name="metalake")
 catalog = gravitino_client.create_catalog(name="catalog",
-                                          type=Catalog.Type.FILESET,
+                                          catalog_type=Catalog.Type.FILESET,
                                           provider="hadoop", 
                                           comment="This is a Hadoop fileset catalog",
                                           properties={"location": "/tmp/test1"})
diff --git a/docs/manage-model-metadata-using-gravitino.md b/docs/manage-model-metadata-using-gravitino.md
@@ -75,7 +75,7 @@ Catalog catalog = gravitinoClient.createCatalog(
 ```python
 gravitino_client: GravitinoClient = GravitinoClient(uri="http://localhost:8090", metalake_name="example")
 catalog = gravitino_client.create_catalog(name="model_catalog",
-                                          type=Catalog.Type.MODEL,
+                                          catalog_type=Catalog.Type.MODEL,
                                           provider=None,
                                           comment="This is a model catalog",
                                           properties={"k1": "v1"})

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ adls_properties = {`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`adls_properties = gravitino_client.create_catalog(name="example_catalog",`
`113`		`- type=Catalog.Type.FILESET,`
	`113`	`+ catalog_type=Catalog.Type.FILESET,`
`114`	`114`	`provider="hadoop",`
`115`	`115`	`comment="This is a ADLS fileset catalog",`
`116`	`116`	`properties=adls_properties)`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ gcs_properties = {`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`gcs_properties = gravitino_client.create_catalog(name="test_catalog",`
`108`		`- type=Catalog.Type.FILESET,`
	`108`	`+ catalog_type=Catalog.Type.FILESET,`
`109`	`109`	`provider="hadoop",`
`110`	`110`	`comment="This is a GCS fileset catalog",`
`111`	`111`	`properties=gcs_properties)`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ oss_properties = {`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`oss_catalog = gravitino_client.create_catalog(name="test_catalog",`
`117`		`- type=Catalog.Type.FILESET,`
	`117`	`+ catalog_type=Catalog.Type.FILESET,`
`118`	`118`	`provider="hadoop",`
`119`	`119`	`comment="This is a OSS fileset catalog",`
`120`	`120`	`properties=oss_properties)`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ s3_properties = {`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`s3_catalog = gravitino_client.create_catalog(name="test_catalog",`
`117`		`- type=Catalog.Type.FILESET,`
	`117`	`+ catalog_type=Catalog.Type.FILESET,`
`118`	`118`	`provider="hadoop",`
`119`	`119`	`comment="This is a S3 fileset catalog",`
`120`	`120`	`properties=s3_properties)`