Add API reference for new V2 endpoints (#263)

tothmano · web-flow · commit e089d0285b29 · 2025-04-22T11:24:34.000+02:00
diff --git a/docs.json b/docs.json
@@ -485,43 +485,118 @@
             ]
           },
           {
-            "group": "User endpoints",
+            "group": "Annotation endpoints",
             "pages": [
-              "restapi/endpoints/getCurrentUser"
+              "restapi/endpoints/getAnnotations",
+              "restapi/endpoints/getAnnotation",
+              "restapi/endpoints/createAnnotation",
+              "restapi/endpoints/updateAnnotation",
+              "restapi/endpoints/deleteAnnotation"
+            ]
+          },
+          {
+            "group": "API token endpoints",
+            "pages": [
+              "restapi/endpoints/getTokens",
+              "restapi/endpoints/getToken",
+              "restapi/endpoints/createToken",
+              "restapi/endpoints/regenerateToken",
+              "restapi/endpoints/deleteToken"
             ]
           },
           {
             "group": "Dataset endpoints",
             "pages": [
               "restapi/endpoints/getDatasets",
               "restapi/endpoints/getDataset",
+              "restapi/endpoints/getFieldsForDataset",
+              "restapi/endpoints/getFieldForDataset",
               "restapi/endpoints/createDataset",
               "restapi/endpoints/ingestIntoDataset",
               "restapi/endpoints/queryApl",
               "restapi/endpoints/queryDataset",
               "restapi/endpoints/trimDataset",
               "restapi/endpoints/updateDataset",
+              "restapi/endpoints/updateFieldForDataset",
+              "restapi/endpoints/vacuumDataset",
               "restapi/endpoints/deleteDataset"
             ]
           },
           {
-            "group": "Annotation endpoints",
+            "group": "Monitor endpoints",
             "pages": [
-              "restapi/endpoints/getAnnotations",
-              "restapi/endpoints/getAnnotation",
-              "restapi/endpoints/createAnnotation",
-              "restapi/endpoints/updateAnnotation",
-              "restapi/endpoints/deleteAnnotation"
+              "restapi/endpoints/getMonitors",
+              "restapi/endpoints/getMonitor",
+              "restapi/endpoints/getMonitorHistory",
+              "restapi/endpoints/createMonitor",
+              "restapi/endpoints/updateMonitor",
+              "restapi/endpoints/deleteMonitor"
             ]
           },
           {
-            "group": "API token endpoints",
+            "group": "Notifier endpoints",
             "pages": [
-              "restapi/endpoints/getTokens",
-              "restapi/endpoints/getToken",
-              "restapi/endpoints/createToken",
-              "restapi/endpoints/regenerateToken",
-              "restapi/endpoints/deleteToken"
+              "restapi/endpoints/getNotifiers",
+              "restapi/endpoints/getNotifier",
+              "restapi/endpoints/createNotifier",
+              "restapi/endpoints/updateNotifier",
+              "restapi/endpoints/deleteNotifier"
+            ]
+          },
+          {
+            "group": "Organization endpoints",
+            "pages": [
+              "restapi/endpoints/getOrgs",
+              "restapi/endpoints/getOrg",
+              "restapi/endpoints/createOrg",
+              "restapi/endpoints/updateOrg"
+            ]
+          },
+          {
+            "group": "Role-based access control endpoints",
+            "pages": [
+              "restapi/endpoints/listRoles",
+              "restapi/endpoints/getRoleById",
+              "restapi/endpoints/listGroups",
+              "restapi/endpoints/getGroupById",
+              "restapi/endpoints/createRole",
+              "restapi/endpoints/createGroup",
+              "restapi/endpoints/updateRole",
+              "restapi/endpoints/updateGroup",
+              "restapi/endpoints/deleteRole",
+              "restapi/endpoints/deleteGroup"
+            ]
+          },
+          {
+            "group": "Starred queries endpoints",
+            "pages": [
+              "restapi/endpoints/getStarredQueries",
+              "restapi/endpoints/getStarred",
+              "restapi/endpoints/createStarred",
+              "restapi/endpoints/updateStarred",
+              "restapi/endpoints/deleteStarred"
+            ]
+          },
+          {
+            "group": "User endpoints",
+            "pages": [
+              "restapi/endpoints/getCurrentUser",
+              "restapi/endpoints/getUsers",
+              "restapi/endpoints/getUser",
+              "restapi/endpoints/createUser",
+              "restapi/endpoints/updateCurrentUser",
+              "restapi/endpoints/updateUserRole",
+              "restapi/endpoints/removeUserFromOrg"
+            ]
+          },
+          {
+            "group": "Virtual fields endpoints",
+            "pages": [
+              "restapi/endpoints/getVirtualFields",
+              "restapi/endpoints/getVirtualField",
+              "restapi/endpoints/createVirtualField",
+              "restapi/endpoints/updateVirtualField",
+              "restapi/endpoints/deleteVirtualField"
             ]
           }
         ]
diff --git a/restapi/endpoints/createDataset.mdx b/restapi/endpoints/createDataset.mdx
@@ -1,4 +1,4 @@
 ---
 title: Create dataset
-openapi: "v1 post /datasets"
+openapi: "v2 post /datasets"
 ---
diff --git a/restapi/endpoints/createGroup.mdx b/restapi/endpoints/createGroup.mdx
@@ -0,0 +1,4 @@
+---
+title: Create group
+openapi: "v2 post /rbac/groups"
+---
diff --git a/restapi/endpoints/createMonitor.mdx b/restapi/endpoints/createMonitor.mdx
@@ -0,0 +1,4 @@
+---
+title: Create monitor
+openapi: "v2 post /monitors"
+---
diff --git a/restapi/endpoints/createNotifier.mdx b/restapi/endpoints/createNotifier.mdx
@@ -0,0 +1,4 @@
+---
+title: Create notifier
+openapi: "v2 post /notifiers"
+---
diff --git a/restapi/endpoints/createOrg.mdx b/restapi/endpoints/createOrg.mdx
@@ -0,0 +1,4 @@
+---
+title: Create org
+openapi: "v2 post /orgs"
+---
diff --git a/restapi/endpoints/createRole.mdx b/restapi/endpoints/createRole.mdx
@@ -0,0 +1,4 @@
+---
+title: Create role
+openapi: "v2 post /rbac/roles"
+---
diff --git a/restapi/endpoints/createStarred.mdx b/restapi/endpoints/createStarred.mdx
@@ -0,0 +1,4 @@
+---
+title: Create starred query
+openapi: "v2 post /apl-starred-queries"
+---
diff --git a/restapi/endpoints/createUser.mdx b/restapi/endpoints/createUser.mdx
@@ -0,0 +1,4 @@
+---
+title: Create user
+openapi: "v2 post /users"
+---
diff --git a/restapi/endpoints/createVirtualField.mdx b/restapi/endpoints/createVirtualField.mdx
@@ -0,0 +1,4 @@
+---
+title: Create virtual field
+openapi: "v2 post /vfields"
+---
diff --git a/restapi/endpoints/deleteDataset.mdx b/restapi/endpoints/deleteDataset.mdx
@@ -1,4 +1,4 @@
 ---
 title: Delete dataset
-openapi: "v1 delete /datasets/{dataset_name}"
+openapi: "v2 delete /datasets/{id}"
 ---
diff --git a/restapi/endpoints/deleteGroup.mdx b/restapi/endpoints/deleteGroup.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete group
+openapi: "v2 delete /rbac/groups/{id}"
+---
diff --git a/restapi/endpoints/deleteMonitor.mdx b/restapi/endpoints/deleteMonitor.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete monitor
+openapi: "v2 delete /monitors/{id}"
+---
diff --git a/restapi/endpoints/deleteNotifier.mdx b/restapi/endpoints/deleteNotifier.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete notifier
+openapi: "v2 delete /notifiers/{id}"
+---
diff --git a/restapi/endpoints/deleteRole.mdx b/restapi/endpoints/deleteRole.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete role
+openapi: "v2 delete /rbac/roles/{id}"
+---
diff --git a/restapi/endpoints/deleteStarred.mdx b/restapi/endpoints/deleteStarred.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete starred query
+openapi: "v2 delete /apl-starred-queries/{id}"
+---
diff --git a/restapi/endpoints/deleteVirtualField.mdx b/restapi/endpoints/deleteVirtualField.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete virtual field
+openapi: "v2 delete /vfields/{id}"
+---
diff --git a/restapi/endpoints/getCurrentUser.mdx b/restapi/endpoints/getCurrentUser.mdx
@@ -1,4 +1,4 @@
 ---
 title: Retrieve current user
-openapi: "v1 get /user"
+openapi: "v2 get /user"
 ---
diff --git a/restapi/endpoints/getDataset.mdx b/restapi/endpoints/getDataset.mdx
@@ -1,4 +1,4 @@
 ---
 title: Retrieve dataset
-openapi: "v1 get /datasets/{dataset_name}"
+openapi: "v2 get /datasets/{id}"
 ---
diff --git a/restapi/endpoints/getDatasets.mdx b/restapi/endpoints/getDatasets.mdx
@@ -1,4 +1,4 @@
 ---
 title: List all datasets
-openapi: "v1 get /datasets"
+openapi: "v2 get /datasets"
 ---
diff --git a/restapi/endpoints/getFieldForDataset.mdx b/restapi/endpoints/getFieldForDataset.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve field in dataset
+openapi: "v2 get /datasets/{id}/fields/{fieldId}"
+---
diff --git a/restapi/endpoints/getFieldsForDataset.mdx b/restapi/endpoints/getFieldsForDataset.mdx
@@ -0,0 +1,4 @@
+---
+title: List all fields in dataset
+openapi: "v2 get /datasets/{id}/fields"
+---
diff --git a/restapi/endpoints/getGroupById.mdx b/restapi/endpoints/getGroupById.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve group
+openapi: "v2 get /rbac/groups/{id}"
+---
diff --git a/restapi/endpoints/getMonitor.mdx b/restapi/endpoints/getMonitor.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve monitor
+openapi: "v2 get /monitors/{id}"
+---
diff --git a/restapi/endpoints/getMonitorHistory.mdx b/restapi/endpoints/getMonitorHistory.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve monitor history
+openapi: "v2 get /monitors/{id}/history"
+---
diff --git a/restapi/endpoints/getMonitors.mdx b/restapi/endpoints/getMonitors.mdx
@@ -0,0 +1,4 @@
+---
+title: List all monitors
+openapi: "v2 get /monitors"
+---
diff --git a/restapi/endpoints/getNotifier.mdx b/restapi/endpoints/getNotifier.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve notifier
+openapi: "v2 get /notifiers/{id}"
+---
diff --git a/restapi/endpoints/getNotifiers.mdx b/restapi/endpoints/getNotifiers.mdx
@@ -0,0 +1,4 @@
+---
+title: List all notifiers
+openapi: "v2 get /notifiers"
+---
diff --git a/restapi/endpoints/getOrg.mdx b/restapi/endpoints/getOrg.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve org
+openapi: "v2 get /orgs/{id}"
+---
diff --git a/restapi/endpoints/getOrgs.mdx b/restapi/endpoints/getOrgs.mdx
@@ -0,0 +1,4 @@
+---
+title: List all orgs
+openapi: "v2 get /orgs"
+---
diff --git a/restapi/endpoints/getRoleById.mdx b/restapi/endpoints/getRoleById.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve role
+openapi: "v2 get /rbac/roles/{id}"
+---
diff --git a/restapi/endpoints/getStarred.mdx b/restapi/endpoints/getStarred.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve starred query
+openapi: "v2 get /apl-starred-queries/{id}"
+---
diff --git a/restapi/endpoints/getStarredQueries.mdx b/restapi/endpoints/getStarredQueries.mdx
@@ -0,0 +1,4 @@
+---
+title: List all starred queries
+openapi: "v2 get /apl-starred-queries"
+---
diff --git a/restapi/endpoints/getUser.mdx b/restapi/endpoints/getUser.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve user
+openapi: "v2 get /users/{id}"
+---
diff --git a/restapi/endpoints/getUsers.mdx b/restapi/endpoints/getUsers.mdx
@@ -0,0 +1,4 @@
+---
+title: List all users
+openapi: "v2 get /users"
+---
diff --git a/restapi/endpoints/getVirtualField.mdx b/restapi/endpoints/getVirtualField.mdx
@@ -0,0 +1,4 @@
+---
+title: Retrieve virtual field
+openapi: "v2 get /vfields/{id}"
+---
diff --git a/restapi/endpoints/getVirtualFields.mdx b/restapi/endpoints/getVirtualFields.mdx
@@ -0,0 +1,4 @@
+---
+title: List all virtual fields
+openapi: "v2 get /vfields"
+---
diff --git a/restapi/endpoints/listGroups.mdx b/restapi/endpoints/listGroups.mdx
@@ -0,0 +1,4 @@
+---
+title: List all groups
+openapi: "v2 get /rbac/groups"
+---
diff --git a/restapi/endpoints/listRoles.mdx b/restapi/endpoints/listRoles.mdx
@@ -0,0 +1,4 @@
+---
+title: List all roles
+openapi: "v2 get /rbac/roles"
+---
diff --git a/restapi/endpoints/removeUserFromOrg.mdx b/restapi/endpoints/removeUserFromOrg.mdx
@@ -0,0 +1,4 @@
+---
+title: Delete user from org
+openapi: "v2 delete /users/{id}"
+---
diff --git a/restapi/endpoints/trimDataset.mdx b/restapi/endpoints/trimDataset.mdx
@@ -1,4 +1,4 @@
 ---
 title: Trim dataset
-openapi: "v1 post /datasets/{dataset_name}/trim"
+openapi: "v2 post /datasets/{id}/trim"
 ---
diff --git a/restapi/endpoints/updateCurrentUser.mdx b/restapi/endpoints/updateCurrentUser.mdx
@@ -0,0 +1,4 @@
+---
+title: Update current user
+openapi: "v2 put /user"
+---
diff --git a/restapi/endpoints/updateDataset.mdx b/restapi/endpoints/updateDataset.mdx
@@ -1,4 +1,4 @@
 ---
 title: Update dataset
-openapi: "v1 put /datasets/{dataset_name}"
+openapi: "v2 put /datasets/{id}"
 ---
diff --git a/restapi/endpoints/updateFieldForDataset.mdx b/restapi/endpoints/updateFieldForDataset.mdx
@@ -0,0 +1,4 @@
+---
+title: Update field
+openapi: "v2 put /datasets/{id}/fields/{fieldId}"
+---
diff --git a/restapi/endpoints/updateGroup.mdx b/restapi/endpoints/updateGroup.mdx
diff --git a/restapi/endpoints/updateMonitor.mdx b/restapi/endpoints/updateMonitor.mdx
diff --git a/restapi/endpoints/updateNotifier.mdx b/restapi/endpoints/updateNotifier.mdx
diff --git a/restapi/endpoints/updateOrg.mdx b/restapi/endpoints/updateOrg.mdx
diff --git a/restapi/endpoints/updateRole.mdx b/restapi/endpoints/updateRole.mdx
diff --git a/restapi/endpoints/updateStarred.mdx b/restapi/endpoints/updateStarred.mdx
diff --git a/restapi/endpoints/updateUserRole.mdx b/restapi/endpoints/updateUserRole.mdx
diff --git a/restapi/endpoints/updateVirtualField.mdx b/restapi/endpoints/updateVirtualField.mdx
diff --git a/restapi/endpoints/vacuumDataset.mdx b/restapi/endpoints/vacuumDataset.mdx
diff --git a/restapi/versions/v2.json b/restapi/versions/v2.json
