Interface GitHubRepositoryAdvisory

Represents a security advisory scoped to a repository.

See

https://docs.github.com/en/rest/security-advisories/repository-advisories#get-a-repository-security-advisory

interface GitHubRepositoryAdvisory {
    author: GitHubUser;
    closed_at: null | string;
    collaborating_teams: null | { name: string; slug: string }[];
    collaborating_users: null | GitHubUser[];
    created_at: string;
    credits: null | { login: string; type: string }[];
    credits_detailed:
        | null
        | { state: string; type: string; user: GitHubUser }[];
    cve_id: null | string;
    cvss: null | { score: number; vector_string: string };
    cwes: null | { cwe_id: string; name: string }[];
    description: string;
    ghsa_id: string;
    html_url: string;
    identifiers: { type: string; value: string }[];
    private_fork: null | GitHubRepository;
    published_at: null | string;
    publisher: null | GitHubUser;
    severity: "critical" | "high" | "medium" | "low" | "unknown";
    state: "closed" | "triage" | "published" | "withdrawn" | "draft";
    submission: null | { accepted: boolean };
    summary: string;
    updated_at: string;
    url: string;
    vulnerabilities: GitHubAdvisoryVulnerability[];
    withdrawn_at: null | string;
}

Properties

author closed_at collaborating_teams collaborating_users created_at credits credits_detailed cve_id cvss cwes description ghsa_id html_url identifiers private_fork published_at publisher severity state submission summary updated_at url vulnerabilities withdrawn_at

Properties

author

author: GitHubUser

User who authored the advisory draft

closed_at

closed_at: null | string

ISO 8601 closure timestamp, or null if still open

collaborating_teams

collaborating_teams: null | { name: string; slug: string }[]

Teams collaborating on this advisory

collaborating_users

collaborating_users: null | GitHubUser[]

Users collaborating on this advisory

created_at

created_at: string

ISO 8601 creation timestamp

credits

credits: null | { login: string; type: string }[]

Credited researchers/reporters

credits_detailed

credits_detailed: null | { state: string; type: string; user: GitHubUser }[]

Credited researchers with detailed info

cve_id

cve_id: null | string

CVE identifier, if assigned

cvss

cvss: null | { score: number; vector_string: string }

CVSS score and vector string

cwes

cwes: null | { cwe_id: string; name: string }[]

CWE classifications

description

description: string

Full description

ghsa_id

ghsa_id: string

GitHub Security Advisory ID

html_url

html_url: string

URL to the advisory on GitHub

identifiers

identifiers: { type: string; value: string }[]

External identifiers

private_fork

private_fork: null | GitHubRepository

Private fork created for this advisory

published_at

published_at: null | string

ISO 8601 publication timestamp, or null if not yet published

publisher

publisher: null | GitHubUser

User who published the advisory

severity

severity: "critical" | "high" | "medium" | "low" | "unknown"

Overall severity

state

state: "closed" | "triage" | "published" | "withdrawn" | "draft"

Advisory lifecycle state

submission

submission: null | { accepted: boolean }

CVE submission status

summary

summary: string

Short summary

updated_at

updated_at: string

ISO 8601 last-updated timestamp

url

url: string

API URL

vulnerabilities

vulnerabilities: GitHubAdvisoryVulnerability[]

Affected packages and version ranges

withdrawn_at

withdrawn_at: null | string

ISO 8601 withdrawal timestamp, or null if not withdrawn

Settings

Member Visibility

On This Page

Properties