Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.
Index ¶
- Constants
- func GetSpec() (swagger *openapi3.T, err error)
- func GetSpecJSON() ([]byte, error)
- func GetSwagger() (*openapi3.T, error)deprecated
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router gin.IRouter, si ServerInterface)
- func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
- type AddTeamMemberRequest
- type AdminAuthProviderProfile
- type AdminAuthProviderProfilesLookupEmailRequest
- type AdminAuthProviderProfilesResolveRequest
- type AdminAuthProviderProfilesResponse
- type AdminAuthProviderUserBootstrapRequest
- type AdminTeamBootstrapRequest
- type BuildId
- type BuildIdOrTemplate
- type BuildIds
- type BuildInfo
- type BuildStatus
- type BuildStatusItem
- type BuildStatuses
- type BuildsCursor
- type BuildsLimit
- type BuildsListResponse
- type BuildsStatusesResponse
- type CPUCount
- type CreateTeamRequest
- type DefaultTemplate
- type DefaultTemplateAlias
- type DefaultTemplatesResponse
- type DiskSizeMB
- type Error
- type GetBuildsParams
- type GetBuildsStatusesParams
- type GetTeamsResolveParams
- type GetTemplatesParams
- type GetTemplatesParamsSort
- type GetTemplatesTemplateIDTagsExistsParams
- type GetTemplatesTemplateIDTagsGroupsParams
- type GetTemplatesTemplateIDTagsGroupsParamsSort
- type GetTemplatesTemplateIDTagsTagAssignmentsParams
- type GinServerOptions
- type HealthResponse
- type ListedBuild
- type MemoryMB
- type MiddlewareFunc
- type N400
- type N401
- type N403
- type N404
- type N409
- type N500
- type N502
- type PatchTeamsTeamIDJSONRequestBody
- type PostAdminTeamsBootstrapJSONRequestBody
- type PostAdminUserProfilesByEmailJSONRequestBody
- type PostAdminUserProfilesResolveJSONRequestBody
- type PostAdminUsersBootstrapJSONRequestBody
- type PostTeamsJSONRequestBody
- type PostTeamsTeamIDMembersJSONRequestBody
- type SandboxID
- type SandboxRecord
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) DeleteAdminUsersUserId(c *gin.Context)
- func (siw *ServerInterfaceWrapper) DeleteTeamsTeamIDMembersUserId(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetAdminUserProfilesUserId(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetBuilds(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetBuildsBuildId(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetBuildsStatuses(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetHealth(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetSandboxesSandboxIDRecord(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTeams(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTeamsResolve(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTeamsTeamIDMembers(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplates(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplatesDefaults(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplatesTemplateID(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsCount(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsExists(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsGroups(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsTagAssignments(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PatchTeamsTeamID(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostAdminTeamsBootstrap(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostAdminUserProfilesByEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostAdminUserProfilesResolve(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostAdminUsersBootstrap(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostTeams(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostTeamsTeamIDMembers(c *gin.Context)
- type Tag
- type TagAssignmentLimit
- type TagAssignmentsCursor
- type TagAssignmentsLimit
- type TagGroupsCursor
- type TagGroupsLimit
- type TagGroupsSearch
- type TagGroupsSort
- type TagPath
- type TeamID
- type TeamMember
- type TeamMembersResponse
- type TeamResolveResponse
- type TeamSlug
- type TeamTemplate
- type TeamTemplatesResponse
- type TemplateDetail
- type TemplateID
- type TemplateTagAssignment
- type TemplateTagAssignmentsResponse
- type TemplateTagExistsResponse
- type TemplateTagGroup
- type TemplateTagGroupsResponse
- type TemplateTagsCountResponse
- type TemplatesCursor
- type TemplatesLimit
- type TemplatesPublic
- type TemplatesSearch
- type TemplatesSort
- type UpdateTeamRequest
- type UpdateTeamResponse
- type UserId
- type UserTeam
- type UserTeamLimits
- type UserTeamsResponse
Constants ¶
const ( AdminApiKeyAuthScopes adminApiKeyAuthContextKey = "AdminApiKeyAuth.Scopes" AuthProviderBearerAuthScopes authProviderBearerAuthContextKey = "AuthProviderBearerAuth.Scopes" AuthProviderTeamAuthScopes authProviderTeamAuthContextKey = "AuthProviderTeamAuth.Scopes" )
Variables ¶
This section is empty.
Functions ¶
func GetSpec ¶
GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.
func GetSpecJSON ¶
GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.
func GetSwagger
deprecated
func PathToRawSpec ¶
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func RegisterHandlers ¶
func RegisterHandlers(router gin.IRouter, si ServerInterface)
RegisterHandlers creates http.Handler with routing matching OpenAPI spec.
func RegisterHandlersWithOptions ¶
func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
RegisterHandlersWithOptions creates http.Handler with additional options
Types ¶
type AddTeamMemberRequest ¶
type AddTeamMemberRequest struct {
Email openapi_types.Email `json:"email"`
}
AddTeamMemberRequest defines model for AddTeamMemberRequest.
type AdminAuthProviderProfile ¶
type AdminAuthProviderProfile struct {
// Email Email address from the configured auth provider.
Email *string `json:"email"`
// UserId Internal E2B user identifier.
UserId openapi_types.UUID `json:"userId"`
}
AdminAuthProviderProfile defines model for AdminAuthProviderProfile.
type AdminAuthProviderProfilesLookupEmailRequest ¶
type AdminAuthProviderProfilesLookupEmailRequest struct {
Email openapi_types.Email `json:"email"`
}
AdminAuthProviderProfilesLookupEmailRequest defines model for AdminAuthProviderProfilesLookupEmailRequest.
type AdminAuthProviderProfilesResolveRequest ¶
type AdminAuthProviderProfilesResolveRequest struct {
UserIds []openapi_types.UUID `json:"userIds"`
}
AdminAuthProviderProfilesResolveRequest defines model for AdminAuthProviderProfilesResolveRequest.
type AdminAuthProviderProfilesResponse ¶
type AdminAuthProviderProfilesResponse struct {
Profiles []AdminAuthProviderProfile `json:"profiles"`
}
AdminAuthProviderProfilesResponse defines model for AdminAuthProviderProfilesResponse.
type AdminAuthProviderUserBootstrapRequest ¶
type AdminAuthProviderUserBootstrapRequest struct {
OidcIssuer string `json:"oidc_issuer"`
OidcUserEmail openapi_types.Email `json:"oidc_user_email"`
OidcUserId string `json:"oidc_user_id"`
OidcUserName *string `json:"oidc_user_name,omitempty"`
SignupIp *string `json:"signup_ip,omitempty"`
SignupUserAgent *string `json:"signup_user_agent,omitempty"`
}
AdminAuthProviderUserBootstrapRequest defines model for AdminAuthProviderUserBootstrapRequest.
type AdminTeamBootstrapRequest ¶
type AdminTeamBootstrapRequest struct {
// Email Billing/contact email for the team.
Email openapi_types.Email `json:"email"`
// Name Team name.
Name string `json:"name"`
}
AdminTeamBootstrapRequest defines model for AdminTeamBootstrapRequest.
type BuildIdOrTemplate ¶
type BuildIdOrTemplate = string
BuildIdOrTemplate defines model for build_id_or_template.
type BuildInfo ¶
type BuildInfo struct {
// CreatedAt Build creation timestamp in RFC3339 format.
CreatedAt time.Time `json:"createdAt"`
// FinishedAt Build completion timestamp in RFC3339 format, if finished.
FinishedAt *time.Time `json:"finishedAt"`
// Names Template names related to this build, if available.
Names *[]string `json:"names,omitempty"`
// Status Build status mapped for dashboard clients.
Status BuildStatus `json:"status"`
// StatusMessage Failure message when status is `failed`, otherwise `null`.
StatusMessage *string `json:"statusMessage"`
}
BuildInfo defines model for BuildInfo.
type BuildStatus ¶
type BuildStatus string
BuildStatus Build status mapped for dashboard clients.
const ( Building BuildStatus = "building" Failed BuildStatus = "failed" Success BuildStatus = "success" )
Defines values for BuildStatus.
func (BuildStatus) Valid ¶
func (e BuildStatus) Valid() bool
Valid indicates whether the value is a known member of the BuildStatus enum.
type BuildStatusItem ¶
type BuildStatusItem struct {
// FinishedAt Build completion timestamp in RFC3339 format, if finished.
FinishedAt *time.Time `json:"finishedAt"`
// Id Identifier of the build.
Id openapi_types.UUID `json:"id"`
// Status Build status mapped for dashboard clients.
Status BuildStatus `json:"status"`
// StatusMessage Failure message when status is `failed`, otherwise `null`.
StatusMessage *string `json:"statusMessage"`
}
BuildStatusItem defines model for BuildStatusItem.
type BuildStatuses ¶
type BuildStatuses = []BuildStatus
BuildStatuses defines model for build_statuses.
type BuildsListResponse ¶
type BuildsListResponse struct {
Data []ListedBuild `json:"data"`
// NextCursor Cursor to pass to the next list request, or `null` if there is no next page.
NextCursor *string `json:"nextCursor"`
}
BuildsListResponse defines model for BuildsListResponse.
type BuildsStatusesResponse ¶
type BuildsStatusesResponse struct {
// BuildStatuses List of build statuses
BuildStatuses []BuildStatusItem `json:"buildStatuses"`
}
BuildsStatusesResponse defines model for BuildsStatusesResponse.
type CreateTeamRequest ¶
type CreateTeamRequest struct {
Name string `json:"name"`
}
CreateTeamRequest defines model for CreateTeamRequest.
type DefaultTemplate ¶
type DefaultTemplate struct {
Aliases []DefaultTemplateAlias `json:"aliases"`
BuildCount int32 `json:"buildCount"`
BuildId openapi_types.UUID `json:"buildId"`
CreatedAt time.Time `json:"createdAt"`
EnvdVersion *string `json:"envdVersion,omitempty"`
Id string `json:"id"`
Public bool `json:"public"`
RamMb int64 `json:"ramMb"`
SpawnCount int64 `json:"spawnCount"`
TotalDiskSizeMb *int64 `json:"totalDiskSizeMb"`
Vcpu int64 `json:"vcpu"`
}
DefaultTemplate defines model for DefaultTemplate.
type DefaultTemplateAlias ¶
type DefaultTemplateAlias struct {
Alias string `json:"alias"`
Namespace *string `json:"namespace,omitempty"`
}
DefaultTemplateAlias defines model for DefaultTemplateAlias.
type DefaultTemplatesResponse ¶
type DefaultTemplatesResponse struct {
Templates []DefaultTemplate `json:"templates"`
}
DefaultTemplatesResponse defines model for DefaultTemplatesResponse.
type Error ¶
type Error struct {
// Code Error code.
Code int32 `json:"code"`
// Message Error message.
Message string `json:"message"`
}
Error defines model for Error.
type GetBuildsParams ¶
type GetBuildsParams struct {
// BuildIdOrTemplate Optional filter by build identifier, template identifier, or template alias.
BuildIdOrTemplate *BuildIdOrTemplate `form:"build_id_or_template,omitempty" json:"build_id_or_template,omitempty"`
// Statuses Comma-separated list of build statuses to include.
Statuses *BuildStatuses `form:"statuses,omitempty" json:"statuses,omitempty"`
// Limit Maximum number of items to return per page.
Limit *BuildsLimit `form:"limit,omitempty" json:"limit,omitempty"`
// Cursor Cursor returned by the previous list response in `created_at|build_id` format.
Cursor *BuildsCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}
GetBuildsParams defines parameters for GetBuilds.
type GetBuildsStatusesParams ¶
type GetBuildsStatusesParams struct {
// BuildIds Comma-separated list of build IDs to get statuses for.
BuildIds BuildIds `form:"build_ids" json:"build_ids"`
}
GetBuildsStatusesParams defines parameters for GetBuildsStatuses.
type GetTeamsResolveParams ¶
type GetTeamsResolveParams struct {
// Slug Team slug to resolve.
Slug TeamSlug `form:"slug" json:"slug"`
}
GetTeamsResolveParams defines parameters for GetTeamsResolve.
type GetTemplatesParams ¶
type GetTemplatesParams struct {
// Public Filter templates by visibility (true = public, false = internal).
Public *TemplatesPublic `form:"public,omitempty" json:"public,omitempty"`
// Search Case-insensitive substring match on template names, aliases, and template id.
Search *TemplatesSearch `form:"search,omitempty" json:"search,omitempty"`
// Sort Sort column and direction.
Sort *GetTemplatesParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
// Limit Maximum number of items to return per page.
Limit *TemplatesLimit `form:"limit,omitempty" json:"limit,omitempty"`
// Cursor Cursor returned by the previous list response in `{sort}|{value}|{templateID}` format. Rejected if its sort does not match the request.
Cursor *TemplatesCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}
GetTemplatesParams defines parameters for GetTemplates.
type GetTemplatesParamsSort ¶
type GetTemplatesParamsSort string
GetTemplatesParamsSort defines parameters for GetTemplates.
const ( GetTemplatesParamsSortCreatedAtAsc GetTemplatesParamsSort = "created_at_asc" GetTemplatesParamsSortCreatedAtDesc GetTemplatesParamsSort = "created_at_desc" GetTemplatesParamsSortUpdatedAtAsc GetTemplatesParamsSort = "updated_at_asc" GetTemplatesParamsSortUpdatedAtDesc GetTemplatesParamsSort = "updated_at_desc" )
Defines values for GetTemplatesParamsSort.
func (GetTemplatesParamsSort) Valid ¶
func (e GetTemplatesParamsSort) Valid() bool
Valid indicates whether the value is a known member of the GetTemplatesParamsSort enum.
type GetTemplatesTemplateIDTagsExistsParams ¶
type GetTemplatesTemplateIDTagsExistsParams struct {
// Tag Template tag name to check.
Tag Tag `form:"tag" json:"tag"`
}
GetTemplatesTemplateIDTagsExistsParams defines parameters for GetTemplatesTemplateIDTagsExists.
type GetTemplatesTemplateIDTagsGroupsParams ¶
type GetTemplatesTemplateIDTagsGroupsParams struct {
// AssignmentLimit Maximum number of ready assignment rows to return per tag.
AssignmentLimit *TagAssignmentLimit `form:"assignmentLimit,omitempty" json:"assignmentLimit,omitempty"`
// TagsLimit Maximum number of distinct tags to return per page.
TagsLimit *TagGroupsLimit `form:"tagsLimit,omitempty" json:"tagsLimit,omitempty"`
// TagsCursor Cursor returned by the previous list response in `{sort}|{latest_assigned_at}|{tag}` format (sort-tagged, RFC3339Nano).
TagsCursor *TagGroupsCursor `form:"tagsCursor,omitempty" json:"tagsCursor,omitempty"`
// Search Case-insensitive substring filter on tag name. Allowed characters are `a-z`, `0-9`, `.`, `_`, `-`.
Search *TagGroupsSearch `form:"search,omitempty" json:"search,omitempty"`
// Sort Sort order for the returned tag groups.
Sort *GetTemplatesTemplateIDTagsGroupsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`
}
GetTemplatesTemplateIDTagsGroupsParams defines parameters for GetTemplatesTemplateIDTagsGroups.
type GetTemplatesTemplateIDTagsGroupsParamsSort ¶
type GetTemplatesTemplateIDTagsGroupsParamsSort string
GetTemplatesTemplateIDTagsGroupsParamsSort defines parameters for GetTemplatesTemplateIDTagsGroups.
const ( GetTemplatesTemplateIDTagsGroupsParamsSortLatestAsc GetTemplatesTemplateIDTagsGroupsParamsSort = "latest_asc" GetTemplatesTemplateIDTagsGroupsParamsSortLatestDesc GetTemplatesTemplateIDTagsGroupsParamsSort = "latest_desc" GetTemplatesTemplateIDTagsGroupsParamsSortNameAsc GetTemplatesTemplateIDTagsGroupsParamsSort = "name_asc" GetTemplatesTemplateIDTagsGroupsParamsSortNameDesc GetTemplatesTemplateIDTagsGroupsParamsSort = "name_desc" )
Defines values for GetTemplatesTemplateIDTagsGroupsParamsSort.
func (GetTemplatesTemplateIDTagsGroupsParamsSort) Valid ¶
func (e GetTemplatesTemplateIDTagsGroupsParamsSort) Valid() bool
Valid indicates whether the value is a known member of the GetTemplatesTemplateIDTagsGroupsParamsSort enum.
type GetTemplatesTemplateIDTagsTagAssignmentsParams ¶
type GetTemplatesTemplateIDTagsTagAssignmentsParams struct {
// Cursor Cursor returned by the previous list response in `assigned_at|assignment_id` format.
Cursor *TagAssignmentsCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
// Limit Maximum number of assignment rows to return per page.
Limit *TagAssignmentsLimit `form:"limit,omitempty" json:"limit,omitempty"`
}
GetTemplatesTemplateIDTagsTagAssignmentsParams defines parameters for GetTemplatesTemplateIDTagsTagAssignments.
type GinServerOptions ¶
type GinServerOptions struct {
BaseURL string
Middlewares []MiddlewareFunc
ErrorHandler func(*gin.Context, error, int)
}
GinServerOptions provides options for the Gin server.
type HealthResponse ¶
type HealthResponse struct {
// Message Human-readable health check result.
Message string `json:"message"`
}
HealthResponse defines model for HealthResponse.
type ListedBuild ¶
type ListedBuild struct {
// CpuCount CPU cores configured for the build.
CpuCount int64 `json:"cpuCount"`
// CreatedAt Build creation timestamp in RFC3339 format.
CreatedAt time.Time `json:"createdAt"`
// DiskSizeMB Disk size in MiB configured for the build, if recorded.
DiskSizeMB *int64 `json:"diskSizeMB"`
// EnvdVersion envd version the build was created with, if recorded.
EnvdVersion *string `json:"envdVersion"`
// FinishedAt Build completion timestamp in RFC3339 format, if finished.
FinishedAt *time.Time `json:"finishedAt"`
// Id Identifier of the build.
Id openapi_types.UUID `json:"id"`
// MemoryMB Memory in MiB configured for the build.
MemoryMB int64 `json:"memoryMB"`
// Status Build status mapped for dashboard clients.
Status BuildStatus `json:"status"`
// StatusMessage Failure message when status is `failed`, otherwise `null`.
StatusMessage *string `json:"statusMessage"`
// Template Template alias when present, otherwise template ID.
Template string `json:"template"`
// TemplateId Identifier of the template.
TemplateId string `json:"templateId"`
}
ListedBuild defines model for ListedBuild.
type MiddlewareFunc ¶
type PatchTeamsTeamIDJSONRequestBody ¶
type PatchTeamsTeamIDJSONRequestBody = UpdateTeamRequest
PatchTeamsTeamIDJSONRequestBody defines body for PatchTeamsTeamID for application/json ContentType.
type PostAdminTeamsBootstrapJSONRequestBody ¶
type PostAdminTeamsBootstrapJSONRequestBody = AdminTeamBootstrapRequest
PostAdminTeamsBootstrapJSONRequestBody defines body for PostAdminTeamsBootstrap for application/json ContentType.
type PostAdminUserProfilesByEmailJSONRequestBody ¶
type PostAdminUserProfilesByEmailJSONRequestBody = AdminAuthProviderProfilesLookupEmailRequest
PostAdminUserProfilesByEmailJSONRequestBody defines body for PostAdminUserProfilesByEmail for application/json ContentType.
type PostAdminUserProfilesResolveJSONRequestBody ¶
type PostAdminUserProfilesResolveJSONRequestBody = AdminAuthProviderProfilesResolveRequest
PostAdminUserProfilesResolveJSONRequestBody defines body for PostAdminUserProfilesResolve for application/json ContentType.
type PostAdminUsersBootstrapJSONRequestBody ¶
type PostAdminUsersBootstrapJSONRequestBody = AdminAuthProviderUserBootstrapRequest
PostAdminUsersBootstrapJSONRequestBody defines body for PostAdminUsersBootstrap for application/json ContentType.
type PostTeamsJSONRequestBody ¶
type PostTeamsJSONRequestBody = CreateTeamRequest
PostTeamsJSONRequestBody defines body for PostTeams for application/json ContentType.
type PostTeamsTeamIDMembersJSONRequestBody ¶
type PostTeamsTeamIDMembersJSONRequestBody = AddTeamMemberRequest
PostTeamsTeamIDMembersJSONRequestBody defines body for PostTeamsTeamIDMembers for application/json ContentType.
type SandboxRecord ¶
type SandboxRecord struct {
// Alias Alias of the template
Alias *string `json:"alias,omitempty"`
// CpuCount CPU cores for the sandbox
CpuCount CPUCount `json:"cpuCount"`
// DiskSizeMB Disk size for the sandbox in MiB
DiskSizeMB DiskSizeMB `json:"diskSizeMB"`
// Domain Base domain where the sandbox traffic is accessible
Domain *string `json:"domain,omitempty"`
// EventsRetentionExpired Whether the sandbox ended more than the team's events retention window ago, so its events data is no longer available. Best-effort - computed from the team's current retention limit, which may differ from the retention stamped on events written before a limit change.
EventsRetentionExpired bool `json:"eventsRetentionExpired"`
// MemoryMB Memory for the sandbox in MiB
MemoryMB MemoryMB `json:"memoryMB"`
// RetentionExpired Whether the sandbox ended more than the fixed retention window ago, so its monitoring and logs data is no longer available
RetentionExpired bool `json:"retentionExpired"`
// SandboxID Identifier of the sandbox
SandboxID string `json:"sandboxID"`
// StartedAt Time when the sandbox was started
StartedAt time.Time `json:"startedAt"`
// StoppedAt Time when the sandbox was stopped
StoppedAt *time.Time `json:"stoppedAt,omitempty"`
// TemplateID Identifier of the template from which is the sandbox created
TemplateID string `json:"templateID"`
}
SandboxRecord defines model for SandboxRecord.
type ServerInterface ¶
type ServerInterface interface {
// Bootstrap team
// (POST /admin/teams/bootstrap)
PostAdminTeamsBootstrap(c *gin.Context)
// Lookup user profiles by email
// (POST /admin/user-profiles/by-email)
PostAdminUserProfilesByEmail(c *gin.Context)
// Resolve user profiles
// (POST /admin/user-profiles/resolve)
PostAdminUserProfilesResolve(c *gin.Context)
// User profile
// (GET /admin/user-profiles/{userId})
GetAdminUserProfilesUserId(c *gin.Context, userId UserId)
// Bootstrap auth provider user
// (POST /admin/users/bootstrap)
PostAdminUsersBootstrap(c *gin.Context)
// Delete user
// (DELETE /admin/users/{userId})
DeleteAdminUsersUserId(c *gin.Context, userId UserId)
// List team builds
// (GET /builds)
GetBuilds(c *gin.Context, params GetBuildsParams)
// Build statuses
// (GET /builds/statuses)
GetBuildsStatuses(c *gin.Context, params GetBuildsStatusesParams)
// Build details
// (GET /builds/{build_id})
GetBuildsBuildId(c *gin.Context, buildId BuildId)
// Health check
// (GET /health)
GetHealth(c *gin.Context)
// Sandbox record
// (GET /sandboxes/{sandboxID}/record)
GetSandboxesSandboxIDRecord(c *gin.Context, sandboxID SandboxID)
// List user teams
// (GET /teams)
GetTeams(c *gin.Context)
// Create team
// (POST /teams)
PostTeams(c *gin.Context)
// Resolve team identity
// (GET /teams/resolve)
GetTeamsResolve(c *gin.Context, params GetTeamsResolveParams)
// Update team
// (PATCH /teams/{teamID})
PatchTeamsTeamID(c *gin.Context, teamID TeamID)
// List team members
// (GET /teams/{teamID}/members)
GetTeamsTeamIDMembers(c *gin.Context, teamID TeamID)
// Add team member
// (POST /teams/{teamID}/members)
PostTeamsTeamIDMembers(c *gin.Context, teamID TeamID)
// Remove team member
// (DELETE /teams/{teamID}/members/{userId})
DeleteTeamsTeamIDMembersUserId(c *gin.Context, teamID TeamID, userId UserId)
// List team templates
// (GET /templates)
GetTemplates(c *gin.Context, params GetTemplatesParams)
// List default templates
// (GET /templates/defaults)
GetTemplatesDefaults(c *gin.Context)
// Template
// (GET /templates/{templateID})
GetTemplatesTemplateID(c *gin.Context, templateID TemplateID)
// Count template tags
// (GET /templates/{templateID}/tags/count)
GetTemplatesTemplateIDTagsCount(c *gin.Context, templateID TemplateID)
// Check ready template tag existence
// (GET /templates/{templateID}/tags/exists)
GetTemplatesTemplateIDTagsExists(c *gin.Context, templateID TemplateID, params GetTemplatesTemplateIDTagsExistsParams)
// List template tag groups
// (GET /templates/{templateID}/tags/groups)
GetTemplatesTemplateIDTagsGroups(c *gin.Context, templateID TemplateID, params GetTemplatesTemplateIDTagsGroupsParams)
// List ready assignments for a single template tag
// (GET /templates/{templateID}/tags/{tag}/assignments)
GetTemplatesTemplateIDTagsTagAssignments(c *gin.Context, templateID TemplateID, tag TagPath, params GetTemplatesTemplateIDTagsTagAssignmentsParams)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandler func(*gin.Context, error, int)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) DeleteAdminUsersUserId ¶
func (siw *ServerInterfaceWrapper) DeleteAdminUsersUserId(c *gin.Context)
DeleteAdminUsersUserId operation middleware
func (*ServerInterfaceWrapper) DeleteTeamsTeamIDMembersUserId ¶
func (siw *ServerInterfaceWrapper) DeleteTeamsTeamIDMembersUserId(c *gin.Context)
DeleteTeamsTeamIDMembersUserId operation middleware
func (*ServerInterfaceWrapper) GetAdminUserProfilesUserId ¶
func (siw *ServerInterfaceWrapper) GetAdminUserProfilesUserId(c *gin.Context)
GetAdminUserProfilesUserId operation middleware
func (*ServerInterfaceWrapper) GetBuilds ¶
func (siw *ServerInterfaceWrapper) GetBuilds(c *gin.Context)
GetBuilds operation middleware
func (*ServerInterfaceWrapper) GetBuildsBuildId ¶
func (siw *ServerInterfaceWrapper) GetBuildsBuildId(c *gin.Context)
GetBuildsBuildId operation middleware
func (*ServerInterfaceWrapper) GetBuildsStatuses ¶
func (siw *ServerInterfaceWrapper) GetBuildsStatuses(c *gin.Context)
GetBuildsStatuses operation middleware
func (*ServerInterfaceWrapper) GetHealth ¶
func (siw *ServerInterfaceWrapper) GetHealth(c *gin.Context)
GetHealth operation middleware
func (*ServerInterfaceWrapper) GetSandboxesSandboxIDRecord ¶
func (siw *ServerInterfaceWrapper) GetSandboxesSandboxIDRecord(c *gin.Context)
GetSandboxesSandboxIDRecord operation middleware
func (*ServerInterfaceWrapper) GetTeams ¶
func (siw *ServerInterfaceWrapper) GetTeams(c *gin.Context)
GetTeams operation middleware
func (*ServerInterfaceWrapper) GetTeamsResolve ¶
func (siw *ServerInterfaceWrapper) GetTeamsResolve(c *gin.Context)
GetTeamsResolve operation middleware
func (*ServerInterfaceWrapper) GetTeamsTeamIDMembers ¶
func (siw *ServerInterfaceWrapper) GetTeamsTeamIDMembers(c *gin.Context)
GetTeamsTeamIDMembers operation middleware
func (*ServerInterfaceWrapper) GetTemplates ¶
func (siw *ServerInterfaceWrapper) GetTemplates(c *gin.Context)
GetTemplates operation middleware
func (*ServerInterfaceWrapper) GetTemplatesDefaults ¶
func (siw *ServerInterfaceWrapper) GetTemplatesDefaults(c *gin.Context)
GetTemplatesDefaults operation middleware
func (*ServerInterfaceWrapper) GetTemplatesTemplateID ¶
func (siw *ServerInterfaceWrapper) GetTemplatesTemplateID(c *gin.Context)
GetTemplatesTemplateID operation middleware
func (*ServerInterfaceWrapper) GetTemplatesTemplateIDTagsCount ¶
func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsCount(c *gin.Context)
GetTemplatesTemplateIDTagsCount operation middleware
func (*ServerInterfaceWrapper) GetTemplatesTemplateIDTagsExists ¶
func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsExists(c *gin.Context)
GetTemplatesTemplateIDTagsExists operation middleware
func (*ServerInterfaceWrapper) GetTemplatesTemplateIDTagsGroups ¶
func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsGroups(c *gin.Context)
GetTemplatesTemplateIDTagsGroups operation middleware
func (*ServerInterfaceWrapper) GetTemplatesTemplateIDTagsTagAssignments ¶
func (siw *ServerInterfaceWrapper) GetTemplatesTemplateIDTagsTagAssignments(c *gin.Context)
GetTemplatesTemplateIDTagsTagAssignments operation middleware
func (*ServerInterfaceWrapper) PatchTeamsTeamID ¶
func (siw *ServerInterfaceWrapper) PatchTeamsTeamID(c *gin.Context)
PatchTeamsTeamID operation middleware
func (*ServerInterfaceWrapper) PostAdminTeamsBootstrap ¶
func (siw *ServerInterfaceWrapper) PostAdminTeamsBootstrap(c *gin.Context)
PostAdminTeamsBootstrap operation middleware
func (*ServerInterfaceWrapper) PostAdminUserProfilesByEmail ¶
func (siw *ServerInterfaceWrapper) PostAdminUserProfilesByEmail(c *gin.Context)
PostAdminUserProfilesByEmail operation middleware
func (*ServerInterfaceWrapper) PostAdminUserProfilesResolve ¶
func (siw *ServerInterfaceWrapper) PostAdminUserProfilesResolve(c *gin.Context)
PostAdminUserProfilesResolve operation middleware
func (*ServerInterfaceWrapper) PostAdminUsersBootstrap ¶
func (siw *ServerInterfaceWrapper) PostAdminUsersBootstrap(c *gin.Context)
PostAdminUsersBootstrap operation middleware
func (*ServerInterfaceWrapper) PostTeams ¶
func (siw *ServerInterfaceWrapper) PostTeams(c *gin.Context)
PostTeams operation middleware
func (*ServerInterfaceWrapper) PostTeamsTeamIDMembers ¶
func (siw *ServerInterfaceWrapper) PostTeamsTeamIDMembers(c *gin.Context)
PostTeamsTeamIDMembers operation middleware
type TagAssignmentLimit ¶
type TagAssignmentLimit = int32
TagAssignmentLimit defines model for tag_assignment_limit.
type TagAssignmentsCursor ¶
type TagAssignmentsCursor = string
TagAssignmentsCursor defines model for tag_assignments_cursor.
type TagAssignmentsLimit ¶
type TagAssignmentsLimit = int32
TagAssignmentsLimit defines model for tag_assignments_limit.
type TagGroupsCursor ¶
type TagGroupsCursor = string
TagGroupsCursor defines model for tag_groups_cursor.
type TagGroupsLimit ¶
type TagGroupsLimit = int32
TagGroupsLimit defines model for tag_groups_limit.
type TagGroupsSearch ¶
type TagGroupsSearch = string
TagGroupsSearch defines model for tag_groups_search.
type TagGroupsSort ¶
type TagGroupsSort string
TagGroupsSort defines model for tag_groups_sort.
const ( TagGroupsSortLatestAsc TagGroupsSort = "latest_asc" TagGroupsSortLatestDesc TagGroupsSort = "latest_desc" TagGroupsSortNameAsc TagGroupsSort = "name_asc" TagGroupsSortNameDesc TagGroupsSort = "name_desc" )
Defines values for TagGroupsSort.
func (TagGroupsSort) Valid ¶
func (e TagGroupsSort) Valid() bool
Valid indicates whether the value is a known member of the TagGroupsSort enum.
type TeamMember ¶
type TeamMember struct {
AddedBy *openapi_types.UUID `json:"addedBy,omitempty"`
CreatedAt *time.Time `json:"createdAt"`
Email string `json:"email"`
Id openapi_types.UUID `json:"id"`
IsDefault bool `json:"isDefault"`
Name *string `json:"name,omitempty"`
ProfilePictureUrl *string `json:"profilePictureUrl,omitempty"`
Providers []string `json:"providers"`
}
TeamMember defines model for TeamMember.
type TeamMembersResponse ¶
type TeamMembersResponse struct {
Members []TeamMember `json:"members"`
}
TeamMembersResponse defines model for TeamMembersResponse.
type TeamResolveResponse ¶
type TeamResolveResponse struct {
Id openapi_types.UUID `json:"id"`
Slug string `json:"slug"`
}
TeamResolveResponse defines model for TeamResolveResponse.
type TeamTemplate ¶
type TeamTemplate struct {
Aliases []string `json:"aliases"`
BuildCount int32 `json:"buildCount"`
BuildID openapi_types.UUID `json:"buildID"`
CpuCount int64 `json:"cpuCount"`
CreatedAt time.Time `json:"createdAt"`
CreatedBy *struct {
Email *string `json:"email,omitempty"`
Id openapi_types.UUID `json:"id"`
} `json:"createdBy"`
DefaultDescription *string `json:"defaultDescription,omitempty"`
DiskSizeMB *int64 `json:"diskSizeMB"`
EnvdVersion *string `json:"envdVersion"`
IsDefault bool `json:"isDefault"`
LastSpawnedAt *time.Time `json:"lastSpawnedAt"`
MemoryMB int64 `json:"memoryMB"`
Names []string `json:"names"`
Public bool `json:"public"`
SpawnCount int64 `json:"spawnCount"`
TemplateID string `json:"templateID"`
UpdatedAt time.Time `json:"updatedAt"`
}
TeamTemplate defines model for TeamTemplate.
type TeamTemplatesResponse ¶
type TeamTemplatesResponse struct {
Data []TeamTemplate `json:"data"`
// NextCursor Cursor to pass to the next list request, or `null` if there is no next page.
NextCursor *string `json:"nextCursor"`
}
TeamTemplatesResponse defines model for TeamTemplatesResponse.
type TemplateDetail ¶
type TemplateDetail struct {
// Aliases Aliases of the template.
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
Aliases []string `json:"aliases"`
// BuildCount Number of times the template was built.
BuildCount int32 `json:"buildCount"`
// BuildID Identifier of the latest ready build for the template, or the zero UUID when none.
BuildID string `json:"buildID"`
// CpuCount vCPU count of the latest ready default build, or `null` when none.
CpuCount *CPUCount `json:"cpuCount"`
// CreatedAt Time when the template was created.
CreatedAt time.Time `json:"createdAt"`
// DiskSizeMB Disk size in MiB of the latest ready default build, or `null` when none.
DiskSizeMB *DiskSizeMB `json:"diskSizeMB"`
// EnvdVersion envd version of the latest ready default build, or `null` when none.
EnvdVersion *string `json:"envdVersion"`
// LastSpawnedAt Time when the template was last used.
LastSpawnedAt *time.Time `json:"lastSpawnedAt"`
// MemoryMB Memory in MiB of the latest ready default build, or `null` when none.
MemoryMB *MemoryMB `json:"memoryMB"`
// Names Names of the template (namespace/alias format when namespaced).
Names []string `json:"names"`
// Public Whether the template is public or only accessible by the team.
Public bool `json:"public"`
// SpawnCount Number of times the template was used.
SpawnCount int64 `json:"spawnCount"`
// TemplateID Identifier of the template.
TemplateID string `json:"templateID"`
// UpdatedAt Time when the template was last updated.
UpdatedAt time.Time `json:"updatedAt"`
}
TemplateDetail Dashboard-shaped single-template read. Mirrors the infra-api `Template` schema fields the dashboard renders.
type TemplateTagAssignment ¶
type TemplateTagAssignment struct {
// AssignedAt Time when the tag was assigned to the build.
AssignedAt time.Time `json:"assignedAt"`
// AssignmentId Identifier of the tag assignment event.
AssignmentId openapi_types.UUID `json:"assignmentId"`
// BuildCreatedAt Time when the assigned build was created.
BuildCreatedAt time.Time `json:"buildCreatedAt"`
// BuildFinishedAt Time when the assigned build finished.
BuildFinishedAt *time.Time `json:"buildFinishedAt"`
// BuildId Identifier of the assigned build.
BuildId openapi_types.UUID `json:"buildId"`
}
TemplateTagAssignment defines model for TemplateTagAssignment.
type TemplateTagAssignmentsResponse ¶
type TemplateTagAssignmentsResponse struct {
// Data Ready assignment events for the tag, sorted latest first.
Data []TemplateTagAssignment `json:"data"`
// NextCursor Cursor to pass to the next list request, or `null` if there is no next page.
NextCursor *string `json:"nextCursor"`
}
TemplateTagAssignmentsResponse defines model for TemplateTagAssignmentsResponse.
type TemplateTagExistsResponse ¶
type TemplateTagExistsResponse struct {
// Exists Whether the template tag has at least one ready assignment.
Exists bool `json:"exists"`
// NormalizedTag Normalized template tag name.
NormalizedTag string `json:"normalizedTag"`
}
TemplateTagExistsResponse defines model for TemplateTagExistsResponse.
type TemplateTagGroup ¶
type TemplateTagGroup struct {
// Assignments Ready assignment events for this tag, sorted latest first.
Assignments []TemplateTagAssignment `json:"assignments"`
// HasMore Whether more ready assignment events exist beyond the requested assignment limit.
HasMore bool `json:"hasMore"`
// Tag Template tag name.
Tag string `json:"tag"`
}
TemplateTagGroup defines model for TemplateTagGroup.
type TemplateTagGroupsResponse ¶
type TemplateTagGroupsResponse struct {
// NextCursor Cursor to pass as `tagsCursor` for the next page, or `null` if there is no next page.
NextCursor *string `json:"nextCursor"`
Tags []TemplateTagGroup `json:"tags"`
}
TemplateTagGroupsResponse defines model for TemplateTagGroupsResponse.
type TemplateTagsCountResponse ¶
type TemplateTagsCountResponse struct {
// Total Total distinct ready tags for the template.
Total int64 `json:"total"`
}
TemplateTagsCountResponse defines model for TemplateTagsCountResponse.
type TemplatesCursor ¶
type TemplatesCursor = string
TemplatesCursor defines model for templates_cursor.
type TemplatesPublic ¶
type TemplatesPublic = bool
TemplatesPublic defines model for templates_public.
type TemplatesSearch ¶
type TemplatesSearch = string
TemplatesSearch defines model for templates_search.
type TemplatesSort ¶
type TemplatesSort string
TemplatesSort defines model for templates_sort.
const ( TemplatesSortCreatedAtAsc TemplatesSort = "created_at_asc" TemplatesSortCreatedAtDesc TemplatesSort = "created_at_desc" TemplatesSortUpdatedAtAsc TemplatesSort = "updated_at_asc" TemplatesSortUpdatedAtDesc TemplatesSort = "updated_at_desc" )
Defines values for TemplatesSort.
func (TemplatesSort) Valid ¶
func (e TemplatesSort) Valid() bool
Valid indicates whether the value is a known member of the TemplatesSort enum.
type UpdateTeamRequest ¶
type UpdateTeamRequest struct {
Name *string `json:"name,omitempty"`
ProfilePictureUrl *string `json:"profilePictureUrl,omitempty"`
}
UpdateTeamRequest defines model for UpdateTeamRequest.
type UpdateTeamResponse ¶
type UpdateTeamResponse struct {
Id openapi_types.UUID `json:"id"`
Name string `json:"name"`
ProfilePictureUrl *string `json:"profilePictureUrl,omitempty"`
}
UpdateTeamResponse defines model for UpdateTeamResponse.
type UserTeam ¶
type UserTeam struct {
BlockedReason *string `json:"blockedReason"`
CreatedAt time.Time `json:"createdAt"`
Email string `json:"email"`
Id openapi_types.UUID `json:"id"`
IsBanned bool `json:"isBanned"`
IsBlocked bool `json:"isBlocked"`
IsDefault bool `json:"isDefault"`
Limits UserTeamLimits `json:"limits"`
Name string `json:"name"`
ProfilePictureUrl *string `json:"profilePictureUrl"`
Slug string `json:"slug"`
Tier string `json:"tier"`
}
UserTeam defines model for UserTeam.
type UserTeamLimits ¶
type UserTeamLimits struct {
ConcurrentSandboxes int32 `json:"concurrentSandboxes"`
ConcurrentTemplateBuilds int32 `json:"concurrentTemplateBuilds"`
DiskMb int32 `json:"diskMb"`
EventsTtlDays int32 `json:"eventsTtlDays"`
MaxLengthHours int64 `json:"maxLengthHours"`
MaxRamMb int32 `json:"maxRamMb"`
MaxVcpu int32 `json:"maxVcpu"`
}
UserTeamLimits defines model for UserTeamLimits.
type UserTeamsResponse ¶
type UserTeamsResponse struct {
Teams []UserTeam `json:"teams"`
}
UserTeamsResponse defines model for UserTeamsResponse.