Skip to content

API docs: add feature flag which disables all LSIF uploads, etc. & turn off by default

Warren Gifford requested to merge sg/apidocs-ff into main

Created by: slimsag

API docs has been on-by-default for many releases now.

There is a feature flag "apidocs.search.indexing": "disabled" which disables the recent search indexing additions (and all the LSIF upload logic that comes with that.)

We're seeing LSIF queue growth and the release branch is to be created in just a few hours, we could default the searc indexing flag to off which I think would resolve the issue - but it seems safer to just disable it all.

The only downside to this is that the "API docs" button on repo pages, and the UI that appears when you click that, will continue to be present even once disabled. If your instance had API docs, they will continue to show - just not update anymore. I think this is OK to do because I haven't heard of any customer actually using API docs and it is so non-discoverable today.

Merge request reports