server/www: simplify operationId in openapi and update www

server/reflector/app.py

@@ -1,6 +1,7 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi_pagination import add_pagination
+from fastapi.routing import APIRoute
 from reflector.views.rtc_offer import router as rtc_offer_router
 from reflector.views.transcripts import router as transcripts_router
 from reflector.events import subscribers_startup, subscribers_shutdown
@@ -49,6 +50,42 @@ app.include_router(rtc_offer_router)
 app.include_router(transcripts_router, prefix="/v1")
 add_pagination(app)
 
+
+# simpler openapi id
+def use_route_names_as_operation_ids(app: FastAPI) -> None:
+    """
+    Simplify operation IDs so that generated API clients have simpler function
+    names.
+
+    Should be called only after all routes have been added.
+    """
+    ensure_uniq_operation_ids = set()
+    for route in app.routes:
+        if isinstance(route, APIRoute):
+            # opid
+
+            # extract version out of path if exists
+            # /v1/transcripts -> v1
+            # /transcripts -> None
+            version = None
+            if route.path.startswith("/v"):
+                version = route.path.split("/")[1]
+                opid = f"{version}_{route.name}"
+            else:
+                opid = route.name
+
+            if opid in ensure_uniq_operation_ids:
+                raise ValueError(
+                    f"Operation ID '{route.name}' is not unique. "
+                    "Please rename the route or the view function."
+                )
+            route.operation_id = opid
+            ensure_uniq_operation_ids.add(route.name)
+
+
+use_route_names_as_operation_ids(app)
+
+
 if __name__ == "__main__":
     import uvicorn
 

www/app/api/.openapi-generator/FILES

@@ -1,4 +1,3 @@
-.openapi-generator-ignore
 apis/DefaultApi.ts
 apis/index.ts
 index.ts

www/app/api/apis/DefaultApi.ts

@@ -39,45 +39,45 @@ import {
   UpdateTranscriptToJSON,
 } from "../models";
 
-export interface RtcOfferOfferPostRequest {
+export interface RtcOfferRequest {
   rtcOffer: RtcOffer;
 }
 
-export interface TranscriptDeleteV1TranscriptsTranscriptIdDeleteRequest {
+export interface V1TranscriptDeleteRequest {
   transcriptId: any;
 }
 
-export interface TranscriptGetAudioV1TranscriptsTranscriptIdAudioGetRequest {
+export interface V1TranscriptGetRequest {
   transcriptId: any;
 }
 
-export interface TranscriptGetTopicsV1TranscriptsTranscriptIdTopicsGetRequest {
+export interface V1TranscriptGetAudioRequest {
   transcriptId: any;
 }
 
-export interface TranscriptGetV1TranscriptsTranscriptIdGetRequest {
+export interface V1TranscriptGetTopicsRequest {
   transcriptId: any;
 }
 
-export interface TranscriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGetRequest {
+export interface V1TranscriptGetWebsocketEventsRequest {
   transcriptId: any;
 }
 
-export interface TranscriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPostRequest {
+export interface V1TranscriptRecordWebrtcRequest {
   transcriptId: any;
   rtcOffer: RtcOffer;
 }
 
-export interface TranscriptUpdateV1TranscriptsTranscriptIdPatchRequest {
+export interface V1TranscriptUpdateRequest {
   transcriptId: any;
   updateTranscript: UpdateTranscript;
 }
 
-export interface TranscriptsCreateV1TranscriptsPostRequest {
+export interface V1TranscriptsCreateRequest {
   createTranscript: CreateTranscript;
 }
 
-export interface TranscriptsListV1TranscriptsGetRequest {
+export interface V1TranscriptsListRequest {
   page?: any;
   size?: any;
 }
@@ -89,8 +89,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Rtc Offer
    */
-  async rtcOfferOfferPostRaw(
+  async rtcOfferRaw(
-    requestParameters: RtcOfferOfferPostRequest,
+    requestParameters: RtcOfferRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<any>> {
     if (
@@ -99,7 +99,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "rtcOffer",
-        "Required parameter requestParameters.rtcOffer was null or undefined when calling rtcOfferOfferPost.",
+        "Required parameter requestParameters.rtcOffer was null or undefined when calling rtcOffer.",
       );
     }
 
@@ -130,22 +130,19 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Rtc Offer
    */
-  async rtcOfferOfferPost(
+  async rtcOffer(
-    requestParameters: RtcOfferOfferPostRequest,
+    requestParameters: RtcOfferRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<any> {
-    const response = await this.rtcOfferOfferPostRaw(
+    const response = await this.rtcOfferRaw(requestParameters, initOverrides);
-      requestParameters,
-      initOverrides,
-    );
     return await response.value();
   }
 
   /**
    * Transcript Delete
    */
-  async transcriptDeleteV1TranscriptsTranscriptIdDeleteRaw(
+  async v1TranscriptDeleteRaw(
-    requestParameters: TranscriptDeleteV1TranscriptsTranscriptIdDeleteRequest,
+    requestParameters: V1TranscriptDeleteRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<DeletionStatus>> {
     if (
@@ -154,7 +151,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptDeleteV1TranscriptsTranscriptIdDelete.",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptDelete.",
       );
     }
 
@@ -183,12 +180,64 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Delete
    */
-  async transcriptDeleteV1TranscriptsTranscriptIdDelete(
+  async v1TranscriptDelete(
-    requestParameters: TranscriptDeleteV1TranscriptsTranscriptIdDeleteRequest,
+    requestParameters: V1TranscriptDeleteRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<DeletionStatus> {
-    const response =
+    const response = await this.v1TranscriptDeleteRaw(
-      await this.transcriptDeleteV1TranscriptsTranscriptIdDeleteRaw(
+      requestParameters,
+      initOverrides,
+    );
+    return await response.value();
+  }
+
+  /**
+   * Transcript Get
+   */
+  async v1TranscriptGetRaw(
+    requestParameters: V1TranscriptGetRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<runtime.ApiResponse<GetTranscript>> {
+    if (
+      requestParameters.transcriptId === null ||
+      requestParameters.transcriptId === undefined
+    ) {
+      throw new runtime.RequiredError(
+        "transcriptId",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptGet.",
+      );
+    }
+
+    const queryParameters: any = {};
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    const response = await this.request(
+      {
+        path: `/v1/transcripts/{transcript_id}`.replace(
+          `{${"transcript_id"}}`,
+          encodeURIComponent(String(requestParameters.transcriptId)),
+        ),
+        method: "GET",
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides,
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) =>
+      GetTranscriptFromJSON(jsonValue),
+    );
+  }
+
+  /**
+   * Transcript Get
+   */
+  async v1TranscriptGet(
+    requestParameters: V1TranscriptGetRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction,
+  ): Promise<GetTranscript> {
+    const response = await this.v1TranscriptGetRaw(
       requestParameters,
       initOverrides,
     );
@@ -198,8 +247,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Get Audio
    */
-  async transcriptGetAudioV1TranscriptsTranscriptIdAudioGetRaw(
+  async v1TranscriptGetAudioRaw(
-    requestParameters: TranscriptGetAudioV1TranscriptsTranscriptIdAudioGetRequest,
+    requestParameters: V1TranscriptGetAudioRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<any>> {
     if (
@@ -208,7 +257,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptGetAudioV1TranscriptsTranscriptIdAudioGet.",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptGetAudio.",
       );
     }
 
@@ -239,12 +288,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Get Audio
    */
-  async transcriptGetAudioV1TranscriptsTranscriptIdAudioGet(
+  async v1TranscriptGetAudio(
-    requestParameters: TranscriptGetAudioV1TranscriptsTranscriptIdAudioGetRequest,
+    requestParameters: V1TranscriptGetAudioRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<any> {
-    const response =
+    const response = await this.v1TranscriptGetAudioRaw(
-      await this.transcriptGetAudioV1TranscriptsTranscriptIdAudioGetRaw(
       requestParameters,
       initOverrides,
     );
@@ -254,8 +302,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Get Topics
    */
-  async transcriptGetTopicsV1TranscriptsTranscriptIdTopicsGetRaw(
+  async v1TranscriptGetTopicsRaw(
-    requestParameters: TranscriptGetTopicsV1TranscriptsTranscriptIdTopicsGetRequest,
+    requestParameters: V1TranscriptGetTopicsRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<any>> {
     if (
@@ -264,7 +312,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptGetTopicsV1TranscriptsTranscriptIdTopicsGet.",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptGetTopics.",
       );
     }
 
@@ -295,65 +343,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Get Topics
    */
-  async transcriptGetTopicsV1TranscriptsTranscriptIdTopicsGet(
+  async v1TranscriptGetTopics(
-    requestParameters: TranscriptGetTopicsV1TranscriptsTranscriptIdTopicsGetRequest,
+    requestParameters: V1TranscriptGetTopicsRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<any> {
-    const response =
+    const response = await this.v1TranscriptGetTopicsRaw(
-      await this.transcriptGetTopicsV1TranscriptsTranscriptIdTopicsGetRaw(
-        requestParameters,
-        initOverrides,
-      );
-    return await response.value();
-  }
-
-  /**
-   * Transcript Get
-   */
-  async transcriptGetV1TranscriptsTranscriptIdGetRaw(
-    requestParameters: TranscriptGetV1TranscriptsTranscriptIdGetRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<runtime.ApiResponse<GetTranscript>> {
-    if (
-      requestParameters.transcriptId === null ||
-      requestParameters.transcriptId === undefined
-    ) {
-      throw new runtime.RequiredError(
-        "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptGetV1TranscriptsTranscriptIdGet.",
-      );
-    }
-
-    const queryParameters: any = {};
-
-    const headerParameters: runtime.HTTPHeaders = {};
-
-    const response = await this.request(
-      {
-        path: `/v1/transcripts/{transcript_id}`.replace(
-          `{${"transcript_id"}}`,
-          encodeURIComponent(String(requestParameters.transcriptId)),
-        ),
-        method: "GET",
-        headers: headerParameters,
-        query: queryParameters,
-      },
-      initOverrides,
-    );
-
-    return new runtime.JSONApiResponse(response, (jsonValue) =>
-      GetTranscriptFromJSON(jsonValue),
-    );
-  }
-
-  /**
-   * Transcript Get
-   */
-  async transcriptGetV1TranscriptsTranscriptIdGet(
-    requestParameters: TranscriptGetV1TranscriptsTranscriptIdGetRequest,
-    initOverrides?: RequestInit | runtime.InitOverrideFunction,
-  ): Promise<GetTranscript> {
-    const response = await this.transcriptGetV1TranscriptsTranscriptIdGetRaw(
       requestParameters,
       initOverrides,
     );
@@ -363,8 +357,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Get Websocket Events
    */
-  async transcriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGetRaw(
+  async v1TranscriptGetWebsocketEventsRaw(
-    requestParameters: TranscriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGetRequest,
+    requestParameters: V1TranscriptGetWebsocketEventsRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<any>> {
     if (
@@ -373,7 +367,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGet.",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptGetWebsocketEvents.",
       );
     }
 
@@ -404,12 +398,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Get Websocket Events
    */
-  async transcriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGet(
+  async v1TranscriptGetWebsocketEvents(
-    requestParameters: TranscriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGetRequest,
+    requestParameters: V1TranscriptGetWebsocketEventsRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<any> {
-    const response =
+    const response = await this.v1TranscriptGetWebsocketEventsRaw(
-      await this.transcriptGetWebsocketEventsV1TranscriptsTranscriptIdEventsGetRaw(
       requestParameters,
       initOverrides,
     );
@@ -419,8 +412,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Record Webrtc
    */
-  async transcriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPostRaw(
+  async v1TranscriptRecordWebrtcRaw(
-    requestParameters: TranscriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPostRequest,
+    requestParameters: V1TranscriptRecordWebrtcRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<any>> {
     if (
@@ -429,7 +422,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPost.",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptRecordWebrtc.",
       );
     }
 
@@ -439,7 +432,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "rtcOffer",
-        "Required parameter requestParameters.rtcOffer was null or undefined when calling transcriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPost.",
+        "Required parameter requestParameters.rtcOffer was null or undefined when calling v1TranscriptRecordWebrtc.",
       );
     }
 
@@ -473,12 +466,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Record Webrtc
    */
-  async transcriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPost(
+  async v1TranscriptRecordWebrtc(
-    requestParameters: TranscriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPostRequest,
+    requestParameters: V1TranscriptRecordWebrtcRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<any> {
-    const response =
+    const response = await this.v1TranscriptRecordWebrtcRaw(
-      await this.transcriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPostRaw(
       requestParameters,
       initOverrides,
     );
@@ -488,8 +480,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Update
    */
-  async transcriptUpdateV1TranscriptsTranscriptIdPatchRaw(
+  async v1TranscriptUpdateRaw(
-    requestParameters: TranscriptUpdateV1TranscriptsTranscriptIdPatchRequest,
+    requestParameters: V1TranscriptUpdateRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<GetTranscript>> {
     if (
@@ -498,7 +490,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "transcriptId",
-        "Required parameter requestParameters.transcriptId was null or undefined when calling transcriptUpdateV1TranscriptsTranscriptIdPatch.",
+        "Required parameter requestParameters.transcriptId was null or undefined when calling v1TranscriptUpdate.",
       );
     }
 
@@ -508,7 +500,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "updateTranscript",
-        "Required parameter requestParameters.updateTranscript was null or undefined when calling transcriptUpdateV1TranscriptsTranscriptIdPatch.",
+        "Required parameter requestParameters.updateTranscript was null or undefined when calling v1TranscriptUpdate.",
       );
     }
 
@@ -540,12 +532,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcript Update
    */
-  async transcriptUpdateV1TranscriptsTranscriptIdPatch(
+  async v1TranscriptUpdate(
-    requestParameters: TranscriptUpdateV1TranscriptsTranscriptIdPatchRequest,
+    requestParameters: V1TranscriptUpdateRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<GetTranscript> {
-    const response =
+    const response = await this.v1TranscriptUpdateRaw(
-      await this.transcriptUpdateV1TranscriptsTranscriptIdPatchRaw(
       requestParameters,
       initOverrides,
     );
@@ -555,8 +546,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcripts Create
    */
-  async transcriptsCreateV1TranscriptsPostRaw(
+  async v1TranscriptsCreateRaw(
-    requestParameters: TranscriptsCreateV1TranscriptsPostRequest,
+    requestParameters: V1TranscriptsCreateRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<GetTranscript>> {
     if (
@@ -565,7 +556,7 @@ export class DefaultApi extends runtime.BaseAPI {
     ) {
       throw new runtime.RequiredError(
         "createTranscript",
-        "Required parameter requestParameters.createTranscript was null or undefined when calling transcriptsCreateV1TranscriptsPost.",
+        "Required parameter requestParameters.createTranscript was null or undefined when calling v1TranscriptsCreate.",
       );
     }
 
@@ -594,11 +585,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcripts Create
    */
-  async transcriptsCreateV1TranscriptsPost(
+  async v1TranscriptsCreate(
-    requestParameters: TranscriptsCreateV1TranscriptsPostRequest,
+    requestParameters: V1TranscriptsCreateRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<GetTranscript> {
-    const response = await this.transcriptsCreateV1TranscriptsPostRaw(
+    const response = await this.v1TranscriptsCreateRaw(
       requestParameters,
       initOverrides,
     );
@@ -608,8 +599,8 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcripts List
    */
-  async transcriptsListV1TranscriptsGetRaw(
+  async v1TranscriptsListRaw(
-    requestParameters: TranscriptsListV1TranscriptsGetRequest,
+    requestParameters: V1TranscriptsListRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<runtime.ApiResponse<PageGetTranscript>> {
     const queryParameters: any = {};
@@ -642,11 +633,11 @@ export class DefaultApi extends runtime.BaseAPI {
   /**
    * Transcripts List
    */
-  async transcriptsListV1TranscriptsGet(
+  async v1TranscriptsList(
-    requestParameters: TranscriptsListV1TranscriptsGetRequest = {},
+    requestParameters: V1TranscriptsListRequest = {},
     initOverrides?: RequestInit | runtime.InitOverrideFunction,
   ): Promise<PageGetTranscript> {
-    const response = await this.transcriptsListV1TranscriptsGetRaw(
+    const response = await this.v1TranscriptsListRaw(
       requestParameters,
       initOverrides,
     );

www/app/components/transcript.js

@@ -26,7 +26,7 @@ const useTranscript = () => {
     );
 
     api
-      .transcriptsCreateV1TranscriptsPost(requestParameters)
+      .v1TranscriptsCreate(requestParameters)
       .then((result) => {
         setResponse(result);
         setLoading(false);

www/app/components/webrtc.js

@@ -31,9 +31,7 @@ const useWebRTC = (stream, transcriptId) => {
         };
 
         api
-          .transcriptRecordWebrtcV1TranscriptsTranscriptIdRecordWebrtcPost(
+          .v1TranscriptRecordWebrtc(requestParameters)
-            requestParameters,
-          )
           .then((answer) => {
             peer.signal(answer);
           })

www/package.json

@@ -7,7 +7,8 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "format": "prettier --write ."
+    "format": "prettier --write .",
+    "openapi": "openapi-generator-cli generate -i http://localhost:1250/openapi.json -g typescript-fetch -o app/api && yarn format"
   },
   "dependencies": {
     "@fortawesome/fontawesome-svg-core": "^6.4.0",
@@ -19,7 +20,6 @@
     "fontawesome": "^5.6.3",
     "jest-worker": "^29.6.2",
     "next": "^13.4.9",
-    "openapi-generator": "^0.1.39",
     "postcss": "8.4.25",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
@@ -37,6 +37,7 @@
   "author": "Andreas <andreas@monadical.com>",
   "license": "All Rights Reserved",
   "devDependencies": {
+    "@openapitools/openapi-generator-cli": "^2.7.0",
     "@types/react": "18.2.20",
     "prettier": "^3.0.0"
   }