Merge pull request #524 from panoratech/speakeasy-yaml

🎨 Improve operationIds for SDK generation
panoratech · Jun 21, 2024 · 9ad0047 · 9ad0047
2 parents 7904c4d + 5618391
commit 9ad0047
Show file tree

Hide file tree

Showing 8 changed files with 14,549 additions and 57 deletions.
diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -164,47 +164,47 @@ services:
       retries: 5
       start_period: 10s
 
-  webapp-nextjs:
-    build:
-      dockerfile: ./apps/client-ts/Dockerfile.dev
-      context: ./
-      args:
-        VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN}
-        VITE_FRONTEND_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN}
-    environment:
-      NEXT_PUBLIC_DISTRIBUTION: ${DISTRIBUTION}
-      NEXT_PUBLIC_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN}
-      NEXT_PUBLIC_MAGIC_LINK_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN}
-      NEXT_PUBLIC_WEBAPP_DOMAIN: ${NEXT_PUBLIC_WEBAPP_DOMAIN}
-    restart: unless-stopped
-    ports:
-      - 80:8090
-    depends_on:
-      api:
-        condition: service_healthy
-    volumes:
-      - .:/app
-    networks:
-      - backend
-      - frontend
+  # webapp-nextjs:
+  #   build:
+  #     dockerfile: ./apps/client-ts/Dockerfile.dev
+  #     context: ./
+  #     args:
+  #       VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN}
+  #       VITE_FRONTEND_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN}
+  #   environment:
+  #     NEXT_PUBLIC_DISTRIBUTION: ${DISTRIBUTION}
+  #     NEXT_PUBLIC_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN}
+  #     NEXT_PUBLIC_MAGIC_LINK_DOMAIN: ${NEXT_PUBLIC_MAGIC_LINK_DOMAIN}
+  #     NEXT_PUBLIC_WEBAPP_DOMAIN: ${NEXT_PUBLIC_WEBAPP_DOMAIN}
+  #   restart: unless-stopped
+  #   ports:
+  #     - 80:8090
+  #   depends_on:
+  #     api:
+  #       condition: service_healthy
+  #   volumes:
+  #     - .:/app
+  #   networks:
+  #     - backend
+  #     - frontend
 
-  magic-link-frontend:
-    build:
-      dockerfile: ./apps/magic-link/Dockerfile.dev
-      context: ./
-      args:
-        VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN}
-    restart: always
-    ports:
-      - 81:5173
-    depends_on:
-      api:
-        condition: service_healthy
-    networks:
-      - backend
-      - frontend
-    volumes:
-      - .:/app
+  # magic-link-frontend:
+  #   build:
+  #     dockerfile: ./apps/magic-link/Dockerfile.dev
+  #     context: ./
+  #     args:
+  #       VITE_BACKEND_DOMAIN: ${NEXT_PUBLIC_BACKEND_DOMAIN}
+  #   restart: always
+  #   ports:
+  #     - 81:5173
+  #   depends_on:
+  #     api:
+  #       condition: service_healthy
+  #   networks:
+  #     - backend
+  #     - frontend
+  #   volumes:
+  #     - .:/app
 
   # ngrok:
   #   image: ngrok/ngrok:latest
@@ -223,14 +223,14 @@ services:
   #       condition: service_healthy
   #   network_mode: "host"
 
-  docs:
-    build:
-      dockerfile: ./Dockerfile.dev
-      context: ./docs/
-    ports:
-      - 911:3000
-    volumes:
-      - ./docs/:/app
+  # docs:
+  #   build:
+  #     dockerfile: ./Dockerfile.dev
+  #     context: ./docs/
+  #   ports:
+  #     - 911:3000
+  #   volumes:
+  #     - ./docs/:/app
 
 networks:
   frontend:

diff --git a/packages/api/src/app.controller.ts b/packages/api/src/app.controller.ts
@@ -13,7 +13,6 @@ export class AppController {
     this.logger.setContext(AppController.name);
   }
 
-  @ApiOperation({ operationId: 'getHello' })
   @Get()
   hello(): string {
     return this.appService.getHello();

diff --git a/packages/api/src/crm/contact/contact.controller.ts b/packages/api/src/crm/contact/contact.controller.ts
@@ -44,8 +44,8 @@ export class ContactController {
   }
 
   @ApiOperation({
-    operationId: 'getCrmContacts',
-    summary: 'List a batch of CRM Contacts',
+    operationId: 'listCrmContacts',
+    summary: 'List CRM Contacts',
   })
   @ApiHeader({
     name: 'x-connection-token',

diff --git a/packages/api/src/main.ts b/packages/api/src/main.ts
@@ -6,6 +6,8 @@ import * as fs from 'fs';
 import * as cookieParser from 'cookie-parser';
 import { useContainer } from 'class-validator';
 import * as cors from 'cors';
+import * as yaml from 'js-yaml';
+
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
@@ -25,7 +27,7 @@ async function bootstrap() {
   useContainer(app.select(AppModule), { fallbackOnErrors: true });
 
   SwaggerModule.setup('docs', app, document);
-  //fs.writeFileSync('./swagger/swagger-spec.yaml', yaml.dump(document));
+  fs.writeFileSync('./swagger/swagger-spec.yaml', yaml.dump(document));
   fs.writeFileSync(
     './swagger/swagger-spec.json',
     JSON.stringify(document, null, 2),

diff --git a/packages/api/swagger/extended_specs.yaml b/packages/api/swagger/extended_specs.yaml
@@ -0,0 +1,7 @@
+x-speakeasy-name-override:
+  - operationId: ^get.*
+    methodNameOverride: retrieve
+  - operationId: ^list.*
+    methodNameOverride: list
+  - operationId: ^new.*
+    methodNameOverride: create
diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json
@@ -3,8 +3,7 @@
   "paths": {
     "/": {
       "get": {
-        "operationId": "getHello",
-        "summary": "",
+        "operationId": "AppController_hello",
         "parameters": [],
         "responses": {
           "200": {
@@ -1658,8 +1657,8 @@
     },
     "/crm/contacts": {
       "get": {
-        "operationId": "getCrmContacts",
-        "summary": "List a batch of CRM Contacts",
+        "operationId": "listCrmContacts",
+        "summary": "List CRM Contacts",
         "parameters": [
           {
             "name": "x-connection-token",