Integrate open api spec

.vscode/settings.json

@@ -9,5 +9,8 @@
     "python.testing.unittestEnabled": true,
     "python.analysis.enablePytestSupport": false,
     "python.testing.pytestEnabled": false,
-    "python.analysis.typeCheckingMode": "strict"
+    "python.analysis.typeCheckingMode": "standard",
+    "python.analysis.extraPaths": [
+        "./openapi/openapi-client"
+    ]
 }

docs/source/development.md

@@ -0,0 +1,55 @@
+# Development
+
+This page describes the set-up of a development environment. The project uses a generated client based on Rapidata's OpenApi spec located at https://docs.rabbitdata.ch/.
+
+## OpenAPI Client generation
+
+### Download Specs
+
+The specs used for generation are tracked at `openapi/output.swagger.json`. The following steps are only necessary to synchronize the generated client with the latest spec.
+
+This requires [openapi-merge-cli](https://www.npmjs.com/package/openapi-merge-cli) installed globally
+
+```
+npm i -g openapi-merge-cli
+```
+
+Download and merge the specification from https://docs.rabbitdata.ch/:
+
+```
+./openapi/download-and-merge-spec.sh
+```
+
+This should have produced/updated the file at `openapi/output.swagger.json`
+
+### Generate OpenAPI Client
+
+This requires [openapi-generator](https://github.com/OpenAPITools/openapi-generator) installed
+
+```
+brew install openapi-generator
+```
+
+Execute the generation command by running
+
+```
+./openapi/generate.sh
+```
+
+## Python Package Management
+
+This repository is using [poetry](https://python-poetry.org/) to manage dependencies.
+
+To set-up a python environment using conda, run:
+```
+conda create -n rapi-client
+```
+
+Then let poetry install all dependencies:
+
+```
+poetry install
+```
+
+This will also install the OpenAPI Client located at `openapi/openapi-client` as a development dependency. So any new generation does not require a re-install.
+

docs/source/index.md

@@ -10,5 +10,6 @@ Welcome! The Rapidata Python Client is a convenient way to interact with the Rap
 
 quickstart
 examples/index
+development
 
 ```

examples/classify_order.py

@@ -5,7 +5,7 @@
 from rapidata.rapidata_client import RapidataClient
 from rapidata.rapidata_client.workflow import FeatureFlags
 from rapidata.rapidata_client.workflow import ClassifyWorkflow
-from rapidata.rapidata_client.workflow.referee import NaiveReferee
+from rapidata.rapidata_client.referee import NaiveReferee
 
 CLIENT_ID = os.getenv("CLIENT_ID")
 CLIENT_SECRET = os.getenv("CLIENT_SECRET")
@@ -32,7 +32,7 @@
     .workflow(
         ClassifyWorkflow(
             question="Who should be president?",
-            categories=["Kamala Harris", "Donald Trump"],
+            options=["Kamala Harris", "Donald Trump"],
         )
         .referee(NaiveReferee(required_guesses=15))
         .feature_flags(FeatureFlags().alert_on_fast_response(3))

openapi/.gitignore

@@ -0,0 +1,2 @@
+openapi-client/
+spec/

openapi/download-and-merge-spec.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+rm -rf openapi/spec
+mkdir openapi/spec
+
+# Use a function to simulate an associative array
+url_for() {
+    case $1 in
+        "order") echo "https://api.app.rabbitdata.ch/Order/swagger/v1/swagger.json" ;;
+        "dataset") echo "https://api.app.rabbitdata.ch/Dataset/swagger/v1/swagger.json" ;;
+        "identity") echo "https://api.app.rabbitdata.ch/Identity/swagger/v1/swagger.json" ;;
+        *) echo "" ;;
+    esac
+}
+
+# List of keys
+keys=("order" "dataset" "identity")
+
+for key in "${keys[@]}"; do
+    url=$(url_for "$key")
+    output_json="openapi/spec/${key}.json"
+    output_ts="openapi/${key}.zod.ts"
+
+    # Download the JSON file using curl
+    curl -o "$output_json" "$url"
+
+    echo "Downloaded $url to $output_json"
+
+done
+
+# Merge the OpenAPI specs into a single file (output.swagger.json)
+cd openapi
+npx openapi-merge-cli

openapi/generate.sh

@@ -0,0 +1,3 @@
+rm -rf openapi/openapi-client
+
+openapi-generator generate -i openapi/output.swagger.json -g python -o openapi/openapi-client --skip-validate-spec

openapi/openapi-merge.json

@@ -0,0 +1,14 @@
+{
+  "inputs": [
+    {
+      "inputFile": "./spec/dataset.json"
+    },
+    {
+      "inputFile": "./spec/order.json"
+    },
+    {
+      "inputFile": "./spec/identity.json"
+    }
+  ],
+  "output": "./output.swagger.json"
+}