forked from ebhomengo/niki
25 lines
725 B
Go
25 lines
725 B
Go
package spec
|
|
|
|
// ExternalDocs allows referencing an external resource for extended documentation.
|
|
//
|
|
// https://spec.openapis.org/oas/v3.1.0#external-documentation-object
|
|
//
|
|
// Example:
|
|
//
|
|
// description: Find more info here
|
|
// url: https://example.com
|
|
type ExternalDocs struct {
|
|
// A description of the target documentation.
|
|
// CommonMark syntax MAY be used for rich text representation.
|
|
Description string `json:"description" yaml:"description"`
|
|
// REQUIRED.
|
|
// The URL for the target documentation.
|
|
// This MUST be in the form of a URL.
|
|
URL string `json:"url" yaml:"url"`
|
|
}
|
|
|
|
// NewExternalDocs creates ExternalDocs object.
|
|
func NewExternalDocs() *Extendable[ExternalDocs] {
|
|
return NewExtendable(&ExternalDocs{})
|
|
}
|