40 lines
1.1 KiB
Go
40 lines
1.1 KiB
Go
package openapi3
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"net/url"
|
|
|
|
"github.com/getkin/kin-openapi/jsoninfo"
|
|
)
|
|
|
|
// ExternalDocs is specified by OpenAPI/Swagger standard version 3.
|
|
// See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#external-documentation-object
|
|
type ExternalDocs struct {
|
|
ExtensionProps `json:"-" yaml:"-"`
|
|
|
|
Description string `json:"description,omitempty" yaml:"description,omitempty"`
|
|
URL string `json:"url,omitempty" yaml:"url,omitempty"`
|
|
}
|
|
|
|
// MarshalJSON returns the JSON encoding of ExternalDocs.
|
|
func (e *ExternalDocs) MarshalJSON() ([]byte, error) {
|
|
return jsoninfo.MarshalStrictStruct(e)
|
|
}
|
|
|
|
// UnmarshalJSON sets ExternalDocs to a copy of data.
|
|
func (e *ExternalDocs) UnmarshalJSON(data []byte) error {
|
|
return jsoninfo.UnmarshalStrictStruct(data, e)
|
|
}
|
|
|
|
// Validate returns an error if ExternalDocs does not comply with the OpenAPI spec.
|
|
func (e *ExternalDocs) Validate(ctx context.Context) error {
|
|
if e.URL == "" {
|
|
return errors.New("url is required")
|
|
}
|
|
if _, err := url.Parse(e.URL); err != nil {
|
|
return fmt.Errorf("url is incorrect: %w", err)
|
|
}
|
|
return nil
|
|
}
|