comments

Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>

Author: laurent-martin

lib/aspera/api/alee.rb

@@ -3,6 +3,7 @@
 require 'aspera/api/aoc.rb'
 module Aspera
   module Api
+    # Aspera License Entitlement Engine API client
     class Alee < Aspera::Rest
       def initialize(entitlement_id, customer_id, api_domain: AoC::SAAS_DOMAIN_PROD, version: 'v1')
         super(

lib/aspera/api/aoc.rb

@@ -12,6 +12,7 @@
 
 module Aspera
   module Api
+    # Aspera on Cloud API client
     class AoC < Rest
       include RestList
 

lib/aspera/api/ats.rb

@@ -5,7 +5,7 @@
 
 module Aspera
   module Api
-    # ATS API without authentication
+    # Aspera Transfer Service API client without authentication
     class Ats < Aspera::Rest
       SERVICE_BASE_URL = 'https://ats.aspera.io'
       # currently supported clouds

lib/aspera/api/cos_node.rb

@@ -7,6 +7,7 @@
 
 module Aspera
   module Api
+    # Cloud Object Storage Node API Client
     class CosNode < Node
       IBM_CLOUD_TOKEN_URL = 'https://iam.cloud.ibm.com/identity'
       TOKEN_FIELD = 'delegated_refresh_token'

lib/aspera/api/faspex.rb

@@ -6,7 +6,7 @@
 require 'digest'
 
 module Aspera
-  # Implement OAuth for Faspex public link
+  # OAuth for Faspex public link
   class FaspexPubLink < OAuth::Base
     class << self
       attr_accessor :additional_info
@@ -56,6 +56,7 @@ def create_token
   end
   OAuth::Factory.instance.register_token_creator(FaspexPubLink)
   module Api
+    # Aspera Faspex 5 API Client
     class Faspex < Aspera::Rest
       include RestList
 

lib/aspera/api/httpgw.rb

@@ -11,6 +11,7 @@
 
 module Aspera
   module Api
+    # Aspera HTTP Gateway API client
     # Start a transfer using Aspera HTTP Gateway, using web socket secure for uploads
     # ref: https://api.ibm.com/explorer/catalog/aspera/product/ibm-aspera/api/http-gateway-api/doc/guides-toc
     # https://developer.ibm.com/apis/catalog?search=%22aspera%20http%22

lib/aspera/api/node.rb

@@ -14,7 +14,8 @@
 
 module Aspera
   module Api
-    # Provides additional functions using node API with gen4 extensions (access keys)
+    # Aspera Node API client
+    # with gen4 extensions (access keys)
     class Node < Rest
       # Format of node scope : node.<access key>:<scope>
       module Scope