search

theRealPadster / diffbot-api-node

Diffbot-API-Node is a Promise-based library to use the Diffbot REST APIs
MIT License
3 stars 2 forks source link

Update docs to more clearly outline all supported parameters for each function #5

Open theRealPadster opened 3 years ago

theRealPadster commented 3 years ago

Have a section for each module that outlines what params are supported. They're mostly the same as the ones from the official Diffbot docs, but some differ, like boolean fields, and not all fields are supported for each module.

theRealPadster commented 3 years ago

Added links to the official Diffbot docs for each API in c4afe2aeb4001674ab1ca46ebf5912da5e3d9cc8. This still doesn't explain any differences, like boolean fields or seeds being an array.

theRealPadster commented 3 years ago

I have added a wiki page for the Analyze API, with a table outlining the supported params. This is just copied from the JSDocs. It might be a good idea to see if I can auto-generate the rest.

theRealPadster commented 3 years ago

Added more wiki pages.

This npm package may be useful for automatically generating documentation based on the jsdocs...