feat: add warehouse connectors openapi (#1304)

* adding warehouse connectors openapi config

* adding importId

* adding importId in params

* adding overview

* adding overview file

* fixing tags

* changing operation id

* modifying spec

* adding empty slug

* removing empty slug

* fixing copy and dates

Author: Yuriy Tolstykh

openapi/openapi.config.yaml

@@ -9,6 +9,7 @@ apiDefinitions:
   lexicon-schemas: ./src/lexicon-schemas.openapi.yaml
   query: ./src/query.openapi.yaml
   service-accounts: ./src/service-accounts.openapi.yaml
+  warehouse-connectors: ./src/warehouse-connectors.openapi.yaml
 
 lint:
   extends:

openapi/src/common/parameters.yaml

@@ -5,14 +5,21 @@ path:
     schema:
       type: integer
     required: true
-    description: 'Your project id (eg: 12345)'
+    description: "Your project id (eg: 12345)"
   organizationId:
     in: path
     name: organizationId
     schema:
       type: integer
     required: true
-    description: 'Your organization id (eg: 12345)'
+    description: "Your organization id (eg: 12345)"
+  importId:
+    in: path
+    name: importId
+    schema:
+      type: integer
+    required: true
+    description: "Your warehouse import id (eg: 12345)"
 query:
   projectId:
     in: query

openapi/src/warehouse-connectors.openapi.yaml

@@ -0,0 +1,49 @@
+openapi: 3.0.2
+info:
+  title: Warehouse Connectors API
+  description: Connect an external warehouse to import events, users, groups, and lookup tables.
+  version: 1.0.0
+  contact:
+    url: https://mixpanel.com/get-support
+servers:
+  - $ref: ./common/app-api.yaml#/server
+security:
+  - ServiceAccount: []
+tags:
+  - name: Run an import
+    description: Trigger an import sync via API
+paths:
+  /projects/{projectId}/warehouse-sources/imports/{importId}/manual-sync:
+    put:
+      parameters:
+        - $ref: ./common/parameters.yaml#/path/projectId
+        - $ref: ./common/parameters.yaml#/path/importId
+      operationId: run-an-import
+      requestBody:
+        required: true
+        content:
+          application/json: {}
+      tags:
+        - Run an import
+      summary: Run an import
+      description: >-
+        This API endpoint triggers an immediate sync for a given warehouse import.
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    $ref: "./common/responses.yaml#/ResponseStatusOk"
+        "401":
+          $ref: "./common/responses.yaml#/401Unauthorized"
+        "403":
+          $ref: "./common/responses.yaml#/403Forbidden"
+        "404":
+          $ref: "./common/responses.yaml#/404NotFound"
+components:
+  securitySchemes:
+    $ref: ./common/securitySchemes.yaml

reference/Mixpanel APIs/overview.md

@@ -3,44 +3,57 @@ title: "Overview"
 slug: "overview"
 hidden: false
 createdAt: "2020-08-13T17:28:39.814Z"
-updatedAt: "2021-10-07T19:08:48.152Z"
+updatedAt: "2024-08-05T19:31:43.295Z"
 ---
+
 Mixpanel supports API endpoints that can query, export, and import data as well as manipulate Mixpanel metadata (such as data definitions).
 
 The API endpoints are organized by the function that they support. The API structure is as follows:
 
-### [**Ingestion API**](ref:ingestion-api) 
+### [**Ingestion API**](ref:ingestion-api)
+
 **Standard Server:** `api.mixpanel.com`
 **EU Residency Server:** `api-eu.mixpanel.com`
 Use the Ingestion API to get your data into Mixpanel. This includes live events, historical imports, and user profile data.
 
+### [**Query API**](ref:query-api)
 
-### [**Query API**](ref:query-api) 
 **Standard Server:** `mixpanel.com/api`
 **EU Residency Server:** `eu.mixpanel.com/api`
 Use the Query AP to get the same calculated data the powers Mixpanel's web application. This includes Insights, Funnels, Retention, and custom JQL Queries.
 
-### [**Raw Data Export API **](ref:raw-data-export-api) 
+### [**Raw Data Export API **](ref:raw-data-export-api)
+
 **Standard Server:** `data.mixpanel.com/api/2.0/export`
 **EU Residency Server:** `data-eu.mixpanel.com/api/2.0/export`
 Use the Raw Data Export API endpoint to obtain your event data. This API supports direct download or uploading to a cloud bucket.
 
 ### [**Data Pipelines API**](ref:overview-2)
+
 **Standard Server:** `data.mixpanel.com/api/2.0/nessie`
 **EU Residency Server:** `data-eu.mixpanel.com/api/2.0/nessie`
-Use the Data Pipelines API to export Mixpanel data to your own Data Warehouse. Mixpanel’s Data Pipelines product removes the need to build complex connectors, maintain exporting code, and apply ad-hoc data transformations. 
+Use the Data Pipelines API to export Mixpanel data to your own Data Warehouse. Mixpanel’s Data Pipelines product removes the need to build complex connectors, maintain exporting code, and apply ad-hoc data transformations.
+
+### [**Lexicon Schemas API**](ref:lexicon-schemas-api)
 
-### [**Lexicon Schemas API**](ref:lexicon-schemas-api) 
 **Standard Server:** `mixpanel.com/api/app/projects`
 **EU Residency Server:** `eu.mixpanel.com/api/app/projects`
 Use the Schemas API to manage your data definitions in Lexicon and Data Audit
 
-### [**Connectors API**](ref:connectors-api) 
+### [**Connectors API**](ref:connectors-api)
+
 **Standard Server:** `mixpanel.com/api/app/projects`
 **EU Residency Server:** `eu.mixpanel.com/api/app/projects`
 Batch import large volumes of data into Mixpanel from a cloud bucket
 
-### [**GDPR API**](ref:gdpr-api) 
+### [**GDPR API**](ref:gdpr-api)
+
 **Standard Server:** `mixpanel.com/api/app/data-retrievals`
 **EU Residency Server:** `eu.mixpanel.com/api/app/data-retrievals`
 The retrieval and deletion API calls are updated for version 3 and are made for GDPR and CCPA compliance.
+
+### [**Warehouse Connectors API**](ref:warehouse-connectors-api)
+
+**Standard Server:** `mixpanel.com/api/app/projects`
+**EU Residency Server:** `eu.mixpanel.com/api/app/projects`
+Use the Warehouse Connectors API to manually run a warehouse imports.

reference/Warehouse Connectors API/overview.md

@@ -0,0 +1,12 @@
+---
+title: "Overview"
+slug: "warehouse-connectors-api"
+hidden: false
+createdAt: "2024-08-05T19:31:43.295Z"
+updatedAt: "2024-08-05T19:31:43.295Z"
+categorySlug: "warehouse-connectors-api"
+---
+
+Warehouse Connectors allow you to connect a warehouse of your choice to import events, users, groups, and lookup tables.
+
+Use Warehouse Connectors API to run a specific import manually.