view release on metacpan or  search on metacpan

t/froodydoc_wiky_js.t  view on Meta::CPAN

== Arguments ==

None.

== Response ==

[%
<response>
  <methods>
    <method>froody.reflection.getMethods</method>
    <method>froody.reflection.getMethodInfo</method>
    <method>bar.baz.blargle</method>
    <method>heartofgold.towel.location</method>
  </methods>
</response>
%]

= froody.reflection.getErrorTypes =

Returns a list of all available froody error types for this repository.

== Arguments ==

None.

== Response ==

[%
<response>
  <errortypes>
    <errortype>froody.error</errortype>
    <errortype>froody.error.blog</errortype>
  </errortypes>
</response>
%]

= froody.reflection.getErrorTypeInfo =

Request information about an Error Type

== Arguments ==

[|Name|Type|Description|Required|
|code|string|The code of the error type whose information is being requested.|required|]

== Response ==

[%
<response>
  <errortype code="mycode">Internal structure of your error type goes here (including XML)</errortype>
</response>
%]

== Errors ==

* *froody.error.notfound.errortype* - Error Type not Found

= froody.reflection.getSpecification =

Request the full public specification for a froody endpoint.

== Arguments ==

None.

== Response ==

[%
<response>
  <spec>
    <methods>
      <method name="froody.fakeMethod" needslogin="1">
        <description>A fake method</description>
        <response>xml-response-example</response>
        <arguments>
          <argument name="color" optional="1" type="scalar">Your favorite color.</argument>
          <argument name="fleece" optional="0" type="csv">Your happy fun clothing of choice.</argument>
        </arguments>
        <errors>
          <error code="1" message="it would be bad">Don't cross the streams.</error>
          <error code="1" message="it would be bad">Don't cross the streams.</error>
        </errors>
      </method>
      <method name="froody.fakeMethod" needslogin="1">
        <description>A fake method</description>
        <response>xml-response-example</response>
        <arguments>
          <argument name="color" optional="1" type="scalar">Your favorite color.</argument>
          <argument name="fleece" optional="0" type="csv">Your happy fun clothing of choice.</argument>
        </arguments>
        <errors>
          <error code="1" message="it would be bad">Don't cross the streams.</error>
          <error code="1" message="it would be bad">Don't cross the streams.</error>
        </errors>
      </method>
    </methods>
    <errortypes>
      <errortype code="mycode">Internal structure of your error type goes here (including XML)</errortype>
      <errortype code="mycode">Internal structure of your error type goes here (including XML)</errortype>
    </errortypes>
  </spec>
</response>
%]