✨ Feature: Add a link to the Github docs for each REST endpoint (#88)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Ju4tCode <[email protected]>
yanyongyu · Jan 22, 2024 · b88bd16 · b88bd16
1 parent 03d0e56
commit b88bd16
Show file tree

Hide file tree

Showing 208 changed files with 6,108 additions and 2,264 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -2,7 +2,7 @@
   "name": "Default Linux Universal",
   "image": "mcr.microsoft.com/devcontainers/universal:2-linux",
   "features": {
-    "ghcr.io/devcontainers-contrib/features/poetry:2": {}
+    "ghcr.io/devcontainers-contrib/features/poetry:2": {},
   },
   "postCreateCommand": "./scripts/setup-envs.sh",
   "customizations": {
@@ -15,34 +15,34 @@
           "editor.defaultFormatter": "ms-python.black-formatter",
           "editor.codeActionsOnSave": {
             "source.fixAll.ruff": true,
-            "source.organizeImports": true
-          }
+            "source.organizeImports": true,
+          },
         },
         "[markdown]": {
-          "editor.defaultFormatter": "esbenp.prettier-vscode"
+          "editor.defaultFormatter": "esbenp.prettier-vscode",
         },
         "[javascript]": {
-          "editor.defaultFormatter": "esbenp.prettier-vscode"
+          "editor.defaultFormatter": "esbenp.prettier-vscode",
         },
         "[html]": {
-          "editor.defaultFormatter": "esbenp.prettier-vscode"
+          "editor.defaultFormatter": "esbenp.prettier-vscode",
         },
         "[typescript]": {
-          "editor.defaultFormatter": "esbenp.prettier-vscode"
+          "editor.defaultFormatter": "esbenp.prettier-vscode",
         },
         "[javascriptreact]": {
-          "editor.defaultFormatter": "esbenp.prettier-vscode"
+          "editor.defaultFormatter": "esbenp.prettier-vscode",
         },
         "[typescriptreact]": {
-          "editor.defaultFormatter": "esbenp.prettier-vscode"
+          "editor.defaultFormatter": "esbenp.prettier-vscode",
         },
         "files.exclude": {
-          "**/__pycache__": true
+          "**/__pycache__": true,
         },
         "files.watcherExclude": {
           "**/target/**": true,
-          "**/__pycache__": true
-        }
+          "**/__pycache__": true,
+        },
       },
       "extensions": [
         "ms-python.python",
@@ -51,8 +51,8 @@
         "ms-python.black-formatter",
         "charliermarsh.ruff",
         "EditorConfig.EditorConfig",
-        "esbenp.prettier-vscode"
-      ]
-    }
-  }
+        "esbenp.prettier-vscode",
+      ],
+    },
+  },
 }
diff --git a/codegen/parser/data.py b/codegen/parser/data.py
@@ -113,6 +113,7 @@ class EndpointData:
     tags: list[str] | None = None
     description: str | None = None
     operation_id: str | None = None
+    external_docs: str | None = None
     deprecated: bool = False
 
     parameters: list[Parameter] = field(default_factory=list)

diff --git a/codegen/parser/endpoints/__init__.py b/codegen/parser/endpoints/__init__.py
@@ -78,6 +78,7 @@ def parse_endpoint(source: "Source", path: str) -> list[EndpointData]:
                 tags=operation.tags,
                 description=operation.description,
                 operation_id=operation.operationId,
+                external_docs=operation.externalDocs and operation.externalDocs.url,
                 deprecated=operation.deprecated,
                 parameters=global_params + op_params,
                 request_body=request_body,

diff --git a/codegen/templates/rest/client.py.jinja b/codegen/templates/rest/client.py.jinja
@@ -93,6 +93,10 @@ class {{ pascal_case(tag) }}Client:
         self,
         {{ endpoint_params(endpoint) | indent(8) }}
     ) -> {{ build_response_type(endpoint.success_response) }}:
+        {% if endpoint.external_docs %}
+        """See also: {{ endpoint.external_docs }}"""
+
+        {% endif %}
         {{ build_request(endpoint) | indent(8) }}
         return self._github.request(
             {{ build_request_params(endpoint) | indent(12) }}
@@ -122,6 +126,10 @@ class {{ pascal_case(tag) }}Client:
         self,
         {{ endpoint_params(endpoint) | indent(8) }}
     ) -> {{ build_response_type(endpoint.success_response) }}:
+        {% if endpoint.external_docs %}
+        """See also: {{ endpoint.external_docs }}"""
+
+        {% endif %}
         {{ build_request(endpoint) | indent(8) }}
         return await self._github.arequest(
             {{ build_request_params(endpoint) | indent(12) }}

diff --git a/githubkit/rest/__init__.py b/githubkit/rest/__init__.py
@@ -149,7 +149,6 @@
     from githubkit.versions.v2022_11_28.models import ContentTraffic as ContentTraffic
     from githubkit.versions.v2022_11_28.models import FullRepository as FullRepository
     from githubkit.versions.v2022_11_28.models import GlobalAdvisory as GlobalAdvisory
-    from githubkit.versions.v2022_11_28.models import HookPropConfig as HookPropConfig
     from githubkit.versions.v2022_11_28.models import LicenseContent as LicenseContent
     from githubkit.versions.v2022_11_28.models import MergedUpstream as MergedUpstream
     from githubkit.versions.v2022_11_28.models import PackageVersion as PackageVersion
@@ -2368,6 +2367,9 @@
     from githubkit.versions.v2022_11_28.models import (
         CodeScanningOrganizationAlertItems as CodeScanningOrganizationAlertItems,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        FullRepositoryPropCustomProperties as FullRepositoryPropCustomProperties,
+    )
     from githubkit.versions.v2022_11_28.models import (
         GistsGistIdGetResponse403PropBlock as GistsGistIdGetResponse403PropBlock,
     )
@@ -3076,6 +3078,9 @@
     from githubkit.versions.v2022_11_28.models import (
         ReposOwnerRepoGitTagsPostBodyPropTagger as ReposOwnerRepoGitTagsPostBodyPropTagger,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        ReposOwnerRepoPropertiesValuesPatchBody as ReposOwnerRepoPropertiesValuesPatchBody,
+    )
     from githubkit.versions.v2022_11_28.models import (
         RepositoryRulePullRequestPropParameters as RepositoryRulePullRequestPropParameters,
     )
@@ -3949,9 +3954,6 @@
     from githubkit.versions.v2022_11_28.models import (
         ReposOwnerRepoActionsWorkflowsGetResponse200 as ReposOwnerRepoActionsWorkflowsGetResponse200,
     )
-    from githubkit.versions.v2022_11_28.models import (
-        ReposOwnerRepoHooksHookIdPatchBodyPropConfig as ReposOwnerRepoHooksHookIdPatchBodyPropConfig,
-    )
     from githubkit.versions.v2022_11_28.models import (
         ReposOwnerRepoImportAuthorsAuthorIdPatchBody as ReposOwnerRepoImportAuthorsAuthorIdPatchBody,
     )
@@ -10706,6 +10708,7 @@
             "CodeOfConductSimple",
             "FullRepository",
             "FullRepositoryPropPermissions",
+            "FullRepositoryPropCustomProperties",
             "RepositoryRulesetBypassActor",
             "RepositoryRulesetConditions",
             "RepositoryRulesetConditionsPropRefName",
@@ -10990,7 +10993,6 @@
             "GitTreePropTreeItems",
             "HookResponse",
             "Hook",
-            "HookPropConfig",
             "Import",
             "ImportPropProjectChoicesItems",
             "PorterAuthor",
@@ -14018,7 +14020,6 @@
             "ReposOwnerRepoHooksPostBody",
             "ReposOwnerRepoHooksPostBodyPropConfig",
             "ReposOwnerRepoHooksHookIdPatchBody",
-            "ReposOwnerRepoHooksHookIdPatchBodyPropConfig",
             "ReposOwnerRepoHooksHookIdConfigPatchBody",
             "ReposOwnerRepoImportPutBody",
             "ReposOwnerRepoImportPatchBody",
@@ -14065,6 +14066,7 @@
             "ReposOwnerRepoPagesPostBodyAnyof1",
             "ReposOwnerRepoPagesDeploymentPostBody",
             "ReposOwnerRepoProjectsPostBody",
+            "ReposOwnerRepoPropertiesValuesPatchBody",
             "ReposOwnerRepoPullsPostBody",
             "ReposOwnerRepoPullsCommentsCommentIdPatchBody",
             "ReposOwnerRepoPullsCommentsCommentIdReactionsPostBody",

diff --git a/githubkit/versions/latest/models.py b/githubkit/versions/latest/models.py
@@ -149,7 +149,6 @@
     from githubkit.versions.v2022_11_28.models import ContentTraffic as ContentTraffic
     from githubkit.versions.v2022_11_28.models import FullRepository as FullRepository
     from githubkit.versions.v2022_11_28.models import GlobalAdvisory as GlobalAdvisory
-    from githubkit.versions.v2022_11_28.models import HookPropConfig as HookPropConfig
     from githubkit.versions.v2022_11_28.models import LicenseContent as LicenseContent
     from githubkit.versions.v2022_11_28.models import MergedUpstream as MergedUpstream
     from githubkit.versions.v2022_11_28.models import PackageVersion as PackageVersion
@@ -2368,6 +2367,9 @@
     from githubkit.versions.v2022_11_28.models import (
         CodeScanningOrganizationAlertItems as CodeScanningOrganizationAlertItems,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        FullRepositoryPropCustomProperties as FullRepositoryPropCustomProperties,
+    )
     from githubkit.versions.v2022_11_28.models import (
         GistsGistIdGetResponse403PropBlock as GistsGistIdGetResponse403PropBlock,
     )
@@ -3076,6 +3078,9 @@
     from githubkit.versions.v2022_11_28.models import (
         ReposOwnerRepoGitTagsPostBodyPropTagger as ReposOwnerRepoGitTagsPostBodyPropTagger,
     )
+    from githubkit.versions.v2022_11_28.models import (
+        ReposOwnerRepoPropertiesValuesPatchBody as ReposOwnerRepoPropertiesValuesPatchBody,
+    )
     from githubkit.versions.v2022_11_28.models import (
         RepositoryRulePullRequestPropParameters as RepositoryRulePullRequestPropParameters,
     )
@@ -3949,9 +3954,6 @@
     from githubkit.versions.v2022_11_28.models import (
         ReposOwnerRepoActionsWorkflowsGetResponse200 as ReposOwnerRepoActionsWorkflowsGetResponse200,
     )
-    from githubkit.versions.v2022_11_28.models import (
-        ReposOwnerRepoHooksHookIdPatchBodyPropConfig as ReposOwnerRepoHooksHookIdPatchBodyPropConfig,
-    )
     from githubkit.versions.v2022_11_28.models import (
         ReposOwnerRepoImportAuthorsAuthorIdPatchBody as ReposOwnerRepoImportAuthorsAuthorIdPatchBody,
     )
@@ -10706,6 +10708,7 @@
             "CodeOfConductSimple",
             "FullRepository",
             "FullRepositoryPropPermissions",
+            "FullRepositoryPropCustomProperties",
             "RepositoryRulesetBypassActor",
             "RepositoryRulesetConditions",
             "RepositoryRulesetConditionsPropRefName",
@@ -10990,7 +10993,6 @@
             "GitTreePropTreeItems",
             "HookResponse",
             "Hook",
-            "HookPropConfig",
             "Import",
             "ImportPropProjectChoicesItems",
             "PorterAuthor",
@@ -14018,7 +14020,6 @@
             "ReposOwnerRepoHooksPostBody",
             "ReposOwnerRepoHooksPostBodyPropConfig",
             "ReposOwnerRepoHooksHookIdPatchBody",
-            "ReposOwnerRepoHooksHookIdPatchBodyPropConfig",
             "ReposOwnerRepoHooksHookIdConfigPatchBody",
             "ReposOwnerRepoImportPutBody",
             "ReposOwnerRepoImportPatchBody",
@@ -14065,6 +14066,7 @@
             "ReposOwnerRepoPagesPostBodyAnyof1",
             "ReposOwnerRepoPagesDeploymentPostBody",
             "ReposOwnerRepoProjectsPostBody",
+            "ReposOwnerRepoPropertiesValuesPatchBody",
             "ReposOwnerRepoPullsPostBody",
             "ReposOwnerRepoPullsCommentsCommentIdPatchBody",
             "ReposOwnerRepoPullsCommentsCommentIdReactionsPostBody",

diff --git a/githubkit/versions/latest/types.py b/githubkit/versions/latest/types.py
@@ -233,9 +233,6 @@
     from githubkit.versions.v2022_11_28.types import (
         GlobalAdvisoryType as GlobalAdvisoryType,
     )
-    from githubkit.versions.v2022_11_28.types import (
-        HookPropConfigType as HookPropConfigType,
-    )
     from githubkit.versions.v2022_11_28.types import (
         LicenseContentType as LicenseContentType,
     )
@@ -2504,6 +2501,9 @@
     from githubkit.versions.v2022_11_28.types import (
         CodeScanningOrganizationAlertItemsType as CodeScanningOrganizationAlertItemsType,
     )
+    from githubkit.versions.v2022_11_28.types import (
+        FullRepositoryPropCustomPropertiesType as FullRepositoryPropCustomPropertiesType,
+    )
     from githubkit.versions.v2022_11_28.types import (
         GistsGistIdGetResponse403PropBlockType as GistsGistIdGetResponse403PropBlockType,
     )
@@ -3212,6 +3212,9 @@
     from githubkit.versions.v2022_11_28.types import (
         ReposOwnerRepoGitTagsPostBodyPropTaggerType as ReposOwnerRepoGitTagsPostBodyPropTaggerType,
     )
+    from githubkit.versions.v2022_11_28.types import (
+        ReposOwnerRepoPropertiesValuesPatchBodyType as ReposOwnerRepoPropertiesValuesPatchBodyType,
+    )
     from githubkit.versions.v2022_11_28.types import (
         RepositoryRulePullRequestPropParametersType as RepositoryRulePullRequestPropParametersType,
     )
@@ -4085,9 +4088,6 @@
     from githubkit.versions.v2022_11_28.types import (
         ReposOwnerRepoActionsWorkflowsGetResponse200Type as ReposOwnerRepoActionsWorkflowsGetResponse200Type,
     )
-    from githubkit.versions.v2022_11_28.types import (
-        ReposOwnerRepoHooksHookIdPatchBodyPropConfigType as ReposOwnerRepoHooksHookIdPatchBodyPropConfigType,
-    )
     from githubkit.versions.v2022_11_28.types import (
         ReposOwnerRepoImportAuthorsAuthorIdPatchBodyType as ReposOwnerRepoImportAuthorsAuthorIdPatchBodyType,
     )
@@ -10842,6 +10842,7 @@
             "CodeOfConductSimpleType",
             "FullRepositoryType",
             "FullRepositoryPropPermissionsType",
+            "FullRepositoryPropCustomPropertiesType",
             "RepositoryRulesetBypassActorType",
             "RepositoryRulesetConditionsType",
             "RepositoryRulesetConditionsPropRefNameType",
@@ -11126,7 +11127,6 @@
             "GitTreePropTreeItemsType",
             "HookResponseType",
             "HookType",
-            "HookPropConfigType",
             "ImportType",
             "ImportPropProjectChoicesItemsType",
             "PorterAuthorType",
@@ -14154,7 +14154,6 @@
             "ReposOwnerRepoHooksPostBodyType",
             "ReposOwnerRepoHooksPostBodyPropConfigType",
             "ReposOwnerRepoHooksHookIdPatchBodyType",
-            "ReposOwnerRepoHooksHookIdPatchBodyPropConfigType",
             "ReposOwnerRepoHooksHookIdConfigPatchBodyType",
             "ReposOwnerRepoImportPutBodyType",
             "ReposOwnerRepoImportPatchBodyType",
@@ -14201,6 +14200,7 @@
             "ReposOwnerRepoPagesPostBodyAnyof1Type",
             "ReposOwnerRepoPagesDeploymentPostBodyType",
             "ReposOwnerRepoProjectsPostBodyType",
+            "ReposOwnerRepoPropertiesValuesPatchBodyType",
             "ReposOwnerRepoPullsPostBodyType",
             "ReposOwnerRepoPullsCommentsCommentIdPatchBodyType",
             "ReposOwnerRepoPullsCommentsCommentIdReactionsPostBodyType",