Skip to content

486 Leaderboard as CSV, JSON, ZIP

Placeholder Christopher "Logan" Ruf requested to merge 486-leaderboard-as-datatypes into develop

Template

This is a template. While not all sections are necessary, depending on the size and complexity of the PR, more information is better.

@ mention of reviewers`

@dde6khkg @ckcollab`

A brief description of the purpose of the changes contained in this PR.

Added api calls to get leaderboard objects in different datatypes. A single leaderboard can be called as a JSON or CSV file. All competitions on a leaderboard can be called as a JSON or multi CSV files in a ZIP archive.

Issues this PR resolves

#486 (closed)

A checklist for hand testing

Results Tab Buttons

Simple Competition

  • "All CSV"
  • "All JSON"
  • "This CSV"
  • "This JSON"

Competition with multiple tasks on different leaderboards

  • "All CSV"
  • "All JSON"
  • "This CSV"
  • "This JSON"

Competition with multiple tasks on the same leaderboard

  • "All CSV"
  • "All JSON"
  • "This CSV"
  • "This JSON"

Api calls

  • hostname/api/competitions/PK/results.json
  • hostname/api/competitions/PK/results.json?id=[Leaderboard ID]
  • hostname/api/competitions/PK/results.json?title=[String in Leaderboard Title]
  • hostname/api/competitions/PK/results.csv?id=[Leaderboard ID]
  • hostname/api/competitions/PK/results.csv?title=[Unique String in Leaderboard Title]
  • hostname/api/competitions/PK/results.zip

Misc. comments

...

Checklist

  • Code review by me
  • Hand tested by me
  • I'm proud of my work
  • Code review by reviewer
  • Hand tested by reviewer
  • Ready to merge

Merge request reports