docs: generate API reference for 2.10.3

Author: shahednasser

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_columns/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/views/{entity}/columns' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/views/{entity}/configurations' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations/post.sh

@@ -0,0 +1,7 @@
+curl -X POST '{backend_url}/admin/views/{entity}/configurations' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+-d '{
+  "is_system_default": true,
+  "name": "Custom View",
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations_active/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/views/{entity}/configurations/active' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations_active/post.sh

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/views/{entity}/configurations/active' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "view_configuration_id": "{value}"
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations_{id}/delete.sh

@@ -0,0 +1,2 @@
+curl -X DELETE '{backend_url}/admin/views/{entity}/configurations/{id}' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations_{id}/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/views/{entity}/configurations/{id}' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_views_{entity}_configurations_{id}/post.sh

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/views/{entity}/configurations/{id}' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+-d '{
+  "is_system_default": true
+}'

www/apps/api-reference/specs/admin/components/schemas/AdminColumn.yaml

@@ -0,0 +1,118 @@
+type: object
+description: The details of a column in a view configuration.
+x-schemaName: AdminColumn
+required:
+  - id
+  - name
+  - field
+  - sortable
+  - hideable
+  - default_visible
+  - data_type
+properties:
+  id:
+    type: string
+    title: id
+    description: The column's ID.
+  name:
+    type: string
+    title: name
+    description: The column's name. This is displayed in the view header.
+  description:
+    type: string
+    title: description
+    description: The column's description.
+  field:
+    type: string
+    title: field
+    description: The column's field in the entity.
+  sortable:
+    type: boolean
+    title: sortable
+    description: Whether the column is sortable.
+  hideable:
+    type: boolean
+    title: hideable
+    description: Whether the column is hideable.
+  default_visible:
+    type: boolean
+    title: default_visible
+    description: Whether the column is visible by default.
+  data_type:
+    type: string
+    description: The data type of the column's value.
+    enum:
+      - string
+      - number
+      - boolean
+      - object
+      - date
+      - currency
+      - enum
+  semantic_type:
+    type: string
+    title: semantic_type
+    description: >-
+      The column's semantic type. It can be `computed`, or other primitive
+      types.
+  context:
+    type: string
+    title: context
+    description: The column's context. It can be `display` or `generic`.
+  computed:
+    type: object
+    description: >-
+      A computed column's details. Only available if the column's
+      `semantic_type` is `computed`.
+    required:
+      - type
+      - required_fields
+      - optional_fields
+    properties:
+      type:
+        type: string
+        title: type
+        description: The computed's type for rendering.
+      required_fields:
+        type: array
+        description: The required fields in the computed column.
+        items:
+          type: string
+          title: required_fields
+          description: A required field in the computed column.
+      optional_fields:
+        type: array
+        description: The optional fields in the computed column.
+        items:
+          type: string
+          title: optional_fields
+          description: An optional field in the computed column.
+  relationship:
+    type: object
+    description: The relationship details. Only available for relationship columns.
+    required:
+      - entity
+      - field
+    properties:
+      entity:
+        type: string
+        title: entity
+        description: The related entity.
+      field:
+        type: string
+        title: field
+        description: The field in the related entity.
+  default_order:
+    type: number
+    title: default_order
+    description: The column's sort order in the default view configuration.
+  category:
+    type: string
+    description: The column's category.
+    enum:
+      - status
+      - metadata
+      - identifier
+      - timestamp
+      - metric
+      - relationship

www/apps/api-reference/specs/admin/components/schemas/AdminCreateViewConfiguration.yaml

@@ -0,0 +1,64 @@
+type: object
+description: The details of a view configuration to create.
+x-schemaName: AdminCreateViewConfiguration
+properties:
+  is_system_default:
+    type: boolean
+    title: is_system_default
+    description: >-
+      Whether the view is the system default. If so, it will be used as the
+      default view for all users that don't have a custom active view set.
+  set_active:
+    type: boolean
+    title: set_active
+    description: Whether the view is set as active.
+  configuration:
+    type: object
+    description: The view's configuration.
+    required:
+      - visible_columns
+      - column_order
+    properties:
+      visible_columns:
+        type: array
+        description: The configuration's visible columns.
+        items:
+          type: string
+          title: visible_columns
+          description: The visible column's name.
+      column_order:
+        type: array
+        description: The columns in the order they should be displayed.
+        items:
+          type: string
+          title: column_order
+          description: The column's name.
+      search:
+        type: string
+        title: search
+        description: The search query used in the view.
+      column_widths:
+        type: object
+        description: The column widths in the view.
+      filters:
+        type: object
+        description: The filters applied to the view.
+      sorting:
+        type: object
+        description: The sorting applied to the view.
+        required:
+          - id
+          - desc
+        properties:
+          id:
+            type: string
+            title: id
+            description: The ID of the sorting column.
+          desc:
+            type: boolean
+            title: desc
+            description: Whether the sorting is descending.
+  name:
+    type: string
+    title: name
+    description: The view's name.