Added a little documentation and cleaned up

Author: rimi-itk

README.md

@@ -11,7 +11,7 @@ Edit settings on `/admin/os2forms_sync/settings`.
 
 ## API
 
-JSON:API
+See [API](docs/API.md) for details on the API.
 
 ## Usage
 
@@ -21,9 +21,7 @@ settings » OS2Forms » OS2Forms sync
 All published webforms are listed on `/admin/os2forms/sync/webform` (API data on
 `/os2forms/sync/jsonapi/webform`).
 
-Webforms available for import are listed on `/os2forms/sync/jsonapi/webform/available`.
-
-Imported webforms are listed on `/os2forms/sync/jsonapi/webform/imported`.
+Webforms available for import are listed on `/admin/os2forms/sync/webform`.
 
 ## Drush commands
 

docs/API.md

@@ -0,0 +1,5 @@
+# OS2Forms sync – API
+
+Webforms are published via a simple [JSON:API](https://jsonapi.org/) API.
+
+[Example webforms](webforms.json).

docs/webforms.json

@@ -0,0 +1,65 @@
+{
+  "data": [
+    {
+      "id": "simpel_formular",
+      "type": "webform",
+      "attributes": {
+        "title": "Simpel formular",
+        "description": "Simpel formular der demonstrerer deling af formularer på tværs af OS2Forms-installationer.",
+        "category": "Test",
+        "elements": {
+          "name": {
+            "#type": "textfield",
+            "#title": "Name",
+            "#required": true
+          },
+          "birthday": {
+            "#type": "datelist",
+            "#title": "Birthday",
+            "#date_part_order": [
+              "year",
+              "month",
+              "day"
+            ],
+            "#required": true
+          },
+          "number": {
+            "#type": "number",
+            "#title": "Number",
+            "#min": 1,
+            "#max": 87
+          },
+          "er_du_tilfreds_": {
+            "#type": "checkbox",
+            "#title": "Er du tilfreds?"
+          }
+        }
+      },
+      "links": {
+        "self": "https://…/os2forms/sync/jsonapi/webform/simpel_formular"
+      }
+    },
+    {
+      "id": "example_form",
+      "type": "webform",
+      "attributes": {
+        "title": "Example form",
+        "description": "Example form.",
+        "category": "Example",
+        "elements": {
+          "name": {
+            "#type": "textfield",
+            "#title": "Name",
+            "#required": true
+          }
+        }
+      },
+      "links": {
+        "self": "https://…/os2forms/sync/jsonapi/webform/example_form"
+      }
+    }
+  ],
+  "links": {
+    "self": "https://…/os2forms/sync/jsonapi/webform"
+  }
+}

src/Helper/JsonAPISerializer.php

@@ -78,7 +78,6 @@ public function serializeWebform(WebformInterface $webform, $inline = FALSE): ar
       $webform->toArray(),
       static function ($key) {
         return in_array($key, [
-          'uuid',
           'title',
           'description',
           'category',

src/Helper/WebformHelper.php

@@ -106,9 +106,8 @@ public function webformThirdPartySettingsFormAlter(array &$form, FormStateInterf
       '#type' => 'checkbox',
       '#title' => $this->t('Publish'),
       '#default_value' => (bool) ($defaultValues['publish'] ?? FALSE),
-      '#description' => $this->t('If checked this form will be listed on <a href=":url_index">:url_index</a> and details made available on <a href=":url_show">:url_show</a>', [
-        ':url_index' => Url::fromRoute('os2forms_sync.jsonapi.webform.index')->toString(),
-        ':url_show' => Url::fromRoute('os2forms_sync.jsonapi.webform.show', ['webform' => $webform->id()])->toString(),
+      '#description' => $this->t('If checked this form will be listed on <a href=":url_index">:url_index</a>. Share this url with others that may import all public webforms on this site.', [
+        ':url_index' => Url::fromRoute('os2forms_sync.jsonapi.webform.index')->setAbsolute()->toString(),
       ]),
     ];