yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-12-12 10:35:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): structured properties openapi guide (#10671)

Browse Source
This commit is contained in:
david-leifker 2024-06-12 12:48:21 -05:00 committed by GitHub
parent e00d7f172d
commit 75f65dd88b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api/tutorials/structured-properties.md
View File

@ -252,7 +252,7 @@ If successful, you should see `Update succeeded for urn:li:dataset:...`
</TabItem> </TabItem>
<TabItem value="OpenAPI" label="OpenAPI"> <TabItem value="OpenAPI" label="OpenAPI">
Following command will set structured properties `retentionTime` as `90` to a dataset `urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)`. Following command will set structured properties `retentionTime` as `60.0` to a dataset `urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)`.
Please note that the structured property and the dataset must exist before executing this command. (You can create sample datasets using the `datahub docker ingest-sample-data`) Please note that the structured property and the dataset must exist before executing this command. (You can create sample datasets using the `datahub docker ingest-sample-data`)
```commandline ```commandline
@ -265,7 +265,7 @@ curl -X 'POST' -v \
{ {
"propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime", "propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime",
"values": [ "values": [
{"string": "90"} {"double": 60.0}
] ]
} }
] ]
@ -331,7 +331,7 @@ curl -X 'POST' -v \
``` ```
This command will attach one of each of the two properties to our test dataset `urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)` This command will attach one of each of the two properties to our test dataset `urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)`
Specically, this will set `io.acryl.privacy.retentionTime` as `90` and `io.acryl.privacy.retentionTime02` as `bar2`. Specically, this will set `io.acryl.privacy.retentionTime` as `60.0` and `io.acryl.privacy.retentionTime02` as `bar2`.
``` ```
@ -344,7 +344,7 @@ curl -X 'POST' -v \
{ {
"propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime", "propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime",
"values": [ "values": [
{"string": "90"} {"double": 60.0}
] ]
}, },
{ {
@ -452,7 +452,7 @@ curl -X 'PATCH' -v \
"propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime", "propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime",
"values": [ "values": [
{ {
"string": "365" "double": 365.0
} }
] ]
} }
@ -485,7 +485,7 @@ Below is the expected response:
{ {
"values": [ "values": [
{ {
"string": "365" "double": 365.0
} }
], ],
"propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime" "propertyUrn": "urn:li:structuredProperty:io.acryl.privacy.retentionTime"