docs: add export templates guide#16
Open
sebdraven wants to merge 1 commit into
Open
Conversation
Documents what an export template can access (the `data` context variable, a list of Observable objects and their common fields), where template files must live (system.template_dir, shared between the api and tasks services), and links to the annotated example templates added to the main repo under extras/templates/. Fixes yeti-platform/yeti#1256
This file contains hidden or 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
1 participant
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.
Summary
system.template_dir), and that both theapiandtasksservices need read access to it (no upload endpoint exists yet)data, a list ofObservableobjects) and its common fieldsrow|tojsonon a whole observable produces malformed JSON in minijinja, with the recommended field-by-field workaroundextras/templates/json_export.jinja2,extras/templates/csv_export.jinja2)Fixes yeti-platform/yeti#1256
Test plan
export-configurationand the main repo resolve correctly