This repository has been archived by the owner on Feb 22, 2019. It is now read-only.

API auto-documentation documentation is missing #452

Open

scottinet opened this issue Mar 29, 2018 · 0 comments

Labels

Contributor

scottinet commented Mar 29, 2018 •

edited

Loading

Kuzzle's API is dynamically auto-documented, and that includes API routes added by plugins.

There are multiple ways to access that documentation:

[all protocols] the server:info route (HTTP URL: http://<server>:<port>/) returns the complete API description
[HTTP only] swagger descriptions (JSON: http://<server>:<port>/swagger.json, YAML: http://<server>:<port>/swagger.yml)

These informations appear to be missing from our documentation, and it should also be mentionned in our plugin documentation.

The text was updated successfully, but these errors were encountered:

scottinet added the info-missing label

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.