Submission Metadata format has diverged from documented

[tsachleben]

Describe the bug Submission Metadata documentation page does not match real format of submission_metadata. Of particular note, the object .assignment.outline (type=list) is not present in the documentation.

To Reproduce Create and submit a programming assignment with an autograder via the Gradescope webpage.

Expected behavior Submission Metadata matches format in submission_metadata.md

Actual behavior

$ jq . submission_metadata.json 
{
  "id": 87184652,
  "users": [
    {
      "id": 233634,
      "email": "[email protected]",
      "name": "Tariq Sachleben",
      "sid": null,
      "assignment": {
        "release_date": "2021-09-10T18:00:00.000000-07:00",
        "due_date": "2021-09-14T18:00:00.000000-07:00",
        "late_due_date": "2021-12-17T20:00:00.000000-08:00"
      }
    }
  ],
  "created_at": "2021-09-10T18:25:53.109082-07:00",
  "assignment_id": null,
  "assignment": {
    "id": 1482034,
    "title": "Project 1 Test",
    "release_date": "2021-09-10T18:00:00.000000-07:00",
    "due_date": "2021-09-14T18:00:00.000000-07:00",
    "total_points": "100.0",
    "course_id": 267363,
    "group_submission": false,
    "group_size": null,
    "late_due_date": "2021-12-17T20:00:00.000000-08:00",
    "outline": [  
      {
        "id": 11489099,
        "type": "ProgrammingQuestion",
        "title": "Autograder",
        "parent_id": null,
        "weight": "0.0",
        "content": [],
        "crop_rect_list": [],
        "index": 1
      },
      {
        "id": 11489101,
        "type": "FreeResponseQuestion",
        "title": "Manual Grading",
        "parent_id": null,
        "weight": "100.0",
        "content": [],
        "crop_rect_list": [],
        "index": 2
      }
    ]
  },
  "submission_method": "upload",
  "previous_submissions": [
    {
      "submission_time": "2021-09-10T18:20:07.128128-07:00",
      "score": "0.0",
      "results": {
        "output": "The autograder failed to execute correctly. Contact your course staff for help in debugging this issue. Make sure to include a link to this page so that they can help you most effectively."
      }
    }
  ]
}

[ibrahima]

Hi Tariq, thanks for pointing this out! It looks like we actually added this several years ago. I've made a ntoe that we should update the documentation to address this. Thanks!