Skip to content

PR 1: feat(explanation): add structured explanation fields - #1712

Open
Vani-soni200 wants to merge 2 commits into
imDarshanGK:mainfrom
Vani-soni200:main
Open

PR 1: feat(explanation): add structured explanation fields#1712
Vani-soni200 wants to merge 2 commits into
imDarshanGK:mainfrom
Vani-soni200:main

Conversation

@Vani-soni200

Copy link
Copy Markdown

Description

This PR enhances the /explanation endpoint by introducing additional structured metadata to make explanations more educational and easier to understand.

Changes

  • Added overview
  • Added purpose
  • Added functions
  • Added constructs
  • Updated the explanation response schema
  • Added tests for the new response fields

Testing

  • Verified functionality through FastAPI Swagger UI.
  • Added automated endpoint tests.
  • Ran the backend test suite successfully.

Kindly, co-ordinate if you find any issues.

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vani-soni200 issue number

@Vani-soni200

Vani-soni200 commented Jul 30, 2026

Copy link
Copy Markdown
Author

@imDarshanGK Sorry for the inconvenience. The issue number is #1707. Being a large issue I have divided this into PRs. This being the first PR.

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vani-soni200 Please avoid creating separate PRs for the same issue. If you want to work on additional or independent changes, create a new issue first, get it approved, and then submit a PR linked to that issue.

Image

@Vani-soni200

Vani-soni200 commented Jul 30, 2026

Copy link
Copy Markdown
Author

@imDarshanGK Ok
I will work on the whole issue now, add the changes to this PR itself, and drop a reminder when done.
I hope that works for you.

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants