providerprofile

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 12, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SchemaVersion = "vango.provider_profile_metadata.v1.0"

	SensitivityPublic   = "public"
	SensitivityInternal = "internal"
	SensitivitySecret   = "secret"
)

Variables

This section is empty.

Functions

func LooksSensitiveValue

func LooksSensitiveValue(s string) bool

func RedactSensitive

func RedactSensitive(s string) string

Types

type Diagnostic

type Diagnostic struct {
	Code      string `json:"code"`
	Severity  string `json:"severity"`
	Message   string `json:"message"`
	FieldPath string `json:"field_path,omitempty"`
}

func Validate

func Validate(m Metadata) []Diagnostic

type EnvRef

type EnvRef struct {
	Name        string `json:"name"`
	Sensitivity string `json:"sensitivity"`
	Required    bool   `json:"required"`
	Role        string `json:"role,omitempty"`
	Description string `json:"description,omitempty"`
}

type Metadata

type Metadata struct {
	SchemaVersion     string                      `json:"schema_version"`
	ProviderProfileID string                      `json:"provider_profile_id"`
	Package           string                      `json:"package"`
	DisplayName       string                      `json:"display_name"`
	Family            string                      `json:"family"`
	Env               []EnvRef                    `json:"env"`
	RecommendedRoutes []Route                     `json:"recommended_routes,omitempty"`
	Webhooks          []WebhookRequirement        `json:"webhooks,omitempty"`
	RuntimeServices   []RuntimeServiceRequirement `json:"runtime_services,omitempty"`
	Diagnostics       []Diagnostic                `json:"diagnostics,omitempty"`
	Scaffold          Scaffold                    `json:"scaffold,omitempty"`
	Validation        ValidationCapabilities      `json:"validation,omitempty"`
}

func ClerkMetadata

func ClerkMetadata() Metadata

func InitialCatalog

func InitialCatalog() []Metadata

func NeonPostgresMetadata

func NeonPostgresMetadata() Metadata

func Normalize

func Normalize(m Metadata) Metadata

func R2S3Metadata

func R2S3Metadata() Metadata

func StripeMetadata

func StripeMetadata() Metadata

func WorkOSMetadata

func WorkOSMetadata() Metadata

type Route

type Route struct {
	Method      string `json:"method,omitempty"`
	Path        string `json:"path"`
	Purpose     string `json:"purpose,omitempty"`
	Recommended bool   `json:"recommended,omitempty"`
}

type RuntimeServiceRequirement

type RuntimeServiceRequirement struct {
	Class           string `json:"class"`
	ProviderProfile string `json:"provider_profile,omitempty"`
	Required        bool   `json:"required"`
	Reason          string `json:"reason,omitempty"`
}

type Scaffold

type Scaffold struct {
	RecommendedPackage string   `json:"recommended_package,omitempty"`
	ImportPath         string   `json:"import_path,omitempty"`
	Capabilities       []string `json:"capabilities,omitempty"`
	Unsupported        []string `json:"unsupported,omitempty"`
}

type ValidationCapabilities

type ValidationCapabilities struct {
	Static             bool     `json:"static"`
	Source             bool     `json:"source"`
	RequiresLiveAPI    bool     `json:"requires_live_api"`
	SecretValueFree    bool     `json:"secret_value_free"`
	SupportedChecks    []string `json:"supported_checks,omitempty"`
	UnsupportedChecks  []string `json:"unsupported_checks,omitempty"`
	ManualReviewFacts  []string `json:"manual_review_facts,omitempty"`
	RequiredArtifacts  []string `json:"required_artifacts,omitempty"`
	ProviderAPICalls   bool     `json:"provider_api_calls"`
	SecretValueOutputs bool     `json:"secret_value_outputs"`
}

type WebhookRequirement

type WebhookRequirement struct {
	Path             string `json:"path,omitempty"`
	SignatureHeader  string `json:"signature_header"`
	SecretEnv        string `json:"secret_env"`
	FreshnessSeconds int    `json:"freshness_seconds,omitempty"`
	Idempotency      string `json:"idempotency,omitempty"`
}

Jump to

Keyboard shortcuts

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