-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor:
openapi3: standardize OAS3 extension support; move embedd…
…ed `x-tagGroups` functionality to `ext/taggroups`
- Loading branch information
Showing
14 changed files
with
224 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| package taggroups | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "reflect" | ||
| "strings" | ||
|
|
||
| "github.com/grokify/mogo/type/stringsutil" | ||
| "github.com/grokify/spectrum/openapi3" | ||
| "github.com/grokify/spectrum/openapi3edit" | ||
| ) | ||
|
|
||
| const XTagGroupsPropertyName = "x-tag-groups" | ||
|
|
||
| type TagGroupSet struct { | ||
| TagGroups []TagGroup | ||
| } | ||
|
|
||
| func NewTagGroupSet() TagGroupSet { | ||
| return TagGroupSet{TagGroups: []TagGroup{}} | ||
| } | ||
|
|
||
| func (set *TagGroupSet) Exists(tagName string) bool { | ||
| for _, tg := range set.TagGroups { | ||
| for _, tgTagName := range tg.Tags { | ||
| if tagName == tgTagName { | ||
| return true | ||
| } | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func (set *TagGroupSet) GetTagGroupNamesForTagNames(wantTagNames ...string) []string { | ||
| tagGroupNames := []string{} | ||
| for _, tg := range set.TagGroups { | ||
| for _, tgTagName := range tg.Tags { | ||
| for _, wantTagName := range wantTagNames { | ||
| if wantTagName == tgTagName { | ||
| tagGroupNames = append(tagGroupNames, tg.Name) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return stringsutil.SliceCondenseSpace(tagGroupNames, true, true) | ||
| } | ||
|
|
||
| func (set *TagGroupSet) AddToSpec(spec *openapi3.Spec) error { | ||
| if len(set.TagGroups) == 0 { | ||
| return nil | ||
| } | ||
| missing := SpecTagsWithoutGroups(spec, *set) | ||
| if len(missing) > 0 { | ||
| return fmt.Errorf("E_TAGS_WITHOUT_GROUPS [%s]", strings.Join(missing, ",")) | ||
| } | ||
| se := openapi3edit.SpecEdit{} | ||
| se.SpecSet(spec) | ||
| se.ExtensionSet(XTagGroupsPropertyName, set.TagGroups) | ||
| // spec.ExtensionProps.Extensions[XTagGroupsPropertyName] = set.TagGroups | ||
| return nil | ||
| } | ||
|
|
||
| // OperationMoreTagGroupNames this function is meant to be used wtih `SpecMore.Table()` | ||
| // and must follow the `OperationMoreStringFunc` interface. | ||
| func (set *TagGroupSet) OperationMoreTagGroupNames(opm *openapi3.OperationMore) string { | ||
| // row = append(row, strings.Join(tgs.GetTagGroupNamesForTagNames(op.Tags...), ", ")) | ||
| if opm == nil || opm.Operation == nil { | ||
| return "" | ||
| } | ||
| return strings.Join(set.GetTagGroupNamesForTagNames(opm.Operation.Tags...), ", ") | ||
| } | ||
|
|
||
| type TagGroup struct { | ||
| Name string `json:"name"` | ||
| Popular bool `json:"popular"` | ||
| Tags []string `json:"tags"` | ||
| } | ||
|
|
||
| /* | ||
| func (sm *SpecMore) TagsWithoutGroups() ([]string, []string, []string, error) { | ||
| tgs, err := sm.TagGroups() | ||
| if err != nil { | ||
| return []string{}, []string{}, []string{}, err | ||
| } | ||
| allTags := []string{} | ||
| topTags := stringsutil.SliceCondenseSpace(sm.Tags(true, false), true, true) | ||
| allTags = append(allTags, topTags...) | ||
| opsTags := stringsutil.SliceCondenseSpace(sm.Tags(false, true), true, true) | ||
| allTags = append(allTags, opsTags...) | ||
| allTags = stringsutil.SliceCondenseSpace(allTags, true, true) | ||
| return allTags, topTags, opsTags, nil | ||
| } | ||
| */ | ||
|
|
||
| func SpecTagsWithoutGroups(spec *openapi3.Spec, tagGroupSet TagGroupSet) []string { | ||
| missing := []string{} | ||
| for _, tag := range spec.Tags { | ||
| if !tagGroupSet.Exists(tag.Name) { | ||
| missing = append(missing, tag.Name) | ||
| } | ||
| } | ||
| return missing | ||
| } | ||
|
|
||
| // SpecTagGroups parses a TagGroupSet from an OpenAPI3 spec. | ||
| func SpecTagGroups(spec *openapi3.Spec) (TagGroupSet, error) { | ||
| sm := openapi3.SpecMore{Spec: spec} | ||
| tgs := NewTagGroupSet() | ||
| iface, ok := sm.Spec.ExtensionProps.Extensions[XTagGroupsPropertyName] | ||
| if !ok { | ||
| return tgs, nil | ||
| } | ||
|
|
||
| tagGroups := []TagGroup{} | ||
| if reflect.TypeOf(iface) == reflect.TypeOf(tagGroups) { | ||
| tgs.TagGroups = iface.([]TagGroup) | ||
| return tgs, nil | ||
| } | ||
|
|
||
| // message is stored as `json.RawMessage` when the data | ||
| // is read in from JSON, vs. set via code. | ||
| rawMessage := iface.(json.RawMessage) | ||
| err := json.Unmarshal(rawMessage, &tagGroups) | ||
| if err != nil { | ||
| return tgs, err | ||
| } | ||
| tgs.TagGroups = tagGroups | ||
| delete(sm.Spec.ExtensionProps.Extensions, XTagGroupsPropertyName) | ||
| sm.Spec.ExtensionProps.Extensions[XTagGroupsPropertyName] = tagGroups | ||
| return tgs, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.