Documentation
¶
Index ¶
- func ComponentTypeToCfgNames(cfg *config.FilterComponentsConfig, typ ComponentType) []string
- func ComponentTypeToComponentMap[T any](components *openapi3.Components, typ ComponentType) (compMap map[string]T)
- func ComponentTypeToDef(typ ComponentType) string
- type ComponentType
- type OpenAPISpecFilter
- type RefsCollector
- func (rc *RefsCollector) AddRef(ref string)
- func (rc *RefsCollector) CollectCallbacks(callbacks openapi3.Callbacks)
- func (rc *RefsCollector) CollectOperation(op *openapi3.Operation)
- func (rc *RefsCollector) CollectParameters(params openapi3.Parameters)
- func (rc *RefsCollector) CollectRequestBodyRef(rbr *openapi3.RequestBodyRef)
- func (rc *RefsCollector) CollectResponses(resps *openapi3.Responses)
- func (rc *RefsCollector) Refs() map[string]struct{}
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ComponentTypeToCfgNames ¶ added in v0.3.2
func ComponentTypeToCfgNames( cfg *config.FilterComponentsConfig, typ ComponentType, ) []string
func ComponentTypeToComponentMap ¶ added in v0.3.2
func ComponentTypeToComponentMap[T any]( components *openapi3.Components, typ ComponentType, ) (compMap map[string]T)
func ComponentTypeToDef ¶ added in v0.3.2
func ComponentTypeToDef(typ ComponentType) string
Types ¶
type ComponentType ¶ added in v0.3.2
type ComponentType int
const ( ComponentTypeSchema ComponentType ComponentTypeParameter ComponentTypeHeader ComponentTypeRequestBody ComponentTypeResponse ContentTypeSecuritySchema ContentTypeExample ContentTypeLink ContentTypeCallback )
func ComponentDefToType ¶ added in v0.3.2
func ComponentDefToType(def string) (typ ComponentType, ok bool)
func ComponentTypes ¶ added in v0.3.2
func ComponentTypes() []ComponentType
type OpenAPISpecFilter ¶
type OpenAPISpecFilter struct {
// contains filtered or unexported fields
}
func NewOpenAPISpecFilter ¶
func NewOpenAPISpecFilter( cfg *config.Config, logger *zap.Logger, ) *OpenAPISpecFilter
func (*OpenAPISpecFilter) Filter ¶
func (oaf *OpenAPISpecFilter) Filter(inputSpecPath, outSpecPath string) error
type RefsCollector ¶ added in v0.3.0
type RefsCollector struct {
// contains filtered or unexported fields
}
func NewRefsCollector ¶ added in v0.3.0
func NewRefsCollector() *RefsCollector
func (*RefsCollector) AddRef ¶ added in v0.3.0
func (rc *RefsCollector) AddRef(ref string)
func (*RefsCollector) CollectCallbacks ¶ added in v0.3.0
func (rc *RefsCollector) CollectCallbacks(callbacks openapi3.Callbacks)
func (*RefsCollector) CollectOperation ¶ added in v0.3.0
func (rc *RefsCollector) CollectOperation(op *openapi3.Operation)
func (*RefsCollector) CollectParameters ¶ added in v0.3.0
func (rc *RefsCollector) CollectParameters(params openapi3.Parameters)
func (*RefsCollector) CollectRequestBodyRef ¶ added in v0.3.0
func (rc *RefsCollector) CollectRequestBodyRef(rbr *openapi3.RequestBodyRef)
func (*RefsCollector) CollectResponses ¶ added in v0.3.0
func (rc *RefsCollector) CollectResponses(resps *openapi3.Responses)
func (*RefsCollector) Refs ¶ added in v0.3.0
func (rc *RefsCollector) Refs() map[string]struct{}
Click to show internal directories.
Click to hide internal directories.