rpc_spec icon indicating copy to clipboard operation
rpc_spec copied to clipboard

Report on MOBILE_API.xml issues(inaccurate description)

Open Yuki-Shoda-Nexty opened this issue 5 years ago • 0 comments

We propose correcting MOBILE_API.xml(inaccurate description)

Currently, MOBILE_API.xml contains some inaccurate descriptions. . By compensating for this, we can provide a more accurate RPC documents to the SDL developers. The target items are described in the Excel file.

MOBILE_API_inaccurate description.xlsx

e.g. alignment that is one of the parameter of RPC Show in MOBILE_API.xml, its description is inaccurate. Add the description of each element as shown below.

Modify the description of alignment as shown below.

<param name="alignment"   type="TextAlignment" mandatory="false"   since="1.0">
<description>
-        Specifies how mainField1 and   mainField2 texts should be aligned on display.
+        Specifies how mainField1, mainField2,   mainField3 and mainField4 texts should be aligned on display.
.If omitted, texts will be centered.
</description>
</param>

Yuki-Shoda-Nexty avatar Jun 15 '20 06:06 Yuki-Shoda-Nexty