additional documentation for mosquito::api classes and methods

src/mosquito/api/executor.cr

@@ -1,5 +1,8 @@
 module Mosquito
   module Api
+    # An interface for an executor.
+    #
+    # This is used to inspect the state of an executor. For more information about executors, see `Mosquito::Runners::Executor`.
     class Executor
       getter :instance_id
       private getter :metadata

src/mosquito/api/job_run.cr

@@ -1,14 +1,22 @@
 module Mosquito::Api
+  # Represents a job run in Mosquito.
+  #
+  # This class is used to inspect a job run stored in the backend.
+  #
+  # For more information about a JobRun, see `Mosquito::JobRun`.
   class JobRun
+    # The id of the job run.
     getter id : String
 
     def initialize(@id : String)
     end
 
+    # Does a JobRun with this ID exist in the backend?
     def found? : Bool
       config.has_key? "type"
     end
 
+    # Get the parameters the job was enqueued with.
     def runtime_parameters : Hash(String, String)
       config.reject do |key, _|
         ["id", "type", "enqueue_time", "retry_count", "started_at", "finished_at"].includes? key
@@ -28,17 +36,19 @@ module Mosquito::Api
       config["type"]
     end
 
-    # A Time object representing the moment this job was enqueued.
+    # The moment this job was enqueued.
     def enqueue_time : Time
       Time.unix_ms config["enqueue_time"].to_i64
     end
 
+    # The moment this job was started.
     def started_at : Time?
       if time = config["started_at"]
         Time.unix_ms time.to_i64
       end
     end
 
+    # The moment this job was finished.
     def finished_at : Time?
       if time = config["finished_at"]
         Time.unix_ms time.to_i64

src/mosquito/api/overseer.cr

@@ -1,5 +1,7 @@
 module Mosquito
-  # A utility for inspecting the state of Mosquito Overseers.
+  # An interface for inspecting the state of Mosquito Overseers.
+  #
+  # For more information about overseers, see `Mosquito::Runners::Overseer`.
   class Api::Overseer
     # The instance ID of the overseer being inspected.
     getter :instance_id