lib/conjur/has_id.rb in conjur-api-4.14.0 vs lib/conjur/has_id.rb in conjur-api-4.15.0

@@ -17,14 +17,26 @@
 # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Conjur
+
+  # Included in classes for assets that derive their id from their urls.
   module HasId
+    # @api private
+    # This method is provided to support basic JSON serialization for all objects with `id`s.
+    #
+    # @param [Hash] options provided for backwards compatibility, do not use.
+    # @return [Hash] the JSON hash.
     def to_json(options = {})
       { id: id }
     end
-  
+
+
+    # Get this assets id.  This is the *unqualified* Conjur id for the asset,
+    # and is derived from the asset's url.
+    #
+    # @return [String] the asset's id
     def id
       URI.unescape self.url.split('/')[-1]
     end    
   end
 end
\ No newline at end of file