lib/voog_api/api/articles.rb in voog_api-0.0.10 vs lib/voog_api/api/articles.rb in voog_api-0.0.11

@@ -1,75 +1,105 @@
 module Voog
   class API
+
+    # Voog Articles API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/articles
     module Articles
 
       # List articles
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#get_articles
       def articles(params = {})
         paginate 'articles', {query: params}
       end
 
       # Get a single article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#get_article
       def article(id, params = {})
         get "articles/#{id}", {query: params}
       end
 
-      # Create a article
+      # Create an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#create_article
       def create_article(data)
         post 'articles', data
       end
 
-      # Update a article
+      # Update an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#update_article
       def update_article(id, data)
         put "articles/#{id}", data
       end
 
-      # Patch a article
+      # Patch an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#patch_article
       def patch_article(id, data)
         patch "articles/#{id}", data
       end
 
-      # Delete a article
+      # Delete an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#remove_article
       def delete_article(id)
         delete "articles/#{id}"
       end
 
       # Update/create a key in article data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#update_article_data_field
       def update_article_data(article_id, id, data)
         put "articles/#{article_id}/data/#{id}", {value: data}
       end
 
       # Delete a key from article data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#delete_article_custom_field
       def delete_article_data(article_id, id)
         delete "articles/#{article_id}/data/#{id}"
       end
 
       # Article contents
 
       # List contents for article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_contents
       def article_contents(id, params = {})
         contents(Voog::API::Contents::ParentKind::Article, id, params)
       end
 
       # Get a single content for article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_content
       def article_content(article_id, id, params = {})
         content(Voog::API::Contents::ParentKind::Article, article_id, id, params)
       end
 
-      # Create a article content for article
+      # Create an article content for article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#create_content
       def create_article_content(article_id, data)
         create_content(Voog::API::Contents::ParentKind::Article, article_id, data)
       end
 
       # Delete a content from article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#delete_content
       def delete_article_content(article_id, id)
         delete_content(Voog::API::Contents::ParentKind::Article, article_id, id)
       end
 
       # Reorder/move article content inside/between content areas and parent objects
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#relocate_content
       def move_article_content(article_id, id, params = {})
         move_content(Voog::API::Contents::ParentKind::Article, article_id, id, params)
       end
     end
   end