mirror of
https://github.com/absmach/magistrala.git
synced 2026-06-23 04:10:28 +00:00
Steve Munene
683809dc6b
Property Based Tests / api-test (push) Has been cancelled
Continuous Delivery / lint-and-build (push) Has been cancelled
Deploy GitHub Pages / swagger-ui (push) Has been cancelled
CI Pipeline / Lint Proto (push) Has been cancelled
Continuous Delivery / Build and Push Docker Images (push) Has been cancelled
CI Pipeline / lint-and-build (push) Has been cancelled
CI Pipeline / Test ${{ matrix.module }} (push) Has been cancelled
CI Pipeline / Upload Coverage (push) Has been cancelled
CI Pipeline / Detect Changes (push) Has been cancelled
Signed-off-by: nyagamunene <stevenyaga2014@gmail.com>
70 lines
2.6 KiB
Go
70 lines
2.6 KiB
Go
// Copyright (c) Abstract Machines
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package bootstrap
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
)
|
|
|
|
// ContentFormat enumerates the supported output formats for rendered profile templates.
|
|
type ContentFormat string
|
|
|
|
const (
|
|
ContentFormatGoTemplate ContentFormat = "go-template"
|
|
ContentFormatRaw ContentFormat = "raw"
|
|
ContentFormatJSON ContentFormat = "json"
|
|
ContentFormatYAML ContentFormat = "yaml"
|
|
ContentFormatTOML ContentFormat = "toml"
|
|
)
|
|
|
|
// Profile is a user-managed device configuration template.
|
|
type Profile struct {
|
|
ID string `json:"id"`
|
|
DomainID string `json:"domain_id,omitempty"`
|
|
Name string `json:"name"`
|
|
Description string `json:"description,omitempty"`
|
|
ContentFormat ContentFormat `json:"content_format"`
|
|
ContentTemplate string `json:"content_template,omitempty"`
|
|
Defaults map[string]any `json:"defaults,omitempty"`
|
|
BindingSlots []BindingSlot `json:"binding_slots,omitempty"`
|
|
Version int `json:"version,omitempty"`
|
|
CreatedAt time.Time `json:"created_at,omitempty"`
|
|
UpdatedAt time.Time `json:"updated_at,omitempty"`
|
|
}
|
|
|
|
// BindingSlot declares a named resource placeholder that a profile template can use.
|
|
type BindingSlot struct {
|
|
Name string `json:"name"`
|
|
Type string `json:"type"`
|
|
Required bool `json:"required"`
|
|
Fields []string `json:"fields,omitempty"`
|
|
}
|
|
|
|
// ProfilesPage contains pagination metadata and a slice of Profiles.
|
|
type ProfilesPage struct {
|
|
Total uint64 `json:"total"`
|
|
Offset uint64 `json:"offset"`
|
|
Limit uint64 `json:"limit"`
|
|
Profiles []Profile `json:"profiles"`
|
|
}
|
|
|
|
// ProfileRepository specifies the persistence API for Profiles.
|
|
type ProfileRepository interface {
|
|
// Save persists a new Profile and returns it with server-assigned fields set.
|
|
Save(ctx context.Context, p Profile) (Profile, error)
|
|
|
|
// RetrieveByID returns the Profile with the given ID inside the given domain.
|
|
RetrieveByID(ctx context.Context, domainID, id string) (Profile, error)
|
|
|
|
// RetrieveAll returns a page of Profiles belonging to the given domain, optionally filtered by name.
|
|
RetrieveAll(ctx context.Context, domainID string, offset, limit uint64, name string) (ProfilesPage, error)
|
|
|
|
// Update updates editable fields of the given Profile and returns the updated Profile.
|
|
Update(ctx context.Context, p Profile) (Profile, error)
|
|
|
|
// Delete removes the Profile with the given ID from the given domain.
|
|
Delete(ctx context.Context, domainID, id string) error
|
|
}
|