v1

Documentation

Index

• type AdditionalErrors
• type Components
• type Contact
• type Content
• type CreateMultipartUploadData
• type Detail
• type ExternalDocs
• type GetDetailsEmbedStructResponse
• type Header
• type Info
• type License
• type Media
• type Namespace
• type Operation
• type Parameter
• type Path
• type Properties
• type RequestBody
• type Response
• type Responses
• type Schema
• type Schemas
• type Server
• type Swagger
  • func (s *Swagger) SaveJSON(path string) (err error)
• type Tag
• type Variable

Types

type AdditionalErrors

type AdditionalErrors struct {
	Name     string `json:"name"`
	LastName string `json:"lastName"`
}

AdditionalErrors ...

type Components

type Components struct {
	Schemas Schemas `json:"schemas,omitempty" yaml:"schemas,omitempty"`
}

Components ...

type Contact

type Contact struct {
	Name  string `json:"name,omitempty" yaml:"name,omitempty"`
	URL   string `json:"url,omitempty" yaml:"url,omitempty"`
	Email string `json:"email,omitempty" yaml:"email,omitempty"`
}

Contact ...

type Content

type Content map[string]Media

Content ...

type CreateMultipartUploadData

type CreateMultipartUploadData struct {
	UploadID string `json:"upload_id"`
}

CreateMultipartUploadData ...

type Detail

type Detail struct {
	Namespace string `json:"namespace"`
	Name      string `json:"name"`
}

Detail ...

type ExternalDocs

type ExternalDocs struct {
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	URL         string `json:"url,omitempty" yaml:"url,omitempty"`
}

ExternalDocs ...

type GetDetailsEmbedStructResponse

type GetDetailsEmbedStructResponse struct {
	Detail    Detail    `json:"detail"`
	Namespace Namespace `json:"namespace"`
}

GetDetailsEmbedStructResponse ...

type Header

type Header struct {
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	Schema      Schema `json:"schema,omitempty" yaml:"schema,omitempty"`
}

Header ...

type Info

type Info struct {
	Title          *string  `json:"title,omitempty" yaml:"title,omitempty"`
	Description    *string  `json:"description,omitempty" yaml:"description,omitempty"`
	TermsOfService *string  `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"`
	Contact        *Contact `json:"contact,omitempty" yaml:"contact,omitempty"`
	License        *License `json:"license,omitempty" yaml:"license,omitempty"`
	Version        *string  `json:"version,omitempty" yaml:"version,omitempty"`
}

Info ...

type License

type License struct {
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	URL  string `json:"url,omitempty" yaml:"url,omitempty"`
}

License ...

type Media

type Media struct {
	Schema Schema `json:"schema,omitempty" yaml:"schema,omitempty"`
}

Media ...

type Namespace

type Namespace struct {
	Name string `json:"name"`
}

Namespace ...

type Operation

type Operation struct {
	Tags        []string     `json:"tags,omitempty" yaml:"tags,omitempty"`
	Summary     *string      `json:"summary,omitempty" yaml:"summary,omitempty"`
	Description *string      `json:"description,omitempty" yaml:"description,omitempty"`
	OperationID string       `json:"operationId,omitempty" yaml:"operationId,omitempty"`
	Consumes    []string     `json:"consumes,omitempty" yaml:"consumes,omitempty"`
	Produces    []string     `json:"produces,omitempty" yaml:"produces,omitempty"`
	Parameters  []Parameter  `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	RequestBody *RequestBody `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`
	Responses   Responses    `json:"responses,omitempty" yaml:"responses,omitempty"`
}

Operation ...

type Parameter

type Parameter struct {
	Ref         string `json:"$ref,omitempty" yaml:"$ref,omitempty"`
	In          string `json:"in,omitempty" yaml:"in,omitempty"`
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	Required    bool   `json:"required,omitempty" yaml:"required,omitempty"`
	Schema      Schema `json:"schema,omitempty" yaml:"schema,omitempty"`
}

Parameter ...

type Path

type Path struct {
	Ref         string     `json:"$ref,omitempty" yaml:"$ref,omitempty"`
	Summary     string     `json:"summary,omitempty" yaml:"summary,omitempty"`
	Description string     `json:"description,omitempty" yaml:"description,omitempty"`
	Get         *Operation `json:"get,omitempty" yaml:"get,omitempty"`
	Post        *Operation `json:"post,omitempty" yaml:"post,omitempty"`
	Patch       *Operation `json:"patch,omitempty" yaml:"patch,omitempty"`
	Put         *Operation `json:"put,omitempty" yaml:"put,omitempty"`
	Delete      *Operation `json:"delete,omitempty" yaml:"delete,omitempty"`
}

Path ...

type Properties

type Properties map[string]Schema

Properties ...

type RequestBody

type RequestBody struct {
	Description string  `json:"description,omitempty" yaml:"description,omitempty"`
	Content     Content `json:"content,omitempty" yaml:"content,omitempty"`
	Required    bool    `json:"required,omitempty" yaml:"required,omitempty"`
}

RequestBody ...

type Response

type Response struct {
	Description string            `json:"description" yaml:"description"`
	Content     Content           `json:"content,omitempty" yaml:"content,omitempty"`
	Headers     map[string]Header `json:"headers,omitempty" yaml:"headers,omitempty"`
}

Response ...

type Responses

type Responses map[string]Response

Responses ...

type Schema

type Schema struct {
	Ref         string      `json:"$ref,omitempty" yaml:"$ref,omitempty"`
	Type        string      `json:"type,omitempty" yaml:"type,omitempty"`
	Format      string      `json:"format,omitempty" yaml:"format,omitempty"`
	Properties  Properties  `json:"properties,omitempty" yaml:"properties,omitempty"`
	Items       *Schema     `json:"items,omitempty" yaml:"items,omitempty"`
	Enum        []string    `json:"enum,omitempty" yaml:"enum,omitempty"`
	Nullable    bool        `json:"nullable,omitempty" yaml:"nullable,omitempty"`
	Example     interface{} `json:"example,omitempty" yaml:"example,omitempty"`
	Description string      `json:"description,omitempty" yaml:"description,omitempty"`

	OneOf []Schema `json:"oneOf,omitempty" yaml:"oneOf,omitempty"`

	AdditionalProperties interface{} `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"`
}

Schema ...

type Schemas

type Schemas map[string]Schema

Schemas ...

type Server

type Server struct {
	URL         string              `json:"url,omitempty" yaml:"url,omitempty"`
	Description string              `json:"description,omitempty" yaml:"description,omitempty"`
	Variables   map[string]Variable `json:"variables,omitempty" yaml:"variables,omitempty"`
}

Server ...

type Swagger

type Swagger struct {
	OpenAPI    string           `json:"openapi" yaml:"openapi"`
	Info       Info             `json:"info,omitempty" yaml:"info,omitempty"`
	Servers    []Server         `json:"servers,omitempty" yaml:"servers,omitempty"`
	Tags       []Tag            `json:"tags,omitempty" yaml:"tags,omitempty"`
	Schemes    []string         `json:"schemes,omitempty" yaml:"schemes,omitempty"`
	Paths      map[string]*Path `json:"paths" yaml:"paths"`
	Components Components       `json:"components,omitempty" yaml:"components,omitempty"`
}

Swagger ...

func (*Swagger) SaveJSON

func (s *Swagger) SaveJSON(path string) (err error)

SaveJSON ...

type Tag

type Tag struct {
	Name         string       `json:"name,omitempty" yaml:"name,omitempty"`
	Description  string       `json:"description,omitempty" yaml:"description,omitempty"`
	ExternalDocs ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`
}

Tag ...

type Variable

type Variable struct {
	Enum        []string `json:"enum,omitempty" yaml:"enum,omitempty"`
	Default     string   `json:"default,omitempty" yaml:"default,omitempty"`
	Description string   `json:"description,omitempty" yaml:"description,omitempty"`
}

Variable ...