openapi

package
v0.0.0-...-d0c362a Latest Latest
Warning

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

Go to latest
Published: May 10, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidParams = errors.New("invalid params")
)

Functions

This section is empty.

Types

type Arg

type Arg struct {
	Name       string `json:"name"`
	Type       string `json:"type,omitempty"`
	Required   bool   `json:"required,omitempty"`
	Location   string `json:"location,omitempty"`
	Confidence string `json:"confidence,omitempty"`
	Service    string `json:"service_name,omitempty"`
	Path       string `json:"path,omitempty"`
}

type Args

type Args struct {
	Mode              *string         `json:"mode,omitempty"`
	SpecText          string          `json:"spec_text,omitempty"`
	Spec              *map[string]any `json:"spec,omitempty"`
	ExistingSteps     *map[string]any `json:"existing_steps,omitempty"`
	IncludeRegistered *bool           `json:"include_registered,omitempty"`
}

type CandidateStep

type CandidateStep struct {
	ID                string         `json:"id"`
	Name              string         `json:"name,omitempty"`
	Source            string         `json:"source,omitempty"`
	Path              string         `json:"path,omitempty"`
	Entity            string         `json:"entity,omitempty"`
	Required          []string       `json:"required"`
	Optional          []string       `json:"optional"`
	Outputs           []string       `json:"outputs"`
	Rationale         []string       `json:"rationale"`
	Ambiguities       []string       `json:"ambiguities"`
	Step              map[string]any `json:"step,omitempty"`
	CoverageStatus    string         `json:"coverage_status,omitempty"`
	CoveredBy         []string       `json:"covered_by,omitempty"`
	CoverageRationale []string       `json:"coverage_rationale,omitempty"`
	CoverageMissing   []string       `json:"coverage_missing,omitempty"`
	CoverageOverlap   []string       `json:"coverage_overlap,omitempty"`
}

type Info

type Info struct {
	Title       string `json:"title"`
	Version     string `json:"version"`
	Description string `json:"description"`
}

type Operation

type Operation struct {
	ID          string   `json:"id"`
	Method      string   `json:"method,omitempty"`
	Path        string   `json:"path,omitempty"`
	Summary     string   `json:"summary,omitempty"`
	Description string   `json:"description,omitempty"`
	Entity      string   `json:"entity,omitempty"`
	Inputs      []Arg    `json:"inputs"`
	Outputs     []Arg    `json:"outputs"`
	Rationale   []string `json:"rationale"`
	Ambiguities []string `json:"ambiguities"`
}

type RegisteredStep

type RegisteredStep struct {
	ID       string   `json:"id"`
	Name     string   `json:"name"`
	Source   string   `json:"source"`
	Path     string   `json:"path,omitempty"`
	Required []string `json:"required"`
	Optional []string `json:"optional"`
	Outputs  []string `json:"outputs"`
}

type Result

type Result struct {
	Mode             string           `json:"mode,omitempty"`
	Info             Info             `json:"info"`
	BaseURL          string           `json:"base_url,omitempty"`
	Warnings         []string         `json:"warnings"`
	Ambiguities      []string         `json:"ambiguities"`
	Operations       []Operation      `json:"operations"`
	ExistingSteps    []RegisteredStep `json:"existing_steps"`
	CandidateSteps   []CandidateStep  `json:"candidate_steps"`
	RecommendedSteps []CandidateStep  `json:"recommended_steps"`
	Plans            []planSpec       `json:"plans"`
	Proposed         []CandidateStep  `json:"proposed_registrations"`
	ExamplePlans     []planSpec       `json:"example_plans"`
	LLMHandoff       string           `json:"llm_handoff_prompt,omitempty"`
}

func Analyze

func Analyze(args Args, existing []Step, warnings []string) (Result, error)

type Step

type Step struct {
	ID            string
	Name          string
	Source        string
	Method        string
	Path          string
	Required      []string
	Optional      []string
	Outputs       []string
	Step          map[string]any
	InputsByType  map[string]string
	OutputsByType map[string]string
	Rationale     []string
	Ambiguities   []string
	Entity        string
}

Jump to

Keyboard shortcuts

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