Documentation
¶
Index ¶
- type Handler
- func (h *Handler) Capabilities(c *gin.Context)
- func (h *Handler) Delete(c *gin.Context)
- func (h *Handler) Descriptors(c *gin.Context)
- func (h *Handler) Detail(c *gin.Context)
- func (h *Handler) Entities(c *gin.Context)
- func (h *Handler) Get(c *gin.Context)
- func (h *Handler) List(c *gin.Context)
- func (h *Handler) Reload(c *gin.Context)
- type ProviderActionRequest
- type ProviderDeleteResponse
- type ProviderDetailRequest
- type ProviderDetailResponse
- type ProviderItem
- type ProviderReloadResponse
- type ProvidersCapabilitiesRequest
- type ProvidersCapabilitiesResponse
- type ProvidersDescriptorsRequest
- type ProvidersDescriptorsResponse
- type ProvidersEntitiesRequest
- type ProvidersEntitiesResponse
- type ProvidersListRequest
- type ProvidersListResponse
- type Service
- func (s *Service) Capabilities(ctx context.Context, req *ProvidersCapabilitiesRequest) (*ProvidersCapabilitiesResponse, error)
- func (s *Service) Delete(ctx context.Context, req *ProviderActionRequest) (*ProviderDeleteResponse, error)
- func (s *Service) Descriptors(ctx context.Context, req *ProvidersDescriptorsRequest) (*ProvidersDescriptorsResponse, error)
- func (s *Service) Detail(ctx context.Context, req *ProviderDetailRequest) (*ProviderDetailResponse, error)
- func (s *Service) Entities(ctx context.Context, req *ProvidersEntitiesRequest) (*ProvidersEntitiesResponse, error)
- func (s *Service) List(ctx context.Context, req *ProvidersListRequest) (*ProvidersListResponse, error)
- func (s *Service) Reload(ctx context.Context, req *ProviderActionRequest) (*ProviderReloadResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func (*Handler) Capabilities ¶
Capabilities handles the request to get provider capabilities
func (*Handler) Descriptors ¶
Descriptors handles the request to get provider descriptors
type ProviderActionRequest ¶
type ProviderActionRequest struct {
ID string `uri:"id"`
}
Provider DTOs - canonical REST contracts for provider API operations.
type ProviderDeleteResponse ¶
type ProviderDeleteResponse struct {
ID string `json:"id"`
}
ProviderDeleteResponse confirms provider deletion.
type ProviderDetailRequest ¶
type ProviderDetailRequest struct {
ID string `uri:"id"`
}
type ProviderDetailResponse ¶
type ProviderDetailResponse = ProviderItem
ProviderDetailResponse returns the canonical detail payload for a single provider.
type ProviderItem ¶ added in v0.1.10
type ProviderItem map[string]interface{}
ProviderItem is the canonical provider metadata item returned by list/detail/capabilities.
type ProviderReloadResponse ¶
ProviderReloadResponse confirms provider reload and updated timestamp.
type ProvidersCapabilitiesRequest ¶
type ProvidersCapabilitiesRequest struct{}
type ProvidersCapabilitiesResponse ¶
type ProvidersCapabilitiesResponse struct {
Items []ProviderItem `json:"items"`
Total int `json:"total"`
}
ProvidersCapabilitiesResponse is the canonical REST list response for provider capabilities.
type ProvidersDescriptorsRequest ¶
type ProvidersDescriptorsRequest struct{}
type ProvidersDescriptorsResponse ¶
type ProvidersDescriptorsResponse struct {
ProviderManifests map[string]interface{} `json:"providerManifests"`
}
ProvidersDescriptorsResponse contains provider OpenAPI manifests keyed by provider id.
type ProvidersEntitiesRequest ¶
type ProvidersEntitiesRequest struct {
ID string `uri:"id"`
}
type ProvidersEntitiesResponse ¶
type ProvidersEntitiesResponse struct {
Items []map[string]interface{} `json:"items"`
Total int `json:"total"`
}
ProvidersEntitiesResponse lists entities exported by one or more providers.
type ProvidersListRequest ¶
type ProvidersListResponse ¶
type ProvidersListResponse struct {
Items []ProviderItem `json:"items"`
Total int `json:"total"`
Page int `json:"page"`
PageSize int `json:"pageSize"`
}
ProvidersListResponse is the canonical REST list response for providers.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func NewService(svcCtx *svc.ServiceContext) *Service
func (*Service) Capabilities ¶
func (s *Service) Capabilities(ctx context.Context, req *ProvidersCapabilitiesRequest) (*ProvidersCapabilitiesResponse, error)
Capabilities returns the capabilities of all providers
func (*Service) Delete ¶
func (s *Service) Delete(ctx context.Context, req *ProviderActionRequest) (*ProviderDeleteResponse, error)
Delete deletes a provider
func (*Service) Descriptors ¶
func (s *Service) Descriptors(ctx context.Context, req *ProvidersDescriptorsRequest) (*ProvidersDescriptorsResponse, error)
Descriptors returns the OpenAPI descriptors of all providers
func (*Service) Detail ¶
func (s *Service) Detail(ctx context.Context, req *ProviderDetailRequest) (*ProviderDetailResponse, error)
Detail returns the details of a provider
func (*Service) Entities ¶
func (s *Service) Entities(ctx context.Context, req *ProvidersEntitiesRequest) (*ProvidersEntitiesResponse, error)
Entities returns the entities of providers
func (*Service) List ¶
func (s *Service) List(ctx context.Context, req *ProvidersListRequest) (*ProvidersListResponse, error)
List returns the list of providers
func (*Service) Reload ¶
func (s *Service) Reload(ctx context.Context, req *ProviderActionRequest) (*ProviderReloadResponse, error)
Reload reloads a provider