openapi3edit

package

Go to main page

Versions in this module

v1

v1.5.4

May 12, 2021

v1.5.3

May 12, 2021

Changes in this version

type OperationMore

+ Path string

+ func (opm *OperationMore) AddExternalDocs(docURL, docDescription string, preserveIfReqEmpty bool)

+ func (opm *OperationMore) AddRequestBodySchemaRef(description string, required bool, contentType string, ...) error

+ func (opm *OperationMore) AddResponseBodySchemaRef(statusCode, description, contentType string, schemaRef *oas3.SchemaRef) error

+ func (opm *OperationMore) HasParameter(paramNameWant string) bool

v1.5.2

May 12, 2021

v1.5.1

May 12, 2021

v1.5.0

May 12, 2021

Changes in this version

+ type OperationEditor struct

+ Operation *oas3.Operation

+ func (oedit *OperationEditor) AddExternalDocs(docURL, docDescription string, preserveIfReqEmpty bool)

+ func (oedit *OperationEditor) AddRequestBodySchemaRef(description string, required bool, contentType string, ...) error

+ func (oedit *OperationEditor) AddResponseBodySchemaRef(statusCode, description, contentType string, schemaRef *oas3.SchemaRef) error

v1.4.1

May 9, 2021

Changes in this version

+ const SchemeHTTP

+ const SecuritySchemeApikeyDefaultName

+ const SecuritySchemeBearertokenDefaultName

+ const TokenTypeBearer

+ func FixFile(input, output string, prefix, indent string, validateOutput bool) (*oas3.Swagger, []*openapi3.OperationMeta, error)

+ func MapSliceIntersection(haystack map[string]int, needles []string, unique bool) []string

+ func MapSliceIntersectionExists(haystack map[string]int, needles []string) bool

+ func MoveRequestBodies(spec *oas3.Swagger, move bool) ([]*openapi3.OperationMeta, error)

+ func NullToEmpty(spec *oas3.Swagger)

+ func NullToEmptyPaths(spec *oas3.Swagger)

+ func OperationAddExternalDocs(op *oas3.Operation, url, description string, preserveIfEmpty bool)

+ func OperationHasParameter(paramNameWant string, op *oas3.Operation) bool

+ func ParsePathParametersParens(urlPath string) []string

+ func PathItemHasEndpoints(pathItem *oas3.PathItem) bool

+ func PathMatchGeneric(path1, path2 string) bool

+ func PathMethods(pathItem *oas3.PathItem) []string

+ func PathVarsToGeneric(input string) string

+ func RemoveOperationsSecurity(spec *oas3.Swagger)

+ func SecuritySchemeAddBearertoken(spec *oas3.Swagger, schemeName, bearerFormat string, ...)

+ func SecuritySchemeAddOperation(op *oas3.Operation, schemeName string, schemeValue []string)

+ func SecuritySchemeApikeyAddDefinition(spec *oas3.Swagger, schemeName, location, name string) error

+ func SecuritySchemeApikeyAddOperations(spec *oas3.Swagger, tags []string, keyName string)

+ func SecuritySchemeBearertokenAddDefinition(spec *oas3.Swagger, schemeName, bearerFormat string)

+ func SecuritySchemeBearertokenAddOperationsByTags(spec *oas3.Swagger, schemeName string, inclTags, skipTags []string)

+ func SortParameters(sourceParams oas3.Parameters, sortOrder []string) oas3.Parameters

+ func SpecAddCustomProperties(spec *oas3.Swagger, custom map[string]interface{}, ...)

+ func SpecAddOperationMetas(spec *oas3.Swagger, metas map[string]openapi3.OperationMeta, overwrite bool)

+ func SpecDeleteOperations(spec *oas3.Swagger, ...)

+ func SpecDeleteProperties(spec *oas3.Swagger, md SpecMetadata)

+ func SpecEndpoints(spec *oas3.Swagger, generic bool) []string

+ func SpecMoreModifyMulti(sm *openapi3.SpecMore, opts SpecMoreModifyMultiOpts) error

+ func SpecOperationIds(spec *oas3.Swagger) map[string]int

+ func SpecOperationIdsFromSummaries(spec *oas3.Swagger, errorOnEmpty bool) error

+ func SpecOperationsCount(spec *oas3.Swagger) uint

+ func SpecOperationsFixResponseReferences(spec *oas3.Swagger) []*openapi3.OperationMeta

+ func SpecOperationsSetDeprecated(spec *oas3.Swagger, newDeprecated bool)

+ func SpecPathsModify(spec *oas3.Swagger, opts SpecPathsModifyOpts) error

+ func SpecSchemaNames(spec *oas3.Swagger) []string

+ func SpecSchemasSetDeprecated(spec *oas3.Swagger, newDeprecated bool)

+ func SpecSetDeprecatedImplicit(spec *oas3.Swagger)

+ func SpecSetOperation(spec *oas3.Swagger, path, method string, op oas3.Operation)

+ func SpecSetSchemaPropertiesOptional(spec *oas3.Swagger, rxOptional *regexp.Regexp)

+ func SpecTagsCondense(spec *oas3.Swagger)

+ func SpecTagsModify(spec *oas3.Swagger, changeTagsRaw map[string]string)

+ func SpecTagsOrder(spec *oas3.Swagger, explicitSortedTagNames []string) error

+ func TagsOrder(curTags oas3.Tags, explicitSortedTagNames []string) (oas3.Tags, error)

+ func ValidateFixOperationPathParameters(spec *oas3.Swagger, fix bool) ([]*openapi3.OperationMeta, error)

+ func ValidateFixOperationResponseTypes(spec *oas3.Swagger, fix bool) ([]*openapi3.OperationMeta, error)

+ type Endpoint struct

+ Method string

+ Operation *oas3.Operation

+ Path string

+ func PathEndpoints(url string, pathItem *oas3.PathItem) []Endpoint

+ func (ep *Endpoint) String() string

+ type IntersectionData struct

+ Intersection SpecMetadata

+ Spec1 SpecMetadata

+ Spec2 SpecMetadata

+ func NewIntersectionData() IntersectionData

+ func SpecsIntersection(spec1, spec2 *oas3.Swagger) IntersectionData

+ func (idata *IntersectionData) Sort()

+ type OperationMore struct

+ Method string

+ Operation *oas3.Operation

+ UrlPath string

+ type OperationMoreSet struct

+ OperationMores []OperationMore

+ func QueryOperationsByTags(spec *oas3.Swagger, tags []string) *OperationMoreSet

+ type PathMeta struct

+ Current string

+ New string

+ type SpecMetadata struct

+ Endpoints []string

+ OperationIDs []string

+ SchemaNames []string

+ func NewSpecMetadata(spec *oas3.Swagger) SpecMetadata

+ func (md *SpecMetadata) Intersection(md2 SpecMetadata) SpecMetadata

+ func (md *SpecMetadata) IsEmpty() bool

+ func (md *SpecMetadata) Sort()

+ type SpecMoreModifyMultiOpts struct

+ OperationsDeleteFunc func(urlpath, method string, op *oas3.Operation) bool

+ OperationsExec bool

+ OperationsRemoveSecurity bool

+ OperationsRenameIdsFunc func(string, string, *oas3.Operation)

+ OperationsShowIds bool

+ Paths SpecPathsModifyOpts

+ PathsExec bool

+ PathsShow bool

+ Tags map[string]string

+ TagsExec bool

+ TagsOperationFunc func(string, string, *oas3.Operation)

+ TagsShow bool

+ type SpecPaths struct

+ Paths []PathMeta

+ Servers oas3.Servers

+ func InspectPaths(spec *oas3.Swagger) SpecPaths

+ type SpecPathsModifyOpts struct

+ OpPathRenameFunc func(string) string

+ OpPathRenameFuncExec bool

+ OpPathRenameNewBase string

+ OpPathRenameNewBaseExec bool

+ ServerPathExec bool

+ ServerPathNew string

+ type UpdateTagsOpts struct

+ TagGroupsSet openapi3.TagGroupSet

+ TagURLsMap map[string][]string

+ TagsMap map[string]string

+ func (uto *UpdateTagsOpts) ModifyTagsOperationFunc(path, method string, op *oas3.Operation)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL