View Source GitHub.SecurityAdvisories (GitHub REST API Client v0.0.8)
Provides API endpoints related to security advisories
Link to this section Summary
Functions
Privately report a security vulnerability
Create a repository security advisory
Get a repository security advisory
List repository security advisories
Update a repository security advisory
Link to this section Functions
Link to this function
create_private_vulnerability_report(owner, repo, body, opts \\ [])
View Source@spec create_private_vulnerability_report( String.t(), String.t(), GitHub.PrivateVulnerabilityReport.Create.t(), keyword() ) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Privately report a security vulnerability
resources
Resources
@spec create_repository_advisory( String.t(), String.t(), GitHub.Repository.Advisory.Create.t(), keyword() ) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Create a repository security advisory
resources
Resources
@spec get_repository_advisory(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Get a repository security advisory
resources
Resources
@spec list_repository_advisories(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Repository.Advisory.t()]} | {:error, GitHub.Error.t()}
List repository security advisories
options
Options
direction
(String.t()): The direction to sort the results by.sort
(String.t()): The property to sort the results by.before
(String.t()): A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.after
(String.t()): A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.per_page
(integer): Number of advisories to return per page.state
(String.t()): Filter by state of the repository advisories. Only advisories of this state will be returned.
resources
Resources
Link to this function
update_repository_advisory(owner, repo, ghsa_id, body, opts \\ [])
View Source@spec update_repository_advisory( String.t(), String.t(), String.t(), GitHub.Repository.Advisory.Update.t(), keyword() ) :: {:ok, GitHub.Repository.Advisory.t()} | {:error, GitHub.Error.t()}
Update a repository security advisory