Class Hierarchy

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

Swagger::ObjectBase | Base class for the Swagger specification objects, wrapping the vendor extensions
Swagger::AbstractParameterObject | Describes a single operation parameter
Swagger::BodyParameter | AbstractParameterObject specialization for `"body"` parameters
Swagger::OtherParameter | AbstractParameterObject specialization for parameters other than `"body"`
Swagger::ContactObject | Contact information for the exposed API
Swagger::ExternalDocumentationObject | Allows referencing an external resource for extended documentation
Swagger::HeaderObject | Describes a single HTTP header
Swagger::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
Swagger::LicenseObject | License information for the exposed API
Swagger::OperationObject | Describes a single API operation on a path
Swagger::PathItemObject | Describes the operations available on a single path
Swagger::PathsObject | This class stores the path tree for URI path matching
Swagger::ResponseObject | Describes a single response from an API Operation
Swagger::ResponsesObject | Possible responses for an operation
Swagger::SchemaObject | Defines an object in a schema
Swagger::ParameterItemsSchemaObject | Items schema object for non-body parameters
Swagger::ScopesObject | Lists the available scopes for an OAuth2 security scheme
Swagger::SecuritySchemeObject | Allows the definition of a security scheme that can be used by the operations
Swagger::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
Swagger::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
Swagger::XmlObject | A metadata object that allows for more fine-tuned XML model definitions
Swagger::PathComponent | Holds the relative paths to the individual endpoints
Swagger::SchemaBase | Base used by OtherParameter, HeaderObject and SchemaObject
Swagger::HeaderObject | Describes a single HTTP header
Swagger::OtherParameter | AbstractParameterObject specialization for parameters other than `"body"`
Swagger::SchemaObject | Defines an object in a schema
Swagger::SwaggerLoader | Used for loading the Swagger definitions