Add the capability to define custom formatting functions for API output #3515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The default output formats of the Nominatim server API only expose a subset of the data that Nominatim has available for a result. Sometimes it can be useful to expose additional information (e.g as requested in #1699) or to do something special with the address information (e.g. localise it per country #213 or #2522). This change allows to install custom formatting functions for an instance in the project directory.
Please see the included documentation for details and refer to the code in
src/nominatim_api/v1/format.pyfor examples on how to write formatting functions.