refactor: remove unused. add some javadocs

Author: BFergerson

codegen/src/main/resources/META-INF/vertx/json-mappers.properties

@@ -2,7 +2,5 @@ java.time.Instant.serializer=spp.protocol.marshall.ProtocolMarshaller#serializeI
 java.time.Instant.deserializer=spp.protocol.marshall.ProtocolMarshaller#deserializeInstant
 spp.protocol.instrument.LiveInstrument.serializer=spp.protocol.marshall.ProtocolMarshaller#serializeLiveInstrument
 spp.protocol.instrument.LiveInstrument.deserializer=spp.protocol.marshall.ProtocolMarshaller#deserializeLiveInstrument
-spp.protocol.platform.auth.ClientAccess.serializer=spp.protocol.marshall.ProtocolMarshaller#serializeClientAccess
-spp.protocol.platform.auth.ClientAccess.deserializer=spp.protocol.marshall.ProtocolMarshaller#deserializeClientAccess
 spp.protocol.platform.auth.RolePermission.serializer=spp.protocol.marshall.ProtocolMarshaller#serializeRolePermission
 spp.protocol.platform.auth.RolePermission.deserializer=spp.protocol.marshall.ProtocolMarshaller#deserializeRolePermission

src/main/kotlin/spp/protocol/SourceServices.kt

@@ -17,7 +17,7 @@
 package spp.protocol
 
 /**
- * todo: description.
+ * Back-end services available to developers.
  *
  * @since 0.2.1
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/artifact/LocalArtifact.kt

@@ -27,9 +27,7 @@ import java.util.function.Predicate
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)
  */
 @DataObject
-data class MetricType(
-    val metricId: String,
-) {
+data class MetricType(val metricId: String) {
 
     companion object {
         val Endpoint_CPM = MetricType("endpoint_cpm")

src/main/kotlin/spp/protocol/artifact/QueryTimeFrame.kt

@@ -17,9 +17,10 @@
 package spp.protocol.instrument.throttle
 
 import io.vertx.core.json.JsonObject
+import spp.protocol.instrument.LiveInstrument
 
 /**
- * todo: description.
+ * Used to throttle the frequency of [LiveInstrument] executions inside a live probe.
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/artifact/log/LogCountSummary.kt

@@ -17,7 +17,7 @@
 package spp.protocol.instrument.throttle
 
 /**
- * todo: description.
+ * Represents a time step for throttling.
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/artifact/metrics/MetricType.kt

@@ -20,7 +20,7 @@ import io.vertx.codegen.annotations.DataObject
 import io.vertx.core.json.JsonObject
 
 /**
- * todo: description.
+ * Holds the serialized state of a variable encountered in a live probe.
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/instrument/DurationStep.kt

@@ -17,7 +17,7 @@
 package spp.protocol.instrument.variable
 
 /**
- * todo: description.
+ * Represents the scope of a variable encountered in a live probe.
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/instrument/throttle/HitThrottle.kt

@@ -23,7 +23,6 @@ import io.vertx.core.json.Json
 import io.vertx.core.json.JsonObject
 import io.vertx.core.json.jackson.DatabindCodec
 import spp.protocol.instrument.*
-import spp.protocol.platform.auth.ClientAccess
 import spp.protocol.platform.auth.RolePermission
 import java.time.Instant
 
@@ -75,19 +74,6 @@ object ProtocolMarshaller {
         }
     }
 
-    @JvmStatic
-    fun serializeClientAccess(value: ClientAccess): JsonObject {
-        return JsonObject(Json.encode(value))
-    }
-
-    @JvmStatic
-    fun deserializeClientAccess(value: JsonObject): ClientAccess {
-        return ClientAccess(
-            value.getString("id"),
-            value.getString("secret")
-        )
-    }
-
     @JvmStatic
     fun serializeRolePermission(value: RolePermission): String {
         return value.name

src/main/kotlin/spp/protocol/instrument/throttle/InstrumentThrottle.kt

@@ -23,7 +23,7 @@ import spp.protocol.artifact.ArtifactQualifiedName
 import spp.protocol.instrument.LiveSourceLocation
 
 /**
- * todo: description.
+ * A back-end subscription to events/metrics for a given set of entities.
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/instrument/throttle/ThrottleStep.kt

@@ -20,7 +20,7 @@ import io.vertx.codegen.annotations.DataObject
 import io.vertx.core.json.JsonObject
 
 /**
- * todo: description.
+ * Additional configuration for a [LiveView].
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)

src/main/kotlin/spp/protocol/instrument/variable/LiveVariable.kt

@@ -21,7 +21,7 @@ import io.vertx.core.json.JsonObject
 import spp.protocol.artifact.ArtifactQualifiedName
 
 /**
- * todo: description.
+ * An event that occurred in a [LiveView].
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)