Skip to content

Commit

Permalink
Reindent method.xml (no actual content changes)
Browse files Browse the repository at this point in the history
  • Loading branch information
wrygiel committed Apr 25, 2017
1 parent 6c66424 commit 1639233
Showing 1 changed file with 33 additions and 19 deletions.
52 changes: 33 additions & 19 deletions okapi/services/apiref/method.xml
Expand Up @@ -14,38 +14,52 @@
<ul>
<li><b>name</b> - name of the method,</li>
<li><b>short_name</b> - name without a path,</li>
<li><b>issue_id</b> - ID of the "general discussion" issue (in our project's
<li>
<b>issue_id</b> - ID of the "general discussion" issue (in our project's
homepage Issue Tracker) associated with this method <b>or null</b> if this
method has associated issue,</li>
method has associated issue,
</li>
<li><b>description</b> - HTML-formatted description of what the method does,</li>
<li><b>brief_description</b> - brief (max 80 characters), single-line,
plain-text description of what the method does,</li>
<li>
<b>brief_description</b> - brief (max 80 characters), single-line, plain-text
description of what the method does,
</li>
<li><b>ref_url</b> - URL of the documentation page with method description,</li>
<li>
<b>auth_options</b> - a dictionary which describes authentication
requirements for this method, it has a following structure:
<p><b>auth_options</b> - a dictionary which describes authentication
requirements for this method, it has a following structure:</p>

<ul>
<li><b>min_auth_level</b> - integer, in range from 0 to 3,
see Introduction page.</li>
<li><b>oauth_consumer</b> - true, if requests are required to be signed
with OAuth Consumer Key (min_auth_level >= 2),</li>
<li><b>oauth_token</b> - true, if requests are required to include an
OAuth Token (min_auth_level == 3).</li>
<li>
<b>min_auth_level</b> - integer, in range from 0 to 3, see Introduction
page.
</li>
<li>
<b>oauth_consumer</b> - true, if requests are required to be signed
with OAuth Consumer Key (min_auth_level >= 2),
</li>
<li>
<b>oauth_token</b> - true, if requests are required to include an OAuth
Token (min_auth_level == 3).
</li>
</ul>
</li>
<li><b>arguments</b> - list of dictionaries, describes method
arguments. Each dictionary has a following structure:
<li>
<p><b>arguments</b> - list of dictionaries, describes method arguments. Each
dictionary has a following structure:</p>

<ul>
<li><b>name</b> - name of an argument,</li>
<li><b>is_required</b> - boolean, true if the argument is required,</li>
<li><b>is_deprecated</b> - boolean, true if the argument is deprecated,</li>
<li><b>description</b> - HTML-formatted description of an argument.</li>
<li>
<p><b>class</b> - space separated list of the following values: <i>public</i>,
<i>inherited</i>, <i>common-formatting</i> and <i>deprecated</i>
(other values might be introduced in future).</p>
<p>Currently these values do not mean anything specific. They are
used for different coloring/styling in the documentation pages.</p>
<p><b>class</b> - space separated list of the following values:
<i>public</i>, <i>inherited</i>, <i>common-formatting</i> and
<i>deprecated</i> (other values might be introduced in future).</p>

<p>Currently these values do not mean anything specific. They are used
for different coloring/styling in the documentation pages.</p>
</li>
</ul>
</li>
Expand Down

0 comments on commit 1639233

Please sign in to comment.