openapi3_parser 0.1.0 → 0.2.0

data/lib/openapi3_parser/nodes/discriminator.rb

@@ -4,13 +4,16 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#discriminatorObject
     class Discriminator
       include Node::Object
 
+      # @return [String]
       def property_name
         node_data["propertyName"]
       end
 
+      # @return [Map] a map of String: String objects
       def mapping
         node_data["mapping"]
       end

data/lib/openapi3_parser/nodes/encoding.rb

@@ -4,25 +4,31 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#encodingObject
     class Encoding
       include Node::Object
 
+      # @return [String, nil]
       def content_type
         node_data["contentType"]
       end
 
+      # @return [Map] a map of String: {Header}[./Header.html] objects
       def headers
         node_data["headers"]
       end
 
+      # @return [String, nil]
       def style
         node_data["style"]
       end
 
+      # @return [Boolean]
       def explode?
         node_data["explode"]
       end
 
+      # @return [Boolean]
       def allow_reserved?
         node_data["allowReserved"]
       end

data/lib/openapi3_parser/nodes/example.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#exampleObject
     class Example
       include Node::Object
 
+      # @return [String, nil]
       def summary
         node_data["summary"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [Object]
       def value
         node_data["value"]
       end
 
+      # @return [String, nil]
       def external_value
         node_data["externalValue"]
       end

data/lib/openapi3_parser/nodes/external_documentation.rb

@@ -4,13 +4,16 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#externalDocumentationObject
     class ExternalDocumentation
       include Node::Object
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [String]
       def url
         node_data["url"]
       end

data/lib/openapi3_parser/nodes/header.rb

@@ -5,6 +5,7 @@ require "openapi3_parser/nodes/parameter/parameter_like"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#headerObject
     class Header
       include Node::Object
       include Parameter::ParameterLike

data/lib/openapi3_parser/nodes/info.rb

@@ -4,29 +4,36 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#infoObject
     class Info
       include Node::Object
 
+      # @return [String]
       def title
         node_data["title"]
       end
 
+      # @return [String, null]
       def description
         node_data["description"]
       end
 
+      # @return [String, null]
       def terms_of_service
         node_data["termsOfService"]
       end
 
+      # @return [Contact, nil]
       def contact
         node_data["contact"]
       end
 
+      # @return [License, nil]
       def license
         node_data["license"]
       end
 
+      # @return [String]
       def version
         node_data["version"]
       end

data/lib/openapi3_parser/nodes/license.rb

@@ -4,13 +4,16 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#licenseObject
     class License
       include Node::Object
 
+      # @return [String]
       def name
         node_data["name"]
       end
 
+      # @return [String, nil]
       def url
         node_data["url"]
       end

data/lib/openapi3_parser/nodes/link.rb

@@ -4,29 +4,36 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#linkObject
     class Link
       include Node::Object
 
+      # @return [String, nil]
       def operation_ref
         node_data["operationRef"]
       end
 
+      # @return [String, nil]
       def operation_id
         node_data["operationId"]
       end
 
+      # @return [Map] a map of String: {Parameter}[./Parameter.html] objects
       def parameters
         node_data["parameters"]
       end
 
+      # @return [Any]
       def request_body
         node_data["requestBody"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [Server, nil]
       def server
         node_data["server"]
       end

data/lib/openapi3_parser/nodes/map.rb

@@ -4,6 +4,12 @@ require "openapi3_parser/node/map"
 
 module Openapi3Parser
   module Nodes
+    # A map within a OpenAPI document.
+    # Very similar to a ruby hash, however this is read only and knows
+    # the context of where it sits in an OpenAPI document
+    #
+    # The contents of the data will be dependent on where this document is in
+    # the document hierachy.
     class Map
       include Node::Map
     end

data/lib/openapi3_parser/nodes/media_type.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#mediaTypeObject
     class MediaType
       include Node::Object
 
+      # @return [Schema, nil]
       def schema
         node_data["schema"]
       end
 
+      # @return [Any]
       def example
         node_data["example"]
       end
 
+      # @return [Map] a map of String: {Example}[./Example.html] objects
       def examples
         node_data["examples"]
       end
 
+      # @return [Map] a map of String: {Encoding}[./Encoding.html] objects
       def encoding
         node_data["encoding"]
       end

data/lib/openapi3_parser/nodes/oauth_flow.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#oauthFlowObject
     class OauthFlow
       include Node::Object
 
+      # @return [String, nil]
       def authorization_url
         node_data["authorizationUrl"]
       end
 
+      # @return [String, nil]
       def token_url
         node_data["tokenUrl"]
       end
 
+      # @return [String, nil]
       def refresh_url
         node_data["refreshUrl"]
       end
 
+      # @return [Map] a map of String: String objects
       def scopes
         node_data["scopes"]
       end

data/lib/openapi3_parser/nodes/oauth_flows.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#oauthFlowsObject
     class OauthFlows
       include Node::Object
 
+      # @return [OauthFlow, nil]
       def implicit
         node_data["implicit"]
       end
 
+      # @return [OauthFlow, nil]
       def password
         node_data["password"]
       end
 
+      # @return [OauthFlow, nil]
       def client_credentials
         node_data["clientCredentials"]
       end
 
+      # @return [OauthFlow, nil]
       def authorization_code
         node_data["authorizationCode"]
       end

data/lib/openapi3_parser/nodes/openapi.rb

@@ -5,37 +5,48 @@ require "openapi3_parser/nodes/components"
 
 module Openapi3Parser
   module Nodes
+    # OpenAPI Root Object
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#oasObject
     class Openapi
       include Node::Object
 
+      # @return [String]
       def openapi
         node_data["openapi"]
       end
 
+      # @return [Info]
       def info
         node_data["info"]
       end
 
+      # @return [Nodes::Array] A collection of {Server}[./Server.html] objects
       def servers
         node_data["servers"]
       end
 
+      # @return [Paths]
       def paths
         node_data["paths"]
       end
 
+      # @return [Components]
       def components
         node_data["components"]
       end
 
+      # @return [Nodes::Array] a collection of
+      #         {SecurityRequirement}[./SecurityRequirement.html] objects
       def security
         node_data["security"]
       end
 
+      # @return [Nodes::Array] A collection of {Tag}[./Tag.html] objects
       def tags
         node_data["tags"]
       end
 
+      # @return [ExternalDocumentation]
       def external_docs
         node_data["externalDocs"]
       end

data/lib/openapi3_parser/nodes/operation.rb

@@ -4,53 +4,69 @@ require "openapi3_parser/node/object"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject
     class Operation
       include Node::Object
 
+      # @return [Nodes::Array] a collection of String objects
       def tags
         node_data["tags"]
       end
 
+      # @return [String, nil]
       def summary
         node_data["summary"]
       end
 
+      # @return [String, nil]
       def description
         node_data["description"]
       end
 
+      # @return [ExternalDocumentation, nil]
       def external_docs
         node_data["externalDocs"]
       end
 
+      # @return [String, nil]
       def operation_id
         node_data["operationId"]
       end
 
+      # @return [Nodes::Array] a collection of {Parameter}[./Parameter.html]
+      #         objects
       def parameters
         node_data["parameters"]
       end
 
+      # @return [RequestBody, nil]
       def request_body
         node_data["requestBody"]
       end
 
+      # @return [Responses]
       def responses
         node_data["responses"]
       end
 
+      # @return [Map] a collection of String: {Callback}[./Callback.html]
+      #         objects
       def callbacks
         node_data["callbacks"]
       end
 
+      # @return [Boolean]
       def deprecated?
         node_data["deprecated"]
       end
 
+      # @return [Nodes::Array] a collection of
+      #         {SecurityRequirement}[./SecurityRequirement.html] objects
       def security
         node_data["security"]
       end
 
+      # @return [Nodes::Array] a collection of {Server}[./Server.html] objects
       def servers
         node_data["servers"]
       end

data/lib/openapi3_parser/nodes/parameter.rb

@@ -5,14 +5,17 @@ require "openapi3_parser/nodes/parameter/parameter_like"
 
 module Openapi3Parser
   module Nodes
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject
     class Parameter
       include Node::Object
       include ParameterLike
 
+      # @return [String]
       def name
         node_data["name"]
       end
 
+      # @return [String]
       def in
         node_data["in"]
       end

data/lib/openapi3_parser/nodes/parameter/parameter_like.rb

@@ -3,47 +3,61 @@
 module Openapi3Parser
   module Nodes
     class Parameter
+      # This contains methods that are shared between nodes that act like a
+      # Parameter, at the time of writing this was {Header}[../Header.html]
+      # and {Parameter}[../Paramater.html]
       module ParameterLike
+        # @return [String]
         def description
           node_data["description"]
         end
 
+        # @return [Boolean]
         def required?
           node_data["required"]
         end
 
+        # @return [Boolean]
         def deprecated?
           node_data["deprecated"]
         end
 
+        # @return [Boolean]
         def allow_empty_value?
           node_data["allowEmptyValue"]
         end
 
+        # @return [String, nil]
         def style
           node_data["style"]
         end
 
+        # @return [Boolean]
         def explode?
           node_data["explode"]
         end
 
+        # @return [Boolean]
         def allow_reserved?
           node_data["allowReserved"]
         end
 
+        # @return [Schema, nil]
         def schema
           node_data["schema"]
         end
 
+        # @return [Any]
         def example
           node_data["example"]
         end
 
+        # @return [Map] a map of String: {Example}[../Example.html] objects
         def examples
           node_data["examples"]
         end
 
+        # @return [Map] a map of String: {MediaType}[../MediaType.html] objects
         def content
           node_data["content"]
         end