apidocs icon indicating copy to clipboard operation
apidocs copied to clipboard

Schema definitions should be linked or inlined in HTML docsform

Open jonnor opened this issue 9 years ago • 1 comments

Right now we just raw-dump the schemas into the blueprint. This is useful-ish, but things like $ref: someother-schema is confusing.

References should be resolved, and then put links into the HTML to navigate up/down between these. For single base definitions (which are usually very short) it might be nicer to inline. Also, there should probably be a link to the schema itself (in .yml and .json format), so people see where it comes from.

Came up in #26

jonnor avatar Aug 18 '15 19:08 jonnor

Using something like docson to generate an HTML with all schemas in one page could be useful to navigate too.

automata avatar Apr 19 '16 01:04 automata