Skip to content

Commit

Permalink
adding back source type for backwards compatibility, added response d…
Browse files Browse the repository at this point in the history
…escriptions, corrected PR comments
  • Loading branch information
ushasan committed Feb 22, 2022
1 parent 0f322ef commit 9040d22
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,17 @@
"200": {
"description": "OK"
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/Watchlist"
},
"headers": {
"Azure-AsyncOperation": {
"description": "Contains the status URL on which clients are expected to poll the status of the delete operation.",
"type": "string"
}
},
"204": {
"description": "No Content"
},
Expand All @@ -178,7 +189,7 @@
"tags": [
"Watchlists"
],
"description": "Creates or updates a watchlist and its watchlist items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its items, we should call this endpoint with rawContent and contentType properties.",
"description": "Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing such large file can be polled through the URL returned in Azure-AsyncOperation header.",
"operationId": "Watchlists_CreateOrUpdate",
"parameters": [
{
Expand Down Expand Up @@ -208,9 +219,15 @@
}
},
"201": {
"description": "Created",
"description": "Created. The response includes the Provisioning State and the Azure-AsyncOperation header. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field.",
"schema": {
"$ref": "#/definitions/Watchlist"
},
"headers": {
"Azure-AsyncOperation": {
"description": "Contains the status URL on which clients are expected to poll the status of the operation.",
"type": "string"
}
}
},
"default": {
Expand Down Expand Up @@ -473,6 +490,18 @@
"description": "The provider of the watchlist",
"type": "string"
},
"source": {
"description": "The filename of the watchlist, called 'source'",
"enum": [
"Local file",
"Remote storage"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "source"
}
},
"sourceType": {
"description": "The sourceType of the watchlist",
"enum": [
Expand Down Expand Up @@ -557,15 +586,11 @@
"uploadStatus": {
"description": "The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted",
"type": "string"
},
"watchlistItemsCount": {
"description": "The number of Watchlist Items in the Watchlist",
"type": "integer",
"format": "int32"
}
},
"required": [
"displayName",
"source",
"sourceType",
"provider",
"itemsSearchKey"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "High Value Assets Watchlist",
"source": "watchlist.csv",
"sourceType": "Local file",
"provider": "Microsoft",
"description": "Watchlist from CSV content",
Expand All @@ -27,6 +28,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "watchlist.csv",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
Expand Down Expand Up @@ -59,6 +61,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "watchlist.csv",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset",
"watchlist": {
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "High Value Assets Watchlist",
"source": "watchlist.csv",
"sourceType": "Local file",
"provider": "Microsoft",
"description": "Watchlist from CSV content",
Expand All @@ -30,6 +32,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "watchlist.csv",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
Expand Down Expand Up @@ -62,6 +65,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "watchlist.csv",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset",
"watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842",
"watchlistItem": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset"
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset",
"watchlistItemId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset"
},
"responses": {
Expand All @@ -17,6 +18,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "watchlist.csv",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset",
"watchlistItemId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"alias": "highValueAsset"
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"api-version": "2022-01-01-preview",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace"
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights"
},
"responses": {
"200": {
Expand All @@ -18,6 +19,7 @@
"watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
"displayName": "High Value Assets Watchlist",
"provider": "Microsoft",
"source": "watchlist.csv",
"sourceType": "Local file",
"created": "2020-09-28T00:26:54.7746089+00:00",
"updated": "2020-09-28T00:26:57+00:00",
Expand Down

0 comments on commit 9040d22

Please sign in to comment.