nulldivision / doctyped Goto Github PK

Current documentation needs to be heavily revised

Current builder lacks a structure and incorporates all API elements as an after thought. To improve it needs to follow the pattern of:

• handling incoming requests for API analysis
• load necessary API analysis submodule

Current builder is mostly strung together with duct tape. To improve modularity it should adhere to the following:

• standard input interface
• modularized output modules for Flow and Typescript
• easily scalable input interface with minimal backtracking or finding

As a more commonly used API documentation service it seems like a good a time as any to start work on adding Nelmio as a builder submodule

EJS adds a lot of whitespace for no reason. Would be nice to have prettier flow files.

Currently we don't support additionalProperties. This should be fixed.

Currently GraphQL API analysis is handled by the main builder. Due to how API calls are handled in GraphQL this needs to be separated as a builder submodule in v2 to:

• handle analysis requests
• handle call to API
• generate standard syntax usable by builder

Built resource interfaces should include metadata as comments for the following information:

• API documentation URL
• date generated
• endpoints where the resource is used

Swagger API analysis is currently handled by the builder. V2 submodule should:

• handle analysis requests
• handle call to API
• generate standard syntax usable by builder

We're currently letting the error message from local file lookup pass through to cli.

ENOENT: no such file or directory, open 'https://localhost/swagger'
Could not resolve path locally

We should hide the ENOENT error.

Current NPM tags are missing GraphQL and Nelmio

External types that are used for multiple props get imported twice. These need to be deduped.