Initial implementation of TechDocs cache in backend plugin

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-07-24 17:00:22 +02:00
committed by Eric Peterson
parent 3e443e8e31
commit 0a44eb7d52
3 changed files with 47 additions and 2 deletions
+17
View File
@@ -226,6 +226,23 @@ export interface Config {
};
};
/**
* @example http://localhost:7007/api/techdocs
* Techdocs cache information
*/
cache?: {
/**
* The cache time-to-live for TechDocs sites (in milliseconds). Set this
* to a non-zero value to cache TechDocs sites and assets as they are
* read from storage.
*
* Note: you must also configure `backend.cache` appropriately as well,
* and to pass a PluginCacheManager instance to TechDocs Backend's
* createRouter method in your backend.
*/
ttl: number;
};
/**
* @example http://localhost:7007/api/techdocs
* @visibility frontend