Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 815 Bytes

api.md

File metadata and controls

15 lines (11 loc) · 815 Bytes

LSIF API server endpoints

The LSIF API server endpoints are documented as an OpenAPI v3 document api.yaml. This document can be viewed locally via docker by running the following command from this directory (or a parent directory if the host path supplied to -v changes accordingly).

docker run \
  -e SWAGGER_JSON=/data/api.yaml \
  -p 8080:8080 \
  -v `pwd`:/data \
  swaggerapi/swagger-ui

The OpenAPI document assumes that the LSIF API server is running locally on port 3186 in order to make sample requests.

This API should not be directly accessible outside of development environments. The endpoints of this API are not authenticated and relies on the Sourcegraph frontend to proxy requests via the HTTP or GraphQL server.