Self-documenting comms layer #2020
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think it will be good if we can make use of this to generate an API reference for the CUG. |
|
Closing this PR until time permits. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A rough sketch of self-documentation capability for the comms layer. Each exposed method is introspected and is used to generate a page for each sub-url (e.g. all the
/broadcast/*server methods are exposed by going to the root/broadcast/page).I'm putting this up as an example for discussion really - there is definitely a better way of presenting this out there. If we're being really wild, there must be some kind of auto-generation of HTML forms based on input metadata for the parameters...