Skip to content

Commit 925d54f

Browse files
oformaniukOleh Formaniuk
andauthored
Add additional OData query parameters + mark some properties as Expandable (#25958)
* Add additional OData query parameters + mark some properties as `Expandable` * Remove not needed changes * Add `x-ms-identifiers` to `dependantTemplates` array * Fix formatting issues * Add missing properties * Remove `$expand` --------- Co-authored-by: Oleh Formaniuk <oformaniuk@microsoft.com>
1 parent fa0011c commit 925d54f

File tree

6 files changed

+79
-5
lines changed

6 files changed

+79
-5
lines changed

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/ContentPackages.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,18 @@
6565
{
6666
"$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy"
6767
},
68+
{
69+
"$ref": "../../../common/2.0/types.json#/parameters/ODataSearch"
70+
},
71+
{
72+
"$ref": "../../../common/2.0/types.json#/parameters/ODataCount"
73+
},
6874
{
6975
"$ref": "../../../common/2.0/types.json#/parameters/ODataTop"
7076
},
77+
{
78+
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkip"
79+
},
7180
{
7281
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken"
7382
}

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/ContentProductPackages.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"tags": [
4545
"ContentProductPackages"
4646
],
47-
"description": "Gets all packages from the catalog.",
47+
"description": "Gets all packages from the catalog.\nExpandable properties:\n- properties/installed\n- properties/packagedContent",
4848
"operationId": "ProductPackages_List",
4949
"parameters": [
5050
{
@@ -208,7 +208,7 @@
208208
},
209209
"packagedContent": {
210210
"$ref": "#/definitions/packagedContent",
211-
"description": "the json to deploy"
211+
"description": "The json to deploy. Expandable."
212212
}
213213
},
214214
"type": "object"

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/ContentProductTemplates.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,18 @@
6565
{
6666
"$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy"
6767
},
68+
{
69+
"$ref": "../../../common/2.0/types.json#/parameters/ODataSearch"
70+
},
71+
{
72+
"$ref": "../../../common/2.0/types.json#/parameters/ODataCount"
73+
},
6874
{
6975
"$ref": "../../../common/2.0/types.json#/parameters/ODataTop"
7076
},
77+
{
78+
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkip"
79+
},
7180
{
7281
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken"
7382
}

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/ContentTemplates.json

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"tags": [
4545
"ContentTemplates"
4646
],
47-
"description": "Gets all installed templates.",
47+
"description": "Gets all installed templates.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates",
4848
"operationId": "ContentTemplates_List",
4949
"parameters": [
5050
{
@@ -65,9 +65,21 @@
6565
{
6666
"$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy"
6767
},
68+
{
69+
"$ref": "../../../common/2.0/types.json#/parameters/ODataExpand"
70+
},
71+
{
72+
"$ref": "../../../common/2.0/types.json#/parameters/ODataSearch"
73+
},
74+
{
75+
"$ref": "../../../common/2.0/types.json#/parameters/ODataCount"
76+
},
6877
{
6978
"$ref": "../../../common/2.0/types.json#/parameters/ODataTop"
7079
},
80+
{
81+
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkip"
82+
},
7183
{
7284
"$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken"
7385
}
@@ -153,7 +165,7 @@
153165
"tags": [
154166
"ContentTemplates"
155167
],
156-
"description": "Gets a template byt its identifier.",
168+
"description": "Gets a template byt its identifier.\nExpandable properties:\n- properties/mainTemplate\n- properties/dependantTemplates",
157169
"operationId": "ContentTemplate_Get",
158170
"parameters": [
159171
{
@@ -298,7 +310,18 @@
298310
"properties": {
299311
"mainTemplate": {
300312
"$ref": "#/definitions/mainTemplate",
301-
"description": "The JSON of the ARM template to deploy active content"
313+
"description": "The JSON of the ARM template to deploy active content. Expandable."
314+
},
315+
"dependantTemplates": {
316+
"type": "array",
317+
"items": {
318+
"$ref": "#/definitions/templateProperties"
319+
},
320+
"description": "Dependant templates. Expandable.",
321+
"readOnly": true,
322+
"x-ms-identifiers": [
323+
"contentId"
324+
]
302325
}
303326
}
304327
},

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/common/ContentCommonTypes.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -535,6 +535,11 @@
535535
"packageName": {
536536
"$ref": "#/definitions/metadataDisplayName",
537537
"description": "the name of the package contains this template"
538+
},
539+
"isDeprecated": {
540+
"$ref": "#/definitions/metadataTrueFalseFlag",
541+
"description": "Flag indicates if this template is deprecated",
542+
"readOnly": true
538543
}
539544
}
540545
},
@@ -569,6 +574,10 @@
569574
"$ref": "#/definitions/metadataTrueFalseFlag",
570575
"description": "Flag indicates if this package is among the featured list."
571576
},
577+
"isDeprecated": {
578+
"$ref": "#/definitions/metadataTrueFalseFlag",
579+
"description": "Flag indicates if this template is deprecated"
580+
},
572581
"version": {
573582
"$ref": "#/definitions/metadataVersion",
574583
"description": "the latest version number of the package"

specification/securityinsights/resource-manager/common/2.0/types.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,30 @@
160160
"type": "integer",
161161
"format": "int32",
162162
"x-ms-parameter-location": "method"
163+
},
164+
"ODataExpand": {
165+
"description": "Expands the object with optional fiends that are not included by default. Optional.",
166+
"in": "query",
167+
"name": "$expand",
168+
"required": false,
169+
"type": "string",
170+
"x-ms-parameter-location": "method"
171+
},
172+
"ODataSearch": {
173+
"description": "Searches for a substring in the response. Optional.",
174+
"in": "query",
175+
"name": "$search",
176+
"required": false,
177+
"type": "string",
178+
"x-ms-parameter-location": "method"
179+
},
180+
"ODataCount": {
181+
"description": "Instructs the server to return only object count without actual body. Optional.",
182+
"in": "query",
183+
"name": "$count",
184+
"required": false,
185+
"type": "boolean",
186+
"x-ms-parameter-location": "method"
163187
}
164188
}
165189
}

0 commit comments

Comments
 (0)