Qore Swagger Module Reference  1.0.1
 All Classes Namespaces Functions Variables Groups Pages
Swagger Namespace Reference

main namespace for all public Swagger declarations More...

Classes

class  AbstractParameterObject
 Describes a single operation parameter. More...
 
class  BodyParameter
 AbstractParameterObject specialization for "body" parameters. More...
 
class  ContactObject
 Contact information for the exposed API. More...
 
class  ExternalDocumentationObject
 Allows referencing an external resource for extended documentation. More...
 
class  HeaderObject
 describes a single HTTP header More...
 
class  InfoObject
 The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience. More...
 
class  LicenseObject
 License information for the exposed API. More...
 
class  ObjectBase
 Base class for the Swagger specification objects, wrapping the vendor extensions. More...
 
class  OperationObject
 Describes a single API operation on a path. More...
 
class  OtherParameter
 AbstractParameterObject specialization for parameters other than "body". More...
 
class  ParameterItemsSchemaObject
 items schema object for non-body parameters More...
 
class  PathComponent
 Holds the relative paths to the individual endpoints. More...
 
class  PathItemObject
 Describes the operations available on a single path. More...
 
class  PathsObject
 This class stores the path tree for URI path matching. More...
 
class  ResponseObject
 Describes a single response from an API Operation. More...
 
class  ResponsesObject
 contains the possible responses for an operation More...
 
class  SchemaBase
 Base used by OtherParameter, HeaderObject and SchemaObject. More...
 
class  SchemaObject
 defines an object in a schema More...
 
class  ScopesObject
 Lists the available scopes for an OAuth2 security scheme. More...
 
class  SecuritySchemeObject
 Allows the definition of a security scheme that can be used by the operations. More...
 
class  SwaggerLoader
 Used for loading the Swagger definitions. More...
 
class  SwaggerSchema
 This is the root document object for the API specification. It combines what previously was the Resource Listing and API Declaration (version 1.2 and earlier) together into one document. More...
 
class  TagObject
 Allows adding metadata to a single tag that is used by the OperationObject. It is not mandatory to have a TagObject per tag used there. More...
 
class  XmlObject
 A metadata object that allows for more fine-tuned XML model definitions. More...
 

Variables

const CollectionFormats
 allowed collection formats
 
const MimeDataTypes const MimeContentTypes = keys MimeDataTypes
 MIME types for data serialization.
 
const MimeDataTypes
 supported mime types for de/serializing data
 
const ParameterCollectionFormats
 valid parameter collection formats
 
const SerializationModules = map $1.module
 modules available for data serialization and/or deserialization
 
const ValidIntFormats = ("int32", "int64")
 Valid integer type formats.
 
const ValidIntFormatsHash = map {$1: True}
 A hash of valid integer type formats.
 
const ValidNumberFormats = ("double", "float")
 Valid number type formats.
 
const ValidNumberFormatsHash = map {$1: True}
 A hash of valid number type formats.
 
const ValidSchemes = ("http", "https", "ws", "wss")
 Valid transfer protocol schemes.
 
const ValidStringFormats = ("binary", "byte", "date", "date-time", "password")
 Valid string type formats.
 
const ValidStringFormatsHash = map {$1: True}
 A hash of valid string type formats.
 

Detailed Description

main namespace for all public Swagger declarations