doc

package

v0.54.1 Latest Latest Go to latest Published: Mar 29, 2024 License: BSD-3-Clause Imports: 17 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ovh/cds

Links

Open Source Insights

Documentation ¶

Index ¶

func CleanAndCheckURL(url string) (string, error)
func CleanURL(url string) string
func CleanURLParameter(u string) string
func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
func GenerateDocumentation(root *cobra.Command, genPath, gitPath string) error
type Doc
type Method
type Middleware
type RouteInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CleanAndCheckURL ¶

func CleanAndCheckURL(url string) (string, error)

CleanAndCheckURL returns cleaned URL but also an error if given url contains variables that can't be cleaned. Ex: /myresource/{permMyresourceID} should be transformed to /myresource/<myresource-id>, an error will be returned if permMyResourceID not converted.

func CleanURL ¶

func CleanURL(url string) string

CleanURL given a URL with declared variable inside, returns the same URL with harmonized variable names. Ex: permProjectKey -> projectKey

func CleanURLParameter ¶

func CleanURLParameter(u string) string

func GenMarkdownCustom ¶

func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenMarkdownCustom creates custom markdown output.

func GenerateDocumentation ¶

func GenerateDocumentation(root *cobra.Command, genPath, gitPath string) error

GenerateDocumentation generates hugo documentation for a command line

Types ¶

type Doc ¶

type Doc struct {
	Title         string
	Description   string
	Method        string
	URL           string
	QueryParams   []string
	ResponseBody  string
	RequestBody   string
	Middlewares   []Middleware
	Scopes        []string
	HTTPOperation string
}

Doc represents elements wanted in the documentation

type Method ¶

type Method struct {
	Doc  string
	Name string
}

Method Represent data on a method

type Middleware ¶

type Middleware struct {
	Name  string
	Value []string
}

Middleware represents a middleware

type RouteInfo ¶

type RouteInfo struct {
	URL           string
	Method        string
	Middlewares   []Middleware
	Scopes        []string
	HTTPOperation string
}

RouteInfo Information on a route

Source Files ¶

View all Source files

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