Skip to content

Commit a268565

Browse files
authored
Merge pull request #4 from Trenza1ore/feat/refine-method-signature
feat: refine method signature
2 parents 6912c82 + 12d770f commit a268565

5 files changed

Lines changed: 778 additions & 109 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
All notable changes to this project are documented here. Release ranges link to the GitHub compare view. Tag names follow the repository (`v1.0.x` through `v1.0.3`, then `1.1.0` onward).
44

5+
---
6+
7+
## TODO:
8+
1. `sync_repo` endpoints:
9+
- https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-sync-repo
10+
- https://docs.gitcode.com/en/docs/apis/put-api-v-5-repos-owner-repo-sync-repo
11+
12+
---
13+
514
## [1.3.2](https://github.com/Trenza1ore/GitCode-API/releases/tag/1.3.2) — 2026-06-14
615

716
Changes since `1.3.1`…`1.3.2`.

‎gitcode_api/resources/account/orgs_resource_group.py‎

Lines changed: 178 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,43 @@ def list_repos(
7777
"""
7878

7979
@abstractmethod
80-
def create_repo(self, *, org: str, name: str, **payload) -> Repository:
80+
def create_repo(
81+
self,
82+
*,
83+
org: str,
84+
name: str,
85+
description: Optional[str] = None,
86+
homepage: Optional[str] = None,
87+
has_issues: Optional[bool] = None,
88+
has_wiki: Optional[bool] = None,
89+
can_comment: Optional[bool] = None,
90+
public: Optional[int] = None,
91+
private: Optional[bool] = None,
92+
auto_init: Optional[bool] = None,
93+
gitignore_template: Optional[str] = None,
94+
license_template: Optional[str] = None,
95+
path: Optional[str] = None,
96+
default_branch: Optional[str] = None,
97+
**kwargs,
98+
) -> Repository:
8199
"""Create an organization repository.
82100
83-
Additional payload fields match the organization repository creation
84-
endpoint, such as ``description``, ``homepage``, ``private``,
85-
``public``, ``auto_init``, and ``default_branch``.
86-
87101
:param org: Organization path or login.
88102
:param name: Repository name.
89-
:param payload: Additional repository creation fields.
103+
:param description: Repository description.
104+
:param homepage: Homepage URL.
105+
:param has_issues: Allow issues to be created. Default: ``True``.
106+
:param has_wiki: Provide wiki. Default: ``True``.
107+
:param can_comment: Allow users to comment on repositories. Default: ``True``.
108+
:param public: Open source type: ``0`` (private), ``1`` (external), ``2`` (internal).
109+
Mutually exclusive with *private*.
110+
:param private: Repository visibility. Mutually exclusive with *public*.
111+
:param auto_init: Initialize with a README. Default: ``False``.
112+
:param gitignore_template: ``.gitignore`` template name.
113+
:param license_template: License template name.
114+
:param path: Repository path.
115+
:param default_branch: Default branch name. Default: ``main``.
116+
:param kwargs: Additional arguments forwarded directly in request.
90117
:returns: Created repository metadata.
91118
"""
92119

@@ -184,11 +211,26 @@ def update_enterprise_member(self, *, enterprise: str, username: str, role: str)
184211
"""
185212

186213
@abstractmethod
187-
def update(self, *, org: str, **payload) -> Organization:
214+
def update(
215+
self,
216+
*,
217+
org: str,
218+
name: Optional[str] = None,
219+
email: Optional[str] = None,
220+
location: Optional[str] = None,
221+
description: Optional[str] = None,
222+
html_url: Optional[str] = None,
223+
**kwargs,
224+
) -> Organization:
188225
"""Update organization metadata.
189226
190227
:param org: Organization path or login.
191-
:param payload: Updatable fields such as ``name``, ``email``, or ``description``.
228+
:param name: Organization name.
229+
:param email: Organization email.
230+
:param location: Organization location.
231+
:param description: Organization description.
232+
:param html_url: Organization site URL.
233+
:param kwargs: Additional arguments forwarded directly in request.
192234
:returns: Updated organization details.
193235
"""
194236

@@ -239,9 +281,46 @@ def list_repos(
239281
params={"type": type, "page": page, "per_page": per_page},
240282
)
241283

242-
def create_repo(self, *, org: str, name: str, **payload) -> Repository:
243-
payload["name"] = name
244-
return self._model("POST", self._client._path("orgs", org, "repos"), Repository, json=payload)
284+
def create_repo(
285+
self,
286+
*,
287+
org: str,
288+
name: str,
289+
description: Optional[str] = None,
290+
homepage: Optional[str] = None,
291+
has_issues: Optional[bool] = None,
292+
has_wiki: Optional[bool] = None,
293+
can_comment: Optional[bool] = None,
294+
public: Optional[int] = None,
295+
private: Optional[bool] = None,
296+
auto_init: Optional[bool] = None,
297+
gitignore_template: Optional[str] = None,
298+
license_template: Optional[str] = None,
299+
path: Optional[str] = None,
300+
default_branch: Optional[str] = None,
301+
**kwargs,
302+
) -> Repository:
303+
return self._model(
304+
"POST",
305+
self._client._path("orgs", org, "repos"),
306+
Repository,
307+
json={
308+
"name": name,
309+
"description": description,
310+
"homepage": homepage,
311+
"has_issues": has_issues,
312+
"has_wiki": has_wiki,
313+
"can_comment": can_comment,
314+
"public": public,
315+
"private": private,
316+
"auto_init": auto_init,
317+
"gitignore_template": gitignore_template,
318+
"license_template": license_template,
319+
"path": path,
320+
"default_branch": default_branch,
321+
**kwargs,
322+
},
323+
)
245324

246325
def get_enterprise_member(self, *, enterprise: str, username: str) -> EnterpriseMember:
247326
return self._model("GET", self._client._path("enterprises", enterprise, "members", username), EnterpriseMember)
@@ -302,8 +381,30 @@ def update_enterprise_member(self, *, enterprise: str, username: str, role: str)
302381
json={"role": role},
303382
)
304383

305-
def update(self, *, org: str, **payload) -> Organization:
306-
return self._model("PATCH", self._client._path("orgs", org), Organization, json=payload)
384+
def update(
385+
self,
386+
*,
387+
org: str,
388+
name: Optional[str] = None,
389+
email: Optional[str] = None,
390+
location: Optional[str] = None,
391+
description: Optional[str] = None,
392+
html_url: Optional[str] = None,
393+
**kwargs,
394+
) -> Organization:
395+
return self._model(
396+
"PATCH",
397+
self._client._path("orgs", org),
398+
Organization,
399+
json={
400+
"name": name,
401+
"email": email,
402+
"location": location,
403+
"description": description,
404+
"html_url": html_url,
405+
**kwargs,
406+
},
407+
)
307408

308409
def leave(self, *, org: str) -> None:
309410
self._request("DELETE", self._client._path("user", "memberships", "orgs", org))
@@ -351,9 +452,46 @@ async def list_repos(
351452
params={"type": type, "page": page, "per_page": per_page},
352453
)
353454

354-
async def create_repo(self, *, org: str, name: str, **payload) -> Repository:
355-
payload["name"] = name
356-
return await self._model("POST", self._client._path("orgs", org, "repos"), Repository, json=payload)
455+
async def create_repo(
456+
self,
457+
*,
458+
org: str,
459+
name: str,
460+
description: Optional[str] = None,
461+
homepage: Optional[str] = None,
462+
has_issues: Optional[bool] = None,
463+
has_wiki: Optional[bool] = None,
464+
can_comment: Optional[bool] = None,
465+
public: Optional[int] = None,
466+
private: Optional[bool] = None,
467+
auto_init: Optional[bool] = None,
468+
gitignore_template: Optional[str] = None,
469+
license_template: Optional[str] = None,
470+
path: Optional[str] = None,
471+
default_branch: Optional[str] = None,
472+
**kwargs,
473+
) -> Repository:
474+
return await self._model(
475+
"POST",
476+
self._client._path("orgs", org, "repos"),
477+
Repository,
478+
json={
479+
"name": name,
480+
"description": description,
481+
"homepage": homepage,
482+
"has_issues": has_issues,
483+
"has_wiki": has_wiki,
484+
"can_comment": can_comment,
485+
"public": public,
486+
"private": private,
487+
"auto_init": auto_init,
488+
"gitignore_template": gitignore_template,
489+
"license_template": license_template,
490+
"path": path,
491+
"default_branch": default_branch,
492+
**kwargs,
493+
},
494+
)
357495

358496
async def get_enterprise_member(self, *, enterprise: str, username: str) -> EnterpriseMember:
359497
return await self._model(
@@ -415,8 +553,30 @@ async def update_enterprise_member(self, *, enterprise: str, username: str, role
415553
json={"role": role},
416554
)
417555

418-
async def update(self, *, org: str, **payload) -> Organization:
419-
return await self._model("PATCH", self._client._path("orgs", org), Organization, json=payload)
556+
async def update(
557+
self,
558+
*,
559+
org: str,
560+
name: Optional[str] = None,
561+
email: Optional[str] = None,
562+
location: Optional[str] = None,
563+
description: Optional[str] = None,
564+
html_url: Optional[str] = None,
565+
**kwargs,
566+
) -> Organization:
567+
return await self._model(
568+
"PATCH",
569+
self._client._path("orgs", org),
570+
Organization,
571+
json={
572+
"name": name,
573+
"email": email,
574+
"location": location,
575+
"description": description,
576+
"html_url": html_url,
577+
**kwargs,
578+
},
579+
)
420580

421581
async def leave(self, *, org: str) -> None:
422582
await self._request("DELETE", self._client._path("user", "memberships", "orgs", org))

‎gitcode_api/resources/collaboration/pulls_resource_group.py‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -415,15 +415,21 @@ def list_operation_logs(
415415

416416
@abstractmethod
417417
def request_test(
418-
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None, **payload
418+
self,
419+
*,
420+
number: Union[int, str],
421+
owner: Optional[str] = None,
422+
repo: Optional[str] = None,
423+
force: Optional[bool] = None,
424+
**kwargs,
419425
) -> None:
420426
"""Request testing for a pull request.
421427
422428
:param number: Pull request number.
423429
:param owner: Repository owner path. Uses the client default when omitted.
424430
:param repo: Repository path. Uses the client default when omitted.
425-
:param payload: JSON fields required by the test request endpoint.
426-
:returns: Test request result.
431+
:param force: Force the test to pass (default ``False``), only effective for administrators.
432+
:param kwargs: Additional arguments forwarded directly in request.
427433
"""
428434

429435
@abstractmethod
@@ -919,12 +925,18 @@ def list_operation_logs(
919925
return [as_model(item, PullRequestOperationLog) for item in data]
920926

921927
def request_test(
922-
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None, **payload
928+
self,
929+
*,
930+
number: Union[int, str],
931+
owner: Optional[str] = None,
932+
repo: Optional[str] = None,
933+
force: Optional[bool] = None,
934+
**kwargs,
923935
) -> None:
924936
self._request(
925937
"POST",
926938
self._client._repo_path("pulls", number, "test", owner=owner, repo=repo),
927-
json=payload,
939+
json={"force": force, **kwargs},
928940
)
929941

930942
def update_testers(
@@ -1375,12 +1387,18 @@ async def list_operation_logs(
13751387
return [as_model(item, PullRequestOperationLog) for item in data]
13761388

13771389
async def request_test(
1378-
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None, **payload
1390+
self,
1391+
*,
1392+
number: Union[int, str],
1393+
owner: Optional[str] = None,
1394+
repo: Optional[str] = None,
1395+
force: Optional[bool] = None,
1396+
**kwargs,
13791397
) -> None:
13801398
await self._request(
13811399
"POST",
13821400
self._client._repo_path("pulls", number, "test", owner=owner, repo=repo),
1383-
json=payload,
1401+
json={"force": force, **kwargs},
13841402
)
13851403

13861404
async def update_testers(

0 commit comments

Comments
 (0)