@itentialopensource/adapter-github

{ "$id": "schema.json", "type": "object", "schema": "http://json-schema.org/draft-07/schema#", "translate": true, "dynamicfields": true, "properties": { "ph_request_type": { "type": "string", "description": "type of request (internal to adapter)", "default": "deleteReposOwnerRepo", "enum": [ "deleteReposOwnerRepo", "getReposOwnerRepo", "patchReposOwnerRepo", "getReposOwnerRepoAssignees", "getReposOwnerRepoAssigneesAssignee", "getReposOwnerRepoBranches", "getReposOwnerRepoBranchesBranch", "getReposOwnerRepoCollaborators", "deleteReposOwnerRepoCollaboratorsUser", "getReposOwnerRepoCollaboratorsUser", "putReposOwnerRepoCollaboratorsUser", "getReposOwnerRepoComments", "deleteReposOwnerRepoCommentsCommentId", "getReposOwnerRepoCommentsCommentId", "patchReposOwnerRepoCommentsCommentId", "getReposOwnerRepoCommits", "getReposOwnerRepoCommitsRefStatus", "getReposOwnerRepoCommitsShaCode", "getReposOwnerRepoCommitsShaCodeComments", "postReposOwnerRepoCommitsShaCodeComments", "getReposOwnerRepoCompareBaseIdHeadId", "deleteReposOwnerRepoContentsPath", "getReposOwnerRepoContributors", "getReposOwnerRepoDeployments", "postReposOwnerRepoDeployments", "getReposOwnerRepoDeploymentsIdStatuses", "postReposOwnerRepoDeploymentsIdStatuses", "getReposOwnerRepoDownloads", "deleteReposOwnerRepoDownloadsDownloadId", "getReposOwnerRepoDownloadsDownloadId", "getReposOwnerRepoEvents", "getReposOwnerRepoForks", "postReposOwnerRepoForks", "postReposOwnerRepoGitBlobs", "getReposOwnerRepoGitBlobsShaCode", "postReposOwnerRepoGitCommits", "getReposOwnerRepoGitCommitsShaCode", "getReposOwnerRepoGitRefs", "postReposOwnerRepoGitRefs", "deleteReposOwnerRepoGitRefsRef", "getReposOwnerRepoGitMatchingRefs", "getReposOwnerRepoGitRefsRef", "patchReposOwnerRepoGitRefsRef", "postReposOwnerRepoGitTags", "getReposOwnerRepoGitTagsShaCode", "postReposOwnerRepoGitTrees", "getReposOwnerRepoGitTreesShaCode", "getReposOwnerRepoHooks", "postReposOwnerRepoHooks", "deleteReposOwnerRepoHooksHookId", "getReposOwnerRepoHooksHookId", "patchReposOwnerRepoHooksHookId", "postReposOwnerRepoHooksHookIdTests", "getReposOwnerRepoIssues", "postReposOwnerRepoIssues", "getReposOwnerRepoIssuesComments", "deleteReposOwnerRepoIssuesCommentsCommentId", "getReposOwnerRepoIssuesCommentsCommentId", "patchReposOwnerRepoIssuesCommentsCommentId", "getReposOwnerRepoIssuesEvents", "getReposOwnerRepoIssuesEventsEventId", "getReposOwnerRepoIssuesNumber", "patchReposOwnerRepoIssuesNumber", "getReposOwnerRepoIssuesNumberComments", "postReposOwnerRepoIssuesNumberComments", "getReposOwnerRepoIssuesNumberEvents", "deleteReposOwnerRepoIssuesNumberLabels", "getReposOwnerRepoIssuesNumberLabels", "postReposOwnerRepoIssuesNumberLabels", "putReposOwnerRepoIssuesNumberLabels", "deleteReposOwnerRepoIssuesNumberLabelsName", "getReposOwnerRepoKeys", "postReposOwnerRepoKeys", "deleteReposOwnerRepoKeysKeyId", "getReposOwnerRepoKeysKeyId", "getReposOwnerRepoLabels", "postReposOwnerRepoLabels", "deleteReposOwnerRepoLabelsName", "getReposOwnerRepoLabelsName", "patchReposOwnerRepoLabelsName", "getReposOwnerRepoLanguages", "postReposOwnerRepoMerges", "getReposOwnerRepoMilestones", "postReposOwnerRepoMilestones", "deleteReposOwnerRepoMilestonesNumber", "getReposOwnerRepoMilestonesNumber", "patchReposOwnerRepoMilestonesNumber", "getReposOwnerRepoMilestonesNumberLabels", "getReposOwnerRepoNotifications", "putReposOwnerRepoNotifications", "getReposOwnerRepoPulls", "postReposOwnerRepoPulls", "getReposOwnerRepoPullsComments", "deleteReposOwnerRepoPullsCommentsCommentId", "getReposOwnerRepoPullsCommentsCommentId", "patchReposOwnerRepoPullsCommentsCommentId", "getReposOwnerRepoPullsNumber", "patchReposOwnerRepoPullsNumber", "getReposOwnerRepoPullsNumberComments", "postReposOwnerRepoPullsNumberComments", "getReposOwnerRepoPullsNumberCommits", "getReposOwnerRepoPullsNumberFiles", "getReposOwnerRepoPullsNumberMerge", "putReposOwnerRepoPullsNumberMerge", "getReposOwnerRepoReadme", "getReposOwnerRepoReleases", "postReposOwnerRepoReleases", "deleteReposOwnerRepoReleasesAssetsId", "getReposOwnerRepoReleasesAssetsId", "patchReposOwnerRepoReleasesAssetsId", "deleteReposOwnerRepoReleasesId", "getReposOwnerRepoReleasesId", "patchReposOwnerRepoReleasesId", "getReposOwnerRepoReleasesIdAssets", "getReposOwnerRepoStargazers", "getReposOwnerRepoStatsCommitActivity", "getReposOwnerRepoStatsContributors", "getReposOwnerRepoStatsParticipation", "getReposOwnerRepoStatusesRef", "postReposOwnerRepoStatusesRef", "getReposOwnerRepoSubscribers", "deleteReposOwnerRepoSubscription", "getReposOwnerRepoSubscription", "putReposOwnerRepoSubscription", "getReposOwnerRepoTags", "getReposOwnerRepoTeams", "getReposOwnerRepoWatchers", "getReposOwnerRepoArchiveFormatPath", "reposGetOrgRulesets", "reposCreateOrgRuleset", "reposGetOrgRuleSuites", "reposGetOrgRuleSuite", "reposGetOrgRuleset", "reposUpdateOrgRuleset", "reposDeleteOrgRuleset", "reposListActivities", "reposCreateAttestation", "reposListAttestations", "reposListAutolinks", "reposCreateAutolink", "reposGetAutolink", "reposDeleteAutolink", "reposCheckAutomatedSecurityFixes", "reposEnableAutomatedSecurityFixes", "reposDisableAutomatedSecurityFixes", "reposGetBranchProtection", "reposUpdateBranchProtection", "reposDeleteBranchProtection", "reposGetAdminBranchProtection", "reposSetAdminBranchProtection", "reposDeleteAdminBranchProtection", "reposGetPullRequestReviewProtection", "reposUpdatePullRequestReviewProtection", "reposDeletePullRequestReviewProtection", "reposGetCommitSignatureProtection", "reposCreateCommitSignatureProtection", "reposDeleteCommitSignatureProtection", "reposGetStatusChecksProtection", "reposUpdateStatusCheckProtection", "reposRemoveStatusCheckProtection", "reposGetAllStatusCheckContexts", "reposAddStatusCheckContexts", "reposSetStatusCheckContexts", "reposRemoveStatusCheckContexts", "reposGetAccessRestrictions", "reposDeleteAccessRestrictions", "reposGetAppsWithAccessToProtectedBranch", "reposAddAppAccessRestrictions", "reposSetAppAccessRestrictions", "reposRemoveAppAccessRestrictions", "reposGetTeamsWithAccessToProtectedBranch", "reposAddTeamAccessRestrictions", "reposSetTeamAccessRestrictions", "reposRemoveTeamAccessRestrictions", "reposGetUsersWithAccessToProtectedBranch", "reposAddUserAccessRestrictions", "reposSetUserAccessRestrictions", "reposRemoveUserAccessRestrictions", "reposRenameBranch", "reposCodeownersErrors", "reposCheckCollaborator", "reposAddCollaborator", "reposRemoveCollaborator", "reposGetCollaboratorPermissionLevel", "reposListBranchesForHeadCommit", "reposListPullRequestsAssociatedWithCommit", "reposGetCommit", "reposListCommitStatusesForRef", "reposGetCommunityProfileMetrics", "reposGetContent", "reposCreateOrUpdateFileContents", "reposDeleteFile", "reposGetDeployment", "reposDeleteDeployment", "reposGetDeploymentStatus", "reposCreateDispatchEvent", "reposGetAllEnvironments", "reposGetEnvironment", "reposCreateOrUpdateEnvironment", "reposDeleteAnEnvironment", "reposListDeploymentBranchPolicies", "reposCreateDeploymentBranchPolicy", "reposGetDeploymentBranchPolicy", "reposUpdateDeploymentBranchPolicy", "reposDeleteDeploymentBranchPolicy", "reposGetAllDeploymentProtectionRules", "reposCreateDeploymentProtectionRule", "reposListCustomDeploymentRuleIntegrations", "reposGetCustomDeploymentProtectionRule", "reposDisableDeploymentProtectionRule", "reposGetWebhookConfigForRepo", "reposUpdateWebhookConfigForRepo", "reposListWebhookDeliveries", "reposGetWebhookDelivery", "reposRedeliverWebhookDelivery", "reposPingWebhook", "reposListInvitations", "reposUpdateInvitation", "reposDeleteInvitation", "reposMergeUpstream", "reposGetPages", "reposCreatePagesSite", "reposUpdateInformationAboutPagesSite", "reposDeletePagesSite", "reposListPagesBuilds", "reposRequestPagesBuild", "reposGetLatestPagesBuild", "reposGetPagesBuild", "reposCreatePagesDeployment", "reposGetPagesDeployment", "reposCancelPagesDeployment", "reposGetPagesHealthCheck", "reposCheckPrivateVulnerabilityReporting", "reposEnablePrivateVulnerabilityReporting", "reposDisablePrivateVulnerabilityReporting", "reposGetCustomPropertiesValues", "reposCreateOrUpdateCustomPropertiesValues", "reposGetReadmeInDirectory", "reposGenerateReleaseNotes", "reposGetLatestRelease", "reposGetReleaseByTag", "reposUploadReleaseAsset", "reposGetBranchRules", "reposGetRepoRulesets", "reposCreateRepoRuleset", "reposGetRepoRuleSuites", "reposGetRepoRuleSuite", "reposGetRepoRuleset", "reposUpdateRepoRuleset", "reposDeleteRepoRuleset", "reposCreateCommitStatus", "reposListTagProtection", "reposCreateTagProtection", "reposDeleteTagProtection", "reposDownloadTarballArchive", "reposGetAllTopics", "reposReplaceAllTopics", "reposGetClones", "reposGetTopPaths", "reposGetTopReferrers", "reposGetViews", "reposTransfer", "reposCheckVulnerabilityAlerts", "reposEnableVulnerabilityAlerts", "reposDisableVulnerabilityAlerts", "reposDownloadZipballArchive", "reposCreateUsingTemplate", "reposListInvitationsForAuthenticatedUser", "reposAcceptInvitationForAuthenticatedUser", "reposDeclineInvitationForAuthenticatedUser" ], "external_name": "ph_request_type" }, "pathParam": { "description": "Valid Git reference, defaults to 'master'.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "path" }, "pathParamQuery": { "description": "The content path.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "path" }, "archiveFormat": { "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "archive_format" }, "issueNumber": { "type": "number", "description": "The number that identifies the issue.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "issue_number" }, "milestoneNumber": { "type": "number", "description": "The number that identifies the milestone.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "milestone_number" }, "pullNumber": { "type": "number", "description": "The number that identifies the pull request.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "pull_number" }, "perPage": { "type": "number", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "per_page" }, "repositoryName": { "type": "number", "description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "repository_name" }, "timePeriod": { "type": "string", "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "time_period" }, "actorName": { "type": "string", "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "actor_name" }, "ruleSuiteResult": { "type": "string", "description": "The rule results to filter on. When specified, only suites with this result will be returned.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "rule_suite_result" }, "ruleSuiteId": { "type": "number", "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suite...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "rule_suite_id" }, "rulesetId": { "type": "number", "description": "The ID of the ruleset.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "ruleset_id" }, "activityType": { "type": "string", "description": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "activity_type" }, "subjectDigest": { "type": "string", "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "subject_digest" }, "autolinkId": { "type": "number", "description": "The unique identifier of the autolink.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "autolink_id" }, "commitSha": { "type": "string", "description": "The SHA of the commit.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "commit_sha" }, "deploymentId": { "type": "number", "description": "deployment_id parameter", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "deployment_id" }, "statusId": { "type": "number", "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "status_id" }, "environmentName": { "type": "string", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "environment_name" }, "branchPolicyId": { "type": "number", "description": "The unique identifier of the branch policy.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "branch_policy_id" }, "protectionRuleId": { "type": "number", "description": "The unique identifier of the protection rule.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "protection_rule_id" }, "hookId": { "type": "number", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "hook_id" }, "deliveryId": { "type": "number", "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "delivery_id" }, "invitationId": { "type": "number", "description": "The unique identifier of the invitation.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "invitation_id" }, "buildId": { "type": "number", "description": "", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "build_id" }, "pagesDeploymentId": { "type": "string", "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "pages_deployment_id" }, "releaseId": { "type": "number", "description": "The unique identifier of the release.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "release_id" }, "includesParents": { "type": "boolean", "description": "Include rulesets configured at higher levels that apply to this repository", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "includes_parents" }, "tagProtectionId": { "type": "number", "description": "The unique identifier of the tag protection.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "tag_protection_id" }, "templateOwner": { "type": "string", "description": "The account owner of the template repository. The name is not case sensitive.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "template_owner" }, "templateRepo": { "type": "string", "description": "The name of the template repository without the `.git` extension. The name is not case sensitive.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "template_repo" } }, "definitions": {} }