filter

type BumpFilter ¶

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

BumpFilter modifies includes the fields "x-state" and "x-beta" to the "preview" and "upcoming" APIs Operations. The "x-state" and "x-beta" fields are bump.sh custom fields to include budges Bump.sh feature: https://docs.bump.sh/help/specification-support/doc-badges/

func (f *BumpFilter) Apply() error

func (f *BumpFilter) ValidateMetadata() error

type CodeSampleFilter ¶

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

CodeSampleFilter modifies includes the fields "x-state" and "x-beta" to the "preview" and "upcoming" APIs Operations. The "x-state" and "x-beta" fields are bump.sh custom fields to include budges Bump.sh feature: https://docs.bump.sh/help/specification-support/doc-code-samples/#example-usage

func (f *CodeSampleFilter) Apply() error

func (f *CodeSampleFilter) ValidateMetadata() error

type ExtensionFilter ¶

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

ExtensionFilter is a filter that removes the x-xgen-IPA-exception extension from the OpenAPI spec. If metadata.keepIPAExceptions is true, the x-xgen-IPA-exception extensions are kept.

func (f *ExtensionFilter) Apply() error

func (f *ExtensionFilter) ValidateMetadata() error

type Filter ¶

type Filter interface {
	Apply() error
	ValidateMetadata() error
}

func DefaultFilters(oas *openapi3.T, metadata *Metadata) []Filter

func FiltersToCleanupRefs(oas *openapi3.T) []Filter

func FiltersToGetVersions(oas *openapi3.T, metadata *Metadata) []Filter

func FiltersWithoutVersioning(oas *openapi3.T, metadata *Metadata) []Filter

type HiddenEnvsFilter ¶

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

HiddenEnvsFilter removes paths, operations, request/response bodies and content types that are hidden for the target environment.

func (f *HiddenEnvsFilter) Apply() error

func (f *HiddenEnvsFilter) ValidateMetadata() error

type InfoVersioningFilter ¶

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

InfoVersioningFilter modifies the Info object in the OpenAPI spec with the target version.

func (f *InfoVersioningFilter) Apply() error

func (f *InfoVersioningFilter) ValidateMetadata() error

type Metadata ¶

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

func NewMetadata(targetVersion *apiversion.APIVersion, targetEnv string) *Metadata

func NewMetadataWithIPAExceptions(targetVersion *apiversion.APIVersion, targetEnv string, keepIPAExceptions bool) *Metadata

type MockFilter ¶

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

MockFilter is a mock of Filter interface.

func NewMockFilter(ctrl *gomock.Controller) *MockFilter

func (m *MockFilter) Apply() error

func (m *MockFilter) EXPECT() *MockFilterMockRecorder

type MockFilterMockRecorder ¶

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

MockFilterMockRecorder is the mock recorder for MockFilter.

func (mr *MockFilterMockRecorder) Apply() *gomock.Call

type OperationConfig ¶

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

OperationConfig contains the information needed while parsing an operation of the OAS.

type OperationsFilter ¶

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

OperationsFilter is a filter that removes the x-xgen-owner-team extension from operations.

func (f *OperationsFilter) Apply() error

func (*OperationsFilter) ValidateMetadata() error

type ParametersFilter ¶

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

func (f *ParametersFilter) Apply() error

func (*ParametersFilter) ValidateMetadata() error

type ResponseFilter ¶

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

func (f *ResponseFilter) Apply() error

func (*ResponseFilter) ValidateMetadata() error

type SchemasFilter ¶

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

SchemasFilter removes unused #/components/schemas/.

func (f *SchemasFilter) Apply() error

func (*SchemasFilter) ValidateMetadata() error

type State ¶

type State struct {
	Label string `json:"label"`
	Color string `json:"color"`
}

type SunsetFilter ¶

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

SunsetFilter removes the sunsetToBeDecided from the openapi specification.

func (f *SunsetFilter) Apply() error

func (*SunsetFilter) ValidateMetadata() error

type TagsFilter ¶

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

TagsFilter removes tags that are not used in the operations.

func (f *TagsFilter) Apply() error

func (*TagsFilter) ValidateMetadata() error

type VersionConfig ¶

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

VersionConfig contains the information needed during the versioning filtering of the OAS. It contains the parsed operations, the operations that need to be removed and the version under scrutiny.

type VersioningExtensionFilter ¶

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

VersioningExtensionFilter is a filter that updates the x-sunset and x-xgen-version extensions to a date string and deletes the x-sunset extension if the latest matched version is deprecated by hidden versions for the target environment.

func (f *VersioningExtensionFilter) Apply() error

func (f *VersioningExtensionFilter) ValidateMetadata() error

type VersioningFilter ¶

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

VersioningFilter is a filter that modifies the OpenAPI spec by removing paths, operations and responses that are not supported by the target version.

func (f *VersioningFilter) Apply() error

func (f *VersioningFilter) ValidateMetadata() error