LukeParke/libopenapi
1
0
Fork 0
mirror of https://github.com/LukeHagar/libopenapi.git synced 2025-12-06 12:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added more docstrings

Browse Source
This commit is contained in:
Calvin Lobo
2024-08-28 15:36:30 -04:00
committed by quobix
parent c8186468ae
commit 9d5251a55e
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
index/index_model.go
View File

@@ -155,7 +155,8 @@ type SpecIndexConfig struct {
uri []string
}
// SetTheoreticalRoot sets the spec file paths to a theoretical file path
// SetTheoreticalRoot sets the spec file paths to point to a theoretical spec file, which does not exist but is required
// in order to formulate the absolute path to root references correctly.
func (s *SpecIndexConfig) SetTheoreticalRoot() {
s.SpecFilePath = filepath.Join(s.BasePath, theoreticalRoot)

7
index/spec_index.go
View File

@@ -16,6 +16,7 @@ import (
"fmt"
"log/slog"
"os"
"path/filepath"
"sort"
"strings"
"sync"
@@ -26,6 +27,7 @@ import (
)
const (
// theoreticalRoot is the name of the theoretical spec file used when a root spec file does not exist
theoreticalRoot = "root.yaml"
)
@@ -156,11 +158,12 @@ func (index *SpecIndex) GetRolodex() *Rolodex {
return index.rolodex
}
// GetSpecFileName returns the root spec filename, if it exists, otherwise returns the theoretical root spec
func (index *SpecIndex) GetSpecFileName() string {
if index == nil || index.rolodex == nil || index.rolodex.indexConfig == nil {
if index == nil || index.rolodex == nil || index.rolodex.indexConfig == nil || index.rolodex.indexConfig.SpecFilePath == "" {
return theoreticalRoot
}
return index.rolodex.indexConfig.SpecFilePath
return filepath.Base(index.rolodex.indexConfig.SpecFilePath)
}
// GetGlobalTagsNode returns document root tags node.