Skip to content

Commit

Permalink
remove embargo example, no longer used in #9881
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin authored Sep 11, 2023
1 parent 75b6832 commit 7929c4f
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions doc/sphinx-guides/source/developers/api-design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 7929c4f

Please sign in to comment.