Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.51 KB

Conversion.md

File metadata and controls

43 lines (27 loc) · 1.51 KB

Kragle.io Documentation

API Reference - Conversion

POST /util/convert

(This endpoint does not require authentication.)

This endpoint allows anyone to perform Kragle-style conversion of an arbitrary json structure against an arbitrary conversion specifier (see Conversion Specifiers for details).

It is provided as a convenience for the community, users building custom Types/Blocks, etc.

The request body must be a JSON object following this format:

{
    "conversion": <object - the conversion specifier to use>,
    "data": <object to convert using the conversion specifier>
}

The response body will be a JSON object - the result of the conversion.

NB: You can also pass _uri -appended versions of both the schema and data parameters if you with to pass a url which points to an appropriate object, instead of the object itself. Ie: this is also valid:

{
    "conversion_uri": <string - a url where a JSON object representing the conversion specifier may be downloaded>,
    "data_uri": <string - a url where a JSON object representing your data to be converted may be downloaded>
}