Add suggested OpenAPI schemas (#3411)

EnricoMi · web-flow · commit a0a9f017268c · 2025-11-14T21:33:29.000+01:00
Adds OpenAPI schemas after fixing API call paths in #3410.
diff --git a/github/AuthenticatedUser.py b/github/AuthenticatedUser.py
@@ -149,6 +149,12 @@ class AuthenticatedUser(CompletableGithubObject):
     This class represents AuthenticatedUsers as returned by https://docs.github.com/en/rest/reference/users#get-the-authenticated-user
 
     An AuthenticatedUser object can be created by calling ``get_user()`` on a Github object.
+
+    The OpenAPI schema can be found at
+
+    - /components/schemas/private-user
+    - /components/schemas/public-user
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/CodeScanAlert.py b/github/CodeScanAlert.py
@@ -48,6 +48,10 @@ class CodeScanAlert(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/code-scanning.
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/code-scanning-alert-items
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/CodeScanRule.py b/github/CodeScanRule.py
@@ -53,6 +53,10 @@ class CodeScanRule(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/code-scanning.
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/code-scanning-alert-rule-summary
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/CodeScanTool.py b/github/CodeScanTool.py
@@ -52,6 +52,10 @@ class CodeScanTool(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/code-scanning.
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/code-scanning-analysis-tool
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/CommitCombinedStatus.py b/github/CommitCombinedStatus.py
@@ -55,6 +55,10 @@ class CommitCombinedStatus(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/repos#statuses
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/combined-commit-status
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/CommitComment.py b/github/CommitComment.py
@@ -209,7 +209,7 @@ def create_reaction(self, reaction_type: str) -> Reaction:
             input=post_parameters,
             headers={"Accept": Consts.mediaTypeReactionsPreview},
         )
-        return github.Reaction.Reaction(self._requester, headers, data, completed=True)
+        return github.Reaction.Reaction(self._requester, headers, data)
 
     def delete_reaction(self, reaction_id: int) -> bool:
         """
diff --git a/github/CommitStatus.py b/github/CommitStatus.py
@@ -59,6 +59,7 @@ class CommitStatus(NonCompletableGithubObject):
 
     The OpenAPI schema can be found at
 
+    - /components/schemas/simple-commit-status
     - /components/schemas/status
 
     """
diff --git a/github/Comparison.py b/github/Comparison.py
@@ -48,6 +48,11 @@
 class Comparison(CompletableGithubObject):
     """
     This class represents Comparisons.
+
+    The OpenAPI schema can be found at
+
+    - /components/schemas/commit-comparison
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/Environment.py b/github/Environment.py
@@ -68,6 +68,10 @@ class Environment(CompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/deployments#environments
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/environment
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/EnvironmentDeploymentBranchPolicy.py b/github/EnvironmentDeploymentBranchPolicy.py
@@ -40,6 +40,10 @@ class EnvironmentDeploymentBranchPolicy(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/deployments#environments
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/deployment-branch-policy-settings
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/GitBlob.py b/github/GitBlob.py
@@ -53,6 +53,7 @@ class GitBlob(CompletableGithubObject):
 
     The OpenAPI schema can be found at
 
+    - /components/schemas/blob
     - /components/schemas/short-blob
 
     """
diff --git a/github/Hook.py b/github/Hook.py
@@ -60,6 +60,7 @@ class Hook(CompletableGithubObject):
     The OpenAPI schema can be found at
 
     - /components/schemas/hook
+    - /components/schemas/org-hook
 
     """
 
diff --git a/github/Issue.py b/github/Issue.py
@@ -668,7 +668,7 @@ def create_reaction(self, reaction_type: str) -> Reaction:
             input=post_parameters,
             headers={"Accept": Consts.mediaTypeReactionsPreview},
         )
-        return github.Reaction.Reaction(self._requester, headers, data, completed=True)
+        return github.Reaction.Reaction(self._requester, headers, data)
 
     def delete_reaction(self, reaction_id: int) -> bool:
         """
diff --git a/github/IssueComment.py b/github/IssueComment.py
@@ -212,7 +212,7 @@ def create_reaction(self, reaction_type: str) -> Reaction:
             input=post_parameters,
             headers={"Accept": Consts.mediaTypeReactionsPreview},
         )
-        return github.Reaction.Reaction(self._requester, headers, data, completed=True)
+        return github.Reaction.Reaction(self._requester, headers, data)
 
     def delete_reaction(self, reaction_id: int) -> bool:
         """
diff --git a/github/Membership.py b/github/Membership.py
@@ -65,6 +65,7 @@ class Membership(CompletableGithubObject):
     The OpenAPI schema can be found at
 
     - /components/schemas/org-membership
+    - /components/schemas/team-membership
 
     """
 
diff --git a/github/NamedUser.py b/github/NamedUser.py
@@ -96,6 +96,7 @@ class NamedUser(github.GithubObject.CompletableGithubObject):
     - /components/schemas/collaborator
     - /components/schemas/contributor
     - /components/schemas/nullable-simple-user
+    - /components/schemas/private-user
     - /components/schemas/public-user
     - /components/schemas/simple-user
 
diff --git a/github/OrganizationCustomProperty.py b/github/OrganizationCustomProperty.py
@@ -160,6 +160,10 @@ class RepositoryCustomPropertyValues(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/org-repo-custom-property-values
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/OrganizationSecret.py b/github/OrganizationSecret.py
@@ -43,6 +43,10 @@ class OrganizationSecret(Secret):
     The reference can be found here
     https://docs.github.com/en/rest/actions/secrets
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/organization-actions-secret
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/OrganizationVariable.py b/github/OrganizationVariable.py
@@ -42,6 +42,10 @@ class OrganizationVariable(Variable):
     The reference can be found here
     https://docs.github.com/en/rest/actions/variables
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/organization-actions-variable
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/Permissions.py b/github/Permissions.py
@@ -56,6 +56,7 @@ class Permissions(NonCompletableGithubObject):
     - /components/schemas/nullable-repository/properties/permissions
     - /components/schemas/repo-search-result-item/properties/permissions
     - /components/schemas/repository/properties/permissions
+    - /components/schemas/team-repository/properties/permissions
     - /components/schemas/team/properties/permissions
 
     """
diff --git a/github/Plan.py b/github/Plan.py
@@ -51,6 +51,7 @@ class Plan(NonCompletableGithubObject):
     The OpenAPI schema can be found at
 
     - /components/schemas/organization-full/properties/plan
+    - /components/schemas/private-user/properties/plan
     - /components/schemas/public-user/properties/plan
     - /components/schemas/team-organization/properties/plan
 
diff --git a/github/PullRequestComment.py b/github/PullRequestComment.py
@@ -53,6 +53,7 @@
 
 import github.GithubObject
 import github.NamedUser
+import github.Organization
 import github.Reaction
 from github import Consts
 from github.GithubObject import Attribute, CompletableGithubObject, NotSet
@@ -69,6 +70,7 @@ class PullRequestComment(CompletableGithubObject):
     The OpenAPI schema can be found at
 
     - /components/schemas/pull-request-review-comment
+    - /components/schemas/review-comment
 
     """
 
@@ -302,7 +304,7 @@ def create_reaction(self, reaction_type: str) -> github.Reaction.Reaction:
             input=post_parameters,
             headers={"Accept": Consts.mediaTypeReactionsPreview},
         )
-        return github.Reaction.Reaction(self._requester, headers, data, completed=True)
+        return github.Reaction.Reaction(self._requester, headers, data)
 
     def delete_reaction(self, reaction_id: int) -> bool:
         """
diff --git a/github/PullRequestMergeStatus.py b/github/PullRequestMergeStatus.py
@@ -53,6 +53,10 @@ class PullRequestMergeStatus(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/pulls#check-if-a-pull-request-has-been-merged
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/pull-request-merge-result
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/PullRequestReview.py b/github/PullRequestReview.py
@@ -60,6 +60,10 @@ class PullRequestReview(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/pulls#reviews
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/pull-request-review
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/Reaction.py b/github/Reaction.py
@@ -44,22 +44,25 @@
 from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
+import github.Consts
 import github.NamedUser
-from github.GithubObject import Attribute, CompletableGithubObject, NotSet
-
-from . import Consts
+from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
 
 if TYPE_CHECKING:
     from github.NamedUser import NamedUser
 
 
-class Reaction(CompletableGithubObject):
+class Reaction(NonCompletableGithubObject):
     """
     This class represents Reactions.
 
     The reference can be found here
     https://docs.github.com/en/rest/reference/reactions
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/reaction
+
     """
 
     def _initAttributes(self) -> None:
@@ -73,22 +76,18 @@ def __repr__(self) -> str:
 
     @property
     def content(self) -> str:
-        self._completeIfNotSet(self._content)
         return self._content.value
 
     @property
     def created_at(self) -> datetime:
-        self._completeIfNotSet(self._created_at)
         return self._created_at.value
 
     @property
     def id(self) -> int:
-        self._completeIfNotSet(self._id)
         return self._id.value
 
     @property
     def user(self) -> NamedUser:
-        self._completeIfNotSet(self._user)
         return self._user.value
 
     def delete(self) -> None:
@@ -99,7 +98,7 @@ def delete(self) -> None:
         self._requester.requestJsonAndCheck(
             "DELETE",
             f"{self._parentUrl('')}/reactions/{self.id}",
-            headers={"Accept": Consts.mediaTypeReactionsPreview},
+            headers={"Accept": github.Consts.mediaTypeReactionsPreview},
         )
 
     def _useAttributes(self, attributes: dict[str, Any]) -> None:
diff --git a/github/Team.py b/github/Team.py
@@ -79,7 +79,7 @@
 import github.TeamDiscussion
 from github import Consts
 from github.GithubException import UnknownObjectException
-from github.GithubObject import Attribute, CompletableGithubObject, NotSet, Opt
+from github.GithubObject import Attribute, CompletableGithubObject, NotSet, Opt, method_returns
 
 if TYPE_CHECKING:
     from github.Membership import Membership
@@ -311,6 +311,7 @@ def add_to_repos(self, repo: str | Repository) -> None:
             "PUT", f"{self.url}/repos/{github.Repository.Repository.as_url_param(repo)}"
         )
 
+    @method_returns(schema_property="permissions")
     def get_repo_permission(self, repo: str | Repository) -> Permissions | None:
         """
         :calls: `GET /teams/{team_id}/repos/{owner}/{repo} <https://docs.github.com/en/rest/reference/teams>`_
diff --git a/github/TeamDiscussion.py b/github/TeamDiscussion.py
@@ -57,6 +57,10 @@ class TeamDiscussion(DiscussionBase):
     The reference can be found here
     https://docs.github.com/en/rest/reference/teams#discussions
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/team-discussion
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/TimelineEvent.py b/github/TimelineEvent.py
@@ -60,6 +60,10 @@ class TimelineEvent(NonCompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/reference/issues#timeline
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/timeline-issue-events
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/github/UserKey.py b/github/UserKey.py
@@ -57,6 +57,7 @@ class UserKey(CompletableGithubObject):
     The OpenAPI schema can be found at
 
     - /components/schemas/key
+    - /components/schemas/key-simple
 
     """
 
diff --git a/github/Variable.py b/github/Variable.py
@@ -40,6 +40,10 @@ class Variable(CompletableGithubObject):
     The reference can be found here
     https://docs.github.com/en/rest/actions/variables
 
+    The OpenAPI schema can be found at
+
+    - /components/schemas/actions-variable
+
     """
 
     def _initAttributes(self) -> None:
diff --git a/tests/Reaction.py b/tests/Reaction.py
@@ -44,16 +44,17 @@ def setUp(self):
         self.reactions = self.g.get_user("PyGithub").get_repo("PyGithub").get_issue(28).get_reactions()
 
     def testAttributes(self):
-        self.assertEqual(self.reactions[0].content, "+1")
+        reaction = self.reactions[0]
+        self.assertEqual(reaction.content, "+1")
         self.assertEqual(
-            self.reactions[0].created_at,
+            reaction.created_at,
             datetime(2017, 12, 5, 1, 59, 33, tzinfo=timezone.utc),
         )
-        self.assertEqual(self.reactions[0].id, 16916340)
-        self.assertEqual(self.reactions[0].user.login, "nicolastrres")
+        self.assertEqual(reaction.id, 16916340)
+        self.assertEqual(reaction.user.login, "nicolastrres")
 
         self.assertEqual(
-            self.reactions[0].__repr__(),
+            reaction.__repr__(),
             'Reaction(user=NamedUser(login="nicolastrres"), id=16916340)',
         )
 

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ def create_reaction(self, reaction_type: str) -> Reaction:`
`209`	`209`	`input=post_parameters,`
`210`	`210`	`headers={"Accept": Consts.mediaTypeReactionsPreview},`
`211`	`211`	`)`
`212`		`- return github.Reaction.Reaction(self._requester, headers, data, completed=True)`
	`212`	`+ return github.Reaction.Reaction(self._requester, headers, data)`
`213`	`213`
`214`	`214`	`def delete_reaction(self, reaction_id: int) -> bool:`
`215`	`215`	`"""`