jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 12:07:35 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #25972 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
Octomerger Bot
2023-06-14 15:01:26 -04:00
committed by GitHub
parent 9bfcb0c793 a2de2fc8fd
commit fed3b81c1d
42 changed files with 642 additions and 197410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

193
.github/workflows/repo-sync.yml vendored
View File

@@ -35,41 +35,54 @@ jobs:
destination_branch: repo-sync
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
- name: Find or create pull request
id: pull-request
- name: Ship pull request
uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410
with:
github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
result-encoding: string
script: |
const { owner, repo } = context.repo
const head = 'repo-sync'
const head = 'github:repo-sync'
const base = 'main'
const label = 'automated-reposync-pr'
// Check if a pull request already exists
let { data: pulls } = await github.rest.pulls.list({ owner, repo, head, base })
let foundPull = pulls.find(pr => pr.labels.some(xlabel => xlabel.name === label))
if (foundPull) {
console.log('Found pull request and will not create a new one', foundPull.html_url)
return foundPull.number
async function closePullRequest(prNumber) {
console.log('Closing pull request', prNumber)
await github.rest.pulls.update({
owner,
repo,
pull_number: prNumber,
state: 'closed'
})
// Error loud here, so no try/catch
console.log('Closed pull request', prNumber)
}
console.log('Close any existing pull requests')
const { data: existingPulls } = await github.rest.pulls.list({ owner, repo, head, base })
if (existingPulls.length) {
console.log('Found existing pull requests', existingPulls.map(pull => pull.number))
for (const pull of existingPulls) {
await closePullRequest(pull.number)
}
console.log('Closed existing pull requests')
}
console.log('Create a new pull request')
const body = `
This is an automated pull request to sync changes between the public and private repos.
Our bot will merge this pull request automatically.
To preserve continuity across repos, _do not squash_ this pull request.
`
console.log('Create a new pull request')
let pull
try {
var { data: pull } = await github.rest.pulls.create({
pull = (await github.rest.pulls.create({
owner,
repo,
head,
base,
title: 'Repo sync',
body,
})
})).data
} catch (err) {
if (err.message?.includes('No commits')) {
console.log(err.message)
@@ -77,137 +90,63 @@ jobs:
}
throw err
}
console.log('Add label', label)
await github.rest.issues.addLabels({
owner,
repo,
issue_number: pull.number,
labels: [label]
})
console.log('Created pull request successfully', pull.html_url)
return pull.number
# Because we get far too much spam ;_;
- name: Lock conversations
if: ${{ github.repository == 'github/docs' && steps.pull-request.outputs.result }}
uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
env:
PR_NUMBER: ${{ steps.pull-request.outputs.result }}
with:
script: |
console.log('Count files')
const { data: prFiles } = await github.rest.pulls.listFiles({ owner, repo, pull_number: pull.number })
if (!prFiles.length) {
console.log('No files changed, closing')
await closePullRequest(pull.number)
return
}
console.log('Check mergeable')
if (!pull.mergeable) {
console.log('Pull request is not mergeable, closing')
await closePullRequest(pull.number)
return
}
console.log('Lock conversations')
try {
await github.rest.issues.lock({
...context.repo,
issue_number: parseInt(process.env.PR_NUMBER),
issue_number: pull.number,
lock_reason: 'spam'
})
console.log('Locked the pull request to prevent spam!')
} catch (error) {
// Log the error but don't fail the workflow
console.error(`Failed to lock the pull request. Error: ${error}`)
console.error('Failed to lock the pull request.', error)
// Don't fail the workflow
}
# There are cases where the branch becomes out-of-date in between the time this workflow began
# and when the pull request is created/updated
- name: Update branch
if: ${{ steps.pull-request.outputs.result }}
uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
env:
PR_NUMBER: ${{ steps.pull-request.outputs.result }}
with:
github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
script: |
const mainHeadSha = await github.rest.git.getRef({
...context.repo,
ref: 'heads/main'
})
console.log(`heads/main sha: ${mainHeadSha.data.object.sha}`)
const pull_number = parseInt(process.env.PR_NUMBER)
const pull = await github.rest.pulls.get({
...context.repo,
pull_number,
})
console.log(`Pull request base sha: ${pull.data.base.sha}`)
if (mainHeadSha.data.object.sha !== pull.data.base.sha || pull.data.mergeable_state === 'behind') {
try {
const updateBranch = await github.rest.pulls.updateBranch({
...context.repo,
pull_number,
})
console.log(updateBranch.data.message)
} catch (error) {
// When the head branch is modified an error with status 422 is thrown
// We should retry one more time to update the branch
if (error.status === 422) {
try {
const updateBranch = await github.rest.pulls.updateBranch({
...context.repo,
pull_number,
})
console.log(updateBranch.data.message)
} catch (error) {
// Only retry once. We'll rely on the update branch workflow to update
// this PR in the case of a second failure.
console.log(`Retried updating the branch, but an error occurred: ${error}`)
}
} else {
// A failed branch update shouldn't fail this worklow.
console.log(`An error occurred when updating the branch: ${error}`)
}
}
} else {
console.log(`Branch is already up-to-date`)
console.log('Approve pull request')
try {
await github.rest.pulls.createReview({
owner,
repo,
pull_number: pull.number,
event: 'APPROVE',
})
} catch (error) {
console.error('Failed to approve the pull request.', error)
// Don't fail the workflow
}
- name: Check pull request file count after updating
if: ${{ steps.pull-request.outputs.result }}
uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
id: pr-files
env:
PR_NUMBER: ${{ steps.pull-request.outputs.result }}
with:
github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
result-encoding: string
script: |
const { data: prFiles } = await github.rest.pulls.listFiles({
...context.repo,
pull_number: process.env.PR_NUMBER,
console.log('Admin merge the pull request')
// Admin merge pull request to avoid squash
await github.rest.pulls.merge({
owner,
repo,
pull_number: pull.number,
merge_method: 'merge',
})
core.setOutput('count', (prFiles && prFiles.length || 0).toString())
# Sometimes after updating the branch, there aren't any remaining files changed.
# If not, we should close the PR instead of merging it and triggering deployments.
- name: Close the pull request if no files remain
if: ${{ steps.pull-request.outputs.result && steps.pr-files.outputs.count == '0' }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ steps.pull-request.outputs.result }}
run: |
gh pr close $PR_NUMBER --repo $GITHUB_REPOSITORY
- name: Approve pull request
if: ${{ steps.steps.pull-request.outputs.result && steps.pr-files.outputs.count != '0' }}
uses: juliangruber/approve-pull-request-action@dcc4effb325c0b503408619918d56e40653dcc91
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
number: ${{ steps.pull-request.outputs.result }}
# Admin merge to avoid being squashed in the merge queue
- name: Admin merge the pull request
if: ${{ steps.pull-request.outputs.result && steps.pr-files.outputs.count != '0' }}
env:
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
PR_NUMBER: ${{ steps.pull-request.outputs.result }}
run: |
gh pr merge $PR_NUMBER --admin --merge
// Error loud here, so no try/catch
console.log('Merged the pull request successfully')
- name: Send Slack notification if workflow fails
uses: someimportantcompany/github-actions-slack-message@1d367080235edfa53df415bd8e0bbab480f29bad
if: failure()
uses: someimportantcompany/github-actions-slack-message@1d367080235edfa53df415bd8e0bbab480f29bad
with:
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

8
components/article/InArticlePicker.tsx
View File

@@ -1,5 +1,5 @@
import { useEffect, useState } from 'react'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import { UnderlineNav } from '@primer/react'
import { sendEvent, EventType } from 'src/events/components/events'
import { useRouter } from 'next/router'
@@ -130,11 +130,7 @@ export const InArticlePicker = ({
preference_value: value,
})
Cookies.set(cookieKey, value, {
sameSite: 'strict',
secure: document.location.protocol !== 'http:',
expires: 365,
})
Cookies.set(cookieKey, value)
}
const sharedContainerProps = {

2
components/hooks/useHasAccount.ts
View File

@@ -1,5 +1,5 @@
import { useState, useEffect } from 'react'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
// Measure if the user has a github.com account and signed in during this session.
// The github.com sends the color_mode cookie every request when you sign in,

2
components/hooks/useTheme.ts
View File

@@ -1,5 +1,5 @@
import { useState, useEffect } from 'react'
import Cookies from 'js-cookie'
import Cookies from '../lib/cookies'
enum CssColorMode {
auto = 'auto',

2
components/hooks/useUserLanguage.ts
View File

@@ -1,5 +1,5 @@
import { useState, useEffect } from 'react'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import { useRouter } from 'next/router'
import { useLanguages } from 'components/context/LanguagesContext'

14
components/lib/cookies.ts Normal file
View File

@@ -0,0 +1,14 @@
import Cookies from 'js-cookie'
// This library only works client side,
// so on the server side we return a mock.
export default typeof document === 'undefined'
? {
get: () => undefined,
set: () => undefined,
}
: Cookies.withAttributes({
expires: 365,
sameSite: 'strict',
secure: document.location.protocol !== 'http:',
})

7
components/page-header/LanguagePicker.tsx
View File

@@ -1,5 +1,5 @@
import { useRouter } from 'next/router'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import { GlobeIcon } from '@primer/octicons-react'
import { useLanguages } from 'components/context/LanguagesContext'
@@ -18,10 +18,7 @@ function rememberPreferredLanguage(value: string) {
// need this in the client-side which is used to determine
// the UI about displaying notifications about preferred
// language if your cookie doesn't match the current URL.
Cookies.set(USER_LANGUAGE_COOKIE_NAME, value, {
expires: 365,
secure: document.location.protocol !== 'http:',
})
Cookies.set(USER_LANGUAGE_COOKIE_NAME, value)
} catch (err) {
// You can never be too careful because setting a cookie
// can fail. For example, some browser

2
data/secret-scanning.yml
View File

@@ -1523,7 +1523,7 @@
ghec: '*'
ghes: '>3.8'
ghae: '>3.8'
isPublic: false
isPublic: true
isPrivateWithGhas: true
hasPushProtection: true
hasValidityCheck: false

2
src/automated-pipelines/components/parameter-table/ChildBodyParametersRows.tsx
View File

@@ -11,7 +11,7 @@ type Props = {
slug: string
childParamsGroups: ChildParameter[]
parentName: string
parentType: string
parentType?: string
oneOfObject?: boolean
}

8
src/automated-pipelines/components/parameter-table/ParameterRow.tsx
View File

@@ -135,7 +135,13 @@ export function ParameterRow({
<ChildBodyParametersRows
slug={slug}
parentName={rowParams.name}
parentType={Array.isArray(rowParams.type) ? rowParams.type.join(' or ') : rowParams.type}
parentType={
rowParams.type
? Array.isArray(rowParams.type)
? rowParams.type.join(' or ')
: rowParams.type
: undefined
}
childParamsGroups={rowParams.childParamsGroups}
open={rowParams.name === clickedBodyParameterName}
oneOfObject={rowParams.oneOfObject}

2
src/automated-pipelines/components/parameter-table/types.ts
View File

@@ -24,7 +24,7 @@ export interface BodyParameter {
export interface ChildParameter {
name: string
description: string
type: string
type?: string
isRequired?: boolean
enum?: Array<string | null>
default?: string | boolean | number | undefined | string[]

8
src/events/components/events.ts
View File

@@ -1,5 +1,5 @@
/* eslint-disable camelcase */
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import { parseUserAgent } from './user-agent'
const COOKIE_NAME = '_docs-events'
@@ -46,11 +46,7 @@ export function getUserEventsId() {
cookieValue = Cookies.get(COOKIE_NAME)
if (cookieValue) return cookieValue
cookieValue = uuidv4()
Cookies.set(COOKIE_NAME, cookieValue, {
secure: document.location.protocol !== 'http:',
sameSite: 'strict',
expires: 365,
})
Cookies.set(COOKIE_NAME, cookieValue)
return cookieValue
}

2
src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
View File

@@ -1813,7 +1813,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghae/server-to-server-rest.json
View File

@@ -1177,7 +1177,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
View File

@@ -1925,7 +1925,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghes-3.4/server-to-server-rest.json
View File

@@ -1465,7 +1465,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghes-3.5/server-to-server-rest.json
View File

@@ -1555,7 +1555,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghes-3.6/server-to-server-rest.json
View File

@@ -1639,7 +1639,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghes-3.7/server-to-server-rest.json
View File

@@ -1689,7 +1689,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghes-3.8/server-to-server-rest.json
View File

@@ -1919,7 +1919,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json
View File

@@ -1943,7 +1943,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit",
"slug": "get-a-commit-object",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"

2
src/github-apps/lib/config.json
View File

@@ -7,5 +7,5 @@
"2022-11-28"
]
},
"sha": "61bae849bcbc5e760a1c32f968137838000c10de"
"sha": "a690f58e01c4ad78d5541f2cf795b53712b25d84"
}

7
src/rest/components/ApiVersionPicker.tsx
View File

@@ -1,5 +1,5 @@
import { useRouter } from 'next/router'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import { InfoIcon } from '@primer/octicons-react'
import { useMainContext } from 'components/context/MainContext'
@@ -15,10 +15,7 @@ function rememberApiVersion(apiVersion: string) {
// We use this cookie to remember which API Version a user chooses
// when they navigate the REST docs.
const apiVersionNormalized = apiVersion.replace(API_VERSION_SUFFIX, '')
Cookies.set(API_VERSION_COOKIE_NAME, apiVersionNormalized, {
expires: 365,
secure: document.location.protocol !== 'http:',
})
Cookies.set(API_VERSION_COOKIE_NAME, apiVersionNormalized)
} catch (err) {
// You can never be too careful because setting a cookie
// can fail. For example, some browser

7
src/rest/components/RestCodeSamples.tsx
View File

@@ -1,7 +1,7 @@
import { useState, useEffect, useRef, FormEvent } from 'react'
import { FormControl, Select, Tooltip, UnderlineNav } from '@primer/react'
import { CheckIcon, CopyIcon } from '@primer/octicons-react'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import cx from 'classnames'
import hljs from 'highlight.js/lib/core'
@@ -111,10 +111,7 @@ export function RestCodeSamples({ operation, slug, heading }: Props) {
const handleLanguageSelection = (languageKey: CodeSampleKeys) => {
setSelectedLanguage(languageKey)
Cookies.set('codeSampleLanguagePreferred', languageKey, {
sameSite: 'strict',
secure: document.location.protocol !== 'http:',
})
Cookies.set('codeSampleLanguagePreferred', languageKey)
}
const handleResponseResize = () => {

2
src/rest/components/RestRedirect.tsx
View File

@@ -1,6 +1,6 @@
import { useEffect } from 'react'
import { useRouter } from 'next/router'
import Cookies from 'js-cookie'
import Cookies from 'components/lib/cookies'
import { useVersion } from 'components/hooks/useVersion'
import { useMainContext } from 'components/context/MainContext'

28
src/rest/data/fpt-2022-11-28/schema.json
View File

@@ -91600,8 +91600,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -91742,8 +91742,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -95317,8 +95317,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -148460,7 +148460,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -156421,7 +156421,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -205626,7 +205626,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -216775,7 +216775,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -222406,7 +222406,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -223491,7 +223491,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -258969,7 +258969,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -259245,7 +259245,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -259287,7 +259287,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -259428,7 +259428,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -259848,7 +259848,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghae/schema.json
View File

@@ -52862,8 +52862,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -53004,8 +53004,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -56409,8 +56409,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -102229,7 +102229,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -110190,7 +110190,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -118784,7 +118784,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -129763,7 +129763,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -135394,7 +135394,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -136479,7 +136479,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -168026,7 +168026,7 @@
"serverUrl": "https://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -168302,7 +168302,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -168344,7 +168344,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -168485,7 +168485,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -168905,7 +168905,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghec-2022-11-28/schema.json
View File

@@ -101200,8 +101200,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -101342,8 +101342,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -104917,8 +104917,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -158740,7 +158740,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -166701,7 +166701,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -217313,7 +217313,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -228462,7 +228462,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -234093,7 +234093,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -235178,7 +235178,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -272512,7 +272512,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -272788,7 +272788,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -272830,7 +272830,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -272971,7 +272971,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -273391,7 +273391,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghes-3.4/schema.json
View File

@@ -77242,8 +77242,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -77384,8 +77384,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -80779,8 +80779,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -129723,7 +129723,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -137624,7 +137624,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -144799,7 +144799,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -155712,7 +155712,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -161343,7 +161343,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -162413,7 +162413,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -200352,7 +200352,7 @@
"serverUrl": "http(s)://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -200628,7 +200628,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -200670,7 +200670,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -200811,7 +200811,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -201231,7 +201231,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghes-3.5/schema.json
View File

@@ -83025,8 +83025,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -83167,8 +83167,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -86562,8 +86562,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -135518,7 +135518,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -143443,7 +143443,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -152050,7 +152050,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -162981,7 +162981,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -168612,7 +168612,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -169688,7 +169688,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -207633,7 +207633,7 @@
"serverUrl": "http(s)://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -207909,7 +207909,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -207951,7 +207951,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -208092,7 +208092,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -208512,7 +208512,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghes-3.6/schema.json
View File

@@ -85120,8 +85120,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -85262,8 +85262,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -88821,8 +88821,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -138035,7 +138035,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -145984,7 +145984,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -154649,7 +154649,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -165762,7 +165762,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -171393,7 +171393,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -172475,7 +172475,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -215968,7 +215968,7 @@
"serverUrl": "http(s)://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -216244,7 +216244,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -216286,7 +216286,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -216427,7 +216427,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -216847,7 +216847,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghes-3.7/schema.json
View File

@@ -86045,8 +86045,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -86187,8 +86187,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -89762,8 +89762,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -139006,7 +139006,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -146967,7 +146967,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -157072,7 +157072,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -168210,7 +168210,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -173841,7 +173841,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -174926,7 +174926,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -218799,7 +218799,7 @@
"serverUrl": "http(s)://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -219075,7 +219075,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -219117,7 +219117,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -219258,7 +219258,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -219678,7 +219678,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghes-3.8/schema.json
View File

@@ -99808,8 +99808,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -99950,8 +99950,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -103525,8 +103525,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -153350,7 +153350,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -161311,7 +161311,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -171470,7 +171470,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -182608,7 +182608,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -188239,7 +188239,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -189324,7 +189324,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -239847,7 +239847,7 @@
"serverUrl": "http(s)://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -240123,7 +240123,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -240165,7 +240165,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -240306,7 +240306,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -240726,7 +240726,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

28
src/rest/data/ghes-3.9-2022-11-28/schema.json
View File

@@ -100114,8 +100114,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Whether the authenticated user has starred the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -100256,8 +100256,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Unstar a repository that the authenticated user has previously starred.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -103831,8 +103831,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Gets information about whether the authenticated user is subscribed to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -153778,7 +153778,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -161739,7 +161739,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -172147,7 +172147,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>",
"descriptionHTML": "<p>Checks the repository permission of a collaborator. The possible repository\npermissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.</p>\n<p><em>Note</em>: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the\n<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the\ncollaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The\n<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -183285,7 +183285,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -188916,7 +188916,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -190001,7 +190001,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -241311,7 +241311,7 @@
"serverUrl": "http(s)://HOSTNAME/api/v3",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
"title": "Get a commit",
"title": "Get a commit object",
"category": "git",
"subcategory": "commits",
"parameters": [
@@ -241587,7 +241587,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects\">commit object</a>.</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Gets a Git <a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-Objects\">commit object</a>.\nTo get the contents of a commit, see \"<a href=\"/rest/commits/commits#get-a-commit\">Get a commit</a>.\"</p>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in the table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -241629,7 +241629,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -241770,7 +241770,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {
@@ -242190,7 +242190,7 @@
},
{
"name": "ref",
"description": "<p>ref parameter</p>",
"description": "<p>The commit reference. Can be a commit SHA, branch name (<code>heads/BRANCH_NAME</code>), or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
"schema": {

2
src/rest/lib/config.json
View File

@@ -33,5 +33,5 @@
]
}
},
"sha": "61bae849bcbc5e760a1c32f968137838000c10de"
"sha": "a690f58e01c4ad78d5541f2cf795b53712b25d84"
}

33896
src/webhooks/data/fpt/schema.json
View File

File diff suppressed because it is too large Load Diff

31783
src/webhooks/data/ghae/schema.json
View File

File diff suppressed because it is too large Load Diff

33896
src/webhooks/data/ghec/schema.json
View File

File diff suppressed because it is too large Load Diff

32645
src/webhooks/data/ghes-3.7/schema.json
View File

File diff suppressed because it is too large Load Diff

32645
src/webhooks/data/ghes-3.8/schema.json
View File

File diff suppressed because it is too large Load Diff

32645
src/webhooks/data/ghes-3.9/schema.json
View File

File diff suppressed because it is too large Load Diff

2
src/webhooks/lib/config.json
View File

@@ -1,3 +1,3 @@
{
"sha": "61bae849bcbc5e760a1c32f968137838000c10de"
"sha": "a690f58e01c4ad78d5541f2cf795b53712b25d84"
}