aicra/internal/config/types.go

package config

import (
	"net/http"
	"reflect"

	"git.xdrm.io/go/aicra/datatype"
)

var availableHTTPMethods = []string{http.MethodGet, http.MethodPost, http.MethodPut, http.MethodDelete}

// validator unifies the check and format routine
type validator interface {
	Validate(...datatype.T) error
}

// Server represents a full server configuration
type Server struct {
	Types    []datatype.T
	Services []*Service
}

// Service represents a service definition (from api.json)
type Service struct {
	Method      string                `json:"method"`
	Pattern     string                `json:"path"`
	Scope       [][]string            `json:"scope"`
	Description string                `json:"info"`
	Input       map[string]*Parameter `json:"in"`
	Output      map[string]*Parameter `json:"out"`

	// references to url parameters
	// format: '/uri/{param}'
	Captures []*BraceCapture

	// references to Query parameters
	// format: 'GET@paranName'
	Query map[string]*Parameter

	// references for form parameters (all but Captures and Query)
	Form map[string]*Parameter
}

// Parameter represents a parameter definition (from api.json)
type Parameter struct {
	Description string `json:"info"`
	Type        string `json:"type"`
	Rename      string `json:"name,omitempty"`
	// ExtractType is the type of data the datatype returns
	ExtractType reflect.Type
	// Optional is set to true when the type is prefixed with '?'
	Optional bool

	// Validator is inferred from @Type
	Validator datatype.Validator
}

// BraceCapture links to the related URI parameter
type BraceCapture struct {
	Name  string
	Index int
	Ref   *Parameter
}