swagger

Documentation

Overview

Package swagger struct definition

Index

• type Contact
• type ExternalDocs
• type Information
• type Item
• type License
• type Operation
• type Parameter
• type ParameterItems
• type Propertie
• type Response
• type Schema
• type Security
• type Swagger
• type Tag

Types

type Contact

type Contact swagger.Contact

Contact information for the exposed API.

type ExternalDocs

type ExternalDocs swagger.ExternalDocs

ExternalDocs include Additional external documentation

type Information

type Information swagger.Information

Information Provides metadata about the API. The metadata can be used by the clients if needed.

type Item

type Item swagger.Item

Item Describes the operations available on a single path.

type License

type License swagger.License

License information for the exposed API.

type Operation

type Operation swagger.Operation

Operation Describes a single API operation on a path.

type Parameter

type Parameter swagger.Parameter

Parameter Describes a single operation parameter.

type ParameterItems

type ParameterItems swagger.ParameterItems

ParameterItems A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body". http://swagger.io/specification/#itemsObject

type Propertie

type Propertie swagger.Propertie

Propertie are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification

type Response

type Response swagger.Response

Response as they are returned from executing this operation.

type Schema

type Schema swagger.Schema

Schema Object allows the definition of input and output data types.

type Security

type Security swagger.Security

Security Allows the definition of a security scheme that can be used by the operations

type Swagger

type Swagger swagger.Swagger

Swagger list the resource

type Tag

type Tag swagger.Tag

Tag Allows adding meta data to a single tag that is used by the Operation Object