options_api_spec.rb in snaptrade-2.0.21

- old
+ new

@@ -26,11 +26,12 @@
       expect(@api_instance).to be_instance_of(SnapTrade::OptionsApi)
     end
   end
 
   # unit tests for get_option_strategy
-  # Creates an option strategy object that will be used to place an option strategy order
+  # Create options strategy
+  # Creates an option strategy object that will be used to place an option strategy order. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to create the option strategy object in.
   # @param options_get_option_strategy_request 
   # @param [Hash] opts the optional parameters
@@ -40,11 +41,12 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_options_chain
-  # Get the options chain
+  # Get the options chain for a symbol
+  # Returns the option chain for the specified symbol in the specified account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get the options chain from.
   # @param symbol Universal symbol ID if symbol
   # @param [Hash] opts the optional parameters
@@ -54,11 +56,12 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_options_strategy_quote
-  # Get latest market data of option strategy
+  # Get options strategy quotes
+  # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account the strategy will be placed in.
   # @param option_strategy_id Option strategy id obtained from response when creating option strategy object
   # @param [Hash] opts the optional parameters
@@ -68,11 +71,12 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for list_option_holdings
-  # Get the options holdings in the account
+  # Get account option holdings
+  # Returns a list of Options Positions. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to fetch options holdings for.
   # @param [Hash] opts the optional parameters
   # @return [Array<OptionsPosition>]
@@ -81,10 +85,11 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for place_option_strategy
-  # Place an option strategy order on the brokerage
+  # Place an option strategy order
+  # Places the option strategy order and returns the order record received from the brokerage.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to execute the strategy in.
   # @param option_strategy_id Option strategy id obtained from response when creating option strategy object
   # @param options_place_option_strategy_request 