Route trailing slash compliance: Add trailing slashes to subresource ID paths

Aperta
#13 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
api

Direzione di ricerca

Start with the listed entry points in campus_python/api/v1/assignments.py, submissions.py, circles.py and campus_python/auth/v1/credentials.py, users.py, and vaults.py. Update the 19 specified path calls, then locate the tests that mock these API requests and update their expected URLs. Done means the affected tests pass and all listed ID-based paths include trailing slashes without changing verb or subresource routes.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Problem

Per campus API conventions, subresource paths with ID parameters should have trailing slashes (e.g., /assignments/{assignment_id}/ instead of /assignments/{assignment_id}). The campus server is being updated to match this convention, and this client library needs to be updated accordingly.

Related issue: nyjc-computing/campus#407

API Methods to Fix

The following client methods call API endpoints that need trailing slashes added. This requires updating the make_path() calls to pass end_slash=True.

campus_python/api/v1/assignments.py

Assignments.Assignment class:

  • get() - Line 73-76
    • Current: self.client.get(self.make_path())
    • Fix: self.client.get(self.make_path(end_slash=True))
  • delete() - Line 68-71
    • Current: self.client.delete(self.make_path())
    • Fix: self.client.delete(self.make_path(end_slash=True))
  • update() - Line 78-81
    • Current: self.client.patch(self.make_path(), json=updates)
    • Fix: self.client.patch(self.make_path(end_slash=True), json=updates)
campus_python/api/v1/submissions.py

Submissions.Submission class:

  • get() - Line 137-141
    • Current: self.client.get(self.make_path())
    • Fix: self.client.get(self.make_path(end_slash=True))
  • delete() - Line 131-135
    • Current: self.client.delete(self.make_path())
    • Fix: self.client.delete(self.make_path(end_slash=True))
  • update() - Line 170
    • Current: self.client.patch(self.make_path(), json=payload)
    • Fix: self.client.patch(self.make_path(end_slash=True), json=payload)

Submissions class:

  • by_assignment() - Line 62
    • Current: path = f"{self.make_path()}/by-assignment/{assignment_id}"
    • Fix: path = f"{self.make_path()}/by-assignment/{assignment_id}/"
  • by_student() - Line 79
    • Current: path = f"{self.make_path()}/by-student/{student_id}"
    • Fix: path = f"{self.make_path()}/by-student/{student_id}/"
campus_python/api/v1/circles.py

Circles.Circle class:

  • get() - Line 56-59
    • Current: self.client.get(self.make_path())
    • Fix: self.client.get(self.make_path(end_slash=True))
  • delete() - Line 51-54
    • Current: self.client.delete(self.make_path())
    • Fix: self.client.delete(self.make_path(end_slash=True))
  • update() - Line 61-64
    • Current: self.client.patch(self.make_path(), json=updates)
    • Fix: self.client.patch(self.make_path(end_slash=True), json=updates)
campus_python/auth/v1/credentials.py

Credentials.Provider.User class:

  • delete() - Line 61-68
    • Current: self.client.delete(self.make_path(), json={"client_id": client_id})
    • Fix: self.client.delete(self.make_path(end_slash=True), json={"client_id": client_id})
  • get() - Line 70-78
    • Current: self.client.get(self.make_path(), query={"client_id": client_id})
    • Fix: self.client.get(self.make_path(end_slash=True), query={"client_id": client_id})
  • update() - Line 95
    • Current: self.client.patch(self.make_path(), json=json_data)
    • Fix: self.client.patch(self.make_path(end_slash=True), json=json_data)
campus_python/auth/v1/users.py

Users.User class:

  • delete() - Line 48-50
    • Current: self.client.delete(self.make_path())
    • Fix: self.client.delete(self.make_path(end_slash=True))
  • get() - Line 52-55
    • Current: self.client.get(self.make_path())
    • Fix: self.client.get(self.make_path(end_slash=True))
campus_python/auth/v1/vaults.py

Vaults.Vault class (methods use make_path(key)):

  • __delitem__() - Line 33
    • Current: self.client.delete(self.make_path(key))
    • Fix: self.client.delete(self.make_path(key, end_slash=True))
  • __getitem__() - Line 40
    • Current: self.client.get(self.make_path(key))
    • Fix: self.client.get(self.make_path(key, end_slash=True))
  • __setitem__() - Line 50
    • Current: self.client.post(self.make_path(key), json={"value": value})
    • Fix: self.client.post(self.make_path(key, end_slash=True), json={"value": value})

Tasks

  1. Update all 19 method calls listed above to use end_slash=True
  2. Update any tests that mock these API calls to expect trailing slashes
  3. Verify compatibility with the updated campus server routes

Notes

  • Routes ending in verbs (e.g., /activate, /submit) do NOT need trailing slashes
  • Routes ending in subresource names (e.g., /links, /responses, /metadata) do NOT need trailing slashes
Lingua principale
Python
Stelle
0
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nyjc-computing/campus-api-python

Tutte le issue di nyjc-computing/campus-api-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.