Recipe to export Epic Comments to CSV #66
Merged
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
This also removes the separate file with the list of recipe contents, putting that content directly into the main README for easier discoverability and maintenance of this important listing of contents.
The useshortcut/exporter project exports Epics, but not their comments. The exporter is also just a shell script that calls Shortcut REST API endpoints and saves the JSON to disk, without any further data manipulation. This epic-comments recipe leverages the `List Epic Comments` endpoint in Shortcut's API to fetch the threaded epic comments for an epic (or all epics in the Shortcut Workspace), which returns a nested JSON structure for all the epic's top-level and nested comments. This recipe then flattens the representation, similar to the structure of Shortcut Story Comments. The resulting CSV of epic comments has a `parent_id` column that, when populated, indicates the comment that is the parent of the comment in that row.
semperos
force-pushed
the
daniel/sc-267254/api-cookbook-recipe-to-create-csv-of-epic
branch
from
78347ec
to
d776c31
Compare
iwillig
approved these changes
May 10, 2024
semperos
deleted the
daniel/sc-267254/api-cookbook-recipe-to-create-csv-of-epic
branch
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.
This PR also includes some milestone -> objectives renaming.
A customer wrote in asking how to export Epic comments to CSV. After sketching out the code locally, I felt it was worth adding to the api-cookbook recipes.
This also begins to highlight which Python functions should make there way into a Python Shortcut API client library for (re)use by customers and these recipes.