fix: update description

Signed-off-by: DorraJaouad <[email protected]>
nextcloud · Nov 28, 2024 · c4b30d7 · c4b30d7
1 parent cc33203
commit c4b30d7
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/lib/Controller/RoomController.php b/lib/Controller/RoomController.php
@@ -2456,7 +2456,7 @@ public function setMessageExpiration(int $seconds): DataResponse {
 	 *
 	 * Content format is comma separated values:
 	 * - Header line is required and must match `"email","name"` or `"email"`
-	 * - one entry per line
+	 * - One entry per line (e.g. `"John Doe","[email protected]"`)
 	 *
 	 * Required capability: `email-csv-import`
 	 *

diff --git a/openapi-full.json b/openapi-full.json
@@ -16590,7 +16590,7 @@
             "post": {
                 "operationId": "room-import-emails-as-participants",
                 "summary": "Import a list of email attendees",
-                "description": "Content format is comma separated values: - Header line is required and must match `\"email\",\"name\"` or `\"email\"` - one entry per line\nRequired capability: `email-csv-import`",
+                "description": "Content format is comma separated values: - Header line is required and must match `\"email\",\"name\"` or `\"email\"` - One entry per line (e.g. `\"John Doe\",\"[email protected]\"`)\nRequired capability: `email-csv-import`",
                 "tags": [
                     "room"
                 ],

diff --git a/openapi.json b/openapi.json
@@ -16724,7 +16724,7 @@
             "post": {
                 "operationId": "room-import-emails-as-participants",
                 "summary": "Import a list of email attendees",
-                "description": "Content format is comma separated values: - Header line is required and must match `\"email\",\"name\"` or `\"email\"` - one entry per line\nRequired capability: `email-csv-import`",
+                "description": "Content format is comma separated values: - Header line is required and must match `\"email\",\"name\"` or `\"email\"` - One entry per line (e.g. `\"John Doe\",\"[email protected]\"`)\nRequired capability: `email-csv-import`",
                 "tags": [
                     "room"
                 ],

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -1320,7 +1320,7 @@ export type paths = {
         put?: never;
         /**
          * Import a list of email attendees
-         * @description Content format is comma separated values: - Header line is required and must match `"email","name"` or `"email"` - one entry per line
+         * @description Content format is comma separated values: - Header line is required and must match `"email","name"` or `"email"` - One entry per line (e.g. `"John Doe","[email protected]"`)
          *     Required capability: `email-csv-import`
          */
         post: operations["room-import-emails-as-participants"];

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -1322,7 +1322,7 @@ export type paths = {
         put?: never;
         /**
          * Import a list of email attendees
-         * @description Content format is comma separated values: - Header line is required and must match `"email","name"` or `"email"` - one entry per line
+         * @description Content format is comma separated values: - Header line is required and must match `"email","name"` or `"email"` - One entry per line (e.g. `"John Doe","[email protected]"`)
          *     Required capability: `email-csv-import`
          */
         post: operations["room-import-emails-as-participants"];