Help us shape the future of Go! Take the 2026 Go Developer Survey

grid

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Package grid 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

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSpec

func GetSpec() (swagger *openapi3.T, err error)

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

func GetSpecJSON() ([]byte, error)

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 GetSwagger() (*openapi3.T, error)

GetSwagger returns the OpenAPI specification corresponding to the generated code in this file.

Deprecated: GetSwagger predates kin-openapi renaming openapi3.Swagger to openapi3.T. Use GetSpec instead. This wrapper is retained for backwards compatibility.

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type AllEntityTypesSummaryResponse

type AllEntityTypesSummaryResponse struct {
	// EntityTypes Required within this object. One entry per monitored entity type: users, groups, permissions, tokens, projects, environments, roles, projectGroups, projectUsers and projectResources. Users, groups, permissions and tokens are replicated through Access federation; the other types report zero counts.
	EntityTypes []EntityTypeSummary `json:"entity_types"`

	// Timestamp Required within this object. Server-owned. RFC 3339 time the counts were computed.
	Timestamp time.Time `json:"timestamp"`
}

AllEntityTypesSummaryResponse Sync counts per entity type across the topology.

type ChiServerOptions

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type CreateGridTopology201JSONResponse

type CreateGridTopology201JSONResponse TopologyResponse

func (CreateGridTopology201JSONResponse) VisitCreateGridTopologyResponse

func (response CreateGridTopology201JSONResponse) VisitCreateGridTopologyResponse(w http.ResponseWriter) error

type CreateGridTopology400JSONResponse

type CreateGridTopology400JSONResponse TopologyValidationError

func (CreateGridTopology400JSONResponse) VisitCreateGridTopologyResponse

func (response CreateGridTopology400JSONResponse) VisitCreateGridTopologyResponse(w http.ResponseWriter) error

type CreateGridTopology401JSONResponse

type CreateGridTopology401JSONResponse ErrorResponse

func (CreateGridTopology401JSONResponse) VisitCreateGridTopologyResponse

func (response CreateGridTopology401JSONResponse) VisitCreateGridTopologyResponse(w http.ResponseWriter) error

type CreateGridTopology403JSONResponse

type CreateGridTopology403JSONResponse ErrorResponse

func (CreateGridTopology403JSONResponse) VisitCreateGridTopologyResponse

func (response CreateGridTopology403JSONResponse) VisitCreateGridTopologyResponse(w http.ResponseWriter) error

type CreateGridTopology409JSONResponse

type CreateGridTopology409JSONResponse ErrorResponse

func (CreateGridTopology409JSONResponse) VisitCreateGridTopologyResponse

func (response CreateGridTopology409JSONResponse) VisitCreateGridTopologyResponse(w http.ResponseWriter) error

type CreateGridTopology500JSONResponse

type CreateGridTopology500JSONResponse ErrorResponse

func (CreateGridTopology500JSONResponse) VisitCreateGridTopologyResponse

func (response CreateGridTopology500JSONResponse) VisitCreateGridTopologyResponse(w http.ResponseWriter) error

type CreateGridTopologyJSONRequestBody

type CreateGridTopologyJSONRequestBody = CreateTopologyRequest

CreateGridTopologyJSONRequestBody defines body for CreateGridTopology for application/json ContentType.

type CreateGridTopologyRequestObject

type CreateGridTopologyRequestObject struct {
	Body *CreateGridTopologyJSONRequestBody
}

type CreateGridTopologyResponseObject

type CreateGridTopologyResponseObject interface {
	VisitCreateGridTopologyResponse(w http.ResponseWriter) error
}

type CreateTopologyRequest

type CreateTopologyRequest struct {
	// Description Optional within this object. Free text.
	Description *string `json:"description,omitempty"`

	// Name Required within this object. Display name. The topology key is derived from it and must be unique.
	Name string `json:"name"`

	// Sites Required within this object. The instances in the topology; at least two, each named once.
	Sites []SiteRequest `json:"sites"`
}

CreateTopologyRequest A new topology: a named set of instances that federate identity with each other.

type DeleteGridTopology204Response

type DeleteGridTopology204Response struct {
}

func (DeleteGridTopology204Response) VisitDeleteGridTopologyResponse

func (response DeleteGridTopology204Response) VisitDeleteGridTopologyResponse(w http.ResponseWriter) error

type DeleteGridTopology401JSONResponse

type DeleteGridTopology401JSONResponse ErrorResponse

func (DeleteGridTopology401JSONResponse) VisitDeleteGridTopologyResponse

func (response DeleteGridTopology401JSONResponse) VisitDeleteGridTopologyResponse(w http.ResponseWriter) error

type DeleteGridTopology403JSONResponse

type DeleteGridTopology403JSONResponse ErrorResponse

func (DeleteGridTopology403JSONResponse) VisitDeleteGridTopologyResponse

func (response DeleteGridTopology403JSONResponse) VisitDeleteGridTopologyResponse(w http.ResponseWriter) error

type DeleteGridTopology404JSONResponse

type DeleteGridTopology404JSONResponse ErrorResponse

func (DeleteGridTopology404JSONResponse) VisitDeleteGridTopologyResponse

func (response DeleteGridTopology404JSONResponse) VisitDeleteGridTopologyResponse(w http.ResponseWriter) error

type DeleteGridTopology409JSONResponse

type DeleteGridTopology409JSONResponse TopologyResponse

func (DeleteGridTopology409JSONResponse) VisitDeleteGridTopologyResponse

func (response DeleteGridTopology409JSONResponse) VisitDeleteGridTopologyResponse(w http.ResponseWriter) error

type DeleteGridTopology500JSONResponse

type DeleteGridTopology500JSONResponse ErrorResponse

func (DeleteGridTopology500JSONResponse) VisitDeleteGridTopologyResponse

func (response DeleteGridTopology500JSONResponse) VisitDeleteGridTopologyResponse(w http.ResponseWriter) error

type DeleteGridTopologyRequestObject

type DeleteGridTopologyRequestObject struct {
	Key string `json:"key"`
}

type DeleteGridTopologyResponseObject

type DeleteGridTopologyResponseObject interface {
	VisitDeleteGridTopologyResponse(w http.ResponseWriter) error
}

type EntityDetailResponse

type EntityDetailResponse struct {
	// EntityId Required within this object. The entity's business id.
	EntityId string `json:"entity_id"`

	// EntityType Required within this object. The entity type public key.
	EntityType string `json:"entity_type"`

	// Targets Required within this object. Delivery state per target.
	Targets []TargetSyncStatus `json:"targets"`
}

EntityDetailResponse Delivery state of one entity to every target, including failure reasons.

type EntityListItem

type EntityListItem struct {
	// EntityId Required within this object. The entity's business id, such as a username.
	EntityId string `json:"entity_id"`

	// EntityType Required within this object. The entity type public key.
	EntityType string `json:"entity_type"`

	// Targets Optional within this object. Delivery state per target.
	Targets *[]TargetSyncStatus `json:"targets,omitempty"`
}

EntityListItem One entity and its per-target states.

type EntityListResponse

type EntityListResponse struct {
	// Entities Required within this object. Entities on this page.
	Entities []EntityListItem `json:"entities"`

	// NextPageToken Required within this object. Opaque token for the next page; empty on the last page.
	NextPageToken string `json:"next_page_token"`

	// TotalCount Required within this object. Entities matching the filters across all pages.
	TotalCount int64 `json:"total_count"`
}

EntityListResponse A page of monitored entities.

type EntityTypeSummary

type EntityTypeSummary struct {
	// Counts Required within this object. Counts across every target in the topology.
	Counts StatusCounts `json:"counts"`

	// EntityType Required within this object. The entity type public key.
	EntityType string `json:"entity_type"`
}

EntityTypeSummary Counts for one monitored entity type.

type ErrorResponse

type ErrorResponse struct {
	// Code Required within this object. A symbolic code such as NOT_FOUND.
	Code string `json:"code"`

	// Details Optional within this object. Field-level details, one string each.
	Details *[]string `json:"details,omitempty"`

	// Message Required within this object. Human readable explanation.
	Message string `json:"message"`
}

ErrorResponse The flat error envelope used by /grid; details lists the offending fields when there are any.

type GetGridTopology200JSONResponse

type GetGridTopology200JSONResponse TopologyResponse

func (GetGridTopology200JSONResponse) VisitGetGridTopologyResponse

func (response GetGridTopology200JSONResponse) VisitGetGridTopologyResponse(w http.ResponseWriter) error

type GetGridTopology401JSONResponse

type GetGridTopology401JSONResponse ErrorResponse

func (GetGridTopology401JSONResponse) VisitGetGridTopologyResponse

func (response GetGridTopology401JSONResponse) VisitGetGridTopologyResponse(w http.ResponseWriter) error

type GetGridTopology403JSONResponse

type GetGridTopology403JSONResponse ErrorResponse

func (GetGridTopology403JSONResponse) VisitGetGridTopologyResponse

func (response GetGridTopology403JSONResponse) VisitGetGridTopologyResponse(w http.ResponseWriter) error

type GetGridTopology404JSONResponse

type GetGridTopology404JSONResponse ErrorResponse

func (GetGridTopology404JSONResponse) VisitGetGridTopologyResponse

func (response GetGridTopology404JSONResponse) VisitGetGridTopologyResponse(w http.ResponseWriter) error

type GetGridTopology500JSONResponse

type GetGridTopology500JSONResponse ErrorResponse

func (GetGridTopology500JSONResponse) VisitGetGridTopologyResponse

func (response GetGridTopology500JSONResponse) VisitGetGridTopologyResponse(w http.ResponseWriter) error

type GetGridTopologyRequestObject

type GetGridTopologyRequestObject struct {
	Key string `json:"key"`
}

type GetGridTopologyResponseObject

type GetGridTopologyResponseObject interface {
	VisitGetGridTopologyResponse(w http.ResponseWriter) error
}

type GetMonitoringEntityDetail200JSONResponse

type GetMonitoringEntityDetail200JSONResponse EntityDetailResponse

func (GetMonitoringEntityDetail200JSONResponse) VisitGetMonitoringEntityDetailResponse

func (response GetMonitoringEntityDetail200JSONResponse) VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error

type GetMonitoringEntityDetail400JSONResponse

type GetMonitoringEntityDetail400JSONResponse ErrorResponse

func (GetMonitoringEntityDetail400JSONResponse) VisitGetMonitoringEntityDetailResponse

func (response GetMonitoringEntityDetail400JSONResponse) VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error

type GetMonitoringEntityDetail401JSONResponse

type GetMonitoringEntityDetail401JSONResponse ErrorResponse

func (GetMonitoringEntityDetail401JSONResponse) VisitGetMonitoringEntityDetailResponse

func (response GetMonitoringEntityDetail401JSONResponse) VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error

type GetMonitoringEntityDetail403JSONResponse

type GetMonitoringEntityDetail403JSONResponse ErrorResponse

func (GetMonitoringEntityDetail403JSONResponse) VisitGetMonitoringEntityDetailResponse

func (response GetMonitoringEntityDetail403JSONResponse) VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error

type GetMonitoringEntityDetail404JSONResponse

type GetMonitoringEntityDetail404JSONResponse ErrorResponse

func (GetMonitoringEntityDetail404JSONResponse) VisitGetMonitoringEntityDetailResponse

func (response GetMonitoringEntityDetail404JSONResponse) VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error

type GetMonitoringEntityDetail500JSONResponse

type GetMonitoringEntityDetail500JSONResponse ErrorResponse

func (GetMonitoringEntityDetail500JSONResponse) VisitGetMonitoringEntityDetailResponse

func (response GetMonitoringEntityDetail500JSONResponse) VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error

type GetMonitoringEntityDetailRequestObject

type GetMonitoringEntityDetailRequestObject struct {
	Key        string `json:"key"`
	EntityType string `json:"entity_type"`
	EntityId   string `json:"entity_id"`
}

type GetMonitoringEntityDetailResponseObject

type GetMonitoringEntityDetailResponseObject interface {
	VisitGetMonitoringEntityDetailResponse(w http.ResponseWriter) error
}

type GetMonitoringEntityList200JSONResponse

type GetMonitoringEntityList200JSONResponse EntityListResponse

func (GetMonitoringEntityList200JSONResponse) VisitGetMonitoringEntityListResponse

func (response GetMonitoringEntityList200JSONResponse) VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error

type GetMonitoringEntityList400JSONResponse

type GetMonitoringEntityList400JSONResponse ErrorResponse

func (GetMonitoringEntityList400JSONResponse) VisitGetMonitoringEntityListResponse

func (response GetMonitoringEntityList400JSONResponse) VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error

type GetMonitoringEntityList401JSONResponse

type GetMonitoringEntityList401JSONResponse ErrorResponse

func (GetMonitoringEntityList401JSONResponse) VisitGetMonitoringEntityListResponse

func (response GetMonitoringEntityList401JSONResponse) VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error

type GetMonitoringEntityList403JSONResponse

type GetMonitoringEntityList403JSONResponse ErrorResponse

func (GetMonitoringEntityList403JSONResponse) VisitGetMonitoringEntityListResponse

func (response GetMonitoringEntityList403JSONResponse) VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error

type GetMonitoringEntityList404JSONResponse

type GetMonitoringEntityList404JSONResponse ErrorResponse

func (GetMonitoringEntityList404JSONResponse) VisitGetMonitoringEntityListResponse

func (response GetMonitoringEntityList404JSONResponse) VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error

type GetMonitoringEntityList500JSONResponse

type GetMonitoringEntityList500JSONResponse ErrorResponse

func (GetMonitoringEntityList500JSONResponse) VisitGetMonitoringEntityListResponse

func (response GetMonitoringEntityList500JSONResponse) VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error

type GetMonitoringEntityListParams

type GetMonitoringEntityListParams struct {
	// EntityType Required query parameter. Entity type public key: users, groups, permissions, tokens, projects, environments, roles, projectGroups, projectUsers and projectResources. Users, groups, permissions and tokens are replicated through Access federation; the other types report zero counts.
	EntityType string `form:"entity_type" json:"entity_type"`

	// Status Optional query parameter. Return only entities with at least one target in this state; omitted means any state.
	Status *GetMonitoringEntityListParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// PageToken Optional query parameter. The next_page_token from the previous page; omitted for the first page.
	PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
}

GetMonitoringEntityListParams defines parameters for GetMonitoringEntityList.

type GetMonitoringEntityListParamsStatus

type GetMonitoringEntityListParamsStatus string

GetMonitoringEntityListParamsStatus defines parameters for GetMonitoringEntityList.

const (
	GetMonitoringEntityListParamsStatusFailure    GetMonitoringEntityListParamsStatus = "failure"
	GetMonitoringEntityListParamsStatusInProgress GetMonitoringEntityListParamsStatus = "in_progress"
	GetMonitoringEntityListParamsStatusSuccess    GetMonitoringEntityListParamsStatus = "success"
)

Defines values for GetMonitoringEntityListParamsStatus.

func (GetMonitoringEntityListParamsStatus) Valid

Valid indicates whether the value is a known member of the GetMonitoringEntityListParamsStatus enum.

type GetMonitoringEntityListRequestObject

type GetMonitoringEntityListRequestObject struct {
	Key    string `json:"key"`
	Params GetMonitoringEntityListParams
}

type GetMonitoringEntityListResponseObject

type GetMonitoringEntityListResponseObject interface {
	VisitGetMonitoringEntityListResponse(w http.ResponseWriter) error
}

type GetMonitoringSummary200JSONResponse

type GetMonitoringSummary200JSONResponse AllEntityTypesSummaryResponse

func (GetMonitoringSummary200JSONResponse) VisitGetMonitoringSummaryResponse

func (response GetMonitoringSummary200JSONResponse) VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error

type GetMonitoringSummary400JSONResponse

type GetMonitoringSummary400JSONResponse ErrorResponse

func (GetMonitoringSummary400JSONResponse) VisitGetMonitoringSummaryResponse

func (response GetMonitoringSummary400JSONResponse) VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error

type GetMonitoringSummary401JSONResponse

type GetMonitoringSummary401JSONResponse ErrorResponse

func (GetMonitoringSummary401JSONResponse) VisitGetMonitoringSummaryResponse

func (response GetMonitoringSummary401JSONResponse) VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error

type GetMonitoringSummary403JSONResponse

type GetMonitoringSummary403JSONResponse ErrorResponse

func (GetMonitoringSummary403JSONResponse) VisitGetMonitoringSummaryResponse

func (response GetMonitoringSummary403JSONResponse) VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error

type GetMonitoringSummary404JSONResponse

type GetMonitoringSummary404JSONResponse ErrorResponse

func (GetMonitoringSummary404JSONResponse) VisitGetMonitoringSummaryResponse

func (response GetMonitoringSummary404JSONResponse) VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error

type GetMonitoringSummary500JSONResponse

type GetMonitoringSummary500JSONResponse ErrorResponse

func (GetMonitoringSummary500JSONResponse) VisitGetMonitoringSummaryResponse

func (response GetMonitoringSummary500JSONResponse) VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error

type GetMonitoringSummaryParams

type GetMonitoringSummaryParams struct {
	// ModifiedAfter Optional query parameter. RFC 3339 time; only entities modified after it are counted.
	ModifiedAfter *time.Time `form:"modified_after,omitempty" json:"modified_after,omitempty"`

	// ModifiedBefore Optional query parameter. RFC 3339 time; only entities modified before it are counted. Must be later than modified_after when both are given.
	ModifiedBefore *time.Time `form:"modified_before,omitempty" json:"modified_before,omitempty"`

	// ShowSystemEntities Optional query parameter. When true, also count the project-scoped types projectUsers, projectGroups and projectResources. Defaults to false.
	ShowSystemEntities *bool `form:"show_system_entities,omitempty" json:"show_system_entities,omitempty"`
}

GetMonitoringSummaryParams defines parameters for GetMonitoringSummary.

type GetMonitoringSummaryRequestObject

type GetMonitoringSummaryRequestObject struct {
	Key    string `json:"key"`
	Params GetMonitoringSummaryParams
}

type GetMonitoringSummaryResponseObject

type GetMonitoringSummaryResponseObject interface {
	VisitGetMonitoringSummaryResponse(w http.ResponseWriter) error
}

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type JPDLocation

type JPDLocation struct {
	// CityName Optional within this object. City name; empty when not configured.
	CityName *string `json:"city_name,omitempty"`

	// CountryCode Optional within this object. ISO 3166-1 alpha-2 country code; empty when not configured.
	CountryCode *string `json:"country_code,omitempty"`
}

JPDLocation Where an instance runs, as configured on that instance.

type JPDResponse

type JPDResponse struct {
	// BaseUrl Optional within this object. The public base URL the instance reports for itself; may differ from url behind a proxy.
	BaseUrl *string `json:"base_url,omitempty"`

	// Id Optional within this object. Server-owned. The instance's service id.
	Id *string `json:"id,omitempty"`

	// Licenses Optional within this object. Licence entries; always one entry.
	Licenses *[]License `json:"licenses,omitempty"`

	// Local Optional within this object. True for the instance answering the request.
	Local *bool `json:"local,omitempty"`

	// Location Optional within this object. Configured location of the instance.
	Location *JPDLocation `json:"location,omitempty"`

	// Name Optional within this object. Display name of the instance.
	Name *string `json:"name,omitempty"`

	// Status Optional within this object. Last observed reachability.
	Status *JPDStatus `json:"status,omitempty"`

	// Url Optional within this object. URL this instance uses to reach it.
	Url *string `json:"url,omitempty"`
}

JPDResponse One instance known to this instance: itself or a paired peer.

type JPDStatus

type JPDStatus struct {
	// Code Optional within this object. ONLINE: reachable and trusted. OFFLINE: not reachable. PARTIAL: reachable but reporting an unhealthy service. UNAUTHORIZED: reachable but the pairing keys are no longer accepted.
	Code *JPDStatusCode `json:"code,omitempty"`

	// Message Optional within this object. Explanation for any code other than ONLINE; empty otherwise.
	Message *string `json:"message,omitempty"`
}

JPDStatus Reachability of an instance as last observed over the peer protocol.

type JPDStatusCode

type JPDStatusCode string

JPDStatusCode Optional within this object. ONLINE: reachable and trusted. OFFLINE: not reachable. PARTIAL: reachable but reporting an unhealthy service. UNAUTHORIZED: reachable but the pairing keys are no longer accepted.

const (
	JPDStatusCodeOFFLINE      JPDStatusCode = "OFFLINE"
	JPDStatusCodeONLINE       JPDStatusCode = "ONLINE"
	JPDStatusCodePARTIAL      JPDStatusCode = "PARTIAL"
	JPDStatusCodeUNAUTHORIZED JPDStatusCode = "UNAUTHORIZED"
)

Defines values for JPDStatusCode.

func (JPDStatusCode) Valid

func (e JPDStatusCode) Valid() bool

Valid indicates whether the value is a known member of the JPDStatusCode enum.

type License

type License struct {
	// Type Optional within this object. Licence type; always `artifactweave`.
	Type *string `json:"type,omitempty"`
}

License A licence entry reported for an instance.

type ListGridTopologies200JSONResponse

type ListGridTopologies200JSONResponse TopologiesListResponse

func (ListGridTopologies200JSONResponse) VisitListGridTopologiesResponse

func (response ListGridTopologies200JSONResponse) VisitListGridTopologiesResponse(w http.ResponseWriter) error

type ListGridTopologies401JSONResponse

type ListGridTopologies401JSONResponse ErrorResponse

func (ListGridTopologies401JSONResponse) VisitListGridTopologiesResponse

func (response ListGridTopologies401JSONResponse) VisitListGridTopologiesResponse(w http.ResponseWriter) error

type ListGridTopologies403JSONResponse

type ListGridTopologies403JSONResponse ErrorResponse

func (ListGridTopologies403JSONResponse) VisitListGridTopologiesResponse

func (response ListGridTopologies403JSONResponse) VisitListGridTopologiesResponse(w http.ResponseWriter) error

type ListGridTopologies500JSONResponse

type ListGridTopologies500JSONResponse ErrorResponse

func (ListGridTopologies500JSONResponse) VisitListGridTopologiesResponse

func (response ListGridTopologies500JSONResponse) VisitListGridTopologiesResponse(w http.ResponseWriter) error

type ListGridTopologiesRequestObject

type ListGridTopologiesRequestObject struct {
}

type ListGridTopologiesResponseObject

type ListGridTopologiesResponseObject interface {
	VisitListGridTopologiesResponse(w http.ResponseWriter) error
}

type ListJPDs200JSONResponse

type ListJPDs200JSONResponse []JPDResponse

func (ListJPDs200JSONResponse) VisitListJPDsResponse

func (response ListJPDs200JSONResponse) VisitListJPDsResponse(w http.ResponseWriter) error

type ListJPDs400JSONResponse

type ListJPDs400JSONResponse ErrorResponse

func (ListJPDs400JSONResponse) VisitListJPDsResponse

func (response ListJPDs400JSONResponse) VisitListJPDsResponse(w http.ResponseWriter) error

type ListJPDs401JSONResponse

type ListJPDs401JSONResponse ErrorResponse

func (ListJPDs401JSONResponse) VisitListJPDsResponse

func (response ListJPDs401JSONResponse) VisitListJPDsResponse(w http.ResponseWriter) error

type ListJPDs403JSONResponse

type ListJPDs403JSONResponse ErrorResponse

func (ListJPDs403JSONResponse) VisitListJPDsResponse

func (response ListJPDs403JSONResponse) VisitListJPDsResponse(w http.ResponseWriter) error

type ListJPDs500JSONResponse

type ListJPDs500JSONResponse ErrorResponse

func (ListJPDs500JSONResponse) VisitListJPDsResponse

func (response ListJPDs500JSONResponse) VisitListJPDsResponse(w http.ResponseWriter) error

type ListJPDsParams

type ListJPDsParams struct {
	// Name Optional query parameter. Filter on instance name; * matches any run of characters.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// Tag Optional query parameter. Filter on instance tag. Instances carry no tags, so only * (or omitting the filter) matches anything.
	Tag *string `form:"tag,omitempty" json:"tag,omitempty"`

	// Url Optional query parameter. Filter on instance URL; * matches any run of characters.
	Url *string `form:"url,omitempty" json:"url,omitempty"`

	// Status Optional query parameter. Filter on status code.
	Status *ListJPDsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
}

ListJPDsParams defines parameters for ListJPDs.

type ListJPDsParamsStatus

type ListJPDsParamsStatus string

ListJPDsParamsStatus defines parameters for ListJPDs.

const (
	ListJPDsParamsStatusOFFLINE      ListJPDsParamsStatus = "OFFLINE"
	ListJPDsParamsStatusONLINE       ListJPDsParamsStatus = "ONLINE"
	ListJPDsParamsStatusPARTIAL      ListJPDsParamsStatus = "PARTIAL"
	ListJPDsParamsStatusUNAUTHORIZED ListJPDsParamsStatus = "UNAUTHORIZED"
)

Defines values for ListJPDsParamsStatus.

func (ListJPDsParamsStatus) Valid

func (e ListJPDsParamsStatus) Valid() bool

Valid indicates whether the value is a known member of the ListJPDsParamsStatus enum.

type ListJPDsRequestObject

type ListJPDsRequestObject struct {
	Params ListJPDsParams
}

type ListJPDsResponseObject

type ListJPDsResponseObject interface {
	VisitListJPDsResponse(w http.ResponseWriter) error
}

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

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 ServerInterface

type ServerInterface interface {
	// ListJPDs List known instances
	// (GET /api/v1/jpds)
	ListJPDs(w http.ResponseWriter, r *http.Request, params ListJPDsParams)
	// ListGridTopologies List topologies
	// (GET /api/v1/topology)
	ListGridTopologies(w http.ResponseWriter, r *http.Request)
	// CreateGridTopology Create a topology
	// (POST /api/v1/topology)
	CreateGridTopology(w http.ResponseWriter, r *http.Request)
	// DeleteGridTopology Delete a topology
	// (DELETE /api/v1/topology/{key})
	DeleteGridTopology(w http.ResponseWriter, r *http.Request, key string)
	// GetGridTopology Get a topology
	// (GET /api/v1/topology/{key})
	GetGridTopology(w http.ResponseWriter, r *http.Request, key string)
	// UpdateGridTopology Update a topology
	// (PATCH /api/v1/topology/{key})
	UpdateGridTopology(w http.ResponseWriter, r *http.Request, key string)
	// GetMonitoringEntityList List monitored entities
	// (GET /api/v1/topology/{key}/monitoring/entities)
	GetMonitoringEntityList(w http.ResponseWriter, r *http.Request, key string, params GetMonitoringEntityListParams)
	// GetMonitoringSummary Summarise entity sync
	// (GET /api/v1/topology/{key}/monitoring/entities/summary)
	GetMonitoringSummary(w http.ResponseWriter, r *http.Request, key string, params GetMonitoringSummaryParams)
	// GetMonitoringEntityDetail Get one entity's sync state
	// (GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id})
	GetMonitoringEntityDetail(w http.ResponseWriter, r *http.Request, key string, entityType string, entityId string)
}

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) CreateGridTopology

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

CreateGridTopology operation middleware

func (*ServerInterfaceWrapper) DeleteGridTopology

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

DeleteGridTopology operation middleware

func (*ServerInterfaceWrapper) GetGridTopology

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

GetGridTopology operation middleware

func (*ServerInterfaceWrapper) GetMonitoringEntityDetail

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

GetMonitoringEntityDetail operation middleware

func (*ServerInterfaceWrapper) GetMonitoringEntityList

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

GetMonitoringEntityList operation middleware

func (*ServerInterfaceWrapper) GetMonitoringSummary

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

GetMonitoringSummary operation middleware

func (*ServerInterfaceWrapper) ListGridTopologies

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

ListGridTopologies operation middleware

func (*ServerInterfaceWrapper) ListJPDs

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

ListJPDs operation middleware

func (*ServerInterfaceWrapper) UpdateGridTopology

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

UpdateGridTopology operation middleware

type SiteRequest

type SiteRequest struct {
	// SiteName Required within this object. Name of a known instance (this one or a paired peer, as listed by GET /grid/api/v1/jpds). Unknown names answer 400 with a detail entry.
	SiteName string `json:"site_name"`
}

SiteRequest A site to include in a topology.

type StatusCounts

type StatusCounts struct {
	// Failure Required within this object. Entity and target pairs whose last delivery failed.
	Failure int64 `json:"failure"`

	// InProgress Required within this object. Pairs with a delivery queued or under way.
	InProgress int64 `json:"in_progress"`

	// Success Required within this object. Pairs whose last delivery was acknowledged.
	Success int64 `json:"success"`
}

StatusCounts Sync outcome counts for one entity type.

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 StrictHandlerFunc func(ctx context.Context, w http.ResponseWriter, r *http.Request, request any) (any, error)

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// ListJPDs List known instances
	// (GET /api/v1/jpds)
	ListJPDs(ctx context.Context, request ListJPDsRequestObject) (ListJPDsResponseObject, error)
	// ListGridTopologies List topologies
	// (GET /api/v1/topology)
	ListGridTopologies(ctx context.Context, request ListGridTopologiesRequestObject) (ListGridTopologiesResponseObject, error)
	// CreateGridTopology Create a topology
	// (POST /api/v1/topology)
	CreateGridTopology(ctx context.Context, request CreateGridTopologyRequestObject) (CreateGridTopologyResponseObject, error)
	// DeleteGridTopology Delete a topology
	// (DELETE /api/v1/topology/{key})
	DeleteGridTopology(ctx context.Context, request DeleteGridTopologyRequestObject) (DeleteGridTopologyResponseObject, error)
	// GetGridTopology Get a topology
	// (GET /api/v1/topology/{key})
	GetGridTopology(ctx context.Context, request GetGridTopologyRequestObject) (GetGridTopologyResponseObject, error)
	// UpdateGridTopology Update a topology
	// (PATCH /api/v1/topology/{key})
	UpdateGridTopology(ctx context.Context, request UpdateGridTopologyRequestObject) (UpdateGridTopologyResponseObject, error)
	// GetMonitoringEntityList List monitored entities
	// (GET /api/v1/topology/{key}/monitoring/entities)
	GetMonitoringEntityList(ctx context.Context, request GetMonitoringEntityListRequestObject) (GetMonitoringEntityListResponseObject, error)
	// GetMonitoringSummary Summarise entity sync
	// (GET /api/v1/topology/{key}/monitoring/entities/summary)
	GetMonitoringSummary(ctx context.Context, request GetMonitoringSummaryRequestObject) (GetMonitoringSummaryResponseObject, error)
	// GetMonitoringEntityDetail Get one entity's sync state
	// (GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id})
	GetMonitoringEntityDetail(ctx context.Context, request GetMonitoringEntityDetailRequestObject) (GetMonitoringEntityDetailResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TargetSyncStatus

type TargetSyncStatus struct {
	// Modified Optional within this object. RFC 3339 time the status last changed.
	Modified *time.Time `json:"modified,omitempty"`

	// SourceJpdId Required within this object. Service id of the sending instance.
	SourceJpdId string `json:"source_jpd_id"`

	// SourceSiteName Optional within this object. Name of the sending site.
	SourceSiteName *string `json:"source_site_name,omitempty"`

	// Status Required within this object. pending: queued, not yet sent. sent: delivered, not yet acknowledged. in_progress: being retried. success: acknowledged. failure: retries exhausted; see status_description.
	Status TargetSyncStatusStatus `json:"status"`

	// StatusDescription Optional within this object. The last error for failure; empty otherwise.
	StatusDescription *string `json:"status_description,omitempty"`

	// TargetJpdId Required within this object. Service id of the receiving instance.
	TargetJpdId string `json:"target_jpd_id"`

	// TargetSiteName Optional within this object. Name of the receiving site.
	TargetSiteName *string `json:"target_site_name,omitempty"`
}

TargetSyncStatus Delivery state of one entity from one site to another, taken from the peer outbox acknowledgements.

type TargetSyncStatusStatus

type TargetSyncStatusStatus string

TargetSyncStatusStatus Required within this object. pending: queued, not yet sent. sent: delivered, not yet acknowledged. in_progress: being retried. success: acknowledged. failure: retries exhausted; see status_description.

const (
	TargetSyncStatusStatusFailure    TargetSyncStatusStatus = "failure"
	TargetSyncStatusStatusInProgress TargetSyncStatusStatus = "in_progress"
	TargetSyncStatusStatusPending    TargetSyncStatusStatus = "pending"
	TargetSyncStatusStatusSent       TargetSyncStatusStatus = "sent"
	TargetSyncStatusStatusSuccess    TargetSyncStatusStatus = "success"
)

Defines values for TargetSyncStatusStatus.

func (TargetSyncStatusStatus) Valid

func (e TargetSyncStatusStatus) Valid() bool

Valid indicates whether the value is a known member of the TargetSyncStatusStatus enum.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type TopologiesListResponse

type TopologiesListResponse struct {
	// Topologies Required within this object. The topologies ordered by key.
	Topologies []TopologyResponse `json:"topologies"`

	// Total Required within this object. Number of topologies returned.
	Total int `json:"total"`
}

TopologiesListResponse Every topology on this instance.

type TopologyResponse

type TopologyResponse struct {
	// Created Optional within this object. Server-owned. RFC 3339 creation time.
	Created *time.Time `json:"created,omitempty"`

	// Description Optional within this object. Free text; empty when none.
	Description *string `json:"description,omitempty"`

	// Key Required within this object. Server-owned. Identifier derived from the name at creation and used in /topology/{key}.
	Key string `json:"key"`

	// Modified Optional within this object. Server-owned. RFC 3339 time of the last change.
	Modified *time.Time `json:"modified,omitempty"`

	// Name Required within this object. Display name.
	Name string `json:"name"`

	// Sites Required within this object. The sites and their state.
	Sites []TopologySiteResponse `json:"sites"`
}

TopologyResponse A stored topology.

type TopologySiteResponse

type TopologySiteResponse struct {
	// IsCurrent Optional within this object. True for the instance answering the request.
	IsCurrent *bool `json:"is_current,omitempty"`

	// Location Optional within this object. Configured location of the site.
	Location *JPDLocation `json:"location,omitempty"`

	// SiteName Optional within this object. The instance name.
	SiteName *string `json:"site_name,omitempty"`

	// Status Optional within this object. Connected when Access federation between this site and the others in the topology is configured and reachable; Disconnected otherwise, with the reason in status_description. A store that succeeds can still leave a site Disconnected.
	Status *TopologySiteResponseStatus `json:"status,omitempty"`

	// StatusDescription Optional within this object. Why a site is Disconnected; empty when Connected.
	StatusDescription *string `json:"status_description,omitempty"`
}

TopologySiteResponse One site of a stored topology and its federation state.

type TopologySiteResponseStatus

type TopologySiteResponseStatus string

TopologySiteResponseStatus Optional within this object. Connected when Access federation between this site and the others in the topology is configured and reachable; Disconnected otherwise, with the reason in status_description. A store that succeeds can still leave a site Disconnected.

const (
	Connected    TopologySiteResponseStatus = "Connected"
	Disconnected TopologySiteResponseStatus = "Disconnected"
)

Defines values for TopologySiteResponseStatus.

func (TopologySiteResponseStatus) Valid

func (e TopologySiteResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the TopologySiteResponseStatus enum.

type TopologyValidationError

type TopologyValidationError struct {
	// Code Required within this object. A symbolic code such as VALIDATION_FAILED.
	Code string `json:"code"`

	// Details Optional within this object. One entry per failing site pair.
	Details *[]ValidationDetail `json:"details,omitempty"`

	// Message Required within this object. Human readable summary.
	Message string `json:"message"`
}

TopologyValidationError The /grid error envelope with per-site validation details; nothing was stored.

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented

type Unimplemented struct{}

func (Unimplemented) CreateGridTopology

func (_ Unimplemented) CreateGridTopology(w http.ResponseWriter, r *http.Request)

CreateGridTopology Create a topology (POST /api/v1/topology)

func (Unimplemented) DeleteGridTopology

func (_ Unimplemented) DeleteGridTopology(w http.ResponseWriter, r *http.Request, key string)

DeleteGridTopology Delete a topology (DELETE /api/v1/topology/{key})

func (Unimplemented) GetGridTopology

func (_ Unimplemented) GetGridTopology(w http.ResponseWriter, r *http.Request, key string)

GetGridTopology Get a topology (GET /api/v1/topology/{key})

func (Unimplemented) GetMonitoringEntityDetail

func (_ Unimplemented) GetMonitoringEntityDetail(w http.ResponseWriter, r *http.Request, key string, entityType string, entityId string)

GetMonitoringEntityDetail Get one entity's sync state (GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id})

func (Unimplemented) GetMonitoringEntityList

func (_ Unimplemented) GetMonitoringEntityList(w http.ResponseWriter, r *http.Request, key string, params GetMonitoringEntityListParams)

GetMonitoringEntityList List monitored entities (GET /api/v1/topology/{key}/monitoring/entities)

func (Unimplemented) GetMonitoringSummary

func (_ Unimplemented) GetMonitoringSummary(w http.ResponseWriter, r *http.Request, key string, params GetMonitoringSummaryParams)

GetMonitoringSummary Summarise entity sync (GET /api/v1/topology/{key}/monitoring/entities/summary)

func (Unimplemented) ListGridTopologies

func (_ Unimplemented) ListGridTopologies(w http.ResponseWriter, r *http.Request)

ListGridTopologies List topologies (GET /api/v1/topology)

func (Unimplemented) ListJPDs

func (_ Unimplemented) ListJPDs(w http.ResponseWriter, r *http.Request, params ListJPDsParams)

ListJPDs List known instances (GET /api/v1/jpds)

func (Unimplemented) UpdateGridTopology

func (_ Unimplemented) UpdateGridTopology(w http.ResponseWriter, r *http.Request, key string)

UpdateGridTopology Update a topology (PATCH /api/v1/topology/{key})

type UnimplementedStrict

type UnimplementedStrict struct{}

UnimplementedStrict answers 501 for every strict operation. Services embed it and override the operations they implement.

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type UpdateGridTopology200JSONResponse

type UpdateGridTopology200JSONResponse TopologyResponse

func (UpdateGridTopology200JSONResponse) VisitUpdateGridTopologyResponse

func (response UpdateGridTopology200JSONResponse) VisitUpdateGridTopologyResponse(w http.ResponseWriter) error

type UpdateGridTopology400JSONResponse

type UpdateGridTopology400JSONResponse TopologyValidationError

func (UpdateGridTopology400JSONResponse) VisitUpdateGridTopologyResponse

func (response UpdateGridTopology400JSONResponse) VisitUpdateGridTopologyResponse(w http.ResponseWriter) error

type UpdateGridTopology401JSONResponse

type UpdateGridTopology401JSONResponse ErrorResponse

func (UpdateGridTopology401JSONResponse) VisitUpdateGridTopologyResponse

func (response UpdateGridTopology401JSONResponse) VisitUpdateGridTopologyResponse(w http.ResponseWriter) error

type UpdateGridTopology403JSONResponse

type UpdateGridTopology403JSONResponse ErrorResponse

func (UpdateGridTopology403JSONResponse) VisitUpdateGridTopologyResponse

func (response UpdateGridTopology403JSONResponse) VisitUpdateGridTopologyResponse(w http.ResponseWriter) error

type UpdateGridTopology404JSONResponse

type UpdateGridTopology404JSONResponse ErrorResponse

func (UpdateGridTopology404JSONResponse) VisitUpdateGridTopologyResponse

func (response UpdateGridTopology404JSONResponse) VisitUpdateGridTopologyResponse(w http.ResponseWriter) error

type UpdateGridTopology500JSONResponse

type UpdateGridTopology500JSONResponse ErrorResponse

func (UpdateGridTopology500JSONResponse) VisitUpdateGridTopologyResponse

func (response UpdateGridTopology500JSONResponse) VisitUpdateGridTopologyResponse(w http.ResponseWriter) error

type UpdateGridTopologyJSONRequestBody

type UpdateGridTopologyJSONRequestBody = UpdateTopologyRequest

UpdateGridTopologyJSONRequestBody defines body for UpdateGridTopology for application/json ContentType.

type UpdateGridTopologyRequestObject

type UpdateGridTopologyRequestObject struct {
	Key  string `json:"key"`
	Body *UpdateGridTopologyJSONRequestBody
}

type UpdateGridTopologyResponseObject

type UpdateGridTopologyResponseObject interface {
	VisitUpdateGridTopologyResponse(w http.ResponseWriter) error
}

type UpdateTopologyRequest

type UpdateTopologyRequest struct {
	// Description Optional within this object. New description.
	Description *string `json:"description,omitempty"`

	// Name Optional within this object. New display name.
	Name *string `json:"name,omitempty"`

	// Sites Optional within this object. Replaces the full site list; sites left out are disconnected from the topology.
	Sites *[]SiteRequest `json:"sites,omitempty"`
}

UpdateTopologyRequest Partial update of a topology; omitted fields keep their values. The key never changes, even when name does.

type ValidationDetail

type ValidationDetail struct {
	// Description Optional within this object. Human readable explanation.
	Description *string `json:"description,omitempty"`

	// SourceSite Optional within this object. The site the check ran from.
	SourceSite *string `json:"source_site,omitempty"`

	// Status Optional within this object. Short status of the failed check, such as unreachable or untrusted.
	Status *string `json:"status,omitempty"`

	// TargetSite Optional within this object. The site that failed.
	TargetSite *string `json:"target_site,omitempty"`
}

ValidationDetail Why one pair of sites failed validation.

Jump to

Keyboard shortcuts

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