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

Update the grader protocol documentation GRADERS.md #1257

Open
markkuriekkinen opened this issue Sep 6, 2023 · 0 comments
Open

Update the grader protocol documentation GRADERS.md #1257

markkuriekkinen opened this issue Sep 6, 2023 · 0 comments
Labels
area: grading interface Stuff between A+ and grading tools effort: hours Estimated to take less than one day, from the creation of a new branch to the merging experience: moderate required knowledge estimate type: documentation Documentation needs to be created or maintained

Comments

@markkuriekkinen
Copy link
Contributor

GRADERS.md is a bit outdated.

  • Not all HTTP GET query parameters are listed there
    • Relevant code that sets parameters:
      def _build_service_url(self, language, students, ordinal_number, url_name, submission_url, lti_launch_id=None):
      """
      Generates complete URL with added parameters to the exercise service.
      """
      uid_str = '-'.join(sorted(str(profile.user.id) for profile in students)) if students else ''
      params = {
      "max_points": self.max_points,
      "max_submissions": self.max_submissions,
      "submission_url": build_aplus_url(submission_url),
      "post_url": build_aplus_url(str(self.get_url(url_name)), user_url=True),
      "uid": uid_str,
      "ordinal_number": ordinal_number,
      "lang": language,
      }
      if lti_launch_id:
      params["lti_launch_id"] = lti_launch_id
      return update_url_params(self.get_service_url(language), params)
  • ExerciseWithAttachment is deprecated and nobody is supposed to use it.

In addition, there are these documents:

They include some details that have never been implemented so that can lead to confusion. At any rate, take a look and compare if there are significant differences and something clearly outdated.

@markkuriekkinen markkuriekkinen added area: grading interface Stuff between A+ and grading tools effort: hours Estimated to take less than one day, from the creation of a new branch to the merging type: documentation Documentation needs to be created or maintained experience: moderate required knowledge estimate labels Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: grading interface Stuff between A+ and grading tools effort: hours Estimated to take less than one day, from the creation of a new branch to the merging experience: moderate required knowledge estimate type: documentation Documentation needs to be created or maintained
Projects
Status: Todo
Development

No branches or pull requests

1 participant