magistrala/bootstrap/api/responses.go

// Copyright (c) Abstract Machines
// SPDX-License-Identifier: Apache-2.0

package api

import (
	"fmt"
	"net/http"

	"github.com/absmach/magistrala"
	"github.com/absmach/magistrala/bootstrap"
)

var (
	_ magistrala.Response = (*removeRes)(nil)
	_ magistrala.Response = (*configRes)(nil)
	_ magistrala.Response = (*changeConfigStatusRes)(nil)
	_ magistrala.Response = (*viewRes)(nil)
	_ magistrala.Response = (*listRes)(nil)
)

type removeRes struct{}

func (res removeRes) Code() int {
	return http.StatusNoContent
}

func (res removeRes) Headers() map[string]string {
	return map[string]string{}
}

func (res removeRes) Empty() bool {
	return true
}

type updateRes struct{}

func (res updateRes) Code() int {
	return http.StatusOK
}

func (res updateRes) Headers() map[string]string {
	return map[string]string{}
}

func (res updateRes) Empty() bool {
	return true
}

type configRes struct {
	ID            string           `json:"id"`
	ExternalID    string           `json:"external_id"`
	Name          string           `json:"name,omitempty"`
	Content       string           `json:"content,omitempty"`
	Status        bootstrap.Status `json:"status"`
	ProfileID     string           `json:"profile_id,omitempty"`
	RenderContext map[string]any   `json:"render_context,omitempty"`
	ClientCert    string           `json:"client_cert,omitempty"`
	CACert        string           `json:"ca_cert,omitempty"`
	ClientKey     string           `json:"client_key,omitempty"`
	created       bool
}

func (res configRes) Code() int {
	if res.created {
		return http.StatusCreated
	}

	return http.StatusOK
}

func (res configRes) Headers() map[string]string {
	if res.created {
		return map[string]string{
			"Location": fmt.Sprintf("/clients/configs/%s", res.ID),
		}
	}

	return map[string]string{}
}

func (res configRes) Empty() bool {
	return false
}

type viewRes struct {
	ID            string           `json:"id,omitempty"`
	ExternalID    string           `json:"external_id"`
	Content       string           `json:"content,omitempty"`
	Name          string           `json:"name,omitempty"`
	Status        bootstrap.Status `json:"status"`
	ProfileID     string           `json:"profile_id,omitempty"`
	RenderContext map[string]any   `json:"render_context,omitempty"`
	ClientCert    string           `json:"client_cert,omitempty"`
	CACert        string           `json:"ca_cert,omitempty"`
	ClientKey     string           `json:"client_key,omitempty"`
}

func (res viewRes) Code() int {
	return http.StatusOK
}

func (res viewRes) Headers() map[string]string {
	return map[string]string{}
}

func (res viewRes) Empty() bool {
	return false
}

type listRes struct {
	Total   uint64    `json:"total"`
	Offset  uint64    `json:"offset"`
	Limit   uint64    `json:"limit"`
	Configs []viewRes `json:"configs"`
}

func (res listRes) Code() int {
	return http.StatusOK
}

func (res listRes) Headers() map[string]string {
	return map[string]string{}
}

func (res listRes) Empty() bool {
	return false
}

type changeConfigStatusRes struct {
	bootstrap.Config
}

func (res changeConfigStatusRes) Code() int {
	return http.StatusOK
}

func (res changeConfigStatusRes) Headers() map[string]string {
	return map[string]string{}
}

func (res changeConfigStatusRes) Empty() bool {
	return false
}

type updateConfigRes struct {
	ID         string `json:"id,omitempty"`
	CACert     string `json:"ca_cert,omitempty"`
	ClientCert string `json:"client_cert,omitempty"`
	ClientKey  string `json:"client_key,omitempty"`
}

func (res updateConfigRes) Code() int {
	return http.StatusOK
}

func (res updateConfigRes) Headers() map[string]string {
	return map[string]string{}
}

func (res updateConfigRes) Empty() bool {
	return false
}

// profileRes is returned on create (201) or update (200).
type profileRes struct {
	bootstrap.Profile
	created bool
}

func (res profileRes) Code() int {
	if res.created {
		return http.StatusCreated
	}
	return http.StatusOK
}

func (res profileRes) Headers() map[string]string {
	if res.created {
		return map[string]string{
			"Location": fmt.Sprintf("/bootstrap/profiles/%s", res.ID),
		}
	}
	return map[string]string{}
}

func (res profileRes) Empty() bool { return false }

// profilesPageRes is returned by ListProfiles.
type profilesPageRes struct {
	bootstrap.ProfilesPage
}

func (res profilesPageRes) Code() int                  { return http.StatusOK }
func (res profilesPageRes) Headers() map[string]string { return map[string]string{} }
func (res profilesPageRes) Empty() bool                { return false }

// profileSlotsRes is returned by profile slots endpoint.
type profileSlotsRes struct {
	BindingSlots []bootstrap.BindingSlot `json:"binding_slots"`
}

func (res profileSlotsRes) Code() int                  { return http.StatusOK }
func (res profileSlotsRes) Headers() map[string]string { return map[string]string{} }
func (res profileSlotsRes) Empty() bool                { return false }

// renderPreviewRes is returned by profile render-preview endpoint.
type renderPreviewRes struct {
	Content string `json:"content"`
}

func (res renderPreviewRes) Code() int                  { return http.StatusOK }
func (res renderPreviewRes) Headers() map[string]string { return map[string]string{} }
func (res renderPreviewRes) Empty() bool                { return false }

// bindingsRes is returned by ListBindings.
type bindingsRes struct {
	Bindings []bootstrap.BindingSnapshot `json:"bindings"`
}

func (res bindingsRes) Code() int                  { return http.StatusOK }
func (res bindingsRes) Headers() map[string]string { return map[string]string{} }
func (res bindingsRes) Empty() bool                { return false }