Extract exercise settings to own object for json output. Consider also change for db schema.

Open
#205 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
28/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
api, database

Research direction

Start with the course exercise JSON endpoint in the issue and compare its current response with the proposed settings object. Then trace where exercise settings and the database schema are defined. Done means the API shape is agreed and implemented, with any required schema change covered.

Written by the indexing model from the issue text.

Description

easy enhancement lowprio

The Exercise-objects embedded in the Courses-objects provided by http://tmc.mooc.fi/hy/courses/37.json?api_version=7 are getting pretty large. Would it be possible to embed a further object of some kind in them to hold all these settings? I'm thinking something like this to provide more structure:

{
    "id": 2968,
    "name": "WK1-W1E00.Hiekkalaatikko",
    "locked": false,
    "deadline_description": "2014-09-14 18:00:00 +0300",
    "deadline": "2014-09-14T18:00:00+03:00",
    "checksum": "cd5e2e409e605b535d7eea2bd72231b8",
    "return_url": "http://tmc.mooc.fi/hy/exercises/2968/submissions.json",
    "zip_url": "http://tmc.mooc.fi/hy/exercises/2968.zip",
    "returnable": true,
    "requires_review": false,
    "attempted": false,
    "completed": false,
    "reviewed": false,
    "all_review_points_given": true,
    "settings": {
        "allow_code_reviews": true,
        "allow_feedback": true,
        "allow_return_expired": false,
        "memory_limit": null,
        "runtime_params": [],
        "valgrind_strategy": "fail"
    },
    "solution_zip_url": "http://tmc.mooc.fi/hy/exercises/2968/solution.zip",
    "exercise_submissions_url": "http://tmc.mooc.fi/hy/exercises/2968.json?api_version=7"
}

Thanks to @ljleppan for the idea!

Dominant language
Ruby
Stars
51
Forks
42
Avg merge
1h 27m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from testmycode/tmc-server

All issues in testmycode/tmc-server

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.