package
1.0.2003
Repository: https://github.com/estafette/estafette-ci-api.git
Documentation: pkg.go.dev

# Functions

Filters returns all allowed values for FilterType.
No description provided by the author
No description provided by the author
No description provided by the author
GetCachedGoogleJWK returns google's json web keys from cache or fetches them from source.
No description provided by the author
GetFilters extracts specific filter parameters specified according to https://jsonapi.org/format/.
GetGenericFilter extracts a filter.
No description provided by the author
GetLabelsFilter extracts a filter to select specific labels.
GetLastFilter extracts a filter to select last n items.
No description provided by the author
GetPagedListResponse runs a paged item query and a count query in parallel and returns them as a ListResponse.
GetPageNumber extracts pagination parameters specified according to https://jsonapi.org/format/.
GetPageSize extracts pagination parameters specified according to https://jsonapi.org/format/.
No description provided by the author
No description provided by the author
GetQueryParameters extracts query parameters specified according to https://jsonapi.org/format/.
No description provided by the author
GetSinceFilter extracts a filter on build/release date.
GetSorting extracts sorting parameters specified according to https://jsonapi.org/format/.
No description provided by the author
GetStatusFilter extracts a filter on status.
No description provided by the author
InjectCommands injects configured commands.
InjectStages injects some mandatory and configured stages.
LogTargetArrayContains returns true of a value is present in the array.
NewAuthMiddleware returns a new api.AuthMiddleware.
NewConfigReader returns a new config.ConfigReader.
No description provided by the author
No description provided by the author
NewWarningHelper returns a new estafette.WarningHelper.
OpenTracingMiddleware creates a span for each request.
No description provided by the author
No description provided by the author
Permissions returns all allowed values for Permission.
No description provided by the author
No description provided by the author
RequestTokenHasSomeRole checks whether the request has at least one of a list of roles.
No description provided by the author
Roles returns all allowed values for Role.
SetPermissionsFilters adds permission related filters for groups and organizations.
StringArrayContains returns true of a value is present in the array.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RoleAdministrator can configure role-based-access-control.
RoleCatalogEntitiesAdmin allows to view, create, update and delete catalog entities.
RoleCatalogEntitiesViewer allows to view all catalog entities.
RoleClientAdmin allows to view, create and update clients.
RoleClientViewer allows to view clients.
RoleCronTrigger can send a cron event.
RoleGroupAdmin allows to view, create and update groups.
RoleGroupPipelinesOperator allows to operate all pipelines linked to a group.
RoleGroupPipelinesViewer allows to view all pipelines linked to a group.
RoleGroupViewer allows to view groups.
RoleLogMigrator is needed to migrate logs from db to cloud storage and vice versa.
RoleOrganizationAdmin allows to view, create and update organizations.
RoleOrganizationPipelinesOperator allows to operate all pipelines linked to an organization.
RoleOrganizationPipelinesViewer allows to view all pipelines linked to an organization.
RoleOrganizationViewer allows to view organizations.
RoleRoleViewer allows to view available roles.
RoleUserAdmin allows to view, create and update users.
RoleUserViewer allows to view users.

# Variables

No description provided by the author
No description provided by the author
ErrInvalidSigningAlgorithm indicates signing algorithm is invalid, needs to be HS256, HS384, HS512, RS256, RS384 or RS512.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
APIConfig represent the configuration for the entire api application.
APIConfigIntegrations contains config for 3rd party integrations.
APIServerConfig represents configuration for the api server.
AuthConfig determines whether to use IAP for authentication and authorization.
AuthOrganizationConfig configures things relevant to each organization using the system.
BigQueryConfig configures the dataset where to send bigquery events.
BitbucketConfig is used to configure bitbucket integration.
CatalogConfig configures various aspect of the catalog page.
CloudSourceConfig is used to configure cloudSource integration.
CloudStorageConfig is used to configure a google cloud storage bucket to be used to store logs.
DatabaseConfig contains config for the dabase connection.
GithubConfig is used to configure github integration.
GoogleJSONWebKey is the Google JWT json web key to represent the public key of the key used to encrypt the Google JWT.
GoogleJWKResponse as returned by https://www.googleapis.com/oauth2/v3/certs.
IAPJSONWebKey is the IAP JWT json web key to represent the public key of the key used to encrypt the IAP JWT.
IAPJWKResponse as returned by https://www.gstatic.com/iap/verify/public_key-jwk.
No description provided by the author
No description provided by the author
No description provided by the author
InstallationOrganizations is used to assign organizations to builds triggered through a specific installation.
JobsConfig configures the lower and upper bounds for automatically setting resources for build/release jobs.
JWTConfig is used to configure JWT middleware.
OAuthProvider is used to configure one or more oauth providers like google, github.
OAuthProviderInfo provides non configurable information for oauth providers.
OrderField determines sorting direction.
OwnerOrganizations is used to assign organizations to builds triggered through a specific owner.
ProjectOrganizations is used to assign organizations to builds triggered through a specific project.
PrometheusConfig configures where to find prometheus for retrieving max cpu and memory consumption of build and release jobs.
PubsubConfig is used to be able to subscribe to pub/sub topics for triggering pipelines based on pub/sub events.
QueueConfig contains config for the dabase connection.
SlackConfig is used to configure slack integration.

# Interfaces

ConfigReader reads the api config from file.
Middleware handles authentication for routes requiring authentication.
WarningHelper checks whether any warnings should be issued.

# Type aliases

No description provided by the author
No description provided by the author
Permissions are used to secure endpoints; each role maps to one or more permissions.
Role is used to hand out permissions to users and clients.