From 7929c4ffae6bb3d0d9662a7d06b2e50e7bafdcb6 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 11 Sep 2023 10:02:28 -0400 Subject: [PATCH] remove embargo example, no longer used in #9881 --- doc/sphinx-guides/source/developers/api-design.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/doc/sphinx-guides/source/developers/api-design.rst b/doc/sphinx-guides/source/developers/api-design.rst index e485236223e..d7a14716c4d 100755 --- a/doc/sphinx-guides/source/developers/api-design.rst +++ b/doc/sphinx-guides/source/developers/api-design.rst @@ -45,14 +45,6 @@ Settings need to be exposed outside to API clients outside of ``/api/admin`` (wh - Final path example: ``/api/info/zipDownloadLimit`` -- If you are exposing logic based on a database setting rather that the setting itself (e.g. a boolean for if embargo is enabled rather than the value of ``:MaxEmbargoDurationInMonths``): - - - Use ``/api/info`` as the root path. - - - Append a meaningful name for the setting (e.g. ``embargoEnabled``). - - - Final path example: ``/api/info/embargoEnabled`` - - If the database setting you're exposing make more sense outside of ``/api/info`` because there's more context (e.g. ``:CustomDatasetSummaryFields``): - Feel free to use a path outside of ``/api/info`` as the root path.