Skip to content

Refactored grading annotation routes to respond with JSON - #8127

Open
david-yz-liu wants to merge 1 commit into
masterfrom
refactor-annotation-responses
Open

Refactored grading annotation routes to respond with JSON#8127
david-yz-liu wants to merge 1 commit into
masterfrom
refactor-annotation-responses

Conversation

@david-yz-liu

Copy link
Copy Markdown
Collaborator

Proposed Changes

(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)

This PR refactors four AnnotationsController methods (add_existing_annotation, create, destroy, update) to respond with JSOn rather than Javascript. This allows the Result component to handle its own updates rather than relying on executing the Javascript response.

Screenshots of your changes (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality) X
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
📖 Documentation update (change that updates documentation)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@coveralls

coveralls commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 31494452996

Coverage increased (+0.007%) to 90.632%

Details

  • Coverage increased (+0.007%) from the base build.
  • Patch coverage: 41 of 41 lines across 3 files are fully covered (100%).
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 51776
Covered Lines: 47944
Line Coverage: 92.6%
Relevant Branches: 2491
Covered Branches: 1239
Branch Coverage: 49.74%
Branches in Coverage %: Yes
Coverage Strength: 129.71 hits per line

💛 - Coveralls

@david-yz-liu
david-yz-liu force-pushed the refactor-annotation-responses branch from ceed5ce to 201bd4b Compare August 10, 2026 01:42
@david-yz-liu
david-yz-liu force-pushed the refactor-annotation-responses branch from 201bd4b to 2d8d63b Compare August 11, 2026 13:06
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