openapi

Documentation

Index

• type Defs
• type OpenapiV3ParameterProxy
• type ProcessError
  • func (e *ProcessError) Error() string
  • func (e *ProcessError) Reason() string
  • func (e *ProcessError) Unwrap() error
• type ToolExtractor
  • func NewToolExtractor(logger *slog.Logger, tracerProvider trace.TracerProvider, db *pgxpool.Pool, ...) *ToolExtractor
  • func (p *ToolExtractor) Do(ctx context.Context, task ToolExtractorTask) (*ToolExtractorResult, error)
• type ToolExtractorResult
• type ToolExtractorTask

Types

type Defs

type Defs = *sequencedmap.Map[string, *oas3.JSONSchema[oas3.Referenceable]]

type OpenapiV3ParameterProxy

type OpenapiV3ParameterProxy struct {
	Schema          json.RawMessage `json:"schema,omitempty" yaml:"schema,omitempty"`
	In              string          `json:"in,omitempty" yaml:"in,omitempty"`
	Name            string          `json:"name,omitempty" yaml:"name,omitempty"`
	Description     string          `json:"description,omitempty" yaml:"description,omitempty"`
	Required        *bool           `json:"required,omitempty" yaml:"required,omitempty"`
	Deprecated      bool            `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
	AllowEmptyValue bool            `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"`
	Style           string          `json:"style,omitempty" yaml:"style,omitempty"`
	Explode         *bool           `json:"explode,omitempty" yaml:"explode,omitempty"`
}

type ProcessError

type ProcessError struct {
	// contains filtered or unexported fields
}

func (*ProcessError) Error

func (e *ProcessError) Error() string

func (*ProcessError) Reason

func (e *ProcessError) Reason() string

func (*ProcessError) Unwrap

func (e *ProcessError) Unwrap() error

type ToolExtractor

type ToolExtractor struct {
	// contains filtered or unexported fields
}

func NewToolExtractor

func NewToolExtractor(logger *slog.Logger, tracerProvider trace.TracerProvider, db *pgxpool.Pool, fp feature.Provider, assetStorage assets.BlobStore) *ToolExtractor

func (*ToolExtractor) Do

func (p *ToolExtractor) Do(
	ctx context.Context,
	task ToolExtractorTask,
) (*ToolExtractorResult, error)

type ToolExtractorResult

type ToolExtractorResult struct {
	DocumentVersion         string
	DocumentUpgrade         *o11y.Outcome
	DocumentUpgradeDuration time.Duration
}

type ToolExtractorTask

type ToolExtractorTask struct {
	Parser string

	ProjectID    uuid.UUID
	DeploymentID uuid.UUID
	DocumentID   uuid.UUID
	DocInfo      *types.OpenAPIv3DeploymentAsset
	DocURL       *url.URL
	ProjectSlug  string
	OrgSlug      string

	OnOperationSkipped func(err error)
}