docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
--- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml
+++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml
@@ -0,0 +1,105 @@
+get:
+  operationId: GetNotifications
+  summary: List Notifications
+  description: >-
+    Retrieve a list of notifications. The notifications can be filtered by
+    fields such as `event_name` or `resource_type`. The notifications can also
+    be paginated.
+  x-authenticated: true
+  parameters:
+    - in: query
+      name: offset
+      description: >-
+        The number of inventory items to skip when retrieving the inventory
+        items.
+      schema:
+        type: integer
+        default: 0
+    - in: query
+      name: limit
+      description: Limit the number of notifications returned.
+      schema:
+        type: integer
+        default: 50
+    - in: query
+      name: fields
+      description: >-
+        Comma-separated fields that should be included in each returned
+        notification.
+      schema:
+        type: string
+    - in: query
+      name: expand
+      description: >-
+        Comma-separated relations that should be expanded in each returned
+        notification.
+      schema:
+        type: string
+    - in: query
+      name: event_name
+      description: >-
+        Filter by the name of the event that triggered sending this
+        notification.
+      schema:
+        type: string
+    - in: query
+      name: resource_type
+      description: Filter by the resource type.
+      schema:
+        type: string
+    - in: query
+      name: resource_id
+      description: Filter by the resource ID.
+      schema:
+        type: string
+    - in: query
+      name: to
+      description: >-
+        Filter by the address that the Notification was sent to. This will
+        usually be an email address, but it can also represent other addresses
+        such as a chat bot user id.
+      schema:
+        type: string
+    - in: query
+      name: include_resends
+      description: >-
+        A boolean indicating whether the result set should include resent
+        notifications or not
+      schema:
+        type: string
+  x-codegen:
+    method: list
+    queryParams: AdminGetNotificationsParams
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/admin_notifications/get.js
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_notifications/get.sh
+  security:
+    - api_token: []
+    - cookie_auth: []
+  tags:
+    - Notifications
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminNotificationsListRes.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml