Skip to content
This repository was archived by the owner on Feb 22, 2019. It is now read-only.
This repository was archived by the owner on Feb 22, 2019. It is now read-only.

API auto-documentation documentation is missing #452

@scottinet

Description

@scottinet

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions