apidocs

Documentation

Index

• Variables
• func RunMerge(cmd *cobra.Command, args []string) error
• func ValidatePositionalArgs(_ *cobra.Command, args []string) error
• type ResolveArguments
• type ResolveConfig
• type ResolveExtSourceMapping
• type ResolveGitHubTokenMapping

Variables

var (
	ResolveCmd = &cobra.Command{
		Use:                "resolve <space_delimited_source_files>",
		Short:              "Generate OAS3 document from contract definitions and external references",
		Example:            `lanai-cli apidocs resolve -O configs/api-docs.yaml -T $GITHUB_TOKEN -R https://api.swaggerhub.com/domains/<organization>/<project>/8=>github://github.com/raw/<organization>/<project>/<tag/branch>/common-domain-8.yaml contracts/service-8.yaml contracts/service-1.json`,
		FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
		Args:               ValidatePositionalArgs,
		RunE:               RunMerge,
	}
	ResolveArgs = ResolveArguments{
		Output:     "api-docs-merged.yaml",
		KeepExtRef: false,
	}
)

var (
	Cmd = &cobra.Command{
		Use:                "apidocs",
		Short:              "Utilities to work with OpenAPI Specs",
		FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
	}
)

var (
	ResolveConf = ResolveConfig{}
)

Functions

func RunMerge

func RunMerge(cmd *cobra.Command, args []string) error

func ValidatePositionalArgs

func ValidatePositionalArgs(_ *cobra.Command, args []string) error

Types

type ResolveArguments

type ResolveArguments struct {
	Output            string   `flag:"output-file,O" desc:"Path of output file, relative to working directory"`
	KeepExtRef        bool     `flag:"keep-external-ref,k" desc:"Keep external $ref as-is (skip resolving external $ref)"`
	ConfigPath        string   `` /* 244-byte string literal not displayed */
	GitHubPATs        []string `` /* 167-byte string literal not displayed */
	ReplaceExtSources []string `` /* 385-byte string literal not displayed */
}

type ResolveConfig

type ResolveConfig struct {
	GitHubTokens      []ResolveGitHubTokenMapping `json:"github-token"`
	ReplaceExtSources []ResolveExtSourceMapping   `json:"replace"`
}

type ResolveExtSourceMapping

type ResolveExtSourceMapping struct {
	Url string `json:"url"`
	To  string `json:"to"`
}

type ResolveGitHubTokenMapping

type ResolveGitHubTokenMapping struct {
	Host  string `json:"host"`
	Token string `json:"token"`
}