Skip to content

Commit

Permalink
docs(configuration): add APIS_FORMER_BASE_URIS setting
Browse files Browse the repository at this point in the history
  • Loading branch information
gythaogg committed Jan 7, 2025
1 parent 6f28df6 commit 34c5d9c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ comes from the ``APIS_BASE_URI`` setting. The second part comes from the reverse
route of ``GetEntityGenericRoot`` if that exists. If not, it uses the
the reverse route of ``apis_core:GetEntityGeneric``, which is defined in
:py:mod:`apis_core.urls` and defaults to ``/entity/{pk}``.
If the value of ``APIS_BASE_URL`` changes and urls containing the former ``APIS_BASE_URL`` remain in the database, then the old ``APIS_BASE_URL`` value must added to the setting ``APIS_FORMER_BASE_URIS``.
``APIS_FORMER_BASE_URIS`` is a list that contains base urls that were once used in this APIS instance.

Django Settings
---------------
Expand Down

0 comments on commit 34c5d9c

Please sign in to comment.