chore: update API specs

Author: leafty

client/src/features/dataConnectorsV2/api/data-connectors.api.ts

@@ -33,6 +33,17 @@ const injectedRtkApi = api.injectEndpoints({
         body: queryArg.globalDataConnectorPost,
       }),
     }),
+    getDataConnectorLinks: build.query<
+      GetDataConnectorLinksApiResponse,
+      GetDataConnectorLinksApiArg
+    >({
+      query: (queryArg) => ({
+        url: `/data_connector_links`,
+        params: {
+          params: queryArg.params,
+        },
+      }),
+    }),
     getDataConnectorsByDataConnectorId: build.query<
       GetDataConnectorsByDataConnectorIdApiResponse,
       GetDataConnectorsByDataConnectorIdApiArg
@@ -256,6 +267,12 @@ export type PostDataConnectorsGlobalApiResponse =
 export type PostDataConnectorsGlobalApiArg = {
   globalDataConnectorPost: GlobalDataConnectorPost;
 };
+export type GetDataConnectorLinksApiResponse =
+  /** status 200 The list of data connector links */ DataConnectorToProjectLinksList;
+export type GetDataConnectorLinksApiArg = {
+  /** query parameters */
+  params?: DataConnectorLinksGetQuery;
+};
 export type GetDataConnectorsByDataConnectorIdApiResponse =
   /** status 200 The data connector */ DataConnectorRead;
 export type GetDataConnectorsByDataConnectorIdApiArg = {
@@ -585,6 +602,17 @@ export type GlobalDataConnectorPost = {
 export type GlobalDataConnectorPostRead = {
   storage: CloudStorageCorePostRead | CloudStorageUrlV2;
 };
+export type DataConnectorToProjectLink = {
+  id: Ulid;
+  data_connector_id: Ulid;
+  project_id: Ulid;
+  creation_date: CreationDate;
+  created_by: UserId;
+};
+export type DataConnectorToProjectLinksList = DataConnectorToProjectLink[];
+export type DataConnectorLinksGetQuery = PaginationRequest & {
+  doi?: Doi;
+};
 export type CloudStorageCorePatch = {
   storage_type?: StorageType;
   configuration?: RCloneConfig;
@@ -625,14 +653,6 @@ export type DataConnectorPermissions = {
   /** The user can manage data connector members */
   change_membership?: boolean;
 };
-export type DataConnectorToProjectLink = {
-  id: Ulid;
-  data_connector_id: Ulid;
-  project_id: Ulid;
-  creation_date: CreationDate;
-  created_by: UserId;
-};
-export type DataConnectorToProjectLinksList = DataConnectorToProjectLink[];
 export type DataConnectorToProjectLinkPost = {
   project_id: Ulid;
 };
@@ -687,6 +707,7 @@ export const {
   useGetDataConnectorsQuery,
   usePostDataConnectorsMutation,
   usePostDataConnectorsGlobalMutation,
+  useGetDataConnectorLinksQuery,
   useGetDataConnectorsByDataConnectorIdQuery,
   usePatchDataConnectorsByDataConnectorIdMutation,
   useDeleteDataConnectorsByDataConnectorIdMutation,

client/src/features/dataConnectorsV2/api/data-connectors.openapi.json

@@ -144,6 +144,79 @@
         "tags": ["data_connectors"]
       }
     },
+    "/data_connector_links": {
+      "get": {
+        "summary": "Get all data connector links",
+        "parameters": [
+          {
+            "in": "query",
+            "description": "query parameters",
+            "name": "params",
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/DataConnectorLinksGetQuery"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The list of data connector links",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DataConnectorToProjectLinksList"
+                }
+              }
+            },
+            "headers": {
+              "page": {
+                "description": "The index of the current page (starting at 1).",
+                "required": true,
+                "schema": {
+                  "type": "integer"
+                }
+              },
+              "per-page": {
+                "description": "The number of items per page.",
+                "required": true,
+                "schema": {
+                  "type": "integer"
+                }
+              },
+              "total": {
+                "description": "The total number of items.",
+                "required": true,
+                "schema": {
+                  "type": "integer"
+                }
+              },
+              "total-pages": {
+                "description": "The total number of pages.",
+                "required": true,
+                "schema": {
+                  "type": "integer"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "The data connector with the given DOI does not exist or user does not have access to it",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "tags": ["data_connectors"]
+      }
+    },
     "/data_connectors/{data_connector_id}": {
       "parameters": [
         {
@@ -1525,6 +1598,21 @@
         "description": "A DOI.",
         "example": "10.16904/envidat.33"
       },
+      "DataConnectorLinksGetQuery": {
+        "description": "Query params for data connectors get request",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginationRequest"
+          },
+          {
+            "properties": {
+              "doi": {
+                "$ref": "#/components/schemas/DOI"
+              }
+            }
+          }
+        ]
+      },
       "DataConnectorsGetQuery": {
         "description": "Query params for data connectors get request",
         "allOf": [

client/src/features/projectsV2/api/projectV2.openapi.json

@@ -1415,42 +1415,6 @@
         "description": "Entity Tag",
         "example": "9EE498F9D565D0C41E511377425F32F3"
       },
-      "DataConnectorToProjectLinksList": {
-        "description": "A list of links from a data connector to a project",
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/DataConnectorToProjectLink"
-        }
-      },
-      "DataConnectorToProjectLink": {
-        "description": "A link from a data connector to a project in Renku 2.0",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "id": {
-            "$ref": "#/components/schemas/Ulid"
-          },
-          "data_connector_id": {
-            "$ref": "#/components/schemas/Ulid"
-          },
-          "project_id": {
-            "$ref": "#/components/schemas/Ulid"
-          },
-          "creation_date": {
-            "$ref": "#/components/schemas/CreationDate"
-          },
-          "created_by": {
-            "$ref": "#/components/schemas/UserId"
-          }
-        },
-        "required": [
-          "id",
-          "data_connector_id",
-          "project_id",
-          "creation_date",
-          "created_by"
-        ]
-      },
       "ProjectGetQuery": {
         "description": "Query params for project get request",
         "allOf": [