This repository has been archived by the owner on Apr 29, 2019. It is now read-only.
Proposal: Augment dna.json to support clearer auto-generated api documentation #97
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please see the changes to
dna/dna.json
:ReturnType
toFunctions
items. Note holochain currently returnstext/plain
content-type for all calls (even if they return json data), hence everything for clutter marked asstring
.InputSchemaFile
toFunctions
items that have aCallingType
ofjson
. This gives us more information about the expected parameters.OutputSchemaFile
toFunctions
items that have aReturnType
ofjson
. Unused at the moment (given holochain always returnstext/plain
) but can in the future give us an indication of output data format.Description
toFunctions
items. This is a string (potentially markdown) that can give a more verbose indication of what functions do / how to use them.Notes on accessing the api-docs:
npm start
... simply navigate to http://localhost:3000/clutter-api-docs.html