mirror of
https://github.com/ZTatman/myst.git
synced 2026-11-21 04:17:59 +00:00
fix(forgejo): query commits by sha and normalize Commit payload
Forgejo's commits endpoint filters on `sha`, not `branch`. Sending `?branch=<name>` was silently ignored and the API returned the default branch's commits for every ref, so branch resolution appeared to work while always yielding the same list. Rename the parameter to `ref` (a branch, tag, or sha) and send it as `sha`, documenting that the slot name is Forgejo's choice while the value is a caller-supplied git ref. The flat commits payload is GitHub-shaped (`sha`, `commit.message`, `html_url`, `created`) while the nested branch commit uses `id`, `message`, `url`, and `timestamp`. Give each Commit field an AliasChoices/AliasPath covering both shapes so one model serves the /branches and /commits endpoints, then map commits through it instead of returning raw dicts under a `list[Commit]` annotation. Also annotate get_branches' limit/page to match get_commits.
This commit is contained in:
parent
5f839a47b6
commit
984b382758
1 changed files with 26 additions and 10 deletions
|
|
@ -32,10 +32,27 @@ class Repo(BaseModel):
|
|||
|
||||
|
||||
class Commit(BaseModel):
|
||||
"""A commit, normalized across Forgejo's two payload shapes.
|
||||
|
||||
``/branches`` nests a trimmed commit keyed ``id``/``timestamp``/``url``,
|
||||
while ``/commits`` returns a flat GitHub-style object keyed
|
||||
``sha``/``commit.message``/``html_url``/``created``. Each field therefore
|
||||
accepts either shape.
|
||||
"""
|
||||
|
||||
id: str = Field(validation_alias=AliasChoices("sha", "id"))
|
||||
message: str
|
||||
url: str
|
||||
created_at: datetime = Field(validation_alias="timestamp")
|
||||
message: str = Field(
|
||||
validation_alias=AliasChoices("message", AliasPath("commit", "message"))
|
||||
)
|
||||
url: str = Field(validation_alias=AliasChoices("html_url", "url"))
|
||||
created_at: datetime = Field(
|
||||
validation_alias=AliasChoices(
|
||||
"timestamp",
|
||||
"created_at",
|
||||
"created",
|
||||
AliasPath("commit", "committer", "date"),
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class Branch(BaseModel):
|
||||
|
|
@ -64,8 +81,8 @@ async def get_branches(
|
|||
owner: str,
|
||||
repo: str,
|
||||
*,
|
||||
limit=10,
|
||||
page=1,
|
||||
limit: int = 10,
|
||||
page: int = 1,
|
||||
) -> list[Branch]:
|
||||
"""Get the branches of a repository from the Forgejo API.
|
||||
Args:
|
||||
|
|
@ -94,7 +111,7 @@ async def get_commits(
|
|||
owner: str,
|
||||
repo: str,
|
||||
*,
|
||||
branch: str,
|
||||
ref: str,
|
||||
limit: int = 10,
|
||||
page: int = 1,
|
||||
) -> list[Commit]:
|
||||
|
|
@ -104,7 +121,7 @@ async def get_commits(
|
|||
access_token: The Forgejo API token.
|
||||
owner: The owner of the repository.
|
||||
repo: The name of the repository.
|
||||
branch: The branch to list commits for.
|
||||
ref: The branch name, commit sha, or tag to list commits for.
|
||||
limit: The maximum number of commits to return.
|
||||
page: The page number to return.
|
||||
|
||||
|
|
@ -113,13 +130,12 @@ async def get_commits(
|
|||
"""
|
||||
commits = await get(
|
||||
app_settings,
|
||||
f"/api/v1/repos/{owner}/{repo}/commits?branch={branch}&limit={limit}&page={page}",
|
||||
f"/api/v1/repos/{owner}/{repo}/commits?sha={ref}&limit={limit}&page={page}",
|
||||
access_token,
|
||||
)
|
||||
if not commits:
|
||||
return []
|
||||
return commits
|
||||
# return [Commit.model_validate(c) for c in commits]
|
||||
return [Commit.model_validate(c) for c in commits]
|
||||
|
||||
|
||||
async def post(app_settings: AppSettings, path: str, data: dict) -> dict:
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue