chore: update api paths

useVenice · Nov 26, 2023 · 9991dd2 · 9991dd2
1 parent 7ab9379
commit 9991dd2
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 55 deletions.
diff --git a/kits/sdk/venice.oas.d.ts b/kits/sdk/venice.oas.d.ts
diff --git a/kits/sdk/venice.oas.json b/kits/sdk/venice.oas.json
diff --git a/packages/engine-backend/router/connectorConfigRouter.ts b/packages/engine-backend/router/connectorConfigRouter.ts
@@ -13,7 +13,7 @@ import {adminProcedure, protectedProcedure, trpc} from './_base'
 
 export {type inferProcedureInput} from '@trpc/server'
 
-const tags = ['Connector Configs']
+const tags = ['Core']
 
 export const connectorConfigRouter = trpc.router({
   adminListConnectorConfigs: adminProcedure

diff --git a/packages/engine-backend/router/connectorRouter.ts b/packages/engine-backend/router/connectorRouter.ts
@@ -13,7 +13,7 @@ export const connectorRouter = trpc.router({
         method: 'GET',
         path: '/connector',
         tags,
-        summary: 'Get catalog of all available connectors',
+        description: 'Get catalog of all available connectors',
       },
     })
     .input(z.object({includeOas: z.boolean().optional()}).optional())

diff --git a/packages/engine-backend/router/endUserRouter.ts b/packages/engine-backend/router/endUserRouter.ts
@@ -112,7 +112,7 @@ const tags = ['Connect']
 /** TODO: Modify this so that admin user can execute it... not just endUser */
 export const endUserRouter = trpc.router({
   createConnectToken: protectedProcedure
-    .meta({openapi: {method: 'POST', path: '/core/connect-token', tags}})
+    .meta({openapi: {method: 'POST', path: '/connect/token', tags}})
     .input(endUserRouterSchema.createConnectToken.input)
     .output(z.object({token: z.string()}))
     .mutation(({input: {validityInSeconds, ...input}, ctx}) => ({
@@ -121,7 +121,7 @@ export const endUserRouter = trpc.router({
       }),
     })),
   createMagicLink: protectedProcedure
-    .meta({openapi: {method: 'POST', path: '/core/magic-link', tags}})
+    .meta({openapi: {method: 'POST', path: '/connect/magic-link', tags}})
     .input(endUserRouterSchema.createMagicLink.input)
     .output(z.object({url: z.string()}))
     .mutation(({input: {endUserId, validityInSeconds, ...params}, ctx}) => {

diff --git a/packages/engine-backend/router/pipelineRouter.ts b/packages/engine-backend/router/pipelineRouter.ts
@@ -7,7 +7,7 @@ import {zListParams} from './_schemas'
 
 export {type inferProcedureInput} from '@trpc/server'
 
-const tags = ['Pipeline']
+const tags = ['Core']
 
 export const pipelineRouter = trpc.router({
   listPipelines: protectedProcedure

diff --git a/packages/engine-backend/router/resourceRouter.ts b/packages/engine-backend/router/resourceRouter.ts
@@ -18,12 +18,14 @@ import {zListParams} from './_schemas'
 
 export {type inferProcedureInput} from '@trpc/server'
 
-const tags = ['Resource']
+const tags = ['Core']
 
 export const resourceRouter = trpc.router({
   // TODO: maybe we should allow resourceId to be part of the path rather than only in the headers
+
+  // Should this really be part of the resource router? or left elsewhere?
   passthrough: remoteProcedure
-    .meta({openapi: {method: 'POST', path: '/core/passthrough', tags}}) // Where do we put this?
+    .meta({openapi: {method: 'POST', path: '/passthrough', tags: ['Internal']}}) // Where do we put this?
     .input(zPassthroughInput)
     .output(z.any())
     .mutation(async ({input, ctx}) => {

diff --git a/verticals/vertical-accounting/accounting.ts b/verticals/vertical-accounting/accounting.ts
@@ -1,16 +1,16 @@
 import type {MaybePromise} from '@usevenice/util'
-import {objectEntries, R, startCase} from '@usevenice/util'
+import {objectEntries, R} from '@usevenice/util'
+import type {
+  PaginatedOutput,
+  Pagination,
+  VerticalRouterOpts,
+} from '@usevenice/vdk'
 import {
   paginatedOutput,
   proxyListRemoteRedux,
   z,
   zPaginationParams,
 } from '@usevenice/vdk'
-import type {
-  PaginatedOutput,
-  Pagination,
-  VerticalRouterOpts,
-} from '@usevenice/vdk'
 import type {
   ConnectorSchemas,
   ConnHelpers,
@@ -80,7 +80,7 @@ export function createAccountingRouter(opts: VerticalRouterOpts) {
           openapi: {
             method: 'GET',
             path: `/verticals/${vertical}/${entityName}`,
-            tags: [`Verticals/${startCase(vertical)}`],
+            tags: ['Verticals'],
           },
         })
         .input(zPaginationParams.nullish())