Documentation
¶
Index ¶
- type EnterprisesRequestBuilder
- type ItemDependabotAlertsRequestBuilder
- type ItemDependabotAlertsRequestBuilderGetQueryParameters
- type ItemDependabotRequestBuilder
- type ItemSecretScanningAlertsRequestBuilder
- func (m *ItemSecretScanningAlertsRequestBuilder) Get(ctx context.Context, ...) (...)
- func (m *ItemSecretScanningAlertsRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ItemSecretScanningAlertsRequestBuilder) WithUrl(rawUrl string) *ItemSecretScanningAlertsRequestBuilder
- type ItemSecretScanningAlertsRequestBuilderGetQueryParameters
- type ItemSecretScanningRequestBuilder
- type WithEnterpriseItemRequestBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EnterprisesRequestBuilder ¶
type EnterprisesRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
EnterprisesRequestBuilder builds and executes requests for operations under \enterprises
func NewEnterprisesRequestBuilder ¶
func NewEnterprisesRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *EnterprisesRequestBuilder
NewEnterprisesRequestBuilder instantiates a new EnterprisesRequestBuilder and sets the default values.
func NewEnterprisesRequestBuilderInternal ¶
func NewEnterprisesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *EnterprisesRequestBuilder
NewEnterprisesRequestBuilderInternal instantiates a new EnterprisesRequestBuilder and sets the default values.
func (*EnterprisesRequestBuilder) ByEnterprise ¶
func (m *EnterprisesRequestBuilder) ByEnterprise(enterprise string) *WithEnterpriseItemRequestBuilder
ByEnterprise gets an item from the github.com/octokit/go-sdk/pkg/github/.enterprises.item collection returns a *WithEnterpriseItemRequestBuilder when successful
type ItemDependabotAlertsRequestBuilder ¶
type ItemDependabotAlertsRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemDependabotAlertsRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\dependabot\alerts
func NewItemDependabotAlertsRequestBuilder ¶
func NewItemDependabotAlertsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotAlertsRequestBuilder
NewItemDependabotAlertsRequestBuilder instantiates a new ItemDependabotAlertsRequestBuilder and sets the default values.
func NewItemDependabotAlertsRequestBuilderInternal ¶
func NewItemDependabotAlertsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotAlertsRequestBuilder
NewItemDependabotAlertsRequestBuilderInternal instantiates a new ItemDependabotAlertsRequestBuilder and sets the default values.
func (*ItemDependabotAlertsRequestBuilder) Get ¶
func (m *ItemDependabotAlertsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemDependabotAlertsRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.DependabotAlertWithRepositoryable, error)
Get lists Dependabot alerts for repositories that are owned by the specified enterprise.The authenticated user must be a member of the enterprise to use this endpoint.Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. returns a []DependabotAlertWithRepositoryable when successful returns a BasicError error when the service returns a 403 status code returns a BasicError error when the service returns a 404 status code returns a ValidationErrorSimple error when the service returns a 422 status code API method documentation
func (*ItemDependabotAlertsRequestBuilder) ToGetRequestInformation ¶
func (m *ItemDependabotAlertsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemDependabotAlertsRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation lists Dependabot alerts for repositories that are owned by the specified enterprise.The authenticated user must be a member of the enterprise to use this endpoint.Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. returns a *RequestInformation when successful
func (*ItemDependabotAlertsRequestBuilder) WithUrl ¶
func (m *ItemDependabotAlertsRequestBuilder) WithUrl(rawUrl string) *ItemDependabotAlertsRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemDependabotAlertsRequestBuilder when successful
type ItemDependabotAlertsRequestBuilderGetQueryParameters ¶
type ItemDependabotAlertsRequestBuilderGetQueryParameters struct { // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." After *string `uriparametername:"after"` // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Before *string `uriparametername:"before"` // The direction to sort the results by. Direction *i77c38d6454f4c9dc55005405729b416470b652fa12f001a040f72bc1395cc732.GetDirectionQueryParameterType `uriparametername:"direction"` // A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` Ecosystem *string `uriparametername:"ecosystem"` // **Deprecated**. The number of results per page (max 100), starting from the first matching result.This parameter must not be used in combination with `last`.Instead, use `per_page` in combination with `after` to fetch the first page of results. First *int32 `uriparametername:"first"` // **Deprecated**. The number of results per page (max 100), starting from the last matching result.This parameter must not be used in combination with `first`.Instead, use `per_page` in combination with `before` to fetch the last page of results. Last *int32 `uriparametername:"last"` // A comma-separated list of package names. If specified, only alerts for these packages will be returned. Package *string `uriparametername:"package"` // The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` // The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. Scope *i77c38d6454f4c9dc55005405729b416470b652fa12f001a040f72bc1395cc732.GetScopeQueryParameterType `uriparametername:"scope"` // A comma-separated list of severities. If specified, only alerts with these severities will be returned.Can be: `low`, `medium`, `high`, `critical` Severity *string `uriparametername:"severity"` // The property by which to sort the results.`created` means when the alert was created.`updated` means when the alert's state last changed. Sort *i77c38d6454f4c9dc55005405729b416470b652fa12f001a040f72bc1395cc732.GetSortQueryParameterType `uriparametername:"sort"` // A comma-separated list of states. If specified, only alerts with these states will be returned.Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` State *string `uriparametername:"state"` }
ItemDependabotAlertsRequestBuilderGetQueryParameters lists Dependabot alerts for repositories that are owned by the specified enterprise.The authenticated user must be a member of the enterprise to use this endpoint.Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
type ItemDependabotRequestBuilder ¶
type ItemDependabotRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemDependabotRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\dependabot
func NewItemDependabotRequestBuilder ¶
func NewItemDependabotRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotRequestBuilder
NewItemDependabotRequestBuilder instantiates a new ItemDependabotRequestBuilder and sets the default values.
func NewItemDependabotRequestBuilderInternal ¶
func NewItemDependabotRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotRequestBuilder
NewItemDependabotRequestBuilderInternal instantiates a new ItemDependabotRequestBuilder and sets the default values.
func (*ItemDependabotRequestBuilder) Alerts ¶
func (m *ItemDependabotRequestBuilder) Alerts() *ItemDependabotAlertsRequestBuilder
Alerts the alerts property returns a *ItemDependabotAlertsRequestBuilder when successful
type ItemSecretScanningAlertsRequestBuilder ¶
type ItemSecretScanningAlertsRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemSecretScanningAlertsRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\secret-scanning\alerts
func NewItemSecretScanningAlertsRequestBuilder ¶
func NewItemSecretScanningAlertsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningAlertsRequestBuilder
NewItemSecretScanningAlertsRequestBuilder instantiates a new ItemSecretScanningAlertsRequestBuilder and sets the default values.
func NewItemSecretScanningAlertsRequestBuilderInternal ¶
func NewItemSecretScanningAlertsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningAlertsRequestBuilder
NewItemSecretScanningAlertsRequestBuilderInternal instantiates a new ItemSecretScanningAlertsRequestBuilder and sets the default values.
func (*ItemSecretScanningAlertsRequestBuilder) Get ¶
func (m *ItemSecretScanningAlertsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemSecretScanningAlertsRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.OrganizationSecretScanningAlertable, error)
Get lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).The authenticated user must be a member of the enterprise in order to use this endpoint.OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. returns a []OrganizationSecretScanningAlertable when successful returns a BasicError error when the service returns a 404 status code returns a Alerts503Error error when the service returns a 503 status code API method documentation
func (*ItemSecretScanningAlertsRequestBuilder) ToGetRequestInformation ¶
func (m *ItemSecretScanningAlertsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemSecretScanningAlertsRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).The authenticated user must be a member of the enterprise in order to use this endpoint.OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. returns a *RequestInformation when successful
func (*ItemSecretScanningAlertsRequestBuilder) WithUrl ¶
func (m *ItemSecretScanningAlertsRequestBuilder) WithUrl(rawUrl string) *ItemSecretScanningAlertsRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemSecretScanningAlertsRequestBuilder when successful
type ItemSecretScanningAlertsRequestBuilderGetQueryParameters ¶
type ItemSecretScanningAlertsRequestBuilderGetQueryParameters struct { // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." After *string `uriparametername:"after"` // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Before *string `uriparametername:"before"` // The direction to sort the results by. Direction *i001db24e943d0f84422b7e2ee3ebec420ca587ebd5e378cf50225876c7468a70.GetDirectionQueryParameterType `uriparametername:"direction"` // The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` // A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. Resolution *string `uriparametername:"resolution"` // A comma-separated list of secret types to return. By default all secret types are returned.See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"for a complete list of secret types. Secret_type *string `uriparametername:"secret_type"` // The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. Sort *i001db24e943d0f84422b7e2ee3ebec420ca587ebd5e378cf50225876c7468a70.GetSortQueryParameterType `uriparametername:"sort"` // Set to `open` or `resolved` to only list secret scanning alerts in a specific state. State *i001db24e943d0f84422b7e2ee3ebec420ca587ebd5e378cf50225876c7468a70.GetStateQueryParameterType `uriparametername:"state"` // A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. Validity *string `uriparametername:"validity"` }
ItemSecretScanningAlertsRequestBuilderGetQueryParameters lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).The authenticated user must be a member of the enterprise in order to use this endpoint.OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
type ItemSecretScanningRequestBuilder ¶
type ItemSecretScanningRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemSecretScanningRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\secret-scanning
func NewItemSecretScanningRequestBuilder ¶
func NewItemSecretScanningRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningRequestBuilder
NewItemSecretScanningRequestBuilder instantiates a new ItemSecretScanningRequestBuilder and sets the default values.
func NewItemSecretScanningRequestBuilderInternal ¶
func NewItemSecretScanningRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningRequestBuilder
NewItemSecretScanningRequestBuilderInternal instantiates a new ItemSecretScanningRequestBuilder and sets the default values.
func (*ItemSecretScanningRequestBuilder) Alerts ¶
func (m *ItemSecretScanningRequestBuilder) Alerts() *ItemSecretScanningAlertsRequestBuilder
Alerts the alerts property returns a *ItemSecretScanningAlertsRequestBuilder when successful
type WithEnterpriseItemRequestBuilder ¶
type WithEnterpriseItemRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
WithEnterpriseItemRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}
func NewWithEnterpriseItemRequestBuilder ¶
func NewWithEnterpriseItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *WithEnterpriseItemRequestBuilder
NewWithEnterpriseItemRequestBuilder instantiates a new WithEnterpriseItemRequestBuilder and sets the default values.
func NewWithEnterpriseItemRequestBuilderInternal ¶
func NewWithEnterpriseItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *WithEnterpriseItemRequestBuilder
NewWithEnterpriseItemRequestBuilderInternal instantiates a new WithEnterpriseItemRequestBuilder and sets the default values.
func (*WithEnterpriseItemRequestBuilder) Dependabot ¶
func (m *WithEnterpriseItemRequestBuilder) Dependabot() *ItemDependabotRequestBuilder
Dependabot the dependabot property returns a *ItemDependabotRequestBuilder when successful
func (*WithEnterpriseItemRequestBuilder) SecretScanning ¶
func (m *WithEnterpriseItemRequestBuilder) SecretScanning() *ItemSecretScanningRequestBuilder
SecretScanning the secretScanning property returns a *ItemSecretScanningRequestBuilder when successful