openapi3

package

Go to main page

Versions in this module

v1

v1.5.4

May 12, 2021

v1.5.3

May 12, 2021

v1.5.2

May 12, 2021

v1.5.1

May 12, 2021

Changes in this version

+ const PointerComponentsSchemas

+ func SchemaPointerExpand(prefix, schemaName string) string

v1.5.0

May 12, 2021

Changes in this version

+ const FormatDate

+ const FormatDateTime

+ const TypeArray

+ const TypeBoolean

+ const TypeObject

+ const TypeString

v1.4.1

May 9, 2021

Changes in this version

+ const FormatInt32

+ const FormatInt64

+ const TypeInteger

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

v1.4.0

May 4, 2021

Changes in this version

+ func OperationSecurityScopes(op *oas3.Operation, fullyQualified bool) []string

+ func ReadURL(oas3url string) (*oas3.Swagger, error)

+ func SecurityRequirementsToRaw(secReqs oas3.SecurityRequirements) []map[string][]string

type MergeOptions

+ TableColumns *table.ColumnSet

+ TableOpFilterFunc func(path, method string, op *oas3.Operation) bool

v1.3.0

Mar 16, 2021

Changes in this version

+ const XTagGroups

+ const XThrottlingGroup

+ func Parse(oas3Bytes []byte) (*oas3.Swagger, error)

type OperationMeta

+ DocsDescription string

+ DocsURL string

+ SecurityScopes []string

+ XThrottlingGroup string

+ func (om *OperationMeta) TrimSpace()

type SpecMore

+ func (sm *SpecMore) OperationCountsByTag() frequency.FrequencyStats

+ func (sm *SpecMore) WriteFileCSV(filename string) error

v1.2.1

Feb 15, 2021

v1.2.0

Feb 15, 2021

v1.1.5

Feb 13, 2021

Changes in this version

+ func CopySchemaStandard(schema oas3.Schema) (oas3.Schema, error)

v1.1.4

Jan 19, 2021

Changes in this version

+ const OASVersionLatest

+ func GetOperationExtensionPropStringOrEmpty(op oas3.Operation, key string) string

+ func NewSpec(oasVersion, apiTitle, apiVersion string) *oas3.Swagger

+ func OperationSetRequestBodySchemaRef(op *oas3.Operation, mediaType string, schemaRef *oas3.SchemaRef)

+ func OperationSetResponseBodySchemaRef(op *oas3.Operation, status, description, mediaType string, ...) error

+ func SchemaPathExpand(schemaName string) string

+ type ExtensionPropsParent interface

type SpecMore

+ func (sm *SpecMore) MarshalJSON(prefix, indent string) ([]byte, error)

+ func (sm *SpecMore) PrintJSON(prefix, indent string) error

+ func (sm *SpecMore) SchemaRef(schemaName string) *oas3.SchemaRef

+ func (sm *SpecMore) SetOperation(path, method string, op *oas3.Operation)

+ func (sm *SpecMore) SetSchemaRef(schemaName string, schemaRef *oas3.SchemaRef) error

v1.1.3

Jan 10, 2021

Changes in this version

type SpecMore

+ func (sm *SpecMore) OperationByID(wantOperationID string) (path, method string, op *oas3.Operation, err error)

+ func (sm *SpecMore) OperationsIDs() []string

v1.1.2

Jan 10, 2021

v1.1.1

Dec 29, 2020

v1.1.0

Oct 21, 2020

Changes in this version

+ func BasePath(spec *oas3.Swagger) (string, error)

+ func MergeDirectoryMore(dir string, mergeOpts *MergeOptions) (*oas3.Swagger, int, error)

+ func ServerURL(spec *oas3.Swagger, index int) string

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

+ func SpecGetComponentRequestBody(spec *oas3.Swagger, componentPath string) *oas3.RequestBodyRef

+ func SpecHasComponentSchema(spec *oas3.Swagger, name string, lowerCaseMatch bool) bool

type SpecMore

+ func (s *SpecMore) SchemaCount() int

type TagGroupSet

+ func SpecTagGroups(spec *oas3.Swagger) (TagGroupSet, error)

v1.0.0

Nov 10, 2019

v0

v0.0.1

Dec 29, 2020

Changes in this version

+ const DescStatusDefaultSep

+ const DescStatusIsEmpty

+ const DescStatusIsNotEmpty

+ const XTagGroupsPropertyName

+ func BuildApiUrlOAS(specServerURL, overrideServerURL, specPath string) string

+ func Copy(spec *oas3.Swagger) (*oas3.Swagger, error)

+ func GetExtensionPropString(xprops oas3.ExtensionProps, key string) (string, error)

+ func GetExtensionPropStringOrEmpty(xprops oas3.ExtensionProps, key string) string

+ func Merge(specMaster, specExtra *oas3.Swagger, specExtraNote string, ...) (*oas3.Swagger, error)

+ func MergeDirectory(dir string, mergeOpts *MergeOptions) (*oas3.Swagger, int, error)

+ func MergeFiles(filepaths []string, mergeOpts *MergeOptions) (*oas3.Swagger, error)

+ func MergeParameters(specMaster, specExtra *oas3.Swagger, specExtraNote string, ...) (*oas3.Swagger, error)

+ func MergePaths(specMaster, specExtra *oas3.Swagger) (*oas3.Swagger, error)

+ func MergeRequestBodies(specMaster, specExtra *oas3.Swagger, specExtraNote string) (*oas3.Swagger, error)

+ func MergeResponses(specMaster, specExtra *oas3.Swagger, specExtraNote string, ...) (*oas3.Swagger, error)

+ func MergeSchemas(specMaster, specExtra *oas3.Swagger, specExtraNote string, ...) (*oas3.Swagger, error)

+ func MergeTags(specMaster, specExtra *oas3.Swagger) *oas3.Swagger

+ func MergeWithTables(spec1, spec2 *oas3.Swagger, specExtraNote string, mergeOpts *MergeOptions) (*oas3.Swagger, []*table.Table, error)

+ func OpTableColumnsDefault() []text.Text

+ func OpTableColumnsRingCentral() *text.TextSet

+ func OperationRequestMediaTypes(op *oas3.Operation) []string

+ func OperationResponseMediaTypes(op *oas3.Operation) []string

+ func ReadAndValidateFile(oas3file string) (*oas3.Swagger, error)

+ func ReadFile(oas3file string, validate bool) (*oas3.Swagger, error)

+ func TagsWithoutGroups(spec *oas3.Swagger, tagGroupSet TagGroupSet) []string

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

+ func WriteFileDirMerge(outfile, inputDir string, perm os.FileMode, mergeOpts *MergeOptions) (int, error)

+ type CollisionCheckResult int

+ const CollisionCheckError

+ const CollisionCheckOverwrite

+ const CollisionCheckSame

+ const CollisionCheckSkip

+ func SchemaCheckCollisionDefault(schemaName string, item1, item2 interface{}, item2Note string) CollisionCheckResult

+ func SchemaCheckCollisionSkip(schemaName string, item1, item2 interface{}, item2Note string) CollisionCheckResult

+ type MergeOptions struct

+ CollisionCheckResult CollisionCheckResult

+ FileRx *regexp.Regexp

+ SchemaFunc func(schemaName string, sch1, sch2 interface{}, hint2 string) CollisionCheckResult

+ ValidateEach bool

+ ValidateFinal bool

+ func NewMergeOptionsSkip() *MergeOptions

+ func (mo *MergeOptions) CheckSchemaCollision(schemaName string, sch1, sch2 interface{}, hint2 string) CollisionCheckResult

+ type OperationMeta struct

+ MetaNotes []string

+ Method string

+ OperationID string

+ Path string

+ Summary string

+ Tags []string

+ func OperationToMeta(url, method string, op *openapi3.Operation) OperationMeta

+ type SpecMeta struct

+ Filepath string

+ IsValid bool

+ ValidationError string

+ Version int

+ type SpecMetas struct

+ Metas []SpecMeta

+ func ReadSpecMetasDir(dir string, rx *regexp.Regexp) (SpecMetas, error)

+ func ReadSpecMetasFiles(files []string) (SpecMetas, error)

+ func (metas *SpecMetas) Filepaths(validOnly bool) []string

+ func (metas *SpecMetas) Merge(validatesOnly bool, mergeOpts *MergeOptions) (SpecMore, error)

+ type SpecMore struct

+ Spec *oas3.Swagger

+ func MergeSpecMetas(metas *SpecMetas, validatesOnly bool, mergeOpts *MergeOptions) (SpecMore, error)

+ func ReadSpecMore(path string, validate bool) (*SpecMore, error)

+ func (sm *SpecMore) ComponentRequestBody(componentPath string) *oas3.RequestBodyRef

+ func (sm *SpecMore) ExtensionNames() map[string]int

+ func (sm *SpecMore) HasComponentSchema(componentSchemaName string, lowerCaseMatch bool) bool

+ func (sm *SpecMore) OperationMetas() []OperationMeta

+ func (sm *SpecMore) OperationParametersDescriptionStatus() maputil.MapStringMapStringInt

+ func (sm *SpecMore) OperationParametersDescriptionStatusCounts() (with, without, all int)

+ func (sm *SpecMore) OperationParametersWithoutDescriptionsWriteFile(filename string) error

+ func (sm *SpecMore) OperationsCount() int

+ func (sm *SpecMore) OperationsTable(columns *text.TextSet) (*table.Table, error)

+ func (sm *SpecMore) SchemaNameExists(schemaName string, includeNil bool) bool

+ func (sm *SpecMore) SchemaNames() []string

+ func (sm *SpecMore) SchemaPropertiesDescriptionStatus() maputil.MapStringMapStringInt

+ func (sm *SpecMore) SchemaPropertiesDescriptionStatusCounts() (with, without, all int)

+ func (sm *SpecMore) SchemaPropertiesWithoutDescriptionsWriteFile(filename string) error

+ func (sm *SpecMore) SchemasCount() int

+ func (sm *SpecMore) ServerURL(index uint) string

+ func (sm *SpecMore) ServerURLBasePath(index uint) (string, error)

+ func (sm *SpecMore) Stats() SpecStats

+ func (sm *SpecMore) TagGroups() (TagGroupSet, error)

+ func (sm *SpecMore) Tags(inclTop, inclOps bool) []string

+ func (sm *SpecMore) TagsMap(inclTop, inclOps bool) map[string]int

+ func (sm *SpecMore) WriteFileJSON(filename string, perm os.FileMode, prefix, indent string) error

+ func (sm *SpecMore) WriteFileXLSX(filename string) error

+ type SpecStats struct

+ OperationsCount int

+ SchemasCount int

+ type TagGroup struct

+ Name string

+ Popular bool

+ Tags []string

+ type TagGroupSet struct

+ TagGroups []TagGroup

+ func NewTagGroupSet() TagGroupSet

+ func (set *TagGroupSet) AddToSpec(spec *oas3.Swagger) error

+ func (set *TagGroupSet) Exists(tagName string) bool

+ func (set *TagGroupSet) GetTagGroupNamesForTagNames(wantTagNames ...string) []string

+ type TagsMore struct

+ Tags oas3.Tags

+ func (tg *TagsMore) Get(tagName string) *oas3.Tag

+ type ValidationStatus struct

+ Context string

+ Message string

+ OpenAPI string

+ Status bool

+ func ValidateMore(spec *oas3.Swagger) (ValidationStatus, error)

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