Skip to content

LSIF: Swagger API documentation

Warren Gifford requested to merge lsif-swagger into master

Created by: efritz

Move API documentation into a Swagger document. This has a few benefits:

  • is structured (not plaintext, has a specification)
  • contains json schema for request/response bodies (can be machine checked)
  • is runnable via Swagger UI (instructions included in api.md)

This required adding CORS to the server API so that it can be reached from the Swagger UI running via docker. I don't think this has any ill-effects as this API is not exposed outside of development environments.

Merge request reports