dadi/apidoc

API documentation middleware for DADI API

apidoc's Issues

Render fails when collection contains "datetime" fields

When a collection schema contains a field with type: "DateTime, rendering of the API documentation fails with error:

[2018-04-11 08:54:00.558] [LOG]   { code: 4,
  message: 'Error parsing input: base type \'datetime\' is not defined in the document',
  location: [ { index: 48763, length: 34 } ],
  input: 'FORMAT: 1A\nHOST:

Add authentication

The documentation is currently available to anyone with the url to the documetation. There should be an option to restrict access - either by username/password or a key.

Add test suite

Blueprint > Swagger

In the current version we've been using API Blueprint for documentation generation, however we should migrate to the OpenAPI specification, formerly Swagger. This will give us the ability to import an OpenAPI specification into a new API instance to automatically create all the collection schema files required to run the API.

Doc generation fails with API media collections

API seems to generate two Media collections, which results in a failure by APIDoc to parse the underlying API Blueprint:

{
  "code": 4,
  "message": "Error parsing input: named type 'MediastoreErrorResult' is defined more than once",
  "location": [
    {
      "index": 76305,
      "length": 35
    }
  ],

Install fails on Node versions > 4