Skip to content

API docs fixes (competition creation status)

Placeholder Eric Carmichael requested to merge 482-api-docs-fixes into develop

@ mention of reviewers`

@dde6khkg @Logan-Ruf`

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

Previously the api docs had too many unorganized endpoints. I'd like to consolidate at least a couple endpoints in this PR:

Old

image

Newer

image

Issues this PR resolves

#482 (closed)

A checklist for hand testing

  • api docs shows resources nicely

TODO

  • Competition creation status -> competitions/creation_status/
  • Front page competitions -> competitions/front_page/
  • my profile -> users/me/ or something similar will tackle this later, maybe if we end up implementing djoser or something
  • upload_submission_scores ??? may take a bit to refactor this, sticking with the other 3 for this small pr
  • datasets/create_dump -> competitions/create_dump
  • can_make_submission also moving to later refactor

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

Loading