fix: add comments to form router. Update README to reflect pagination response

Author: jwilkinson87

README.md

@@ -94,6 +94,6 @@ runBlocking {
 
     api.applySessionToken(response.sessionToken)
     val vehicles = api.vehicles.all("org-123")
-    println(vehicles.size)
+    println(vehicles.data.size)
 }
 ```

src/main/kotlin/com/ctrlhub/core/datacapture/FormsRouter.kt

@@ -7,7 +7,18 @@ import com.ctrlhub.core.router.Router
 import com.ctrlhub.core.router.request.RequestParameters
 import io.ktor.client.HttpClient
 
+/**
+ * A router that interacts with the forms realm of the Ctrl Hub API
+ */
 class FormsRouter(httpClient: HttpClient) : Router(httpClient) {
+
+    /**
+     * Retrieve a list of all forms
+     *
+     * @param organisationId String The organisation ID to retrieve all forms for
+     *
+     * @return A list of all forms
+     */
     suspend fun all(
         organisationId: String,
         requestParameters: RequestParameters = RequestParameters()
@@ -19,6 +30,13 @@ class FormsRouter(httpClient: HttpClient) : Router(httpClient) {
         )
     }
 
+    /**
+     * Fetch a single form by ID
+     *
+     * @param organisationId String The organisation ID to retrieve a single form for
+     *
+     * @return FOrm
+     */
     suspend fun one(organisationId: String, formId: String): Form {
         return fetchJsonApiResource("/v3/orgs/${organisationId}/data-capture-forms/${formId}")
     }