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.8.0 DO NOT EDIT.
Index ¶
- func GetSpec() (swagger *openapi3.T, err error)
- func GetSpecJSON() ([]byte, error)
- func GetSwagger() (*openapi3.T, error)deprecated
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type Block
- type CreateTemplate200JSONResponse
- type CreateTemplateJSONRequestBody
- type CreateTemplateRequestObject
- type CreateTemplateResponseObject
- type CreateTemplatedefaultJSONResponse
- type DeleteTemplate204Response
- type DeleteTemplateRequestObject
- type DeleteTemplateResponseObject
- type DeleteTemplatedefaultJSONResponse
- type Document
- type Error
- type ErrorJSONResponse
- type ErrorResponse
- type Event
- type EventType
- type EventTypeQueryParam
- type ExportDocument200ApplicationoctetStreamResponse
- type ExportDocumentJSONRequestBody
- type ExportDocumentRequestObject
- type ExportDocumentResponseObject
- type ExportDocumentdefaultJSONResponse
- type ExportFormat
- type ExportRequest
- type Filter
- type FormField
- type FromQueryParam
- type GapQueryParam
- type GenerateTemplate200JSONResponse
- type GenerateTemplateJSONRequestBody
- type GenerateTemplateRequest
- type GenerateTemplateRequestObject
- type GenerateTemplateResponseObject
- type GenerateTemplatedefaultJSONResponse
- type GetSyncStatus200JSONResponse
- type GetSyncStatusRequestObject
- type GetSyncStatusResponseObject
- type GetSyncStatusdefaultJSONResponse
- type InvalidParamFormatError
- type ListOwners200JSONResponse
- type ListOwnersRequestObject
- type ListOwnersResponseObject
- type ListOwnersdefaultJSONResponse
- type ListRepos200JSONResponse
- type ListReposParams
- type ListReposRequestObject
- type ListReposResponseObject
- type ListReposdefaultJSONResponse
- type ListSessions200JSONResponse
- type ListSessionsParams
- type ListSessionsRequestObject
- type ListSessionsResponseObject
- type ListSessionsdefaultJSONResponse
- type ListTemplates200JSONResponse
- type ListTemplatesRequestObject
- type ListTemplatesResponseObject
- type ListTemplatesdefaultJSONResponse
- type ListTimeline200JSONResponse
- type ListTimelineParams
- type ListTimelineRequestObject
- type ListTimelineResponseObject
- type ListTimelinedefaultJSONResponse
- type MiddlewareFunc
- type OwnerQueryParam
- type OwnerQueryParamRequired
- type PageQueryParam
- type PerPageQueryParam
- type RepoQueryParam
- type RequiredHeaderError
- type RequiredParamError
- type RunRequest
- type RunTemplate200JSONResponse
- type RunTemplateJSONRequestBody
- type RunTemplateRequestObject
- type RunTemplateResponseObject
- type RunTemplatedefaultJSONResponse
- type ServeMux
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) CreateTemplate(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteTemplate(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ExportDocument(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GenerateTemplate(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetSyncStatus(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListOwners(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListRepos(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListSessions(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListTemplates(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListTimeline(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RunTemplate(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) TriggerSync(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) UpdateTemplate(w http.ResponseWriter, r *http.Request)
- type Session
- type SessionsResponse
- type StdHTTPServerOptions
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type SyncJob
- type SyncStatus
- type Template
- type TemplateIdPathParam
- type TemplateInput
- type TimelinePage
- type ToQueryParam
- type TooManyValuesForParamError
- type TransformStep
- type TriggerSync202JSONResponse
- type TriggerSyncRequestObject
- type TriggerSyncResponseObject
- type TriggerSyncdefaultJSONResponse
- type UnescapedCookieParamError
- type UnmarshalingParamError
- type UpdateTemplate200JSONResponse
- type UpdateTemplateJSONRequestBody
- type UpdateTemplateRequestObject
- type UpdateTemplateResponseObject
- type UpdateTemplatedefaultJSONResponse
Constants ¶
This section is empty.
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 Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerFromMuxWithBaseURL ¶
func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type Block ¶
type Block struct {
// Data Block-type-specific payload.
Data map[string]interface{} `json:"data"`
// Type heading | text | list | table | keyvalue | metric | code | chart.
Type string `json:"type"`
}
Block One display building block.
type CreateTemplate200JSONResponse ¶
type CreateTemplate200JSONResponse Template
func (CreateTemplate200JSONResponse) VisitCreateTemplateResponse ¶
func (response CreateTemplate200JSONResponse) VisitCreateTemplateResponse(w http.ResponseWriter) error
type CreateTemplateJSONRequestBody ¶
type CreateTemplateJSONRequestBody = TemplateInput
CreateTemplateJSONRequestBody defines body for CreateTemplate for application/json ContentType.
type CreateTemplateRequestObject ¶
type CreateTemplateRequestObject struct {
Body *CreateTemplateJSONRequestBody
}
type CreateTemplateResponseObject ¶
type CreateTemplateResponseObject interface {
VisitCreateTemplateResponse(w http.ResponseWriter) error
}
type CreateTemplatedefaultJSONResponse ¶
type CreateTemplatedefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (CreateTemplatedefaultJSONResponse) VisitCreateTemplateResponse ¶
func (response CreateTemplatedefaultJSONResponse) VisitCreateTemplateResponse(w http.ResponseWriter) error
type DeleteTemplate204Response ¶
type DeleteTemplate204Response struct {
}
func (DeleteTemplate204Response) VisitDeleteTemplateResponse ¶
func (response DeleteTemplate204Response) VisitDeleteTemplateResponse(w http.ResponseWriter) error
type DeleteTemplateRequestObject ¶
type DeleteTemplateRequestObject struct {
Id TemplateIdPathParam `json:"id"`
}
type DeleteTemplateResponseObject ¶
type DeleteTemplateResponseObject interface {
VisitDeleteTemplateResponse(w http.ResponseWriter) error
}
type DeleteTemplatedefaultJSONResponse ¶
type DeleteTemplatedefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (DeleteTemplatedefaultJSONResponse) VisitDeleteTemplateResponse ¶
func (response DeleteTemplatedefaultJSONResponse) VisitDeleteTemplateResponse(w http.ResponseWriter) error
type ErrorJSONResponse ¶
type ErrorJSONResponse ErrorResponse
type ErrorResponse ¶
type ErrorResponse struct {
// Code Machine-readable error code, UPPER_SNAKE_CASE.
Code string `json:"code"`
Details *map[string]interface{} `json:"details,omitempty"`
Message string `json:"message"`
}
ErrorResponse defines model for ErrorResponse.
type Event ¶
type Event struct {
Additions *int `json:"additions,omitempty"`
Branch *string `json:"branch,omitempty"`
Deletions *int `json:"deletions,omitempty"`
// Id Stable id: "{type}:{owner}/{repo}:{sha|number}".
Id string `json:"id"`
// Number PR/issue number.
Number *int `json:"number,omitempty"`
Owner string `json:"owner"`
Repo string `json:"repo"`
Sha *string `json:"sha,omitempty"`
// Title Commit subject / PR title.
Title *string `json:"title,omitempty"`
// Ts Unix seconds.
Ts int64 `json:"ts"`
Type EventType `json:"type"`
Url *string `json:"url,omitempty"`
}
Event A single ingested activity event.
type EventType ¶
type EventType string
EventType defines model for EventType.
type EventTypeQueryParam ¶
type EventTypeQueryParam = EventType
EventTypeQueryParam defines model for EventTypeQueryParam.
type ExportDocument200ApplicationoctetStreamResponse ¶
func (ExportDocument200ApplicationoctetStreamResponse) VisitExportDocumentResponse ¶
func (response ExportDocument200ApplicationoctetStreamResponse) VisitExportDocumentResponse(w http.ResponseWriter) error
type ExportDocumentJSONRequestBody ¶
type ExportDocumentJSONRequestBody = ExportRequest
ExportDocumentJSONRequestBody defines body for ExportDocument for application/json ContentType.
type ExportDocumentRequestObject ¶
type ExportDocumentRequestObject struct {
Body *ExportDocumentJSONRequestBody
}
type ExportDocumentResponseObject ¶
type ExportDocumentResponseObject interface {
VisitExportDocumentResponse(w http.ResponseWriter) error
}
type ExportDocumentdefaultJSONResponse ¶
type ExportDocumentdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ExportDocumentdefaultJSONResponse) VisitExportDocumentResponse ¶
func (response ExportDocumentdefaultJSONResponse) VisitExportDocumentResponse(w http.ResponseWriter) error
type ExportFormat ¶
type ExportFormat string
ExportFormat defines model for ExportFormat.
const ( Csv ExportFormat = "csv" Json ExportFormat = "json" Pdf ExportFormat = "pdf" )
Defines values for ExportFormat.
func (ExportFormat) Valid ¶
func (e ExportFormat) Valid() bool
Valid indicates whether the value is a known member of the ExportFormat enum.
type ExportRequest ¶
type ExportRequest struct {
// Document An ordered list of display blocks.
Document *Document `json:"document,omitempty"`
// Filter Timeline filter selecting the range/scope to operate on.
Filter *Filter `json:"filter,omitempty"`
FormValues *map[string]interface{} `json:"formValues,omitempty"`
Format ExportFormat `json:"format"`
TemplateId *string `json:"templateId,omitempty"`
}
ExportRequest defines model for ExportRequest.
type Filter ¶
type Filter struct {
From *int64 `json:"from,omitempty"`
Owner *string `json:"owner,omitempty"`
Repo *string `json:"repo,omitempty"`
To *int64 `json:"to,omitempty"`
Type *EventType `json:"type,omitempty"`
}
Filter Timeline filter selecting the range/scope to operate on.
type FormField ¶
type FormField struct {
// Default Default value, if any. Shape matches `type`.
Default interface{} `json:"default,omitempty"`
Label *string `json:"label,omitempty"`
Name string `json:"name"`
Required *bool `json:"required,omitempty"`
// Type Form field kind, e.g. string, number, boolean, date, select.
Type string `json:"type"`
}
FormField One input field a template's form collects on run.
type GenerateTemplate200JSONResponse ¶
type GenerateTemplate200JSONResponse Template
func (GenerateTemplate200JSONResponse) VisitGenerateTemplateResponse ¶
func (response GenerateTemplate200JSONResponse) VisitGenerateTemplateResponse(w http.ResponseWriter) error
type GenerateTemplateJSONRequestBody ¶
type GenerateTemplateJSONRequestBody = GenerateTemplateRequest
GenerateTemplateJSONRequestBody defines body for GenerateTemplate for application/json ContentType.
type GenerateTemplateRequest ¶
type GenerateTemplateRequest struct {
Prompt string `json:"prompt"`
}
GenerateTemplateRequest defines model for GenerateTemplateRequest.
type GenerateTemplateRequestObject ¶
type GenerateTemplateRequestObject struct {
Body *GenerateTemplateJSONRequestBody
}
type GenerateTemplateResponseObject ¶
type GenerateTemplateResponseObject interface {
VisitGenerateTemplateResponse(w http.ResponseWriter) error
}
type GenerateTemplatedefaultJSONResponse ¶
type GenerateTemplatedefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (GenerateTemplatedefaultJSONResponse) VisitGenerateTemplateResponse ¶
func (response GenerateTemplatedefaultJSONResponse) VisitGenerateTemplateResponse(w http.ResponseWriter) error
type GetSyncStatus200JSONResponse ¶
type GetSyncStatus200JSONResponse SyncStatus
func (GetSyncStatus200JSONResponse) VisitGetSyncStatusResponse ¶
func (response GetSyncStatus200JSONResponse) VisitGetSyncStatusResponse(w http.ResponseWriter) error
type GetSyncStatusRequestObject ¶
type GetSyncStatusRequestObject struct {
}
type GetSyncStatusResponseObject ¶
type GetSyncStatusResponseObject interface {
VisitGetSyncStatusResponse(w http.ResponseWriter) error
}
type GetSyncStatusdefaultJSONResponse ¶
type GetSyncStatusdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (GetSyncStatusdefaultJSONResponse) VisitGetSyncStatusResponse ¶
func (response GetSyncStatusdefaultJSONResponse) VisitGetSyncStatusResponse(w http.ResponseWriter) error
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListOwners200JSONResponse ¶
type ListOwners200JSONResponse []string
func (ListOwners200JSONResponse) VisitListOwnersResponse ¶
func (response ListOwners200JSONResponse) VisitListOwnersResponse(w http.ResponseWriter) error
type ListOwnersRequestObject ¶
type ListOwnersRequestObject struct {
}
type ListOwnersResponseObject ¶
type ListOwnersResponseObject interface {
VisitListOwnersResponse(w http.ResponseWriter) error
}
type ListOwnersdefaultJSONResponse ¶
type ListOwnersdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ListOwnersdefaultJSONResponse) VisitListOwnersResponse ¶
func (response ListOwnersdefaultJSONResponse) VisitListOwnersResponse(w http.ResponseWriter) error
type ListRepos200JSONResponse ¶
type ListRepos200JSONResponse []string
func (ListRepos200JSONResponse) VisitListReposResponse ¶
func (response ListRepos200JSONResponse) VisitListReposResponse(w http.ResponseWriter) error
type ListReposParams ¶
type ListReposParams struct {
// Owner Owner/org to list repos for.
Owner OwnerQueryParamRequired `form:"owner" json:"owner"`
}
ListReposParams defines parameters for ListRepos.
type ListReposRequestObject ¶
type ListReposRequestObject struct {
Params ListReposParams
}
type ListReposResponseObject ¶
type ListReposResponseObject interface {
VisitListReposResponse(w http.ResponseWriter) error
}
type ListReposdefaultJSONResponse ¶
type ListReposdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ListReposdefaultJSONResponse) VisitListReposResponse ¶
func (response ListReposdefaultJSONResponse) VisitListReposResponse(w http.ResponseWriter) error
type ListSessions200JSONResponse ¶
type ListSessions200JSONResponse SessionsResponse
func (ListSessions200JSONResponse) VisitListSessionsResponse ¶
func (response ListSessions200JSONResponse) VisitListSessionsResponse(w http.ResponseWriter) error
type ListSessionsParams ¶
type ListSessionsParams struct {
// Owner Filter by owner/org.
Owner *OwnerQueryParam `form:"owner,omitempty" json:"owner,omitempty"`
// From Range start, unix seconds (inclusive).
From *FromQueryParam `form:"from,omitempty" json:"from,omitempty"`
// To Range end, unix seconds (exclusive).
To *ToQueryParam `form:"to,omitempty" json:"to,omitempty"`
// Gap Inter-event gap threshold, in seconds, overriding GITRAKZ_SESSION_GAP for this request's sessionization.
Gap *GapQueryParam `form:"gap,omitempty" json:"gap,omitempty"`
}
ListSessionsParams defines parameters for ListSessions.
type ListSessionsRequestObject ¶
type ListSessionsRequestObject struct {
Params ListSessionsParams
}
type ListSessionsResponseObject ¶
type ListSessionsResponseObject interface {
VisitListSessionsResponse(w http.ResponseWriter) error
}
type ListSessionsdefaultJSONResponse ¶
type ListSessionsdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ListSessionsdefaultJSONResponse) VisitListSessionsResponse ¶
func (response ListSessionsdefaultJSONResponse) VisitListSessionsResponse(w http.ResponseWriter) error
type ListTemplates200JSONResponse ¶
type ListTemplates200JSONResponse []Template
func (ListTemplates200JSONResponse) VisitListTemplatesResponse ¶
func (response ListTemplates200JSONResponse) VisitListTemplatesResponse(w http.ResponseWriter) error
type ListTemplatesRequestObject ¶
type ListTemplatesRequestObject struct {
}
type ListTemplatesResponseObject ¶
type ListTemplatesResponseObject interface {
VisitListTemplatesResponse(w http.ResponseWriter) error
}
type ListTemplatesdefaultJSONResponse ¶
type ListTemplatesdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ListTemplatesdefaultJSONResponse) VisitListTemplatesResponse ¶
func (response ListTemplatesdefaultJSONResponse) VisitListTemplatesResponse(w http.ResponseWriter) error
type ListTimeline200JSONResponse ¶
type ListTimeline200JSONResponse TimelinePage
func (ListTimeline200JSONResponse) VisitListTimelineResponse ¶
func (response ListTimeline200JSONResponse) VisitListTimelineResponse(w http.ResponseWriter) error
type ListTimelineParams ¶
type ListTimelineParams struct {
// Owner Filter by owner/org.
Owner *OwnerQueryParam `form:"owner,omitempty" json:"owner,omitempty"`
// Repo Filter by repo.
Repo *RepoQueryParam `form:"repo,omitempty" json:"repo,omitempty"`
// Type Filter by event type.
Type *EventTypeQueryParam `form:"type,omitempty" json:"type,omitempty"`
// From Range start, unix seconds (inclusive).
From *FromQueryParam `form:"from,omitempty" json:"from,omitempty"`
// To Range end, unix seconds (exclusive).
To *ToQueryParam `form:"to,omitempty" json:"to,omitempty"`
// Page 1-indexed page number.
Page *PageQueryParam `form:"page,omitempty" json:"page,omitempty"`
// PerPage Page size.
PerPage *PerPageQueryParam `form:"per_page,omitempty" json:"per_page,omitempty"`
}
ListTimelineParams defines parameters for ListTimeline.
type ListTimelineRequestObject ¶
type ListTimelineRequestObject struct {
Params ListTimelineParams
}
type ListTimelineResponseObject ¶
type ListTimelineResponseObject interface {
VisitListTimelineResponse(w http.ResponseWriter) error
}
type ListTimelinedefaultJSONResponse ¶
type ListTimelinedefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ListTimelinedefaultJSONResponse) VisitListTimelineResponse ¶
func (response ListTimelinedefaultJSONResponse) VisitListTimelineResponse(w http.ResponseWriter) error
type OwnerQueryParam ¶
type OwnerQueryParam = string
OwnerQueryParam defines model for OwnerQueryParam.
type OwnerQueryParamRequired ¶
type OwnerQueryParamRequired = string
OwnerQueryParamRequired defines model for OwnerQueryParamRequired.
type PerPageQueryParam ¶
type PerPageQueryParam = int
PerPageQueryParam defines model for PerPageQueryParam.
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type RunRequest ¶
type RunRequest struct {
// Filter Timeline filter selecting the range/scope to operate on.
Filter *Filter `json:"filter,omitempty"`
// FormValues Values keyed by the template's form field names.
FormValues *map[string]interface{} `json:"formValues,omitempty"`
TemplateId string `json:"templateId"`
}
RunRequest defines model for RunRequest.
type RunTemplate200JSONResponse ¶
type RunTemplate200JSONResponse Document
func (RunTemplate200JSONResponse) VisitRunTemplateResponse ¶
func (response RunTemplate200JSONResponse) VisitRunTemplateResponse(w http.ResponseWriter) error
type RunTemplateJSONRequestBody ¶
type RunTemplateJSONRequestBody = RunRequest
RunTemplateJSONRequestBody defines body for RunTemplate for application/json ContentType.
type RunTemplateRequestObject ¶
type RunTemplateRequestObject struct {
Body *RunTemplateJSONRequestBody
}
type RunTemplateResponseObject ¶
type RunTemplateResponseObject interface {
VisitRunTemplateResponse(w http.ResponseWriter) error
}
type RunTemplatedefaultJSONResponse ¶
type RunTemplatedefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (RunTemplatedefaultJSONResponse) VisitRunTemplateResponse ¶
func (response RunTemplatedefaultJSONResponse) VisitRunTemplateResponse(w http.ResponseWriter) error
type ServeMux ¶
type ServeMux interface {
HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
http.Handler
}
ServeMux is an abstraction of http.ServeMux.
type ServerInterface ¶
type ServerInterface interface {
// ExportDocument Export a document (or a template run) to a file
// (POST /export)
ExportDocument(w http.ResponseWriter, r *http.Request)
// ListOwners List distinct owners/orgs
// (GET /owners)
ListOwners(w http.ResponseWriter, r *http.Request)
// ListRepos List repos under an owner
// (GET /repos)
ListRepos(w http.ResponseWriter, r *http.Request, params ListReposParams)
// RunTemplate Run a template's transform pipeline over a filtered range
// (POST /run)
RunTemplate(w http.ResponseWriter, r *http.Request)
// ListSessions Derived, sessionized view of the timeline
// (GET /sessions)
ListSessions(w http.ResponseWriter, r *http.Request, params ListSessionsParams)
// TriggerSync Trigger an incremental sync of activity from `gh`
// (POST /sync)
TriggerSync(w http.ResponseWriter, r *http.Request)
// GetSyncStatus Current sync status
// (GET /sync/status)
GetSyncStatus(w http.ResponseWriter, r *http.Request)
// ListTemplates List templates (built-in + custom)
// (GET /templates)
ListTemplates(w http.ResponseWriter, r *http.Request)
// CreateTemplate Create a custom template
// (POST /templates)
CreateTemplate(w http.ResponseWriter, r *http.Request)
// GenerateTemplate LLM-compose a template draft from a description
// (POST /templates/generate)
GenerateTemplate(w http.ResponseWriter, r *http.Request)
// DeleteTemplate Delete a custom template
// (DELETE /templates/{id})
DeleteTemplate(w http.ResponseWriter, r *http.Request, id TemplateIdPathParam)
// UpdateTemplate Edit a template
// (PUT /templates/{id})
UpdateTemplate(w http.ResponseWriter, r *http.Request, id TemplateIdPathParam)
// ListTimeline Paginated, filterable event timeline
// (GET /timeline)
ListTimeline(w http.ResponseWriter, r *http.Request, params ListTimelineParams)
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
func NewStrictHandlerWithOptions ¶
func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) CreateTemplate ¶
func (siw *ServerInterfaceWrapper) CreateTemplate(w http.ResponseWriter, r *http.Request)
CreateTemplate operation middleware
func (*ServerInterfaceWrapper) DeleteTemplate ¶
func (siw *ServerInterfaceWrapper) DeleteTemplate(w http.ResponseWriter, r *http.Request)
DeleteTemplate operation middleware
func (*ServerInterfaceWrapper) ExportDocument ¶
func (siw *ServerInterfaceWrapper) ExportDocument(w http.ResponseWriter, r *http.Request)
ExportDocument operation middleware
func (*ServerInterfaceWrapper) GenerateTemplate ¶
func (siw *ServerInterfaceWrapper) GenerateTemplate(w http.ResponseWriter, r *http.Request)
GenerateTemplate operation middleware
func (*ServerInterfaceWrapper) GetSyncStatus ¶
func (siw *ServerInterfaceWrapper) GetSyncStatus(w http.ResponseWriter, r *http.Request)
GetSyncStatus operation middleware
func (*ServerInterfaceWrapper) ListOwners ¶
func (siw *ServerInterfaceWrapper) ListOwners(w http.ResponseWriter, r *http.Request)
ListOwners operation middleware
func (*ServerInterfaceWrapper) ListRepos ¶
func (siw *ServerInterfaceWrapper) ListRepos(w http.ResponseWriter, r *http.Request)
ListRepos operation middleware
func (*ServerInterfaceWrapper) ListSessions ¶
func (siw *ServerInterfaceWrapper) ListSessions(w http.ResponseWriter, r *http.Request)
ListSessions operation middleware
func (*ServerInterfaceWrapper) ListTemplates ¶
func (siw *ServerInterfaceWrapper) ListTemplates(w http.ResponseWriter, r *http.Request)
ListTemplates operation middleware
func (*ServerInterfaceWrapper) ListTimeline ¶
func (siw *ServerInterfaceWrapper) ListTimeline(w http.ResponseWriter, r *http.Request)
ListTimeline operation middleware
func (*ServerInterfaceWrapper) RunTemplate ¶
func (siw *ServerInterfaceWrapper) RunTemplate(w http.ResponseWriter, r *http.Request)
RunTemplate operation middleware
func (*ServerInterfaceWrapper) TriggerSync ¶
func (siw *ServerInterfaceWrapper) TriggerSync(w http.ResponseWriter, r *http.Request)
TriggerSync operation middleware
func (*ServerInterfaceWrapper) UpdateTemplate ¶
func (siw *ServerInterfaceWrapper) UpdateTemplate(w http.ResponseWriter, r *http.Request)
UpdateTemplate operation middleware
type Session ¶
type Session struct {
// Day Owner-local calendar day this session is grouped under.
Day *openapi_types.Date `json:"day,omitempty"`
// DurationHours (endTs - startTs) + lead-in padding, in hours.
DurationHours float64 `json:"durationHours"`
EndTs int64 `json:"endTs"`
Events []Event `json:"events"`
Owner string `json:"owner"`
StartTs int64 `json:"startTs"`
}
Session A derived cluster of events (per owner) whose inter-event gaps are all under the sessionization threshold.
type SessionsResponse ¶
type SessionsResponse struct {
Sessions []Session `json:"sessions"`
}
SessionsResponse defines model for SessionsResponse.
type StdHTTPServerOptions ¶
type StdHTTPServerOptions struct {
BaseURL string
BaseRouter ServeMux
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type StrictHTTPServerOptions ¶
type StrictHTTPServerOptions struct {
RequestErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type StrictHandlerFunc ¶
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// ExportDocument Export a document (or a template run) to a file
// (POST /export)
ExportDocument(ctx context.Context, request ExportDocumentRequestObject) (ExportDocumentResponseObject, error)
// ListOwners List distinct owners/orgs
// (GET /owners)
ListOwners(ctx context.Context, request ListOwnersRequestObject) (ListOwnersResponseObject, error)
// ListRepos List repos under an owner
// (GET /repos)
ListRepos(ctx context.Context, request ListReposRequestObject) (ListReposResponseObject, error)
// RunTemplate Run a template's transform pipeline over a filtered range
// (POST /run)
RunTemplate(ctx context.Context, request RunTemplateRequestObject) (RunTemplateResponseObject, error)
// ListSessions Derived, sessionized view of the timeline
// (GET /sessions)
ListSessions(ctx context.Context, request ListSessionsRequestObject) (ListSessionsResponseObject, error)
// TriggerSync Trigger an incremental sync of activity from `gh`
// (POST /sync)
TriggerSync(ctx context.Context, request TriggerSyncRequestObject) (TriggerSyncResponseObject, error)
// GetSyncStatus Current sync status
// (GET /sync/status)
GetSyncStatus(ctx context.Context, request GetSyncStatusRequestObject) (GetSyncStatusResponseObject, error)
// ListTemplates List templates (built-in + custom)
// (GET /templates)
ListTemplates(ctx context.Context, request ListTemplatesRequestObject) (ListTemplatesResponseObject, error)
// CreateTemplate Create a custom template
// (POST /templates)
CreateTemplate(ctx context.Context, request CreateTemplateRequestObject) (CreateTemplateResponseObject, error)
// GenerateTemplate LLM-compose a template draft from a description
// (POST /templates/generate)
GenerateTemplate(ctx context.Context, request GenerateTemplateRequestObject) (GenerateTemplateResponseObject, error)
// DeleteTemplate Delete a custom template
// (DELETE /templates/{id})
DeleteTemplate(ctx context.Context, request DeleteTemplateRequestObject) (DeleteTemplateResponseObject, error)
// UpdateTemplate Edit a template
// (PUT /templates/{id})
UpdateTemplate(ctx context.Context, request UpdateTemplateRequestObject) (UpdateTemplateResponseObject, error)
// ListTimeline Paginated, filterable event timeline
// (GET /timeline)
ListTimeline(ctx context.Context, request ListTimelineRequestObject) (ListTimelineResponseObject, error)
}
StrictServerInterface represents all server handlers.
type SyncJob ¶
type SyncJob struct {
JobId string `json:"jobId"`
}
SyncJob defines model for SyncJob.
type SyncStatus ¶
type SyncStatus struct {
InProgress bool `json:"inProgress"`
// LastSyncedTs Unix seconds of the most recent completed sync.
LastSyncedTs int64 `json:"lastSyncedTs"`
// PerOwner Per-owner sync counts/state, keyed by owner name.
PerOwner map[string]interface{} `json:"perOwner"`
}
SyncStatus defines model for SyncStatus.
type Template ¶
type Template struct {
Description *string `json:"description,omitempty"`
Exports []ExportFormat `json:"exports"`
Form []FormField `json:"form"`
Id string `json:"id"`
Layout []Block `json:"layout"`
// Model Only meaningful when the layout has an LLM-backed block.
Model *string `json:"model,omitempty"`
Name string `json:"name"`
Transform []TransformStep `json:"transform"`
}
Template defines model for Template.
type TemplateIdPathParam ¶
type TemplateIdPathParam = string
TemplateIdPathParam defines model for TemplateIdPathParam.
type TemplateInput ¶
type TemplateInput struct {
Description *string `json:"description,omitempty"`
Exports []ExportFormat `json:"exports"`
Form []FormField `json:"form"`
Layout []Block `json:"layout"`
// Model Only meaningful when the layout has an LLM-backed block.
Model *string `json:"model,omitempty"`
Name string `json:"name"`
Transform []TransformStep `json:"transform"`
}
TemplateInput Template fields a client submits on create/edit (no id).
type TimelinePage ¶
TimelinePage defines model for TimelinePage.
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type TransformStep ¶
type TransformStep struct {
// Params Primitive-specific parameters.
Params *map[string]interface{} `json:"params,omitempty"`
// Primitive sessionize | exclude-off-time | split-by-active-days | aggregate | group-by | rate | describe-work | passthrough.
Primitive string `json:"primitive"`
}
TransformStep One step of a template's transform pipeline.
type TriggerSync202JSONResponse ¶
type TriggerSync202JSONResponse SyncJob
func (TriggerSync202JSONResponse) VisitTriggerSyncResponse ¶
func (response TriggerSync202JSONResponse) VisitTriggerSyncResponse(w http.ResponseWriter) error
type TriggerSyncRequestObject ¶
type TriggerSyncRequestObject struct {
}
type TriggerSyncResponseObject ¶
type TriggerSyncResponseObject interface {
VisitTriggerSyncResponse(w http.ResponseWriter) error
}
type TriggerSyncdefaultJSONResponse ¶
type TriggerSyncdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (TriggerSyncdefaultJSONResponse) VisitTriggerSyncResponse ¶
func (response TriggerSyncdefaultJSONResponse) VisitTriggerSyncResponse(w http.ResponseWriter) error
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error
type UpdateTemplate200JSONResponse ¶
type UpdateTemplate200JSONResponse Template
func (UpdateTemplate200JSONResponse) VisitUpdateTemplateResponse ¶
func (response UpdateTemplate200JSONResponse) VisitUpdateTemplateResponse(w http.ResponseWriter) error
type UpdateTemplateJSONRequestBody ¶
type UpdateTemplateJSONRequestBody = TemplateInput
UpdateTemplateJSONRequestBody defines body for UpdateTemplate for application/json ContentType.
type UpdateTemplateRequestObject ¶
type UpdateTemplateRequestObject struct {
Id TemplateIdPathParam `json:"id"`
Body *UpdateTemplateJSONRequestBody
}
type UpdateTemplateResponseObject ¶
type UpdateTemplateResponseObject interface {
VisitUpdateTemplateResponse(w http.ResponseWriter) error
}
type UpdateTemplatedefaultJSONResponse ¶
type UpdateTemplatedefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (UpdateTemplatedefaultJSONResponse) VisitUpdateTemplateResponse ¶
func (response UpdateTemplatedefaultJSONResponse) VisitUpdateTemplateResponse(w http.ResponseWriter) error