Changes for page #[RPC\Response]

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

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

Summary

Details

Page properties
Content
... ... @@ -1,25 +1,32 @@
1 -{{box cssClass="floatinginfobox"}}
1 +{{box cssClass="floatinginfobox" width="400px"}}
2 2  == (% style="display:block; margin-top:-30px; text-align:center" %)Summary(%%) ==
3 3  
4 -|**Classname**|(% colspan="2" rowspan="1" %)(((
4 +(% style="margin-right:auto; width:353px" %)
5 +|(% style="width:141px" %)**Classname**|(% colspan="2" rowspan="1" style="width:79px" %)(((
5 5  Response
6 6  )))
7 -|**Namespace**|(% colspan="2" %)(((
8 +|(% style="width:141px" %)**Namespace**|(% colspan="2" style="width:79px" %)(((
8 8  Ufo\RpcObject\RPC
9 9  )))
10 -|**Target**|(% colspan="2" rowspan="1" %)method
11 -|(% colspan="3" %)**Arguments:**
12 -|(% colspan="1" rowspan="3" %)(((
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" %)(((
13 13  $responseFormat
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
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
23 23  {{/box}}
24 24  
25 25  = Enhanced Response Format =
... ... @@ -75,16 +75,10 @@
75 75  {{code language="json" layout="LINENUMBERS"}}
76 76  {
77 77   "envelope": "JSON-RPC-2.0/UFO-RPC-6",
85 + "transport": "POST",
86 + "target": "/api",
78 78   "contentType": "application/json",
79 79   "description": "",
80 - "transport": {
81 - "sync": {
82 - "scheme": "https",
83 - "host": "example.com",
84 - "path": "/api",
85 - "method": "POST"
86 - }
87 - },
88 88   "methods": {
89 89   "ExampleApi.getUserInfo": {
90 90   "name": "ExampleApi.getUserInfo",
... ... @@ -192,7 +192,7 @@
192 192   "methods": {
193 193   "ExampleApi.getUserInfo": {
194 194   "name": "ExampleApi.getUserInfo",
195 - ...,
196 + ...
196 196   "returns": "object",
197 197   "responseFormat": {
198 198   "id": "int",
... ... @@ -202,7 +202,7 @@
202 202   },
203 203   "ExampleApi.getUserInfoAsArray": {
204 204   "name": "ExampleApi.getUserInfoAsArray",
205 - ...,
206 + ...
206 206   "returns": "array",
207 207   "responseFormat": {
208 208   "id": "int",
... ... @@ -212,7 +212,7 @@
212 212   },
213 213   "ExampleApi.getUsersList": {
214 214   "name": "ExampleApi.getUsersList",
215 - ...,
216 + ...
216 216   "returns": "array",
217 217   "responseFormat": [
218 218   {
... ... @@ -305,7 +305,7 @@
305 305   "methods": {
306 306   "ExampleApi.getUserInfo": {
307 307   "name": "ExampleApi.getUserInfo",
308 - ...,
309 + ...
309 309   "returns": "object",
310 310   "responseFormat": {
311 311   "id": "int",
... ... @@ -315,7 +315,7 @@
315 315   },
316 316   "ExampleApi.getUserInfoAsArray": {
317 317   "name": "ExampleApi.getUserInfoAsArray",
318 - ...,
319 +
319 319   "returns": "array",
320 320   "responseFormat": {
321 321   "id": "int",
... ... @@ -325,7 +325,7 @@
325 325   },
326 326   "ExampleApi.getUsersList": {
327 327   "name": "ExampleApi.getUsersList",
328 - ...,
329 +
329 329   "returns": "array",
330 330   "responseFormat": [
331 331   {
... ... @@ -345,3 +345,4 @@
345 345  )))
346 346  )))
347 347  )))
349 +