Commit 6d8b81f4 authored by Aaron Wells's avatar Aaron Wells Committed by Robert Lyon

Bug 1620879: Improve formatting of WS function descriptions

behatnotneeded

Change-Id: Idea08ba7827d939af6f2fc8ec6be30774f2af5cb
parent 9efa71f6
......@@ -256,7 +256,7 @@ $string['context'] = 'Context';
$string['createtoken'] = 'Create token';
$string['createtokenforuser'] = 'Create a token for a user';
$string['createuser'] = 'Create a specific user';
$string['default'] = 'Default to "%s"';
$string['default'] = 'Default %s';
$string['deleteservice'] = 'Delete the service: {$a->name} (id: {$a->id})';
$string['doc'] = 'Documentation';
$string['documentation'] = 'web services documentation';
......@@ -292,6 +292,7 @@ $string['invalidtimedtoken'] = 'Invalid token: Token expired';
$string['invalidtoken'] = 'Invalid token: Token not found';
$string['invalidtokensession'] = 'Invalid session based token: Session not found or expired';
$string['iprestriction'] = 'IP restriction';
$string['list'] = 'list of';
$string['key'] = 'Key';
$string['missingpassword'] = 'Missing password';
$string['missingusername'] = 'Missing username';
......
......@@ -3,7 +3,7 @@
{/if}
<h2>{str tag="function" section="auth.webservice"}: {$function->name} </h2>
<table>
<table class="table table-striped">
<tr><td>{str tag="wsdocdescription" section="auth.webservice"}:</td><td>{$functiondescription}</td></tr>
<tr><td>{str tag="component" section="auth.webservice"}:</td><td>{$function->component}</td></tr>
<tr><td>{str tag="class" section="auth.webservice"}:</td><td>{$function->classname}</td></tr>
......@@ -13,20 +13,14 @@
<span class='arguments'>{str tag="arguments" section="auth.webservice"}</span>
<br/>
{foreach from=$fdesc->parameters_desc->keys item=paramdesc key=paramname}
<span style='font-size: 80%'>
<b>{$paramname}</b> ({if $paramdesc->required == 1 }{str tag="required" section="auth.webservice"}{else}{if $paramdesc->required == 2}{str tag="optional" section="auth.webservice"}{else}{if ($paramdesc->default === null)} null {else} {$paramdesc->default}{/if}{/if}{/if})
<br/>
{$paramdesc->desc}
<br/>
<div>
<div class="detaildescription">
<pre class='detaildescription'><b>{str tag="generalstructure" section="auth.webservice"}</b>
{wsdoc_detailed_description_html($paramdesc)}
<pre class='detaildescription'>
{foreach from=$fdesc->parameters_desc->keys item=paramdesc key=paramname}
<span class="wsname">{$paramname}:</span> {wsdoc_detailed_description_html($paramdesc, 1)}
{/foreach}
</pre>
</div>
</div>
{foreach from=$fdesc->parameters_desc->keys item=paramdesc key=paramname}
{if $xmlrpcactive == 1 }
<br/>
<div>
......@@ -48,7 +42,7 @@
</div>
{/if}
</span>
{/foreach}
{/foreach}
<br/>
<br/>
......
......@@ -257,3 +257,24 @@ label.lead {
.licenseicon {
padding: 0 10px 5px 0;
}
pre {
span.wsname {
font-weight: bold;
}
span.wsdescription {
color: #2A33A6;
padding-right: 10px;
.wsrequired {
font-weight: bold;
color: $brand-danger;
}
.wsoptional {
font-weight: bold;
}
.wsdescriptiontext {
font-style: italic;
}
}
}
\ No newline at end of file
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment