openapi3_parser 0.1.0 → 0.2.0

data/lib/openapi3_parser/nodes/path_item.rb

@@ -4,53 +4,67 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#pathItemObject
     class PathItem
       include Node::Object
 
+      # @return [String, nil]
       def summary
         node_data["summary"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [Operation, nil]
       def get
         node_data["get"]
       end
 
+      # @return [Operation, nil]
       def put
         node_data["put"]
       end
 
+      # @return [Operation, nil]
       def post
         node_data["post"]
       end
 
+      # @return [Operation, nil]
       def delete
         node_data["delete"]
       end
 
+      # @return [Operation, nil]
       def options
         node_data["options"]
       end
 
+      # @return [Operation, nil]
       def head
         node_data["head"]
       end
 
+      # @return [Operation, nil]
       def patch
         node_data["patch"]
       end
 
+      # @return [Operation, nil]
       def trace
         node_data["trace"]
       end
 
+      # @return [Nodes::Array] a collection of {Server}[./Server.html] objects
       def servers
         node_data["servers"]
       end
 
+      # @return [Nodes::Array] a collection of {Parameter}[./Parameter.html]
+      #         objects
       def parameters
         node_data["parameters"]
       end

data/lib/openapi3_parser/nodes/paths.rb

@@ -4,6 +4,7 @@ require "openapi3_parser/node/map"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#pathsObject
     class Paths
       include Node::Map
     end

data/lib/openapi3_parser/nodes/request_body.rb

@@ -4,17 +4,21 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#requestBodyObject
     class RequestBody
       include Node::Object
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [Map] a map of String: {MediaType}[./MediaType.html] objects
       def content
         node_data["content"]
       end
 
+      # @return [Boolean]
       def required?
         node_data["required"]
       end

data/lib/openapi3_parser/nodes/response.rb

@@ -4,21 +4,26 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject
     class Response
       include Node::Object
 
+      # @return [String]
       def description
         node_data["description"]
       end
 
+      # @return [Map] a map of String: {Header}[./Header.html] objects
       def headers
         node_data["headers"]
       end
 
+      # @return [Map] a map of String: {MediaType}[./MediaType.html] objects
       def content
         node_data["content"]
       end
 
+      # @return [Map] a map of String: {Link}[./Link.html] objects
       def links
         node_data["links"]
       end

data/lib/openapi3_parser/nodes/responses.rb

@@ -4,9 +4,11 @@ require "openapi3_parser/node/map"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responsesObject
     class Responses
       include Node::Map
 
+      # @return [Response]
       def default
         node_data["default"]
       end

data/lib/openapi3_parser/nodes/schema.rb

@@ -4,152 +4,190 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
     # rubocop:disable ClassLength
     class Schema
       include Node::Object
 
+      # @return [String, nil]
       def title
         node_data["title"]
       end
 
+      # @return [Numeric, nil]
       def multiple_of
         node_data["multipleOf"]
       end
 
+      # @return [Integer, nil]
       def maximum
         node_data["maximum"]
       end
 
+      # @return [Boolean]
       def exclusive_maximum?
         node_data["exclusiveMaximum"]
       end
 
+      # @return [Integer, nil]
       def minimum
         node_data["minimum"]
       end
 
+      # @return [Boolean]
       def exclusive_minimum?
         node_data["exclusiveMinimum"]
       end
 
+      # @return [Integer, nil]
       def max_length
         node_data["maxLength"]
       end
 
+      # @return [Integer]
       def min_length
         node_data["minLength"]
       end
 
+      # @return [String, nil]
       def pattern
         node_data["pattern"]
       end
 
+      # @return [Integer, nil]
       def max_items
         node_data["maxItems"]
       end
 
+      # @return [Integer]
       def min_items
         node_data["minItems"]
       end
 
+      # @return [Boolean]
       def unique_items?
         node_data["uniqueItems"]
       end
 
+      # @return [Integer, nil]
       def max_properties
         node_data["maxProperties"]
       end
 
+      # @return [Integer]
       def min_properties
         node_data["minProperties"]
       end
 
+      # @return [Nodes::Array, nil] a collection of String objects or nil
       def required
         node_data["required"]
       end
 
+      # @return [Nodes::Array, nil] a collection of objects of no fixed type or
+      #         nil
       def enum
         node_data["enum"]
       end
 
+      # @return [String, nil]
       def type
         node_data["type"]
       end
 
+      # @return [Nodes::Array, nil] a collection of Schema objects or nil
       def all_of
         node_data["allOf"]
       end
 
+      # @return [Nodes::Array, nil] a collection of Schema objects or nil
       def one_of
         node_data["oneOf"]
       end
 
+      # @return [Nodes::Array, nil] a collection of Schema objects or nil
       def any_of
         node_data["anyOf"]
       end
 
+      # @return [Schema, nil]
       def not
         node_data["not"]
       end
 
+      # @return [Schema, nil]
       def items
         node_data["items"]
       end
 
+      # @return [Map] a collection of Schema objects
       def properties
         node_data["properties"]
       end
 
+      # @return [Boolean]
       def additional_properties?
         node_data["additionalProperties"] != false
       end
 
+      # @return [Schema, nil]
       def additional_properties_schema
         properties = node_data["additionalProperties"]
         return if [true, false].include?(properties)
         properties
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [String, nil]
       def format
         node_data["format"]
       end
 
+      # @return [Any]
       def default
         node_data["default"]
       end
 
+      # @return [Boolean]
       def nullable?
         node_data["nullable"]
       end
 
+      # @return [Discriminator, nil]
       def disciminator
         node_data["discriminator"]
       end
 
+      # @return [Boolean]
       def read_only?
         node_data["readOnly"]
       end
 
+      # @return [Boolean]
       def write_only?
         node_data["writeOnly"]
       end
 
+      # @return [Xml, nil]
       def xml
         node_data["xml"]
       end
 
+      # @return [ExternalDocumentation, nil]
       def external_docs
         node_data["externalDocs"]
       end
 
+      # @return [Any]
       def example
         node_data["example"]
       end
 
+      # @return [Boolean]
       def deprecated?
         node_data["deprecated"]
       end

data/lib/openapi3_parser/nodes/security_requirement.rb

@@ -4,6 +4,7 @@ require "openapi3_parser/node/map"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#securityRequirementObject
     class SecurityRequirement
       include Node::Map
     end

data/lib/openapi3_parser/nodes/security_scheme.rb

@@ -5,37 +5,46 @@ require "openapi3_parser/nodes/oauth_flows"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#securitySchemeObject
     class SecurityScheme
       include Node::Object
 
+      # @return [String, nil]
       def type
         node_data["type"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [String, nil]
       def name
         node_data["name"]
       end
 
+      # @return [String, nil]
       def in
         node_data["in"]
       end
 
+      # @return [String, nil]
       def scheme
         node_data["scheme"]
       end
 
+      # @return [String, nil]
       def bearer_format
         node_data["bearerFormat"]
       end
 
+      # @return [OauthFlows, nil]
       def flows
         node_data["flows"]
       end
 
+      # @return [String, nil]
       def open_id_connect_url
         node_data["openIdConnectUrl"]
       end

data/lib/openapi3_parser/nodes/server.rb

@@ -4,19 +4,22 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#serverObject
     class Server
       include Node::Object
 
-      # @TODO there's scope for an interpolated_url method which can use the
-      # values from variables
+      # @return [String]
       def url
         node_data["url"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [Map] a map of String: {ServerVariable}[./ServerVariable.html]
+      #         objects
       def variables
         node_data["variables"]
       end

data/lib/openapi3_parser/nodes/server_variable.rb

@@ -4,17 +4,21 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#serverVariableObject
     class ServerVariable
       include Node::Object
 
+      # @return [Nodes::Array, nil] a collection of String objects or nil
       def enum
         node_data["enum"]
       end
 
+      # @return [String]
       def default
         node_data["default"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end

data/lib/openapi3_parser/nodes/tag.rb

@@ -4,17 +4,21 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#tagObject
     class Tag
       include Node::Object
 
+      # @return [String]
       def name
         node_data["name"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [ExternalDocumentation, nil]
       def external_docs
         node_data["externalDocs"]
       end