Changes for page #[RPC\Response]

Last modified by Ashterix on 2024/05/19 21:13

From version 1.1
edited by Ashterix
on 2024/05/10 14:41
Change comment: There is no comment for this version
To version 4.2
edited by Ashterix
on 2024/05/19 21:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,32 +1,25 @@
1 -{{box cssClass="floatinginfobox" width="400px"}}
1 +{{box cssClass="floatinginfobox"}}
2 2  == (% style="display:block; margin-top:-30px; text-align:center" %)Summary(%%) ==
3 3  
4 -(% style="margin-right:auto; width:353px" %)
5 -|(% style="width:141px" %)**Classname**|(% colspan="2" rowspan="1" style="width:79px" %)(((
4 +|**Classname**|(% colspan="2" rowspan="1" %)(((
6 6  Response
7 7  )))
8 -|(% style="width:141px" %)**Namespace**|(% colspan="2" style="width:79px" %)(((
7 +|**Namespace**|(% colspan="2" %)(((
9 9  Ufo\RpcObject\RPC
10 10  )))
11 -|(% style="width:141px" %)(((
12 -**Target**
13 -)))|(% colspan="2" rowspan="1" style="width:79px" %)method
14 -|(% colspan="3" style="width:141px" %)**Arguments:**
15 -|(% colspan="1" rowspan="3" style="width:141px" %)(((
10 +|**Target**|(% colspan="2" rowspan="1" %)method
11 +|(% colspan="3" %)**Arguments:**
12 +|(% colspan="1" rowspan="3" %)(((
16 16  $responseFormat
17 -)))|(% style="width:79px" %)**type**|(% style="width:153px" %)array
18 -|(% style="width:79px" %)**optional**|(% style="width:153px" %)true
19 -|(% style="width:79px" %)**default**|(% style="width:153px" %)[]
20 -|(% colspan="1" rowspan="3" style="width:141px" %)(((
21 -$dto
22 -)))|(% style="width:79px" %)**type**|(% style="width:153px" %)string
23 -|(% style="width:79px" %)**optional**|(% style="width:153px" %)true
24 -|(% style="width:79px" %)**default**|(% style="width:153px" %)''
25 -|(% colspan="1" rowspan="3" style="width:141px" %)(((
26 -$collection
27 -)))|(% style="width:79px" %)**type**|(% style="width:153px" %)bool
28 -|(% style="width:79px" %)**optional**|(% style="width:153px" %)true
29 -|(% style="width:79px" %)**default**|(% style="width:153px" %)false
14 +)))|**type**|array
15 +|**optional**|true
16 +|**default**|[]
17 +|(% colspan="1" rowspan="3" %)$dto|**type**|string
18 +|**optional**|true
19 +|**default**|''
20 +|(% colspan="1" rowspan="3" %)$collection|**type**|bool
21 +|**optional**|true
22 +|**default**|false
30 30  {{/box}}
31 31  
32 32  = Enhanced Response Format =
... ... @@ -82,10 +82,16 @@
82 82  {{code language="json" layout="LINENUMBERS"}}
83 83  {
84 84   "envelope": "JSON-RPC-2.0/UFO-RPC-6",
85 - "transport": "POST",
86 - "target": "/api",
87 87   "contentType": "application/json",
88 88   "description": "",
80 + "transport": {
81 + "sync": {
82 + "scheme": "https",
83 + "host": "example.com",
84 + "path": "/api",
85 + "method": "POST"
86 + }
87 + },
89 89   "methods": {
90 90   "ExampleApi.getUserInfo": {
91 91   "name": "ExampleApi.getUserInfo",
... ... @@ -193,7 +193,7 @@
193 193   "methods": {
194 194   "ExampleApi.getUserInfo": {
195 195   "name": "ExampleApi.getUserInfo",
196 - ...
195 + ...,
197 197   "returns": "object",
198 198   "responseFormat": {
199 199   "id": "int",
... ... @@ -203,7 +203,7 @@
203 203   },
204 204   "ExampleApi.getUserInfoAsArray": {
205 205   "name": "ExampleApi.getUserInfoAsArray",
206 - ...
205 + ...,
207 207   "returns": "array",
208 208   "responseFormat": {
209 209   "id": "int",
... ... @@ -213,7 +213,7 @@
213 213   },
214 214   "ExampleApi.getUsersList": {
215 215   "name": "ExampleApi.getUsersList",
216 - ...
215 + ...,
217 217   "returns": "array",
218 218   "responseFormat": [
219 219   {
... ... @@ -306,7 +306,7 @@
306 306   "methods": {
307 307   "ExampleApi.getUserInfo": {
308 308   "name": "ExampleApi.getUserInfo",
309 - ...
308 + ...,
310 310   "returns": "object",
311 311   "responseFormat": {
312 312   "id": "int",
... ... @@ -316,7 +316,7 @@
316 316   },
317 317   "ExampleApi.getUserInfoAsArray": {
318 318   "name": "ExampleApi.getUserInfoAsArray",
319 -
318 + ...,
320 320   "returns": "array",
321 321   "responseFormat": {
322 322   "id": "int",
... ... @@ -326,7 +326,7 @@
326 326   },
327 327   "ExampleApi.getUsersList": {
328 328   "name": "ExampleApi.getUsersList",
329 -
328 + ...,
330 330   "returns": "array",
331 331   "responseFormat": [
332 332   {
... ... @@ -346,4 +346,3 @@
346 346  )))
347 347  )))
348 348  )))
349 -