openapiimport

type AdditionalProperties struct {
	// Allowed retains an authored boolean value.
	Allowed *bool
	// Schema describes map values when additionalProperties is a schema.
	Schema *Schema
}

type Components struct {
	// SecuritySchemes contains supported reusable security schemes.
	SecuritySchemes []SecurityScheme
	// Schemas contains reusable schema definitions sorted by source name.
	Schemas []NamedSchema
	// Parameters contains reusable parameter definitions.
	Parameters []NamedParameter
	// RequestBodies contains reusable request body definitions.
	RequestBodies []NamedRequestBody
	// Responses contains reusable response definitions.
	Responses []NamedResponse
	// Headers contains reusable header definitions.
	Headers []NamedHeader
}

type Diagnostic struct {
	// Code identifies the importer limit class, for example "media-type".
	Code string
	// Path is the JSON Pointer of the offending construct in the source document.
	Path string
	// Message explains why the construct cannot be imported faithfully.
	Message string
}

type Diagnostics []Diagnostic

type Document struct {
	// OpenAPIVersion is the exact supported 3.x version declared by the input.
	OpenAPIVersion string
	// Title is the API title.
	Title string
	// Description is the API description.
	Description string
	// APIVersion is the application version from the Info object.
	APIVersion string
	// Tags lists declared tag names in source order.
	Tags []string
	// TagMetadata contains declared tag details in source order.
	TagMetadata []Tag
	// Extensions contains document-level vendor extensions.
	Extensions map[string]any
	// SecurityDefined reports whether the source declares the security member.
	SecurityDefined bool
	// Security contains root security requirement alternatives in source order.
	Security SecurityRequirements
	// Components contains normalized reusable definitions.
	Components Components
	// Operations contains HTTP operations in deterministic path-and-method order.
	Operations []Operation
}

type Example struct {
	// Name is the authored media example key or a deterministic schema example name.
	Name string
	// Summary is the authored media example summary.
	Summary string
	// Description is the authored example description.
	Description string
	// ComponentName is the reusable OpenAPI example component name.
	ComponentName string
	// DataValue reports that Value belongs in the OpenAPI 3.2 dataValue field.
	DataValue bool
	// SerializedValue is the authored OpenAPI 3.2 serialized representation.
	SerializedValue string
	// Value is the decoded example value.
	Value any
}

type Header struct {
	// Ref is the authored local component reference, when retained as a reference.
	Ref string
	// Description is the response header description.
	Description string
	// Required reports whether the response header is required.
	Required bool
	// Deprecated reports whether the response header is deprecated.
	Deprecated bool
	// AllowReserved permits reserved URI characters in the encoded value.
	AllowReserved bool
	// Schema describes the response header value.
	Schema *Schema
}

type NamedHeader struct {
	// Name is the authored header name or component key.
	Name string
	// Header is the normalized header definition.
	Header Header
}

type NamedParameter struct {
	// Name is the authored OpenAPI component key.
	Name string
	// Parameter is the normalized component parameter.
	Parameter Parameter
}

type NamedProperty struct {
	// Name is the authored JSON property name.
	Name string
	// Schema describes the property value.
	Schema *Schema
}

type NamedRequestBody struct {
	// Name is the authored OpenAPI component key.
	Name string
	// RequestBody is the normalized component request body.
	RequestBody RequestBody
}

type NamedResponse struct {
	// Name is the authored OpenAPI component key.
	Name string
	// Response is the normalized component response.
	Response Response
}

type NamedSchema struct {
	// Name is the authored OpenAPI component key.
	Name string
	// GoName is the deterministic collision-safe Go identifier.
	GoName string
	// Schema is the normalized component schema.
	Schema *Schema
}

type OAuthFlow struct {
	// Kind is authorizationCode, implicit, password, or clientCredentials.
	Kind string
	// AuthorizationURL is the flow authorization endpoint.
	AuthorizationURL string
	// TokenURL is the flow token endpoint.
	TokenURL string
	// RefreshURL is the optional flow refresh endpoint.
	RefreshURL string
}

type Operation struct {
	// Method is the uppercase HTTP method.
	Method string
	// Path is the authored OpenAPI path template.
	Path string
	// OperationID is the authored OpenAPI operationId, if present.
	OperationID string
	// GoName is the deterministic collision-safe method identifier.
	GoName string
	// Summary is the authored operation summary.
	Summary string
	// Description is the authored operation description.
	Description string
	// Tags contains the operation tag names in source order.
	Tags []string
	// Deprecated reports whether the operation is deprecated.
	Deprecated bool
	// Extensions contains operation-level vendor extensions.
	Extensions map[string]any
	// SecurityDefined reports whether the operation overrides root security.
	SecurityDefined bool
	// Security contains operation security requirement alternatives.
	Security SecurityRequirements
	// Parameters contains inherited path-item and operation parameters.
	Parameters []Parameter
	// RequestBody is the operation request body, if any.
	RequestBody *RequestBody
	// Responses contains responses sorted by status code.
	Responses []StatusResponse
}

type Options struct {
	// PackageName is the Go package name used by the rendered design. It
	// defaults to design.
	PackageName string
}

type Parameter struct {
	// Ref is the authored local component reference, when retained as a reference.
	Ref string
	// Name is the wire parameter name.
	Name string
	// In is path, query, header, or cookie.
	In string
	// Description is the parameter description.
	Description string
	// Required reports whether the parameter is required.
	Required bool
	// Deprecated reports whether the parameter is deprecated.
	Deprecated bool
	// AllowEmptyValue reports whether an empty parameter value is permitted.
	AllowEmptyValue bool
	// Style is the authored serialization style when Loom supports it.
	Style string
	// AllowReserved permits reserved URI characters in the encoded value.
	AllowReserved bool
	// Extensions contains parameter-level vendor extensions.
	Extensions map[string]any
	// Schema describes the parameter value.
	Schema *Schema
}

type PartialAnalysis struct {
	// Document contains all operations that pass strict analysis.
	Document *Document
	// Blocked contains the grouped refusal source before operations are skipped.
	Blocked Diagnostics
	// Warnings contains allowed lossy diagnostics for retained operations.
	Warnings Diagnostics
	// Omitted contains document-level constructs skipped by partial import.
	Omitted Diagnostics
	// OperationOmissions contains metadata omitted from retained operations.
	OperationOmissions []SkippedOperation
	// Skipped contains operations that cannot be rendered and their diagnostics.
	Skipped []SkippedOperation
	// TotalOperations is the number of operations before partial analysis.
	TotalOperations int
	// TotalSchemas is the number of reachable schemas before partial analysis.
	TotalSchemas int
}

type RequestBody struct {
	// Ref is the authored local component reference, when retained as a reference.
	Ref string
	// Description is the request body description.
	Description string
	// Required reports whether the request body is required.
	Required bool
	// ContentTypes are the request media types that share Schema and Examples.
	ContentTypes []string
	// Schema describes the request body.
	Schema *Schema
	// Examples contains examples declared on the request media type.
	Examples []Example
	// Extensions contains request-body-level vendor extensions.
	Extensions map[string]any
}

type Response struct {
	// Ref is the authored local component reference, when retained as a reference.
	Ref string
	// Description is the response description.
	Description string
	// Summary is the OpenAPI 3.2 response summary.
	Summary string
	// ContentType is the single response media type, if the response has a body.
	ContentType string
	// Schema describes the response body.
	Schema *Schema
	// Examples contains examples declared on the response media type.
	Examples []Example
	// Headers contains response headers sorted by wire name.
	Headers []NamedHeader
	// Extensions contains response-level vendor extensions.
	Extensions map[string]any
}

type Schema struct {
	// Ref is the authored local schema component reference.
	Ref string
	// Unconstrained reports that the schema accepts every JSON value.
	Unconstrained bool
	// Type is the single JSON Schema type.
	Type string
	// Nullable reports that the schema also accepts the JSON null value.
	Nullable bool
	// OneOf contains the branches of a supported untagged object union.
	OneOf []*Schema
	// Format is the authored schema format.
	Format string
	// Title is the schema title.
	Title string
	// Description is the schema description.
	Description string
	// Bases contains local object schemas extended by this schema.
	Bases []*Schema
	// Properties contains object properties sorted by wire name.
	Properties []NamedProperty
	// Required contains sorted required property names.
	Required []string
	// Items describes array elements.
	Items *Schema
	// AdditionalProperties describes map values or object openness.
	AdditionalProperties *AdditionalProperties
	// Enum contains decoded scalar enum values.
	Enum []any
	// Pattern is the string validation pattern.
	Pattern string
	// Minimum is the inclusive numeric lower bound.
	Minimum *float64
	// Maximum is the inclusive numeric upper bound.
	Maximum *float64
	// ExclusiveMinimum is the exclusive numeric lower bound.
	ExclusiveMinimum *float64
	// ExclusiveMaximum is the exclusive numeric upper bound.
	ExclusiveMaximum *float64
	// MinLength is the minimum string or collection length.
	MinLength *int64
	// MaxLength is the maximum string or collection length.
	MaxLength *int64
	// MinItems is the minimum array length.
	MinItems *int64
	// MaxItems is the maximum array length.
	MaxItems *int64
	// Deprecated reports whether the schema declares the JSON Schema
	// deprecated keyword.
	Deprecated bool
	// ReadOnly reports whether the schema declares the JSON Schema readOnly
	// keyword.
	ReadOnly bool
	// WriteOnly reports whether the schema declares the JSON Schema writeOnly
	// keyword.
	WriteOnly bool
	// Default holds the decoded JSON Schema default value, or nil when the
	// schema declares no default.
	Default *SchemaDefault
	// Examples contains decoded examples declared by example or examples.
	Examples []Example
	// Extensions contains schema-level vendor extensions.
	Extensions map[string]any
	// contains filtered or unexported fields
}

type SchemaDefault struct {
	// Value is the decoded default value.
	Value any
}

type SecurityRequirement struct {
	// Schemes lists required schemes in source order. An empty list permits
	// anonymous access as one alternative.
	Schemes []SecurityRequirementScheme
}

type SecurityRequirementScheme struct {
	// Name is the referenced security scheme component key.
	Name string
	// Scopes contains the authored scopes. Supported API-key schemes require
	// this list to be empty.
	Scopes []string
}

type SecurityRequirements []SecurityRequirement

type SecurityScheme struct {
	// Name is the authored component key.
	Name string
	// GoName is the deterministic collision-safe variable identifier.
	GoName string
	// Type is the OpenAPI security scheme type.
	Type string
	// Scheme is the HTTP authentication scheme for type http.
	Scheme string
	// Description describes the credential contract.
	Description string
	// In identifies the credential location: header, query, or cookie.
	In string
	// ParameterName is the authored wire name of the credential.
	ParameterName string
	// Deprecated reports whether use of the scheme is discouraged.
	Deprecated bool
	// OAuth2MetadataURL locates OAuth authorization server metadata.
	OAuth2MetadataURL string
	// OAuthFlows contains supported OAuth2 flows in specification order.
	OAuthFlows []OAuthFlow
	// Scopes contains the shared OAuth2 scope definitions.
	Scopes []SecurityScope
	// Extensions contains scheme-level vendor extensions.
	Extensions map[string]any
}

type SecurityScope struct {
	// Name is the authored scope value.
	Name string
	// Description explains the permission granted by the scope.
	Description string
}

type Selection struct {
	// Tags selects operations with at least one exact tag match.
	Tags []string
	// PathPrefixes selects operations whose path starts with a prefix.
	PathPrefixes []string
	// Paths selects operations whose path matches a path.Match pattern.
	Paths []string
}

type SelectionReport struct {
	// Tags contains deterministic operation and path counts by tag.
	Tags []TagSummary
	// UnclaimedPaths lists paths that do not use a requested tag.
	UnclaimedPaths []string
}

type SkippedOperation struct {
	// Method is the uppercase HTTP method.
	Method string
	// Path is the authored OpenAPI path.
	Path string
	// Diagnostics explains why the operation cannot be rendered.
	Diagnostics Diagnostics
}

type StatusResponse struct {
	// Status is a concrete three-digit HTTP status code.
	Status string
	// Response is the normalized response definition.
	Response Response
}

type Tag struct {
	// Name is the authored tag name.
	Name string
	// Summary is the short display label.
	Summary string
	// Description describes the tagged operations.
	Description string
	// Parent names the containing OpenAPI 3.2 tag.
	Parent string
	// Kind classifies the tag in OpenAPI 3.2.
	Kind string
	// ExternalDocsURL locates additional documentation.
	ExternalDocsURL string
	// ExternalDocsDescription describes the additional documentation.
	ExternalDocsDescription string
	// Extensions contains tag-level vendor extensions.
	Extensions map[string]any
}

type TagSummary struct {
	// Name is the exact OpenAPI tag name.
	Name string
	// Operations is the number of operations assigned to the tag.
	Operations int
	// Paths is the number of distinct paths assigned to the tag.
	Paths int
}