docs

Author: Foxcapades

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/common.kt

@@ -2,6 +2,34 @@ package org.veupathdb.vdi.lib.common.intra
 
 import com.fasterxml.jackson.annotation.JsonProperty
 
+/**
+ * Defines a common response body consisting of a JSON object containing a
+ * single key "message" mapped to a string value containing an error message.
+ *
+ * ```json
+ * {
+ *   "message": "some error message"
+ * }
+ * ```
+ *
+ * @since 10.1.0
+ */
 data class SimpleErrorResponse(@JsonProperty(JSONKeys.Message) val message: String)
 
+/**
+ * Defines a common response body consisting of a JSON object containing a
+ * single key "warnings" mapped to an array of strings representing warnings
+ * generated during the triggering request.
+ *
+ * ```json
+ * {
+ *   "warnings": [
+ *     "some warning 1",
+ *     "some warning 2"
+ *   ]
+ * }
+ * ```
+ *
+ * @since 10.1.0
+ */
 data class WarningResponse(@JsonProperty(JSONKeys.Warnings) val warnings: Collection<String>)

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/import.kt

@@ -4,6 +4,22 @@ import com.fasterxml.jackson.annotation.JsonProperty
 import org.veupathdb.vdi.lib.common.field.DatasetID
 import org.veupathdb.vdi.lib.common.model.VDIDatasetMeta
 
+/**
+ * Represents the JSON body of a dataset import request made by the core VDI
+ * service to a plugin server.
+ *
+ * ```json
+ * {
+ *   "vdiID": "W7GY9DuVdxv",
+ *   "jobID": 22305,
+ *   "meta": {
+ *     ... see VDIDatasetMeta ...
+ *   }
+ * }
+ * ```
+ *
+ * @since v10.1.0
+ */
 data class ImportRequest(
   @JsonProperty(JSONKeys.VDIID) val vdiID: DatasetID,
   @JsonProperty(JSONKeys.JobID) val jobID: ULong,

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/install.kt

@@ -5,12 +5,43 @@ import org.veupathdb.vdi.lib.common.field.DatasetID
 import org.veupathdb.vdi.lib.common.field.ProjectID
 import org.veupathdb.vdi.lib.common.model.VDIDatasetMeta
 
+/**
+ * Represents the JSON body of a dataset data install request made by the core
+ * VDI service to a plugin server.
+ *
+ * ```json
+ * {
+ *   "vdiID": "W7GY9DuVdxv",
+ *   "jobID": 22305,
+ *   "projectID": "PlasmoDB"
+ * }
+ * ```
+ *
+ * @since v10.1.0
+ */
 data class InstallDataRequest(
   @JsonProperty(JSONKeys.VDIID)     val vdiID: DatasetID,
   @JsonProperty(JSONKeys.JobID)     val jobID: ULong,
   @JsonProperty(JSONKeys.ProjectID) val projectID: ProjectID,
 )
 
+/**
+ * Represents the JSON body of a dataset meta install request made by the core
+ * VDI service to a plugin server.
+ *
+ * ```json
+ * {
+ *   "vdiID": "W7GY9DuVdxv",
+ *   "jobID": 22305,
+ *   "projectID": "PlasmoDB",
+ *   "meta": {
+ *     ... see VDIDatasetMeta ...
+ *   }
+ * }
+ * ```
+ *
+ * @since v10.1.0
+ */
 data class InstallMetaRequest(
   @JsonProperty(JSONKeys.VDIID)     val vdiID: DatasetID,
   @JsonProperty(JSONKeys.JobID)     val jobID: ULong,

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/json.kt

@@ -1,5 +1,8 @@
 package org.veupathdb.vdi.lib.common.intra
 
+/**
+ * Internal registry of JSON object keys used in this package.
+ */
 internal object JSONKeys {
   const val JobID = "jobID"
   const val Message = "message"

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/uninstall.kt

@@ -4,6 +4,20 @@ import com.fasterxml.jackson.annotation.JsonProperty
 import org.veupathdb.vdi.lib.common.field.DatasetID
 import org.veupathdb.vdi.lib.common.field.ProjectID
 
+/**
+ * Represents the JSON body of a dataset uninstall request made by the core VDI
+ * service to a plugin server.
+ *
+ * ```json
+ * {
+ *   "vdiID": "W7GY9DuVdxv",
+ *   "jobID": 22305,
+ *   "projectID": "PlasmoDB"
+ * }
+ * ```
+ *
+ * @since v10.1.0
+ */
 data class UninstallRequest(
   @JsonProperty(JSONKeys.VDIID)     val vdiID: DatasetID,
   @JsonProperty(JSONKeys.JobID)     val jobID: ULong,