Open geraintluff opened 12 years ago
You also need documentation for the plugins.
Perhaps /api/
and /api/plugins/render/
?
Current documentation is uncategorised.
How about making "category" pages, that group methods by purpose, and embed particular method definitions like data.json#/methods/pointerPath
?
API documentation format needs something like extends
/allOf
.
Format could actually extend JSON Schema. Have a oneOf
that checks for presence of arguments
or results
to apply "function definition" schema?
Needs theme-specific page (page documenting all AJAX methods, page documenting all data manipulation methods).
Separate docs for in-browser renderer.
Easiest way is probably a custom JSON format:
title
/description
/properties
/methods
title
/description
/arguments
/return
/properties
/methods
Set up quick-and-dirty editing API for local use.