Merge pull request #7 from RocketChat/dev

update descriptions

Author: rachana-visavadiya

marketplace-apps.yaml

@@ -1,12 +1,11 @@
 openapi: 3.0.0
 info:
-  version: ''
+  version: 1.0.0
   title: Marketplace Apps
-  contact:
-    name: Rocket.Chat
-    url: 'https://rocket.chat/'
-    email: [email protected]
-  description: ''
+  description: |- 
+    The following marketplace apps endpoints are available:
+    * **WhatsApp**: Send a template [WhatsApp](https://docs.rocket.chat/extend-rocket.chat-capabilities/rocket.chat-marketplace/rocket.chat-public-apps-guides/omnichannel-apps/whatsapp) message.
+    * **Rasa**: Close a [Rasa](https://docs.rocket.chat/extend-rocket.chat-capabilities/rocket.chat-marketplace/rocket.chat-public-apps-guides/omnichannel-apps/rasa-app) app chat or perform handover.
 servers:
   - url: 'http://localhost:3000'
 paths:
@@ -286,4 +285,4 @@ components:
                 message: You must be logged in to do this.
 tags:
   - name: Rasa App
-  - name: WhatsApp
+  - name: WhatsApp

notifications.yml

@@ -1,16 +1,11 @@
 openapi: 3.0.0
 info:
-  version: ''
+  version: 1.0.0
   title: Notifications
-  description: ''
-  termsOfService: 'https://rocket.chat/'
-  contact:
-    name: Rocket.Chat
-    url: 'https://rocket.chat/'
-    email: [email protected]
-  license:
-    url: 'https://rocket.chat/'
-    name: Apache2.0
+  description: |- 
+    The Rocket.Chat notifications endpoints are as follows:
+    * **Banners**: Get and dismiss banners.
+    * **Push token**: Create and manage push tokens.
 servers:
   - url: 'http://localhost:3000'
 paths:
@@ -634,4 +629,4 @@ components:
           examples:
             Example 1:
               value:
-                success: true
+                success: true

omnichannel.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: ''
+  version: 1.0.0
   title: Omnichannel
   description: |-
     With the Rocket.Chat [Omnichannel](https://docs.rocket.chat/use-rocket.chat/omnichannel) feature, you can talk to your customers and website visitors, regardless of the channel they choose to connect with you.
@@ -9,13 +9,6 @@ info:
 
     - **Endpoints requiring authentication:** The workspace admins and managers use the endpoints that require authentication with a login method.
     - **Endpoints not requiring authentication:** Visitors can use the endpoints that require no authentication. These endpoints require a visitor `token` which is like an authentication parameter for visitors. Visitors can [register themselves](livechat-endpoints/visitor/register-a-new-livechat-visitor.md) by providing a random unique string as the `token` which can be used for other such endpoints.
-  contact:
-    name: Rocket.Chat
-    url: 'https://rocket.chat/'
-    email: [email protected]
-  license:
-    url: 'https://rocket.chat/'
-    name: Apache2.0
 servers:
   - url: 'http://localhost:3000'
 paths:
@@ -1022,32 +1015,16 @@ paths:
             application/json:
               schema:
                 type: array
-                x-examples:
-                  Example 1:
-                    - title: Total_conversations
-                      value: 1086
-                    - title: Open_conversations
-                      value: 119
-                    - title: On_Hold_conversations
-                      value: 1
-                    - title: Total_messages
-                      value: 4892
-                    - title: Busiest_day
-                      value: Tuesday
-                    - title: Conversations_per_day
-                      value: '0.74'
-                    - title: Busiest_time
-                      value: 7AM- 8AM
                 items:
                   type: object
                   properties:
                     title:
                       type:
                         - string
                     value:
-                      type:
-                        - string
-                        - integer
+                      oneOf:
+                        - type: string
+                        - type: integer
               examples:
                 Success Example:
                   value:

settings.yml

@@ -2,15 +2,17 @@ openapi: 3.0.0
 info:
   version: ''
   title: Settings
-  description: ''
-  termsOfService: ''
-  contact:
-    name: ''
-    url: ''
-    email: ''
-  license:
-    url: ''
-    name: ''
+  description: |-
+    Configure your Rocket.Chat workspace with the following endpoints:
+      * **Settings**: Manage public and private settings.
+      * **Cloud**: Register your workspace on Rocket.Chat Cloud.
+      * **DNS**: Resolve DNS text and URL records.
+      * **E2E**: Create and manage [E2E](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/e2e-encryption) keys.
+      * **Import** and **Bulk user import**: Import users, rooms, and other details to your workspace.
+      * **Instances**: View details of your instances.
+      * **Federation**: Add and manage [federated](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/federation) servers.
+      * **Moderation**: View and manage [reported messages](https://docs.rocket.chat/use-rocket.chat/workspace-administration/moderation).
+      * **Device management**: Manage [user sessions](https://docs.rocket.chat/use-rocket.chat/user-management/device-manager) on the workspace.
 servers:
   - url: 'http://localhost:3000'
 paths:
@@ -3566,4 +3568,4 @@ components:
             Permission Error:
               value:
                 success: false
-                error: 'User does not have the permissions required for this action [error-unauthorized]'
+                error: 'User does not have the permissions required for this action [error-unauthorized]'

statistics.yaml

@@ -1,14 +1,14 @@
 openapi: 3.0.0
 info:
-  version: ''
+  version: 1.0.0
   title: Statistics
-  contact:
-    name: ''
-    url: ''
-    email: ''
-  license:
-    url: ''
-    name: ''
+  description: |-
+      * View your Rocket.Chat workspace **statistics**.
+      * Get the following workspace [engagement](https://docs.rocket.chat/use-rocket.chat/workspace-administration/engagement) details:
+          * **Channels**
+          * **Messages**
+          * **Users**
+      * View and manage channel **subscription** information.
 servers:
   - url: 'http://localhost:3000'
 paths:
@@ -3006,4 +3006,4 @@ components:
           examples:
             Example 1:
               value:
-                success: true
+                success: true