Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added max_total_score and max_scores to /assessment_details #2127

Merged
merged 2 commits into from
Mar 25, 2024

Conversation

coder6583
Copy link
Contributor

Description

  • Added max_total_score to /assessment_details
  • Added max_scores to /assessment_details
  • Changed API documentation accordingly

Motivation and Context

Issue #2113.

How Has This Been Tested?

Tested in local environment by accessing http://localhost:3000/api/v1/courses/test_course/assessments/Fizz with access token.
image

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
  • My change requires a change to the documentation, which is located at Autolab Docs
  • I have updated the documentation accordingly, included in this PR

Copy link
Contributor

coderabbitai bot commented Mar 23, 2024

Walkthrough

Walkthrough

The changes involve expanding the AssessmentsController to include max_total_score and max_scores in its show method, which enriches the API response with these new fields. These additions allow users to understand the maximum attainable scores for both the assessment overall and its individual problems, enhancing the API's usability for applications like grading tools or CLI interfaces that require detailed scoring information.

Changes

File Path Change Summary
app/controllers/api/v1/.../assessments_controller.rb Expanded allowed attributes to include :max_total_score and :max_scores; updated result to include these new fields.
docs/api-interface.md Documented the addition of max_total_score (float) and max_scores (object) to the API interface.

Related issues

  • API: Add max_score to /assessment_details #2113: The PR addresses the user's request by adding max_total_score and max_scores to the API, which could be used to determine how well a student did relative to the maximum scores. This directly aligns with the issue's objective of making maximum scores available for assessments and problems.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@coder6583 coder6583 requested review from a team and damianhxy and removed request for a team March 23, 2024 17:56
Copy link
Member

@damianhxy damianhxy left a comment

Choose a reason for hiding this comment

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

LGTM

(I assume you're manually filtering allowed as otherwise the contents of max_scores will be stripped)

Screenshot 2024-03-23 at 15 42 24

@damianhxy damianhxy linked an issue Mar 24, 2024 that may be closed by this pull request
@coder6583 coder6583 added this pull request to the merge queue Mar 25, 2024
Merged via the queue into master with commit 4b093a2 Mar 25, 2024
5 checks passed
@coder6583 coder6583 deleted the somanarita-max-score-assessment branch March 25, 2024 20:49
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.

API: Add max_score to /assessment_details
2 participants