Skip to content

Commit 80fee25

Browse files
yifan-zhou922yifan-zhou922
authored
Expose some missing query parameters and add some examples (#19219)
* expose a query parameter in term get API * fixed type * update 2022-03-01-preview to keep consistent * Revert "update 2022-03-01-preview to keep consistent" This reverts commit a747b81. * fix model validation * Update purviewcatalog.json * update the swagger to 2022-03-01-preview * update swagger * Update purviewcatalog.json * update tag * update desc * Update Glossary_ExportGlossaryTermsAsCsv.json * fix the parameter order
1 parent a8b1ff4 commit 80fee25

File tree

5 files changed

+120
-10
lines changed

5 files changed

+120
-10
lines changed

‎specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-03-01-preview/examples/Glossary_ExportGlossaryTermsAsCsv.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"glossaryGuid": "ed27f06c-dcfc-4e60-be27-7be65060108f",
5+
"termGuids": [
6+
"1ec7ed72-f188-4bfe-bab9-bb9b5475381e",
7+
"7869f462-33d4-4ec9-9901-b9f25a25e6df"
8+
],
9+
"includeTermHierarchy": true,
10+
"api-version": "2022-03-01-preview"
11+
},
12+
"responses": {
13+
"200": {
14+
"body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example."
15+
}
16+
}
17+
}

‎specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-03-01-preview/examples/Glossary_GetGlossaryTerm_WithoutAssets.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
5+
"excludeRelationshipTypeList": [
6+
"AtlasGlossarySemanticAssignment"
7+
]
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
13+
"qualifiedName": "ExampleTerm1@Glossary",
14+
"name": "ExampleTerm1",
15+
"shortDescription": "Example Short Description",
16+
"lastModifiedTS": "1",
17+
"abbreviation": "T1",
18+
"createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
19+
"updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
20+
"createTime": 1606287247276,
21+
"updateTime": 1606287247276,
22+
"status": "Approved",
23+
"anchor": {
24+
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
25+
"relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
26+
},
27+
"seeAlso": [
28+
{
29+
"termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
30+
"relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
31+
"displayText": "ExampleTerm2"
32+
}
33+
],
34+
"synonyms": [
35+
{
36+
"termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
37+
"relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
38+
"displayText": "ExampleTerm2"
39+
}
40+
],
41+
"contacts": {
42+
"Expert": [
43+
{
44+
"id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
45+
"info": "Example Expert Info"
46+
}
47+
],
48+
"Steward": [
49+
{
50+
"id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
51+
"info": "Example Steward Info"
52+
}
53+
]
54+
},
55+
"resources": [
56+
{
57+
"displayName": "Example Display Name",
58+
"url": "Example Url"
59+
}
60+
]
61+
}
62+
}
63+
}
64+
}

‎specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-03-01-preview/examples/Glossary_GetImportCSVOperationStatus.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
},
88
"responses": {
99
"202": {
10+
"headers": {
11+
"location": "https://exampleaccountname.purview.azure.com/catalog/api/glossary/terms/import/3ffca165-75a7-4987-ba71-cfc0a273d6b7"
12+
},
1013
"body": {
1114
"id": "3ffca165-75a7-4987-ba71-cfc0a273d6b7",
1215
"status": "Running",

‎specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-03-01-preview/examples/Glossary_GetImportCSVOperationStatusByGloassaryName.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
},
99
"responses": {
1010
"202": {
11+
"headers": {
12+
"location": "https://exampleaccountname.purview.azure.com/catalog/api/glossary/terms/import/99e60bea-6f70-4fcb-966a-a313bb2738ef"
13+
},
1114
"body": {
1215
"id": "99e60bea-6f70-4fcb-966a-a313bb2738ef",
1316
"status": "Running",

‎specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-03-01-preview/purviewcatalog.json‎

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1031,8 +1031,8 @@
10311031
"tags": [
10321032
"Entity"
10331033
],
1034-
"description": "Delete business metadata from an entity.",
1035-
"operationId": "Entity_DeleteBusinessAttributes",
1034+
"description": "Delete business metadata attributes from an entity.",
1035+
"operationId": "Entity_DeleteBusinessMetadataAttributes",
10361036
"consumes": [
10371037
"application/json"
10381038
],
@@ -1057,13 +1057,13 @@
10571057
"required": false,
10581058
"in": "body",
10591059
"schema": {
1060-
"description": "BusinessAttribute",
1060+
"description": "BusinessMetadataAttributes",
10611061
"type": "object",
10621062
"additionalProperties": {
10631063
"type": "object"
10641064
}
10651065
},
1066-
"description": "BusinessAttribute"
1066+
"description": "BusinessMetadataAttributes"
10671067
}
10681068
],
10691069
"responses": {
@@ -1076,8 +1076,8 @@
10761076
"tags": [
10771077
"Entity"
10781078
],
1079-
"description": "Add or update business attributes",
1080-
"operationId": "Entity_AddOrUpdateBusinessAttributes",
1079+
"description": "Add or update business metadata attributes",
1080+
"operationId": "Entity_AddOrUpdateBusinessMetadataAttributes",
10811081
"consumes": [
10821082
"application/json"
10831083
],
@@ -1102,13 +1102,13 @@
11021102
"required": false,
11031103
"in": "body",
11041104
"schema": {
1105-
"description": "BusinessAttribute",
1105+
"description": "BusinessMetadataAttributes",
11061106
"type": "object",
11071107
"additionalProperties": {
11081108
"type": "object"
11091109
}
11101110
},
1111-
"description": "BusinessAttribute"
1111+
"description": "BusinessMetadataAttributes"
11121112
}
11131113
],
11141114
"responses": {
@@ -1149,7 +1149,7 @@
11491149
"Entity"
11501150
],
11511151
"description": "Upload the file for creating Business Metadata in BULK",
1152-
"operationId": "Entity_ImportBusinessAttributes",
1152+
"operationId": "Entity_ImportBusinessMetadata",
11531153
"consumes": [
11541154
"multipart/form-data"
11551155
],
@@ -1980,6 +1980,9 @@
19801980
"x-ms-examples": {
19811981
"Glossary_GetGlossaryTerm": {
19821982
"$ref": "./examples/Glossary_GetGlossaryTerm.json"
1983+
},
1984+
"Glossary_GetGlossaryTerm_WithoutAssets": {
1985+
"$ref": "./examples/Glossary_GetGlossaryTerm_WithoutAssets.json"
19831986
}
19841987
},
19851988
"parameters": [
@@ -1988,6 +1991,18 @@
19881991
},
19891992
{
19901993
"$ref": "#/parameters/includeTermHierarchy"
1994+
},
1995+
{
1996+
"name": "excludeRelationshipTypes",
1997+
"in": "query",
1998+
"description": "An array of relationship types which need to be excluded.",
1999+
"required": false,
2000+
"type": "array",
2001+
"items": {
2002+
"type": "string"
2003+
},
2004+
"collectionFormat": "multi",
2005+
"x-ms-client-name": "excludeRelationshipTypeList"
19912006
}
19922007
],
19932008
"responses": {
@@ -2028,6 +2043,9 @@
20282043
"schema": {
20292044
"$ref": "#/definitions/AtlasGlossaryTerm"
20302045
}
2046+
},
2047+
{
2048+
"$ref": "#/parameters/includeTermHierarchy"
20312049
}
20322050
],
20332051
"responses": {
@@ -2913,6 +2931,11 @@
29132931
],
29142932
"description": "Export Glossary Terms as csv file",
29152933
"operationId": "Glossary_ExportGlossaryTermsAsCsv",
2934+
"x-ms-examples": {
2935+
"Glossary_ExportGlossaryTermsAsCsv": {
2936+
"$ref": "./examples/Glossary_ExportGlossaryTermsAsCsv.json"
2937+
}
2938+
},
29162939
"produces": [
29172940
"text/csv"
29182941
],
@@ -4029,7 +4052,7 @@
40294052
"/atlas/v2/types/businessmetadatadef/guid/{guid}": {
40304053
"get": {
40314054
"tags": [
4032-
"TypesREST"
4055+
"Types"
40334056
],
40344057
"description": "Get the businessMetadata definition for the given guid",
40354058
"operationId": "Types_GetBusinessMetadataDefByGuid",

0 commit comments

Comments
 (0)