lucybot-inc/documentation-starter

Interactive REST API Documentation

documentation-starter's Issues

Use ngRoute

Pages should use fragments for #documentation and #console tabs, and for each individual endpoint

Not able to pickup my openapi.json file

Hi Team,

I tried to configure lucyBot(https://github.com/LucyBot-Inc/documentation-starter.git) in my local system and it worked with petstore example as expected but when I tried to update openApi.json file with my content it is not taking it up though I restarted server,cleared cache. can you help me if I am doing anythin wrong ?

Improve customizability

Expose specific CSS classes or LESS variables to override

Use JSON schema description fields in Documentation

The static-site branch

Hi Lucy,

I come across the static-site branch and see it's really easy to use. Is this branch stable enough to use instead of the master?

Compress content

This is good article http://blog.modulus.io/nodejs-and-express-static-content

Add sections to README page

Fix link to swagger file

https://github.com/bobby-brennan/lucy-console/blob/b6807cd4cc2bab1ed497da5b37a2a1ad45a90d93/views/includes/spec-link.jade#L3

should be changed to 'https://apis-guru.github.io/api-models/'

Minify and concatenate JS and CSS

You can use for example https://github.com/pgilad/grunt-jade-usemin

Display urls from `externalDocs` inside Swagger.

Support both global and per operation externalDocs
Examples:
global
per method

Migrate from CSS to LESS

This will help consoles take better advantage of user-defined variables

Remove proxy for 'api-models'

I create gh-pages branch for api-models repo.
So you can use links like http://apis-guru.github.io/api-models/googleapis.com/drive/v2/swagger.json
to access specs. gh-pages support compression and Access-Control-Allow-Origin: * so you can remove proxy.
If this will work as expected I will remove master branch and make `gh-pages' main branch.

Don't render all routes in docs tab

Scaling issues - giant specs will crash your browser

Dynamic inputs

Allow filling in of select boxes via API calls.

[Unsure] support for OpenAPI v. 3.0.0

I have an OpenAPI specification v. 3.0.0 in YAML format. I converted it to JSON and put into the root directory as suggested, but the rendering I see is very poor, it only contains the top-level list of methods and that's all. If I click on a method, it shows method's description, list of parameters and response code tabs, but everything with empty content.

I am wondering if it is something related to my JSON file and how it can be fixed. Does the tool support "openapi": "3.0.0" at all?