arangodb-driver 3.10.4 → 3.10.4.1

data/lib/arango/requests/administration/get_log_level.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/log/level
       class GetLogLevel < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/get_mode.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/server/mode
       class GetMode < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/get_task.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_api/tasks/{id}
       class GetTask < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/list_tasks.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_api/tasks/
       class ListTasks < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/log.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/log
       class Log < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/metrics.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/metrics
       class Metrics < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/reload_routing.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/routing/reload
       class ReloadRouting < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/administration/role.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/server/role
       class Role < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/server_id.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/server/id
       class ServerId < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/set_log_level.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: PUT /_admin/log/level
       class SetLogLevel < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/administration/set_mode.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: PUT /_admin/server/mode
       class SetMode < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/administration/statistics.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/statistics
       class Statistics < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/statistics_description.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/statistics-description
       class StatisticsDescription < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/status.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/status
       class Status < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/target_version.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/database/target-version
       class TargetVersion < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/time.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/time
       class Time < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/administration/version.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Administration Requests
     module Administration
+      # API: GET /_admin/version
       class Version < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/analyzer/create.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Analyzer Requests
     module Analyzer
+      # API: POST /_api/analyzer
       class Create < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/analyzer/delete.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Analyzer Requests
     module Analyzer
+      # API: DELETE /_api/analyzer/{name}
       class Delete < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/analyzer/get.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Analyzer Requests
     module Analyzer
+      # API: GET /_api/analyzer/{name}
       class List < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/analyzer/list.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Analyzer Requests
     module Analyzer
+      # API: /_api/analyzer
       class List < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/clear_query_result_cache.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: DELETE /_api/query-cache
       class ClearQueryResultCache < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/aql/create_function.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: POST /_api/aqlfunction
       class CreateFunction < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/aql/current_queries.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: GET /_api/query/current
       class CurrentQueries < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/delete_function.rb

@@ -1,6 +1,10 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: DELETE /_api/aqlfunction/{name}
+      # @param name [String]
       class DeleteFunction < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/aql/delete_slow_query_list.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: DELETE /_api/query/slow
       class DeleteSlowQueryList < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/aql/explain.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: POST /_api/explain
       class Explain < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/aql/get_query_result_cache_properties.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: GET /_api/query-cache/properties
       class GetQueryResultCacheProperties < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/get_query_tracking_properties.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: GET /_api/query/properties
       class GetQueryTrackingProperties < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/get_slow_query_list.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: GET /_api/query/slow
       class GetSlowQueryList < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/kill_query.rb

@@ -1,6 +1,10 @@
 module Arango
+  # Arango Requests
   module Requests
+    # AQL Requests
     module AQL
+      # API: DELETE /_api/query/{id}
+      # @param id [Integer]
       class KillQuery < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/aql/list_functions.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # AQL Requests
     module AQL
+      # API: GET /_api/aqlfunction
       class ListFunctions < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/parse.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # AQL Requests
     module AQL
+      # API: POST /_api/query
       class Parse < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/aql/query_result_cache_entries.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # AQL Requests
     module AQL
+      # API: GET /_api/query-cache/entries
       class QueryResultCacheEntries < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/aql/set_query_result_cache_properties.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # AQL Requests
     module AQL
+      # API: PUT /_api/query-cache/properties
       class SetQueryResultCacheProperties < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/aql/set_query_tracking_properties.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # AQL Requests
     module AQL
+      # API: PUT /_api/query/properties
       class SetQueryTrackingProperties < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/backup/create.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Backup Requests
     module Backup
+      # API: POST /_admin/backup/create
       class Create < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/backup/delete.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Backup Requests
     module Backup
+      # API: POST /_admin/backup/delete
       class Delete < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/backup/download.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Backup Requests
     module Backup
+      # API: POST /_admin/backup/download
       class Download < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/backup/list.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Backup Requests
     module Backup
+      # API: POST /_admin/backup/list
       class List < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/backup/restore.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Backup Requests
     module Backup
+      # API: POST /_admin/backup/restore
       class Restore < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/backup/upload.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Backup Requests
     module Backup
+      # API: POST /_admin/backup/upload
       class Upload < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/bulk/execute.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Bulk Requests
     module Bulk
+      # API: POST /_api/batch
       class Execute < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/bulk/export.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Bulk Requests
     module Bulk
+      # API: POST /_api/export
       class Export < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/bulk/import_document.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Bulk Requests
     module Bulk
+      # API: POST /_api/import#document
       class ImportDocument < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/bulk/import_json.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Bulk Requests
     module Bulk
+      # API: POST /_api/import#json
       class ImportJson < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/cluster/health.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Cluster Requests
     module Cluster
+      # API: GET /_admin/cluster/health
       class Health < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/cluster/maintenance.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Cluster Requests
     module Cluster
+      # API: PUT /_admin/cluster/maintenance
       class Maintenance < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/cluster/statistics.rb

@@ -1,10 +1,12 @@
 module Arango
   module Requests
+    # Cluster Requests
     module Cluster
+      # API: GET /_admin/backup/statistics
       class Statistics < Arango::Request
         self.request_method = :get
 
-        self.uri_template = "/_admin/backup/create"
+        self.uri_template = "/_admin/backup/statistics"
 
         # TODO db_server -> DBserver
         param :db_server

data/lib/arango/requests/collection/checksum.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: GET /_api/collection/{name}/checksum
       class Checksum < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/collection/count.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: GET /_api/collection/{name}/count
       class Count < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/collection/create.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: POST /_api/collection
       class Create < Arango::Request
         self.request_method = :post
 

data/lib/arango/requests/collection/delete.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: DELETE /_api/collection/{name}
       class Delete < Arango::Request
         self.request_method = :delete
 

data/lib/arango/requests/collection/get.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: GET /_api/collection/{name}
       class Get < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/collection/get_properties.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: GET /_api/collection/{name}/properties
       class GetProperties < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/collection/list_all.rb

@@ -1,6 +1,9 @@
 module Arango
+  # Arango Requests
   module Requests
+    # Collection Requests
     module Collection
+      # API: GET /_api/collection
       class ListAll < Arango::Request
         self.request_method = :get
 

data/lib/arango/requests/collection/load.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Collection Requests
     module Collection
+      # API: PUT /_api/collection/{name}/load
       class Load < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/collection/load_indexes_into_memory.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Collection Requests
     module Collection
+      # API: PUT /_api/collection/{name}/loadIndexesIntoMemory
       class LoadIndexesIntoMemory < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/collection/recalculate_count.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Collection Requests
     module Collection
+      # API: PUT /_api/collection/{name}/recalculateCount
       class RecalculateCount < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/collection/rename.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Collection Requests
     module Collection
+      # API: PUT /_api/collection/{name}/rename
       class Rename < Arango::Request
         self.request_method = :put
 

data/lib/arango/requests/collection/responsible_shard.rb

@@ -1,6 +1,8 @@
 module Arango
   module Requests
+    # Collection Requests
     module Collection
+      # API: PUT /_api/collection/{name}/responsibleShard
       class ResponsibleShard < Arango::Request
         self.request_method = :put