analogjupiter / amp Goto Github PK

• https://github.com/apiaryio/drafter/releases/tag/v5.0.0-rc.1
• https://github.com/apiaryio/drafter/releases/tag/v5.0.0

It would be nice, if for endpoints, where there is no request body, it would not be shown or at least not as if there was one (as usual), but empty.

It would be nice to be able to not only view an example of the Request/Response, but to also be able to switch to a view where the attributes are listed with their data-type and description like the parameters above.

It is currently not possible to define several responses for a single resource.
Yet, it would be very useful to have the possibility to, for example, add error responses.

I cannot accomplish adding example values to requests or responses that contain an array at their root.
Example resource:

### Archive Notes [POST /notes/archive-notes]
Archive Notes with the ids passed
+ Request (application/json)
    + Attributes (array[numbers])
+ Response 204 (application/json)

How can example values be added for this request?

In the Table of Contents, all levels of the hierarchy should be collapsible (even groups.
Otherwise, if you have a lot of Groups, the ToC gets very overloaded very fast.
(maybe also collapse everything by default)

Is it possible to indicate if an endpoint is already implemented or not.
It would be a cool feature, especially if you could see it in the overview already (and not only when clicking on a specific endpoint).

Say, the directory containing the files to parse is under /parent/api_doc.

If I now try to create the api-documentation by using /parent/api_doc$ amp --force . ./html, it does not show any error and seems to parse correctly. The file html.drafterlog does not contain any errors either. Yet, there is no api_doc.html file under /parent/api_doc/html.

When, on the other hand, using /parent$ amp --force ./api_doc ./api_doc/html, the api-documentation is created correctly and the file /parent/api_doc/api_doc.html exists.