Documentation
¶
Overview ¶
Package provider provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.
Index ¶
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
- type ApplyProvider200JSONResponse
- type ApplyProvider400ApplicationProblemPlusJSONResponse
- type ApplyProvider404ApplicationProblemPlusJSONResponse
- type ApplyProvider409ApplicationProblemPlusJSONResponse
- type ApplyProviderJSONRequestBody
- type ApplyProviderRequestObject
- type ApplyProviderResponseObject
- type ApplyProviderdefaultApplicationProblemPlusJSONResponse
- type ChiServerOptions
- type CreateProvider200JSONResponse
- type CreateProvider201JSONResponse
- type CreateProvider400ApplicationProblemPlusJSONResponse
- type CreateProvider409ApplicationProblemPlusJSONResponse
- type CreateProvider422ApplicationProblemPlusJSONResponse
- type CreateProviderJSONRequestBody
- type CreateProviderParams
- type CreateProviderRequestObject
- type CreateProviderResponseObject
- type CreateProviderdefaultApplicationProblemPlusJSONResponse
- type DeleteProvider204Response
- type DeleteProvider400ApplicationProblemPlusJSONResponse
- type DeleteProvider404ApplicationProblemPlusJSONResponse
- type DeleteProviderRequestObject
- type DeleteProviderResponseObject
- type DeleteProviderdefaultApplicationProblemPlusJSONResponse
- type Error
- type GetProvider200JSONResponse
- type GetProvider400ApplicationProblemPlusJSONResponse
- type GetProvider404ApplicationProblemPlusJSONResponse
- type GetProviderRequestObject
- type GetProviderResponseObject
- type GetProviderdefaultApplicationProblemPlusJSONResponse
- type InvalidParamFormatError
- type ListProviders200JSONResponse
- type ListProviders400ApplicationProblemPlusJSONResponse
- type ListProvidersParams
- type ListProvidersRequestObject
- type ListProvidersResponseObject
- type ListProvidersdefaultApplicationProblemPlusJSONResponse
- type MiddlewareFunc
- type Provider
- type ProviderIdPath
- type ProviderList
- type ProviderMetadata
- type RequiredHeaderError
- type RequiredParamError
- type ResourceCapacity
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) ApplyProvider(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateProvider(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteProvider(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProvider(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListProviders(w http.ResponseWriter, r *http.Request)
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type TooManyValuesForParamError
- type UnescapedCookieParamError
- type Unimplemented
- func (_ Unimplemented) ApplyProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
- func (_ Unimplemented) CreateProvider(w http.ResponseWriter, r *http.Request, params CreateProviderParams)
- func (_ Unimplemented) DeleteProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
- func (_ Unimplemented) GetProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
- func (_ Unimplemented) ListProviders(w http.ResponseWriter, r *http.Request, params ListProvidersParams)
- type UnmarshalingParamError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type ApplyProvider200JSONResponse ¶
type ApplyProvider200JSONResponse Provider
func (ApplyProvider200JSONResponse) VisitApplyProviderResponse ¶
func (response ApplyProvider200JSONResponse) VisitApplyProviderResponse(w http.ResponseWriter) error
type ApplyProvider400ApplicationProblemPlusJSONResponse ¶
type ApplyProvider400ApplicationProblemPlusJSONResponse Error
func (ApplyProvider400ApplicationProblemPlusJSONResponse) VisitApplyProviderResponse ¶
func (response ApplyProvider400ApplicationProblemPlusJSONResponse) VisitApplyProviderResponse(w http.ResponseWriter) error
type ApplyProvider404ApplicationProblemPlusJSONResponse ¶
type ApplyProvider404ApplicationProblemPlusJSONResponse Error
func (ApplyProvider404ApplicationProblemPlusJSONResponse) VisitApplyProviderResponse ¶
func (response ApplyProvider404ApplicationProblemPlusJSONResponse) VisitApplyProviderResponse(w http.ResponseWriter) error
type ApplyProvider409ApplicationProblemPlusJSONResponse ¶
type ApplyProvider409ApplicationProblemPlusJSONResponse Error
func (ApplyProvider409ApplicationProblemPlusJSONResponse) VisitApplyProviderResponse ¶
func (response ApplyProvider409ApplicationProblemPlusJSONResponse) VisitApplyProviderResponse(w http.ResponseWriter) error
type ApplyProviderJSONRequestBody ¶
type ApplyProviderJSONRequestBody = Provider
ApplyProviderJSONRequestBody defines body for ApplyProvider for application/json ContentType.
type ApplyProviderRequestObject ¶
type ApplyProviderRequestObject struct {
ProviderId ProviderIdPath `json:"providerId"`
Body *ApplyProviderJSONRequestBody
}
type ApplyProviderResponseObject ¶
type ApplyProviderResponseObject interface {
VisitApplyProviderResponse(w http.ResponseWriter) error
}
type ApplyProviderdefaultApplicationProblemPlusJSONResponse ¶
func (ApplyProviderdefaultApplicationProblemPlusJSONResponse) VisitApplyProviderResponse ¶
func (response ApplyProviderdefaultApplicationProblemPlusJSONResponse) VisitApplyProviderResponse(w http.ResponseWriter) error
type ChiServerOptions ¶
type ChiServerOptions struct {
BaseURL string
BaseRouter chi.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type CreateProvider200JSONResponse ¶
type CreateProvider200JSONResponse Provider
func (CreateProvider200JSONResponse) VisitCreateProviderResponse ¶
func (response CreateProvider200JSONResponse) VisitCreateProviderResponse(w http.ResponseWriter) error
type CreateProvider201JSONResponse ¶
type CreateProvider201JSONResponse Provider
func (CreateProvider201JSONResponse) VisitCreateProviderResponse ¶
func (response CreateProvider201JSONResponse) VisitCreateProviderResponse(w http.ResponseWriter) error
type CreateProvider400ApplicationProblemPlusJSONResponse ¶
type CreateProvider400ApplicationProblemPlusJSONResponse Error
func (CreateProvider400ApplicationProblemPlusJSONResponse) VisitCreateProviderResponse ¶
func (response CreateProvider400ApplicationProblemPlusJSONResponse) VisitCreateProviderResponse(w http.ResponseWriter) error
type CreateProvider409ApplicationProblemPlusJSONResponse ¶
type CreateProvider409ApplicationProblemPlusJSONResponse Error
func (CreateProvider409ApplicationProblemPlusJSONResponse) VisitCreateProviderResponse ¶
func (response CreateProvider409ApplicationProblemPlusJSONResponse) VisitCreateProviderResponse(w http.ResponseWriter) error
type CreateProvider422ApplicationProblemPlusJSONResponse ¶
type CreateProvider422ApplicationProblemPlusJSONResponse Error
func (CreateProvider422ApplicationProblemPlusJSONResponse) VisitCreateProviderResponse ¶
func (response CreateProvider422ApplicationProblemPlusJSONResponse) VisitCreateProviderResponse(w http.ResponseWriter) error
type CreateProviderJSONRequestBody ¶
type CreateProviderJSONRequestBody = Provider
CreateProviderJSONRequestBody defines body for CreateProvider for application/json ContentType.
type CreateProviderParams ¶
type CreateProviderParams struct {
// Id Optional provider ID for idempotent registration
Id *string `form:"id,omitempty" json:"id,omitempty"`
}
CreateProviderParams defines parameters for CreateProvider.
type CreateProviderRequestObject ¶
type CreateProviderRequestObject struct {
Params CreateProviderParams
Body *CreateProviderJSONRequestBody
}
type CreateProviderResponseObject ¶
type CreateProviderResponseObject interface {
VisitCreateProviderResponse(w http.ResponseWriter) error
}
type CreateProviderdefaultApplicationProblemPlusJSONResponse ¶
func (CreateProviderdefaultApplicationProblemPlusJSONResponse) VisitCreateProviderResponse ¶
func (response CreateProviderdefaultApplicationProblemPlusJSONResponse) VisitCreateProviderResponse(w http.ResponseWriter) error
type DeleteProvider204Response ¶
type DeleteProvider204Response struct {
}
func (DeleteProvider204Response) VisitDeleteProviderResponse ¶
func (response DeleteProvider204Response) VisitDeleteProviderResponse(w http.ResponseWriter) error
type DeleteProvider400ApplicationProblemPlusJSONResponse ¶
type DeleteProvider400ApplicationProblemPlusJSONResponse Error
func (DeleteProvider400ApplicationProblemPlusJSONResponse) VisitDeleteProviderResponse ¶
func (response DeleteProvider400ApplicationProblemPlusJSONResponse) VisitDeleteProviderResponse(w http.ResponseWriter) error
type DeleteProvider404ApplicationProblemPlusJSONResponse ¶
type DeleteProvider404ApplicationProblemPlusJSONResponse Error
func (DeleteProvider404ApplicationProblemPlusJSONResponse) VisitDeleteProviderResponse ¶
func (response DeleteProvider404ApplicationProblemPlusJSONResponse) VisitDeleteProviderResponse(w http.ResponseWriter) error
type DeleteProviderRequestObject ¶
type DeleteProviderRequestObject struct {
ProviderId ProviderIdPath `json:"providerId"`
}
type DeleteProviderResponseObject ¶
type DeleteProviderResponseObject interface {
VisitDeleteProviderResponse(w http.ResponseWriter) error
}
type DeleteProviderdefaultApplicationProblemPlusJSONResponse ¶
func (DeleteProviderdefaultApplicationProblemPlusJSONResponse) VisitDeleteProviderResponse ¶
func (response DeleteProviderdefaultApplicationProblemPlusJSONResponse) VisitDeleteProviderResponse(w http.ResponseWriter) error
type Error ¶
type Error struct {
// Detail Human-readable explanation specific to this occurrence
Detail *string `json:"detail,omitempty"`
// Instance URI reference for this specific error occurrence
Instance *string `json:"instance,omitempty"`
// Status HTTP status code
Status *int `json:"status,omitempty"`
// Title Short human-readable summary of the problem
Title string `json:"title"`
// Type URI reference identifying the error type
Type string `json:"type"`
}
Error RFC 7807 compliant error response
type GetProvider200JSONResponse ¶
type GetProvider200JSONResponse Provider
func (GetProvider200JSONResponse) VisitGetProviderResponse ¶
func (response GetProvider200JSONResponse) VisitGetProviderResponse(w http.ResponseWriter) error
type GetProvider400ApplicationProblemPlusJSONResponse ¶
type GetProvider400ApplicationProblemPlusJSONResponse Error
func (GetProvider400ApplicationProblemPlusJSONResponse) VisitGetProviderResponse ¶
func (response GetProvider400ApplicationProblemPlusJSONResponse) VisitGetProviderResponse(w http.ResponseWriter) error
type GetProvider404ApplicationProblemPlusJSONResponse ¶
type GetProvider404ApplicationProblemPlusJSONResponse Error
func (GetProvider404ApplicationProblemPlusJSONResponse) VisitGetProviderResponse ¶
func (response GetProvider404ApplicationProblemPlusJSONResponse) VisitGetProviderResponse(w http.ResponseWriter) error
type GetProviderRequestObject ¶
type GetProviderRequestObject struct {
ProviderId ProviderIdPath `json:"providerId"`
}
type GetProviderResponseObject ¶
type GetProviderResponseObject interface {
VisitGetProviderResponse(w http.ResponseWriter) error
}
type GetProviderdefaultApplicationProblemPlusJSONResponse ¶
func (GetProviderdefaultApplicationProblemPlusJSONResponse) VisitGetProviderResponse ¶
func (response GetProviderdefaultApplicationProblemPlusJSONResponse) VisitGetProviderResponse(w http.ResponseWriter) error
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListProviders200JSONResponse ¶
type ListProviders200JSONResponse ProviderList
func (ListProviders200JSONResponse) VisitListProvidersResponse ¶
func (response ListProviders200JSONResponse) VisitListProvidersResponse(w http.ResponseWriter) error
type ListProviders400ApplicationProblemPlusJSONResponse ¶
type ListProviders400ApplicationProblemPlusJSONResponse Error
func (ListProviders400ApplicationProblemPlusJSONResponse) VisitListProvidersResponse ¶
func (response ListProviders400ApplicationProblemPlusJSONResponse) VisitListProvidersResponse(w http.ResponseWriter) error
type ListProvidersParams ¶
type ListProvidersParams struct {
// Type Filter providers by service type
Type *string `form:"type,omitempty" json:"type,omitempty"`
// MaxPageSize Maximum number of results per page
MaxPageSize *int `form:"max_page_size,omitempty" json:"max_page_size,omitempty"`
// PageToken Token for pagination
PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
}
ListProvidersParams defines parameters for ListProviders.
type ListProvidersRequestObject ¶
type ListProvidersRequestObject struct {
Params ListProvidersParams
}
type ListProvidersResponseObject ¶
type ListProvidersResponseObject interface {
VisitListProvidersResponse(w http.ResponseWriter) error
}
type ListProvidersdefaultApplicationProblemPlusJSONResponse ¶
func (ListProvidersdefaultApplicationProblemPlusJSONResponse) VisitListProvidersResponse ¶
func (response ListProvidersdefaultApplicationProblemPlusJSONResponse) VisitListProvidersResponse(w http.ResponseWriter) error
type Provider ¶
type Provider struct {
// CreateTime Timestamp when the provider was first registered
CreateTime *time.Time `json:"create_time,omitempty"`
// DisplayName Human-readable display name for the provider
DisplayName *string `json:"display_name,omitempty"`
// Endpoint Full endpoint URL where the provider API is accessible
Endpoint string `json:"endpoint"`
// HealthStatus Health status of the provider
HealthStatus *string `json:"health_status,omitempty"`
// Id Unique identifier for the Service Provider
Id *string `json:"id,omitempty"`
// Metadata Additional metadata about the provider
Metadata *ProviderMetadata `json:"metadata,omitempty"`
// Name Unique name of the Service Provider
Name string `json:"name"`
// Operations List of operations supported for this service type
Operations *[]string `json:"operations,omitempty"`
// Path Resource path identifier
Path *string `json:"path,omitempty"`
// SchemaVersion Schema version of the service type the SP supports
SchemaVersion string `json:"schema_version"`
// ServiceType Type of service this provider offers
ServiceType string `json:"service_type"`
// UpdateTime Timestamp when the provider was last updated
UpdateTime *time.Time `json:"update_time,omitempty"`
}
Provider Full provider resource representation
type ProviderList ¶
type ProviderList struct {
// NextPageToken Token for retrieving the next page of results
NextPageToken *string `json:"next_page_token,omitempty"`
Providers *[]Provider `json:"providers,omitempty"`
}
ProviderList Paginated list of providers
type ProviderMetadata ¶
type ProviderMetadata struct {
// RegionCode Geographic region code where the provider operates
RegionCode *string `json:"region_code,omitempty"`
// Resources Resource capacity information
Resources *ResourceCapacity `json:"resources,omitempty"`
// Status Current operational status of the provider
Status *string `json:"status,omitempty"`
// Zone Availability zone or datacenter identifier
Zone *string `json:"zone,omitempty"`
AdditionalProperties map[string]interface{} `json:"-"`
}
ProviderMetadata Additional metadata about the provider
func (ProviderMetadata) Get ¶
func (a ProviderMetadata) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for ProviderMetadata. Returns the specified element and whether it was found
func (ProviderMetadata) MarshalJSON ¶
func (a ProviderMetadata) MarshalJSON() ([]byte, error)
Override default JSON handling for ProviderMetadata to handle AdditionalProperties
func (*ProviderMetadata) Set ¶
func (a *ProviderMetadata) Set(fieldName string, value interface{})
Setter for additional properties for ProviderMetadata
func (*ProviderMetadata) UnmarshalJSON ¶
func (a *ProviderMetadata) UnmarshalJSON(b []byte) error
Override default JSON handling for ProviderMetadata to handle AdditionalProperties
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 ResourceCapacity ¶
type ResourceCapacity struct {
// TotalCpu Total CPU cores available
TotalCpu *int `json:"total_cpu,omitempty"`
// TotalMemory Total memory available
TotalMemory *string `json:"total_memory,omitempty"`
// TotalNode Total number of nodes
TotalNode *int `json:"total_node,omitempty"`
// TotalStorage Total storage available
TotalStorage *string `json:"total_storage,omitempty"`
}
ResourceCapacity Resource capacity information
type ServerInterface ¶
type ServerInterface interface {
// List all providers
// (GET /providers)
ListProviders(w http.ResponseWriter, r *http.Request, params ListProvidersParams)
// Register a Service Provider
// (POST /providers)
CreateProvider(w http.ResponseWriter, r *http.Request, params CreateProviderParams)
// Delete a service Provider
// (DELETE /providers/{providerId})
DeleteProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
// Get a provider
// (GET /providers/{providerId})
GetProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
// Update a Service Provider
// (PUT /providers/{providerId})
ApplyProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
}
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) ApplyProvider ¶
func (siw *ServerInterfaceWrapper) ApplyProvider(w http.ResponseWriter, r *http.Request)
ApplyProvider operation middleware
func (*ServerInterfaceWrapper) CreateProvider ¶
func (siw *ServerInterfaceWrapper) CreateProvider(w http.ResponseWriter, r *http.Request)
CreateProvider operation middleware
func (*ServerInterfaceWrapper) DeleteProvider ¶
func (siw *ServerInterfaceWrapper) DeleteProvider(w http.ResponseWriter, r *http.Request)
DeleteProvider operation middleware
func (*ServerInterfaceWrapper) GetProvider ¶
func (siw *ServerInterfaceWrapper) GetProvider(w http.ResponseWriter, r *http.Request)
GetProvider operation middleware
func (*ServerInterfaceWrapper) ListProviders ¶
func (siw *ServerInterfaceWrapper) ListProviders(w http.ResponseWriter, r *http.Request)
ListProviders operation middleware
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 {
// List all providers
// (GET /providers)
ListProviders(ctx context.Context, request ListProvidersRequestObject) (ListProvidersResponseObject, error)
// Register a Service Provider
// (POST /providers)
CreateProvider(ctx context.Context, request CreateProviderRequestObject) (CreateProviderResponseObject, error)
// Delete a service Provider
// (DELETE /providers/{providerId})
DeleteProvider(ctx context.Context, request DeleteProviderRequestObject) (DeleteProviderResponseObject, error)
// Get a provider
// (GET /providers/{providerId})
GetProvider(ctx context.Context, request GetProviderRequestObject) (GetProviderResponseObject, error)
// Update a Service Provider
// (PUT /providers/{providerId})
ApplyProvider(ctx context.Context, request ApplyProviderRequestObject) (ApplyProviderResponseObject, error)
}
StrictServerInterface represents all server handlers.
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type Unimplemented ¶
type Unimplemented struct{}
func (Unimplemented) ApplyProvider ¶
func (_ Unimplemented) ApplyProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
Update a Service Provider (PUT /providers/{providerId})
func (Unimplemented) CreateProvider ¶
func (_ Unimplemented) CreateProvider(w http.ResponseWriter, r *http.Request, params CreateProviderParams)
Register a Service Provider (POST /providers)
func (Unimplemented) DeleteProvider ¶
func (_ Unimplemented) DeleteProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
Delete a service Provider (DELETE /providers/{providerId})
func (Unimplemented) GetProvider ¶
func (_ Unimplemented) GetProvider(w http.ResponseWriter, r *http.Request, providerId ProviderIdPath)
Get a provider (GET /providers/{providerId})
func (Unimplemented) ListProviders ¶
func (_ Unimplemented) ListProviders(w http.ResponseWriter, r *http.Request, params ListProvidersParams)
List all providers (GET /providers)
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error