swathysubhash / docprint Goto Github PK

When I try to run the command line tool I always get this error:

$ docprint -p index.md -d docs
TypeError: Cannot read property 'find' of undefined
    at setHost (/usr/local/lib/node_modules/docprint/src/index.js:76:22)
    at module.exports (/usr/local/lib/node_modules/docprint/src/index.js:43:5)
    at Object.<anonymous> (/usr/local/lib/node_modules/docprint/bin/index.js:15:18)
    at Module._compile (module.js:571:32)
    at Object.Module._extensions..js (module.js:580:10)
    at Module.load (module.js:488:32)
    at tryModuleLoad (module.js:447:12)
    at Function.Module._load (module.js:439:3)
    at Module.runMain (module.js:605:10)
    at run (bootstrap_node.js:425:7) 'TypeError: Cannot read property \'find\' of undefined\n    at setHost (/usr/local/lib/node_modules/docprint/src/index.js:76:22)\n    at module.exports (/usr/local/lib/node_modules/docprint/src/index.js:43:5)\n    at Object.<anonymous> (/usr/local/lib/node_modules/docprint/bin/index.js:15:18)\n    at Module._compile (module.js:571:32)\n    at Object.Module._extensions..js (module.js:580:10)\n    at Module.load (module.js:488:32)\n    at tryModuleLoad (module.js:447:12)\n    at Function.Module._load (module.js:439:3)\n    at Module.runMain (module.js:605:10)\n    at run (bootstrap_node.js:425:7)'

For any input file. My node version is 7.7.3.

When using a ENUM in the parameters, which follows the specification, the build of the documentation fails.

As you can see here , + Members was added to make it meet the specification

https://apiblueprint.org/documentation/specification.html#def-uriparameters-section

But it results in the following error when ran -

It appears to be trying to insert not just the example value, but the whole set of possible options into the URI.

When running the doc generation, HTML 4.0 entities are being processed in a few place.

In my case, I discovered this with &notice is being converted to ¬ice and rendering a not symbol.

This only applies to the URL method, not the same code that is generated.

See screenshot -

Code where query param is specified -

Hi!

Maybe I am missing something, but it makes sense to include an example request body into generated Example requests, as otherwise there is no any use of POST example requests.

Is it currently supported somehow?

Nick

Example:

+ Parameters
    + reference: 2018-95 (string, required) - The reference of a given entity

The part with The reference of a given entity isn't included in the generated output.

It does work for attributes, though.

This is beautiful and nicer than alternatives since they are not maintained.

Is there any way we can get something like aglio -i input.apib -s? It will run a live preview server on http://localhost:3000/

So docprint gives bad output when API description contains non-ASCII characters.
My Browser interprets output as 8bit encoding.

Hi,

This library is exactly what I'm looking for, but unfortunately it isn't working very well with data structures.

If I use, for example, the Data Structures example from apiblueprint, it doesn't work. Ignoring the missing HOST problem, which is easily fixed by adding HOST: in after FORMAT:, it fails to load the datastructure because the element has no content. Here is the output I found adding a console.log(result) at parse.js:23:

Result object parsing: { element: 'dataStructure', content: [ { element: 'Coupon' } ] }

Because the meta is empty, it fails and crashes.

Thanks