[FEATURE] Add Support for Including GitHub Issue Comments in Get Resource JSON File #4
Description
It would be a significant improvement to include all comments from a GitHub Issue in the context of the Get Resource JSON file. This feature would provide a more comprehensive view of the issue's discussion and context, making it easier to understand the full scope of the issue without needing to navigate back to GitHub.
Benefits:
- Including comments in the JSON file would streamline workflows by centralizing all relevant information.
- It would significantly accelerate development by reducing the need to cross-reference discussions on GitHub, saving time and improving efficiency.
- Developers could access critical context directly within the Get Resource JSON, enhancing productivity and reducing potential oversights.
Proposed Implementation:
- Extend the Get Resource JSON schema to include a
commentsfield that contains an array of issue comments (e.g., comment ID, author, timestamp, and body). - Ensure compatibility with existing APIs and tools that rely on the Get Resource JSON format.
- Optionally, add a parameter to toggle whether comments are included to avoid unnecessary data in cases where comments are not needed but for most Use Cases all comments would be so great!
Example JSON Structure:
{
"issue": {
"id": 12345,
"title": "Sample Issue",
"body": "Description of the issue",
"comments": [
{
"id": 1,
"author": "user1",
"created_at": "2025-06-30T10:00:00Z",
"body": "This is a comment."
},
{
"id": 2,
"author": "user2",
"created_at": "2025-06-30T10:05:00Z",
"body": "Another comment."
}
]
}
}