Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type SpecOverview ¶
type SpecOverview struct {
Alias string `json:"alias"`
SourceType registry.SourceType `json:"sourceType"`
Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"`
Stats SpecStats `json:"stats"`
LatestStableVersion string `json:"latestStableVersion"`
AvailableVersions []string `json:"availableVersions"`
HasPreview bool `json:"hasPreview"`
HasUpcoming bool `json:"hasUpcoming"`
}
SpecOverview is the response body for the openapi://specs/{alias} resource.
type SpecStats ¶
type SpecStats struct {
Paths int `json:"paths"`
Operations int `json:"operations"`
Schemas int `json:"schemas"`
Tags int `json:"tags"`
}
SpecStats holds counts of the spec's top-level components.
type SpecSummary ¶
type SpecSummary struct {
Alias string `json:"alias"`
SourceType registry.SourceType `json:"sourceType"`
FilePath string `json:"filePath,omitempty"`
}
SpecSummary is a summary of a single spec returned by the openapi://specs resource.
type SpecsResource ¶
type SpecsResource struct {
Specs []SpecSummary `json:"specs"`
Total int `json:"total"`
}
SpecsResource is the response body for the openapi://specs resource.
type TagOperation ¶
type TagOperation struct {
OperationID string `json:"operationId"`
Method string `json:"method"`
Path string `json:"path"`
Summary string `json:"summary"`
}
TagOperation represents a single operation belonging to a tag.
type TagsResource ¶
type TagsResource struct {
Tag string `json:"tag"`
Total int `json:"total"`
Operations []TagOperation `json:"operations"`
}
TagsResource is the response body for the openapi://specs/{alias}/tags/{tagName} resource.
Click to show internal directories.
Click to hide internal directories.