api

package module

Go to main page

Versions in this module

v1

v1.5.0

May 19, 2025

v1.4.0

May 19, 2025

v1.3.0

May 19, 2025

Changes in this version

type API

+ func (api *API) GetVertexAttributes(ctx context.Context, request GetVertexAttributesRequestObject) (GetVertexAttributesResponseObject, error)

+ func (api *API) MarkVertexHealthy(ctx context.Context, request MarkVertexHealthyRequestObject) (MarkVertexHealthyResponseObject, error)

type Edge

+ Key string

+ Target string

type GetPathRequestObject

+ Key Key

+ Target string

+ type GetVertexAttributes200JSONResponse VertexAttrubutes

+ func (response GetVertexAttributes200JSONResponse) VisitGetVertexAttributesResponse(w http.ResponseWriter) error

+ type GetVertexAttributes401JSONResponse struct

+ func (response GetVertexAttributes401JSONResponse) VisitGetVertexAttributesResponse(w http.ResponseWriter) error

+ type GetVertexAttributes404JSONResponse struct

+ func (response GetVertexAttributes404JSONResponse) VisitGetVertexAttributesResponse(w http.ResponseWriter) error

+ type GetVertexAttributes422JSONResponse struct

+ func (response GetVertexAttributes422JSONResponse) VisitGetVertexAttributesResponse(w http.ResponseWriter) error

+ type GetVertexAttributes500JSONResponse struct

+ func (response GetVertexAttributes500JSONResponse) VisitGetVertexAttributesResponse(w http.ResponseWriter) error

+ type GetVertexAttributesRequestObject struct

+ Key Key

+ type GetVertexAttributesResponseObject interface

+ VisitGetVertexAttributesResponse func(w http.ResponseWriter) error

type GetVertexDependenciesRequestObject

+ Key Key

type GetVertexDependentsRequestObject

+ Key Key

type GetVertexNeighborsRequestObject

+ Key Key

type GetVertexRequestObject

+ Key Key

+ type Key = string

+ type MarkVertexHealthy200Response struct

+ func (response MarkVertexHealthy200Response) VisitMarkVertexHealthyResponse(w http.ResponseWriter) error

+ type MarkVertexHealthy401JSONResponse struct

+ func (response MarkVertexHealthy401JSONResponse) VisitMarkVertexHealthyResponse(w http.ResponseWriter) error

+ type MarkVertexHealthy404JSONResponse struct

+ func (response MarkVertexHealthy404JSONResponse) VisitMarkVertexHealthyResponse(w http.ResponseWriter) error

+ type MarkVertexHealthy422JSONResponse struct

+ func (response MarkVertexHealthy422JSONResponse) VisitMarkVertexHealthyResponse(w http.ResponseWriter) error

+ type MarkVertexHealthy500JSONResponse struct

+ func (response MarkVertexHealthy500JSONResponse) VisitMarkVertexHealthyResponse(w http.ResponseWriter) error

+ type MarkVertexHealthyRequestObject struct

+ Key Key

+ type MarkVertexHealthyResponseObject interface

+ VisitMarkVertexHealthyResponse func(w http.ResponseWriter) error

type MarkVertexUnhealthyRequestObject

+ Key Key

type ServerInterface

+ GetVertexAttributes func(w http.ResponseWriter, r *http.Request, key Key)

+ MarkVertexHealthy func(w http.ResponseWriter, r *http.Request, key Key)

type ServerInterfaceWrapper

+ func (siw *ServerInterfaceWrapper) GetVertexAttributes(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) MarkVertexHealthy(w http.ResponseWriter, r *http.Request)

type StrictServerInterface

+ GetVertexAttributes func(ctx context.Context, request GetVertexAttributesRequestObject) (GetVertexAttributesResponseObject, error)

+ MarkVertexHealthy func(ctx context.Context, request MarkVertexHealthyRequestObject) (MarkVertexHealthyResponseObject, error)

type Vertex

+ Key string

+ type VertexAttrubutes = []struct

+ type VertexAttrubutesValue0 = string

+ type VertexAttrubutesValue1 = int

+ type VertexAttrubutesValue2 = bool

+ type VertexAttrubutes_Value struct

+ func (t *VertexAttrubutes_Value) FromVertexAttrubutesValue0(v VertexAttrubutesValue0) error

+ func (t *VertexAttrubutes_Value) FromVertexAttrubutesValue1(v VertexAttrubutesValue1) error

+ func (t *VertexAttrubutes_Value) FromVertexAttrubutesValue2(v VertexAttrubutesValue2) error

+ func (t *VertexAttrubutes_Value) MergeVertexAttrubutesValue0(v VertexAttrubutesValue0) error

+ func (t *VertexAttrubutes_Value) MergeVertexAttrubutesValue1(v VertexAttrubutesValue1) error

+ func (t *VertexAttrubutes_Value) MergeVertexAttrubutesValue2(v VertexAttrubutesValue2) error

+ func (t *VertexAttrubutes_Value) UnmarshalJSON(b []byte) error

+ func (t VertexAttrubutes_Value) AsVertexAttrubutesValue0() (VertexAttrubutesValue0, error)

+ func (t VertexAttrubutes_Value) AsVertexAttrubutesValue1() (VertexAttrubutesValue1, error)

+ func (t VertexAttrubutes_Value) AsVertexAttrubutesValue2() (VertexAttrubutesValue2, error)

+ func (t VertexAttrubutes_Value) MarshalJSON() ([]byte, error)

v1.2.0

May 13, 2025

Changes in this version

type API

+ func (api *API) ClearHealthStatus(ctx context.Context, request ClearHealthStatusRequestObject) (ClearHealthStatusResponseObject, error)

+ func (api *API) MarkVertexUnhealthy(ctx context.Context, request MarkVertexUnhealthyRequestObject) (MarkVertexUnhealthyResponseObject, error)

+ type ClearHealthStatus200Response struct

+ func (response ClearHealthStatus200Response) VisitClearHealthStatusResponse(w http.ResponseWriter) error

+ type ClearHealthStatus401JSONResponse struct

+ func (response ClearHealthStatus401JSONResponse) VisitClearHealthStatusResponse(w http.ResponseWriter) error

+ type ClearHealthStatus500JSONResponse struct

+ func (response ClearHealthStatus500JSONResponse) VisitClearHealthStatusResponse(w http.ResponseWriter) error

+ type ClearHealthStatusRequestObject struct

+ type ClearHealthStatusResponseObject interface

+ VisitClearHealthStatusResponse func(w http.ResponseWriter) error

+ type MarkVertexUnhealthy200Response struct

+ func (response MarkVertexUnhealthy200Response) VisitMarkVertexUnhealthyResponse(w http.ResponseWriter) error

+ type MarkVertexUnhealthy401JSONResponse struct

+ func (response MarkVertexUnhealthy401JSONResponse) VisitMarkVertexUnhealthyResponse(w http.ResponseWriter) error

+ type MarkVertexUnhealthy404JSONResponse struct

+ func (response MarkVertexUnhealthy404JSONResponse) VisitMarkVertexUnhealthyResponse(w http.ResponseWriter) error

+ type MarkVertexUnhealthy422JSONResponse struct

+ func (response MarkVertexUnhealthy422JSONResponse) VisitMarkVertexUnhealthyResponse(w http.ResponseWriter) error

+ type MarkVertexUnhealthy500JSONResponse struct

+ func (response MarkVertexUnhealthy500JSONResponse) VisitMarkVertexUnhealthyResponse(w http.ResponseWriter) error

+ type MarkVertexUnhealthyRequestObject struct

+ Label Label

+ type MarkVertexUnhealthyResponseObject interface

+ VisitMarkVertexUnhealthyResponse func(w http.ResponseWriter) error

type ServerInterface

+ ClearHealthStatus func(w http.ResponseWriter, r *http.Request)

+ MarkVertexUnhealthy func(w http.ResponseWriter, r *http.Request, label Label)

type ServerInterfaceWrapper

+ func (siw *ServerInterfaceWrapper) ClearHealthStatus(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) MarkVertexUnhealthy(w http.ResponseWriter, r *http.Request)

type StrictServerInterface

+ ClearHealthStatus func(ctx context.Context, request ClearHealthStatusRequestObject) (ClearHealthStatusResponseObject, error)

+ MarkVertexUnhealthy func(ctx context.Context, request MarkVertexUnhealthyRequestObject) (MarkVertexUnhealthyResponseObject, error)

type Summary

+ TotalEdges int

type Vertex

+ Healthy bool

v1.1.0

May 12, 2025

v1.0.0

May 12, 2025

Changes in this version

+ const BearerHttpAuthenticationScopes

+ func GetSwagger() (swagger *openapi3.T, err error)

+ 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 API struct

+ func (api *API) GetPath(ctx context.Context, request GetPathRequestObject) (GetPathResponseObject, error)

+ func (api *API) GetVertex(ctx context.Context, request GetVertexRequestObject) (GetVertexResponseObject, error)

+ func (api *API) GetVertexDependencies(ctx context.Context, request GetVertexDependenciesRequestObject) (GetVertexDependenciesResponseObject, error)

+ func (api *API) GetVertexDependents(ctx context.Context, request GetVertexDependentsRequestObject) (GetVertexDependentsResponseObject, error)

+ func (api *API) GetVertexLineages(ctx context.Context, request GetVertexLineagesRequestObject) (GetVertexLineagesResponseObject, error)

+ func (api *API) GetVertexNeighbors(ctx context.Context, request GetVertexNeighborsRequestObject) (GetVertexNeighborsResponseObject, error)

+ func (api *API) Summary(ctx context.Context, request SummaryRequestObject) (SummaryResponseObject, error)

+ type Edge struct

+ Class string

+ Destination string

+ Label string

+ Source string

+ type GetPath200JSONResponse Subgraph

+ func (response GetPath200JSONResponse) VisitGetPathResponse(w http.ResponseWriter) error

+ type GetPath401JSONResponse struct

+ func (response GetPath401JSONResponse) VisitGetPathResponse(w http.ResponseWriter) error

+ type GetPath404JSONResponse struct

+ func (response GetPath404JSONResponse) VisitGetPathResponse(w http.ResponseWriter) error

+ type GetPath422JSONResponse struct

+ func (response GetPath422JSONResponse) VisitGetPathResponse(w http.ResponseWriter) error

+ type GetPath500JSONResponse struct

+ func (response GetPath500JSONResponse) VisitGetPathResponse(w http.ResponseWriter) error

+ type GetPathRequestObject struct

+ Destination string

+ Label Label

+ type GetPathResponseObject interface

+ VisitGetPathResponse func(w http.ResponseWriter) error

+ type GetVertex200JSONResponse Vertex

+ func (response GetVertex200JSONResponse) VisitGetVertexResponse(w http.ResponseWriter) error

+ type GetVertex401JSONResponse struct

+ func (response GetVertex401JSONResponse) VisitGetVertexResponse(w http.ResponseWriter) error

+ type GetVertex404JSONResponse struct

+ func (response GetVertex404JSONResponse) VisitGetVertexResponse(w http.ResponseWriter) error

+ type GetVertex422JSONResponse struct

+ func (response GetVertex422JSONResponse) VisitGetVertexResponse(w http.ResponseWriter) error

+ type GetVertex500JSONResponse struct

+ func (response GetVertex500JSONResponse) VisitGetVertexResponse(w http.ResponseWriter) error

+ type GetVertexDependencies200JSONResponse Subgraph

+ func (response GetVertexDependencies200JSONResponse) VisitGetVertexDependenciesResponse(w http.ResponseWriter) error

+ type GetVertexDependencies401JSONResponse struct

+ func (response GetVertexDependencies401JSONResponse) VisitGetVertexDependenciesResponse(w http.ResponseWriter) error

+ type GetVertexDependencies404JSONResponse struct

+ func (response GetVertexDependencies404JSONResponse) VisitGetVertexDependenciesResponse(w http.ResponseWriter) error

+ type GetVertexDependencies422JSONResponse struct

+ func (response GetVertexDependencies422JSONResponse) VisitGetVertexDependenciesResponse(w http.ResponseWriter) error

+ type GetVertexDependencies500JSONResponse struct

+ func (response GetVertexDependencies500JSONResponse) VisitGetVertexDependenciesResponse(w http.ResponseWriter) error

+ type GetVertexDependenciesParams struct

+ All *bool

+ type GetVertexDependenciesRequestObject struct

+ Label Label

+ Params GetVertexDependenciesParams

+ type GetVertexDependenciesResponseObject interface

+ VisitGetVertexDependenciesResponse func(w http.ResponseWriter) error

+ type GetVertexDependents200JSONResponse Subgraph

+ func (response GetVertexDependents200JSONResponse) VisitGetVertexDependentsResponse(w http.ResponseWriter) error

+ type GetVertexDependents401JSONResponse struct

+ func (response GetVertexDependents401JSONResponse) VisitGetVertexDependentsResponse(w http.ResponseWriter) error

+ type GetVertexDependents404JSONResponse struct

+ func (response GetVertexDependents404JSONResponse) VisitGetVertexDependentsResponse(w http.ResponseWriter) error

+ type GetVertexDependents422JSONResponse struct

+ func (response GetVertexDependents422JSONResponse) VisitGetVertexDependentsResponse(w http.ResponseWriter) error

+ type GetVertexDependents500JSONResponse struct

+ func (response GetVertexDependents500JSONResponse) VisitGetVertexDependentsResponse(w http.ResponseWriter) error

+ type GetVertexDependentsParams struct

+ All *bool

+ type GetVertexDependentsRequestObject struct

+ Label Label

+ Params GetVertexDependentsParams

+ type GetVertexDependentsResponseObject interface

+ VisitGetVertexDependentsResponse func(w http.ResponseWriter) error

+ type GetVertexLineages200JSONResponse Subgraph

+ func (response GetVertexLineages200JSONResponse) VisitGetVertexLineagesResponse(w http.ResponseWriter) error

+ type GetVertexLineages401JSONResponse struct

+ func (response GetVertexLineages401JSONResponse) VisitGetVertexLineagesResponse(w http.ResponseWriter) error

+ type GetVertexLineages404JSONResponse struct

+ func (response GetVertexLineages404JSONResponse) VisitGetVertexLineagesResponse(w http.ResponseWriter) error

+ type GetVertexLineages422JSONResponse struct

+ func (response GetVertexLineages422JSONResponse) VisitGetVertexLineagesResponse(w http.ResponseWriter) error

+ type GetVertexLineages500JSONResponse struct

+ func (response GetVertexLineages500JSONResponse) VisitGetVertexLineagesResponse(w http.ResponseWriter) error

+ type GetVertexLineagesRequestObject struct

+ Label Label

+ type GetVertexLineagesResponseObject interface

+ VisitGetVertexLineagesResponse func(w http.ResponseWriter) error

+ type GetVertexNeighbors200JSONResponse Subgraph

+ func (response GetVertexNeighbors200JSONResponse) VisitGetVertexNeighborsResponse(w http.ResponseWriter) error

+ type GetVertexNeighbors401JSONResponse struct

+ func (response GetVertexNeighbors401JSONResponse) VisitGetVertexNeighborsResponse(w http.ResponseWriter) error

+ type GetVertexNeighbors404JSONResponse struct

+ func (response GetVertexNeighbors404JSONResponse) VisitGetVertexNeighborsResponse(w http.ResponseWriter) error

+ type GetVertexNeighbors422JSONResponse struct

+ func (response GetVertexNeighbors422JSONResponse) VisitGetVertexNeighborsResponse(w http.ResponseWriter) error

+ type GetVertexNeighbors500JSONResponse struct

+ func (response GetVertexNeighbors500JSONResponse) VisitGetVertexNeighborsResponse(w http.ResponseWriter) error

+ type GetVertexNeighborsRequestObject struct

+ Label Label

+ type GetVertexNeighborsResponseObject interface

+ VisitGetVertexNeighborsResponse func(w http.ResponseWriter) error

+ type GetVertexRequestObject struct

+ Label Label

+ type GetVertexResponseObject interface

+ VisitGetVertexResponse func(w http.ResponseWriter) error

+ type InternalServerError struct

+ Code int

+ Error string

+ type InternalServerErrorJSONResponse struct

+ Code int

+ Error string

+ type InvalidParamFormatError struct

+ Err error

+ ParamName string

+ func (e *InvalidParamFormatError) Error() string

+ func (e *InvalidParamFormatError) Unwrap() error

+ type InvalidRequest struct

+ Code int

+ Error string

+ type InvalidRequestJSONResponse struct

+ Code int

+ Error string

+ type Label = string

+ type MiddlewareFunc func(http.Handler) http.Handler

+ type NotFound struct

+ Code int

+ Error string

+ type NotFoundJSONResponse struct

+ Code int

+ Error string

+ type RequiredHeaderError struct

+ Err error

+ ParamName string

+ func (e *RequiredHeaderError) Error() string

+ func (e *RequiredHeaderError) Unwrap() error

+ type RequiredParamError struct

+ ParamName string

+ func (e *RequiredParamError) Error() string

+ type ServeMux interface

+ HandleFunc func(pattern string, handler func(http.ResponseWriter, *http.Request))

+ ServeHTTP func(w http.ResponseWriter, r *http.Request)

+ type ServerInterface interface

+ GetPath func(w http.ResponseWriter, r *http.Request, label Label, destination string)

+ GetVertex func(w http.ResponseWriter, r *http.Request, label Label)

+ GetVertexDependencies func(w http.ResponseWriter, r *http.Request, label Label, ...)

+ GetVertexDependents func(w http.ResponseWriter, r *http.Request, label Label, ...)

+ GetVertexLineages func(w http.ResponseWriter, r *http.Request, label Label)

+ GetVertexNeighbors func(w http.ResponseWriter, r *http.Request, label Label)

+ Summary func(w http.ResponseWriter, r *http.Request)

+ func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

+ func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, ...) ServerInterface

+ type ServerInterfaceWrapper struct

+ ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)

+ Handler ServerInterface

+ HandlerMiddlewares []MiddlewareFunc

+ func (siw *ServerInterfaceWrapper) GetPath(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) GetVertex(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) GetVertexDependencies(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) GetVertexDependents(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) GetVertexLineages(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) GetVertexNeighbors(w http.ResponseWriter, r *http.Request)

+ func (siw *ServerInterfaceWrapper) Summary(w http.ResponseWriter, r *http.Request)

+ type StdHTTPServerOptions struct

+ BaseRouter ServeMux

+ BaseURL string

+ ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)

+ Middlewares []MiddlewareFunc

+ 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 = strictnethttp.StrictHTTPHandlerFunc

+ type StrictMiddlewareFunc = strictnethttp.StrictHTTPMiddlewareFunc

+ type StrictServerInterface interface

+ GetPath func(ctx context.Context, request GetPathRequestObject) (GetPathResponseObject, error)

+ GetVertex func(ctx context.Context, request GetVertexRequestObject) (GetVertexResponseObject, error)

+ GetVertexDependencies func(ctx context.Context, request GetVertexDependenciesRequestObject) (GetVertexDependenciesResponseObject, error)

+ GetVertexDependents func(ctx context.Context, request GetVertexDependentsRequestObject) (GetVertexDependentsResponseObject, error)

+ GetVertexLineages func(ctx context.Context, request GetVertexLineagesRequestObject) (GetVertexLineagesResponseObject, error)

+ GetVertexNeighbors func(ctx context.Context, request GetVertexNeighborsRequestObject) (GetVertexNeighborsResponseObject, error)

+ Summary func(ctx context.Context, request SummaryRequestObject) (SummaryResponseObject, error)

+ func New(s *service.Service) StrictServerInterface

+ type Subgraph struct

+ All bool

+ Edges []Edge

+ Highlights []Vertex

+ Principal Vertex

+ Title string

+ Vertices []Vertex

+ type Summary struct

+ TotalVertices int

+ UnhealthyVertices []Vertex

+ type Summary200JSONResponse Summary

+ func (response Summary200JSONResponse) VisitSummaryResponse(w http.ResponseWriter) error

+ type Summary401JSONResponse struct

+ func (response Summary401JSONResponse) VisitSummaryResponse(w http.ResponseWriter) error

+ type Summary500JSONResponse struct

+ func (response Summary500JSONResponse) VisitSummaryResponse(w http.ResponseWriter) error

+ type SummaryRequestObject struct

+ type SummaryResponseObject interface

+ VisitSummaryResponse func(w http.ResponseWriter) error

+ type TooManyValuesForParamError struct

+ Count int

+ ParamName string

+ func (e *TooManyValuesForParamError) Error() string

+ type Unauthorized struct

+ Code int

+ Error string

+ type UnauthorizedJSONResponse struct

+ Code int

+ Error string

+ type UnescapedCookieParamError struct

+ Err error

+ ParamName string

+ func (e *UnescapedCookieParamError) Error() string

+ func (e *UnescapedCookieParamError) Unwrap() error

+ type UnmarshalingParamError struct

+ Err error

+ ParamName string

+ func (e *UnmarshalingParamError) Error() string

+ func (e *UnmarshalingParamError) Unwrap() error

+ type Vertex struct

+ Class string

+ Label string

+ LastCheck string

+ Status VertexStatus

+ type VertexStatus string

+ const Error

+ const Ok

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL