Skip to content

Commit 1676a09

Browse files
aaronweedenaaronweeden
authored
Merge branch 'xdmod10.5' into stateless-my-profile-window
2 parents 23c4ccd + 01d3fd0 commit 1676a09

File tree

1 file changed

+74
-75
lines changed

1 file changed

+74
-75
lines changed

‎docs/xdmod-rest-schema.json

Lines changed: 74 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,15 @@
7171
"properties": {
7272
"operation": {
7373
"type": "string",
74-
"const": "get_data",
75-
"description": "`get_data`"
74+
"enum": [ "get_data" ]
7675
},
7776
"aggregation_unit": {
7877
"type": "string",
7978
"description": "Set to the time binning for the query ('day', 'month', 'quarter', etc.) or 'Auto' to use the bin choice determined by the selected time interval."
8079
},
8180
"controller_module": {
8281
"type": "string",
83-
"const": "metric_explorer",
84-
"description": "`metric_explorer`"
82+
"enum": [ "metric_explorer" ]
8583
},
8684
"data_series": {
8785
"type": "string"
@@ -207,13 +205,11 @@
207205
"properties": {
208206
"operation": {
209207
"type": "string",
210-
"const": "get_charts",
211-
"description": "`get_charts`"
208+
"enum": [ "get_charts" ]
212209
},
213210
"controller_module": {
214211
"type": "string",
215-
"const": "user_interface",
216-
"description": "`user_interface`"
212+
"enum": [ "user_interface" ]
217213
},
218214
"public_user": {
219215
"type": "string",
@@ -355,8 +351,7 @@
355351
"properties": {
356352
"operation": {
357353
"type": "string",
358-
"const": "get_menus",
359-
"description": "`get_menus`"
354+
"enum": [ "get_menus" ]
360355
},
361356
"node": {
362357
"type": "string",
@@ -390,8 +385,7 @@
390385
"properties": {
391386
"operation": {
392387
"type": "string",
393-
"const": "get_tabs",
394-
"description": "`get_tabs`"
388+
"enum": [ "get_tabs" ]
395389
},
396390
"public_user": {
397391
"type": "boolean",
@@ -543,6 +537,11 @@
543537
}
544538
}
545539
}
540+
},
541+
"responses": {
542+
"200": {
543+
"description": ""
544+
}
546545
}
547546
}
548547
},
@@ -567,8 +566,7 @@
567566
"properties": {
568567
"operation": {
569568
"type": "string",
570-
"const": "get_dw_descripter",
571-
"description": "`get_dw_descripter`"
569+
"enum": [ "get_dw_descripter" ]
572570
}
573571
},
574572
"required": ["operation"],
@@ -588,6 +586,11 @@
588586
}
589587
}
590588
}
589+
},
590+
"responses": {
591+
"200": {
592+
"description": ""
593+
}
591594
}
592595
}
593596
},
@@ -989,15 +992,15 @@
989992
"required": true,
990993
"description": "The username of the local XDMoD user account.",
991994
"schema": {
992-
"type": "text"
995+
"type": "string"
993996
}
994997
}, {
995998
"name": "password",
996999
"in": "query",
9971000
"required": true,
9981001
"description": "The password for the local XDMoD user account.",
9991002
"schema": {
1000-
"type": "text"
1003+
"type": "string"
10011004
}
10021005
}],
10031006
"responses": {
@@ -1084,7 +1087,10 @@
10841087
"name": "returnTo",
10851088
"description": "The location to redirect to after authentication is completed.",
10861089
"in": "query",
1087-
"required": true
1090+
"required": true,
1091+
"schema": {
1092+
"type": "string"
1093+
}
10881094
}],
10891095
"responses": {
10901096
"200": {
@@ -1571,7 +1577,7 @@
15711577
"required": true,
15721578
"description": "The identifier for the resource that has job performance data.",
15731579
"schema": {
1574-
"type": "int"
1580+
"type": "integer"
15751581
}
15761582
}, {
15771583
"name": "db_id",
@@ -1742,10 +1748,12 @@
17421748
"type": "integer"
17431749
},
17441750
"results": {
1745-
"type": "array"
1751+
"type": "array",
1752+
"items": {}
17461753
},
17471754
"data": {
1748-
"type": "array"
1755+
"type": "array",
1756+
"items": {}
17491757
},
17501758
"message": {
17511759
"enum": ["An error was encountered while attempting to process the requested authorization procedure."]
@@ -1823,10 +1831,12 @@
18231831
"type": "integer"
18241832
},
18251833
"results": {
1826-
"type": "array"
1834+
"type": "array",
1835+
"items": {}
18271836
},
18281837
"data": {
1829-
"type": "array"
1838+
"type": "array",
1839+
"items": {}
18301840
},
18311841
"message": {
18321842
"enum": [
@@ -1898,10 +1908,12 @@
18981908
"type": "integer"
18991909
},
19001910
"results": {
1901-
"type": "array"
1911+
"type": "array",
1912+
"items": {}
19021913
},
19031914
"data": {
1904-
"type": "array"
1915+
"type": "array",
1916+
"items": {}
19051917
},
19061918
"message": {
19071919
"enum": [
@@ -2002,7 +2014,7 @@
20022014
"format": "int32"
20032015
}
20042016
}, {
2005-
"$ref": "#components/parameters/realm"
2017+
"$ref": "#/components/parameters/realm"
20062018
}],
20072019
"responses": {
20082020
"200": {
@@ -2034,7 +2046,7 @@
20342046
"format": "int32"
20352047
}
20362048
}, {
2037-
"$ref": "#components/parameters/realm"
2049+
"$ref": "#/components/parameters/realm"
20382050
}, {
20392051
"name": "data",
20402052
"in": "query",
@@ -2074,7 +2086,7 @@
20742086
"format": "int32"
20752087
}
20762088
}, {
2077-
"$ref": "#components/parameters/realm"
2089+
"$ref": "#/components/parameters/realm"
20782090
}, {
20792091
"name": "data",
20802092
"in": "query",
@@ -2114,7 +2126,7 @@
21142126
"format": "int32"
21152127
}
21162128
}, {
2117-
"$ref": "#components/parameters/realm"
2129+
"$ref": "#/components/parameters/realm"
21182130
}],
21192131
"responses": {
21202132
"200": {
@@ -2353,7 +2365,7 @@
23532365
"description": "",
23542366
"operationId": "get-warehouse-dimensions-{dimension}-name",
23552367
"parameters": [{
2356-
"$ref": "#components/parameters/dimension"
2368+
"$ref": "#/components/parameters/dimension"
23572369
}],
23582370
"responses": {
23592371
"200": {
@@ -2377,9 +2389,20 @@
23772389
"summary": "",
23782390
"description": "",
23792391
"operationId": "get-warehouse-dimensions-{dimension}-values-{valueId}-name",
2380-
"parameters": [{
2381-
"$ref": "#components/parameters/dimension"
2382-
}],
2392+
"parameters": [
2393+
{
2394+
"$ref": "#/components/parameters/dimension"
2395+
},
2396+
{
2397+
"name": "valueId",
2398+
"in": "path",
2399+
"required": true,
2400+
"description": "The value of the corresponding dimension",
2401+
"schema": {
2402+
"type": "integer"
2403+
}
2404+
}
2405+
],
23832406
"responses": {
23842407
"200": {
23852408
"description": "",
@@ -2642,7 +2665,7 @@
26422665
"properties": {
26432666
"success": {
26442667
"type": "boolean",
2645-
"const": true
2668+
"enum": [ true ]
26462669
},
26472670
"data": {
26482671
"type": "array",
@@ -2773,7 +2796,7 @@
27732796
"properties": {
27742797
"success": {
27752798
"type": "boolean",
2776-
"const": true
2799+
"enum": [ true ]
27772800
},
27782801
"message": {
27792802
"type": "string"
@@ -2840,7 +2863,7 @@
28402863
"properties": {
28412864
"success": {
28422865
"type": "boolean",
2843-
"const": true
2866+
"enum": [ true ]
28442867
},
28452868
"data": {
28462869
"type": "array",
@@ -2865,17 +2888,11 @@
28652888
},
28662889
"export_succeeded": {
28672890
"description": "Did the export succeed?",
2868-
"anyOf": [
2869-
{
2870-
"type": "null"
2871-
},
2872-
{
2873-
"type": "integer",
2874-
"format": "int32",
2875-
"minimum": 0,
2876-
"maximum": 1
2877-
}
2878-
]
2891+
"nullable": true,
2892+
"type": "integer",
2893+
"format": "int32",
2894+
"minimum": 0,
2895+
"maximum": 1
28792896
},
28802897
"export_expired": {
28812898
"description": "Is the export expired?",
@@ -2886,27 +2903,15 @@
28862903
},
28872904
"export_expires_datetime": {
28882905
"description": "Data export expiration date",
2889-
"anyOf": [
2890-
{
2891-
"type": "null"
2892-
},
2893-
{
2894-
"type": "string",
2895-
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
2896-
}
2897-
]
2906+
"nullable": true,
2907+
"type": "string",
2908+
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
28982909
},
28992910
"export_created_datetime": {
29002911
"description": "Data export creation date",
2901-
"anyOf": [
2902-
{
2903-
"type": "null"
2904-
},
2905-
{
2906-
"type": "string",
2907-
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
2908-
}
2909-
]
2912+
"nullable": true,
2913+
"type": "string",
2914+
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
29102915
},
29112916
"export_file_format": {
29122917
"description": "Data export file type",
@@ -2922,15 +2927,9 @@
29222927
},
29232928
"downloaded_datetime": {
29242929
"description": "Data export (first) download date",
2925-
"anyOf": [
2926-
{
2927-
"type": "null"
2928-
},
2929-
{
2930-
"type": "string",
2931-
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
2932-
}
2933-
]
2930+
"nullable": true,
2931+
"type": "string",
2932+
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
29342933
},
29352934
"state": {
29362935
"description": "Data export state",
@@ -2999,7 +2998,7 @@
29992998
"properties": {
30002999
"success": {
30013000
"type": "boolean",
3002-
"const": true
3001+
"enum": [ true ]
30033002
},
30043003
"message": {
30053004
"type": "string"
@@ -3140,7 +3139,7 @@
31403139
"properties": {
31413140
"success": {
31423141
"type": "boolean",
3143-
"const": true
3142+
"enum": [ true ]
31443143
},
31453144
"message": {
31463145
"type": "string"

0 commit comments

Comments
 (0)