Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#13 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
python
領域
api

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
Python
スター
0
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nyjc-computing/campus-api-python のほかの issue

nyjc-computing/campus-api-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。