Struct roctogen::endpoints::secret_scanning::SecretScanning[−][src]

pub struct SecretScanning<'api> { /* fields omitted */ }

Implementations

impl<'api> SecretScanning<'api>[src]

pub async fn get_alert_async(
    &self,
    owner: &str,
    repo: &str,
    alert_number: AlertNumber
) -> Result<SecretScanningAlert, SecretScanningGetAlertError>[src]

Get a secret scanning alert

Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GitHub API docs for get_alert

pub fn get_alert(
    &self,
    owner: &str,
    repo: &str,
    alert_number: AlertNumber
) -> Result<SecretScanningAlert, SecretScanningGetAlertError>[src]

Get a secret scanning alert

Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GitHub API docs for get_alert

pub async fn list_alerts_for_repo_async(
    &self,
    owner: &str,
    repo: &str,
    query_params: Option<impl Into<SecretScanningListAlertsForRepoParams<'api>>>
) -> Result<Vec<SecretScanningAlert>, SecretScanningListAlertsForRepoError>[src]

List secret scanning alerts for a repository

Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GitHub API docs for list_alerts_for_repo

pub fn list_alerts_for_repo(
    &self,
    owner: &str,
    repo: &str,
    query_params: Option<impl Into<SecretScanningListAlertsForRepoParams<'api>>>
) -> Result<Vec<SecretScanningAlert>, SecretScanningListAlertsForRepoError>[src]

List secret scanning alerts for a repository

Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

GitHub API docs for list_alerts_for_repo

pub async fn update_alert_async(
    &self,
    owner: &str,
    repo: &str,
    alert_number: AlertNumber,
    body: PatchSecretScanningUpdateAlert
) -> Result<SecretScanningAlert, SecretScanningUpdateAlertError>[src]

Update a secret scanning alert

Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

GitHub API docs for update_alert

pub fn update_alert(
    &self,
    owner: &str,
    repo: &str,
    alert_number: AlertNumber,
    body: PatchSecretScanningUpdateAlert
) -> Result<SecretScanningAlert, SecretScanningUpdateAlertError>[src]

Update a secret scanning alert

Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

GitHub API docs for update_alert

Auto Trait Implementations

impl<'api> RefUnwindSafe for SecretScanning<'api>

impl<'api> Send for SecretScanning<'api>

impl<'api> Sync for SecretScanning<'api>

impl<'api> Unpin for SecretScanning<'api>

impl<'api> UnwindSafe for SecretScanning<'api>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.