securityAdvisoriesCreateRepositoryAdvisory
Create a repository security advisory
Details
- Method:
POST - Path:
/repos/{owner}/{repo}/security-advisories - Operation ID:
security-advisories/create-repository-advisory
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"summary": {
"description": "A short summary of the advisory.",
"required": true,
"location": "body",
"type": "string"
},
"description": {
"description": "A detailed description of what the advisory impacts.",
"required": true,
"location": "body",
"type": "string"
},
"cve_id": {
"description": "The Common Vulnerabilities and Exposures (CVE) ID.",
"required": false,
"location": "body",
"type": "string"
},
"vulnerabilities": {
"description": "A product affected by the vulnerability detailed in a repository security advisory.",
"required": true,
"location": "body",
"type": "array"
},
"cwe_ids": {
"description": "A list of Common Weakness Enumeration (CWE) IDs.",
"required": false,
"location": "body",
"type": "array"
},
"credits": {
"description": "A list of users receiving credit for their participation in the security advisory.",
"required": false,
"location": "body",
"type": "array"
},
"severity": {
"description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
"required": false,
"location": "body",
"type": "string",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"cvss_vector_string": {
"description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
"required": false,
"location": "body",
"type": "string"
},
"start_private_fork": {
"description": "Whether to create a temporary private fork of the repository to collaborate on a fix.",
"required": false,
"location": "body",
"type": "boolean"
}
}Response Schema
{
"description": "A repository security advisory.",
"type": "object",
"properties": {
"ghsa_id": {
"type": "string",
"description": "The GitHub Security Advisory ID.",
"readOnly": true
},
"cve_id": {
"type": "string",
"description": "The Common Vulnerabilities and Exposures (CVE) ID.",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"description": "The API URL for the advisory.",
"readOnly": true
},
"html_url": {
"type": "string",
"format": "uri",
"description": "The URL for the advisory.",
"readOnly": true
},
"summary": {
"type": "string",
"description": "A short summary of the advisory.",
"maxLength": 1024
},
"description": {
"type": "string",
"description": "A detailed description of what the advisory entails.",
"maxLength": 65535,
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the advisory.",
"nullable": true,
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"author": {
"allOf": [
{
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"email": {
"nullable": true,
"type": "string"
},
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"user_view_type": {
"type": "string",
"example": "public"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
]
}
],
"readOnly": true,
"nullable": true,
"description": "The author of the advisory."
},
"publisher": {
"allOf": [
{
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"email": {
"nullable": true,
"type": "string"
},
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"user_view_type": {
"type": "string",
"example": "public"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
]
}
],
"readOnly": true,
"nullable": true,
"description": "The publisher of the advisory."
},
"identifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of identifier.",
"enum": [
"CVE",
"GHSA"
]
},
"value": {
"type": "string",
"description": "The identifier value."
}
},
"required": [
"type",
"value"
]
},
"readOnly": true
},
"state": {
"type": "string",
"description": "The state of the advisory.",
"enum": [
"published",
"closed",
"withdrawn",
"draft",
"triage"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the advisory was created, in ISO 8601 format.",
"readOnly": true,
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the advisory was last updated, in ISO 8601 format.",
"readOnly": true,
"nullable": true
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the advisory was published, in ISO 8601 format.",
"readOnly": true,
"nullable": true
},
"closed_at": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the advisory was closed, in ISO 8601 format.",
"readOnly": true,
"nullable": true
},
"withdrawn_at": {
"type": "string",
"format": "date-time",
"description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.",
"readOnly": true,
"nullable": true
},
"submission": {
"type": "object",
"nullable": true,
"readOnly": true,
"properties": {
"accepted": {
"type": "boolean",
"description": "Whether a private vulnerability report was accepted by the repository's administrators.",
"readOnly": true
}
},
"required": [
"accepted"
]
},
"vulnerabilities": {
"type": "array",
"nullable": true,
"items": {
"description": "A product affected by the vulnerability detailed in a repository security advisory.",
"type": "object",
"properties": {
"package": {
"description": "The name of the package affected by the vulnerability.",
"type": "object",
"nullable": true,
"properties": {
"ecosystem": {
"type": "string",
"description": "The package's language or package management ecosystem.",
"enum": [
"rubygems",
"npm",
"pip",
"maven",
"nuget",
"composer",
"go",
"rust",
"erlang",
"actions",
"pub",
"other",
"swift"
]
},
"name": {
"type": "string",
"description": "The unique package name within its ecosystem.",
"nullable": true
}
},
"required": [
"ecosystem",
"name"
]
},
"vulnerable_version_range": {
"type": "string",
"description": "The range of the package versions affected by the vulnerability.",
"nullable": true
},
"patched_versions": {
"type": "string",
"description": "The package version(s) that resolve the vulnerability.",
"nullable": true
},
"vulnerable_functions": {
"type": "array",
"description": "The functions in the package that are affected.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"required": [
"package",
"vulnerable_version_range",
"patched_versions",
"vulnerable_functions"
],
"additionalProperties": false
}
},
"cvss": {
"type": "object",
"nullable": true,
"properties": {
"vector_string": {
"type": "string",
"description": "The CVSS vector.",
"nullable": true
},
"score": {
"type": "number",
"description": "The CVSS score.",
"minimum": 0,
"maximum": 10,
"nullable": true,
"readOnly": true
}
},
"required": [
"vector_string",
"score"
]
},
"cvss_severities": {
"type": "object",
"nullable": true,
"properties": {
"cvss_v3": {
"type": "object",
"nullable": true,
"properties": {
"vector_string": {
"type": "string",
"description": "The CVSS 3 vector string.",
"nullable": true
},
"score": {
"type": "number",
"description": "The CVSS 3 score.",
"minimum": 0,
"maximum": 10,
"nullable": true,
"readOnly": true
}
},
"required": [
"vector_string",
"score"
]
},
"cvss_v4": {
"type": "object",
"nullable": true,
"properties": {
"vector_string": {
"type": "string",
"description": "The CVSS 4 vector string.",
"nullable": true
},
"score": {
"type": "number",
"description": "The CVSS 4 score.",
"minimum": 0,
"maximum": 10,
"nullable": true,
"readOnly": true
}
},
"required": [
"vector_string",
"score"
]
}
}
},
"cwes": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"cwe_id": {
"type": "string",
"description": "The Common Weakness Enumeration (CWE) identifier."
},
"name": {
"type": "string",
"description": "The name of the CWE.",
"readOnly": true
}
},
"required": [
"cwe_id",
"name"
]
},
"readOnly": true
},
"cwe_ids": {
"type": "array",
"description": "A list of only the CWE IDs.",
"nullable": true,
"items": {
"type": "string"
}
},
"credits": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The username of the user credited."
},
"type": {
"type": "string",
"description": "The type of credit the user is receiving.",
"enum": [
"analyst",
"finder",
"reporter",
"coordinator",
"remediation_developer",
"remediation_reviewer",
"remediation_verifier",
"tool",
"sponsor",
"other"
]
}
}
}
},
"credits_detailed": {
"type": "array",
"nullable": true,
"items": {
"description": "A credit given to a user for a repository security advisory.",
"type": "object",
"properties": {
"user": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"email": {
"nullable": true,
"type": "string"
},
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"user_view_type": {
"type": "string",
"example": "public"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
]
},
"type": {
"type": "string",
"description": "The type of credit the user is receiving.",
"enum": [
"analyst",
"finder",
"reporter",
"coordinator",
"remediation_developer",
"remediation_reviewer",
"remediation_verifier",
"tool",
"sponsor",
"other"
]
},
"state": {
"type": "string",
"description": "The state of the user's acceptance of the credit.",
"enum": [
"accepted",
"declined",
"pending"
]
}
},
"required": [
"user",
"type",
"state"
],
"additionalProperties": false
},
"readOnly": true
},
"collaborating_users": {
"type": "array",
"description": "A list of users that collaborate on the advisory.",
"nullable": true,
"items": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"email": {
"nullable": true,
"type": "string"
},
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"user_view_type": {
"type": "string",
"example": "public"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
]
}
},
"collaborating_teams": {
"type": "array",
"description": "A list of teams that collaborate on the advisory.",
"nullable": true,
"items": {
"title": "Team",
"description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"privacy": {
"type": "string"
},
"notification_setting": {
"type": "string"
},
"permission": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"pull": {
"type": "boolean"
},
"triage": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"admin": {
"type": "boolean"
}
},
"required": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
},
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/orgs/rails/teams/core"
},
"members_url": {
"type": "string"
},
"repositories_url": {
"type": "string",
"format": "uri"
},
"type": {
"description": "The ownership type of the team",
"type": "string",
"enum": [
"enterprise",
"organization"
]
},
"organization_id": {
"type": "integer",
"description": "Unique identifier of the organization to which this team belongs",
"example": 37
},
"enterprise_id": {
"type": "integer",
"description": "Unique identifier of the enterprise to which this team belongs",
"example": 42
},
"parent": {
"title": "Team Simple",
"description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the team",
"type": "integer",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VGVhbTE="
},
"url": {
"description": "URL for the team",
"type": "string",
"format": "uri",
"example": "https://api.github.com/organizations/1/team/1"
},
"members_url": {
"type": "string",
"example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
"name": {
"description": "Name of the team",
"type": "string",
"example": "Justice League"
},
"description": {
"description": "Description of the team",
"type": "string",
"nullable": true,
"example": "A great team."
},
"permission": {
"description": "Permission that the team will have for its repositories",
"type": "string",
"example": "admin"
},
"privacy": {
"description": "The level of privacy this team should have",
"type": "string",
"example": "closed"
},
"notification_setting": {
"description": "The notification setting the team has set",
"type": "string",
"example": "notifications_enabled"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/orgs/rails/teams/core"
},
"repositories_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/organizations/1/team/1/repos"
},
"slug": {
"type": "string",
"example": "justice-league"
},
"ldap_dn": {
"description": "Distinguished Name (DN) that team maps to within LDAP environment",
"example": "uid=example,ou=users,dc=github,dc=com",
"type": "string"
},
"type": {
"description": "The ownership type of the team",
"type": "string",
"enum": [
"enterprise",
"organization"
]
},
"organization_id": {
"type": "integer",
"description": "Unique identifier of the organization to which this team belongs",
"example": 37
},
"enterprise_id": {
"type": "integer",
"description": "Unique identifier of the enterprise to which this team belongs",
"example": 42
}
},
"required": [
"id",
"node_id",
"url",
"members_url",
"name",
"description",
"permission",
"html_url",
"repositories_url",
"slug",
"type"
],
"nullable": true
}
},
"required": [
"id",
"node_id",
"url",
"members_url",
"name",
"description",
"permission",
"html_url",
"repositories_url",
"slug",
"parent",
"type"
]
}
},
"private_fork": {
"allOf": [
{
"title": "Simple Repository",
"description": "A GitHub repository.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1296269,
"description": "A unique identifier of the repository."
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"description": "The GraphQL identifier of the repository."
},
"name": {
"type": "string",
"example": "Hello-World",
"description": "The name of the repository."
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World",
"description": "The full, globally unique, name of the repository."
},
"owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"email": {
"nullable": true,
"type": "string"
},
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"user_view_type": {
"type": "string",
"example": "public"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
]
},
"private": {
"type": "boolean",
"description": "Whether the repository is private."
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World",
"description": "The URL to view the repository on GitHub.com."
},
"description": {
"type": "string",
"example": "This your first repo!",
"nullable": true,
"description": "The repository description."
},
"fork": {
"type": "boolean",
"description": "Whether the repository is a fork."
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World",
"description": "The URL to get more information about the repository from the GitHub API."
},
"archive_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"description": "A template for the API URL to download the repository as an archive."
},
"assignees_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"description": "A template for the API URL to list the available assignees for issues in the repository."
},
"blobs_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"description": "A template for the API URL to create or retrieve a raw Git blob in the repository."
},
"branches_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"description": "A template for the API URL to get information about branches in the repository."
},
"collaborators_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"description": "A template for the API URL to get information about collaborators of the repository."
},
"comments_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"description": "A template for the API URL to get information about comments on the repository."
},
"commits_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"description": "A template for the API URL to get information about commits on the repository."
},
"compare_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"description": "A template for the API URL to compare two commits or refs."
},
"contents_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"description": "A template for the API URL to get the contents of the repository."
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/contributors",
"description": "A template for the API URL to list the contributors to the repository."
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/deployments",
"description": "The API URL to list the deployments of the repository."
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/downloads",
"description": "The API URL to list the downloads on the repository."
},
"events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/events",
"description": "The API URL to list the events of the repository."
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/forks",
"description": "The API URL to list the forks of the repository."
},
"git_commits_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"description": "A template for the API URL to get information about Git commits of the repository."
},
"git_refs_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"description": "A template for the API URL to get information about Git refs of the repository."
},
"git_tags_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"description": "A template for the API URL to get information about Git tags of the repository."
},
"issue_comment_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"description": "A template for the API URL to get information about issue comments on the repository."
},
"issue_events_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"description": "A template for the API URL to get information about issue events on the repository."
},
"issues_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"description": "A template for the API URL to get information about issues on the repository."
},
"keys_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"description": "A template for the API URL to get information about deploy keys on the repository."
},
"labels_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"description": "A template for the API URL to get information about labels of the repository."
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/languages",
"description": "The API URL to get information about the languages of the repository."
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/merges",
"description": "The API URL to merge branches in the repository."
},
"milestones_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"description": "A template for the API URL to get information about milestones of the repository."
},
"notifications_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"description": "A template for the API URL to get information about notifications on the repository."
},
"pulls_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"description": "A template for the API URL to get information about pull requests on the repository."
},
"releases_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"description": "A template for the API URL to get information about releases on the repository."
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"description": "The API URL to list the stargazers on the repository."
},
"statuses_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"description": "A template for the API URL to get information about statuses of a commit."
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"description": "The API URL to list the subscribers on the repository."
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/subscription",
"description": "The API URL to subscribe to notifications for this repository."
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/tags",
"description": "The API URL to get information about tags on the repository."
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/teams",
"description": "The API URL to list the teams on the repository."
},
"trees_url": {
"type": "string",
"example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"description": "A template for the API URL to create or retrieve a raw Git tree of the repository."
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/hooks",
"description": "The API URL to list the hooks on the repository."
}
},
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url"
]
}
],
"readOnly": true,
"nullable": true,
"description": "A temporary private fork of the advisory's repository for collaborating on a fix."
}
},
"required": [
"ghsa_id",
"cve_id",
"url",
"html_url",
"summary",
"description",
"severity",
"author",
"publisher",
"identifiers",
"state",
"created_at",
"updated_at",
"published_at",
"closed_at",
"withdrawn_at",
"submission",
"vulnerabilities",
"cvss",
"cwes",
"cwe_ids",
"credits",
"credits_detailed",
"collaborating_users",
"collaborating_teams",
"private_fork"
],
"additionalProperties": false
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('securityAdvisoriesCreateRepositoryAdvisory', {
# Add required parameters here
})