api

package

v0.14.0 Latest Latest Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/absmach/magistrala

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api contains API-related concerns: endpoint definitions, middlewares and all resource representations.

Index ¶

func AssignMembersEndpoint(svc groups.Service, relation, memberKind string) endpoint.Endpoint
func CreateGroupEndpoint(svc groups.Service, kind string) endpoint.Endpoint
func DecodeAssignMembersRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeChangeGroupStatus(_ context.Context, r *http.Request) (interface{}, error)
func DecodeGroupCreate(_ context.Context, r *http.Request) (interface{}, error)
func DecodeGroupPermsRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeGroupRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeGroupUpdate(_ context.Context, r *http.Request) (interface{}, error)
func DecodeListChildrenRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeListGroupsRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeListMembersRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeListParentsRequest(_ context.Context, r *http.Request) (interface{}, error)
func DecodeUnassignMembersRequest(_ context.Context, r *http.Request) (interface{}, error)
func DeleteGroupEndpoint(svc groups.Service) endpoint.Endpoint
func DisableGroupEndpoint(svc groups.Service) endpoint.Endpoint
func EnableGroupEndpoint(svc groups.Service) endpoint.Endpoint
func ListGroupsEndpoint(svc groups.Service, memberKind string) endpoint.Endpoint
func ListMembersEndpoint(svc groups.Service, memberKind string) endpoint.Endpoint
func LoggingMiddleware(svc groups.Service, logger *slog.Logger) groups.Service
func MetricsMiddleware(svc groups.Service, counter metrics.Counter, latency metrics.Histogram) groups.Service
func UnassignMembersEndpoint(svc groups.Service, relation, memberKind string) endpoint.Endpoint
func UpdateGroupEndpoint(svc groups.Service) endpoint.Endpoint
func ViewGroupEndpoint(svc groups.Service) endpoint.Endpoint
func ViewGroupPermsEndpoint(svc groups.Service) endpoint.Endpoint

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AssignMembersEndpoint ¶

func AssignMembersEndpoint(svc groups.Service, relation, memberKind string) endpoint.Endpoint

func CreateGroupEndpoint ¶

func CreateGroupEndpoint(svc groups.Service, kind string) endpoint.Endpoint

func DecodeAssignMembersRequest ¶

func DecodeAssignMembersRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeChangeGroupStatus ¶

func DecodeChangeGroupStatus(_ context.Context, r *http.Request) (interface{}, error)

func DecodeGroupCreate ¶

func DecodeGroupCreate(_ context.Context, r *http.Request) (interface{}, error)

func DecodeGroupPermsRequest ¶

func DecodeGroupPermsRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeGroupRequest ¶

func DecodeGroupRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeGroupUpdate ¶

func DecodeGroupUpdate(_ context.Context, r *http.Request) (interface{}, error)

func DecodeListChildrenRequest ¶

func DecodeListChildrenRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeListGroupsRequest ¶

func DecodeListGroupsRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeListMembersRequest ¶

func DecodeListMembersRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeListParentsRequest ¶

func DecodeListParentsRequest(_ context.Context, r *http.Request) (interface{}, error)

func DecodeUnassignMembersRequest ¶

func DecodeUnassignMembersRequest(_ context.Context, r *http.Request) (interface{}, error)

func DeleteGroupEndpoint ¶

func DeleteGroupEndpoint(svc groups.Service) endpoint.Endpoint

func DisableGroupEndpoint ¶

func DisableGroupEndpoint(svc groups.Service) endpoint.Endpoint

func EnableGroupEndpoint ¶

func EnableGroupEndpoint(svc groups.Service) endpoint.Endpoint

func ListGroupsEndpoint ¶

func ListGroupsEndpoint(svc groups.Service, memberKind string) endpoint.Endpoint

func ListMembersEndpoint ¶

func ListMembersEndpoint(svc groups.Service, memberKind string) endpoint.Endpoint

func LoggingMiddleware ¶

func LoggingMiddleware(svc groups.Service, logger *slog.Logger) groups.Service

LoggingMiddleware adds logging facilities to the groups service.

func MetricsMiddleware ¶

func MetricsMiddleware(svc groups.Service, counter metrics.Counter, latency metrics.Histogram) groups.Service

MetricsMiddleware instruments policies service by tracking request count and latency.

func UnassignMembersEndpoint ¶

func UnassignMembersEndpoint(svc groups.Service, relation, memberKind string) endpoint.Endpoint

func UpdateGroupEndpoint ¶

func UpdateGroupEndpoint(svc groups.Service) endpoint.Endpoint

func ViewGroupEndpoint ¶

func ViewGroupEndpoint(svc groups.Service) endpoint.Endpoint

func ViewGroupPermsEndpoint ¶

func ViewGroupPermsEndpoint(svc groups.Service) endpoint.Endpoint

Types ¶

This section is empty.

Source Files ¶

View all Source files

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