Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 2acfa13

Browse files
authored
Fix: Slugify operation id (#307)
1 parent 018fbb4 commit 2acfa13

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

src/generator/paths.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const getOpenApiPathsObject = (
1515
const procedures = appRouter._def.procedures as OpenApiProcedureRecord;
1616

1717
forEachOpenApiProcedure(procedures, ({ path: procedurePath, type, procedure, openapi }) => {
18-
const operationId = `${type}.${procedurePath}`;
18+
const procedureName = `${type}.${procedurePath}`;
1919

2020
try {
2121
if (type === 'subscription') {
@@ -59,7 +59,7 @@ export const getOpenApiPathsObject = (
5959
pathsObject[path] = {
6060
...pathsObject[path],
6161
[httpMethod]: {
62-
operationId,
62+
operationId: procedurePath.replace(/\./g, '-'),
6363
summary,
6464
description,
6565
tags: tags,
@@ -85,7 +85,7 @@ export const getOpenApiPathsObject = (
8585
};
8686
} catch (error: any) {
8787
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
88-
error.message = `[${operationId}] - ${error.message}`;
88+
error.message = `[${procedureName}] - ${error.message}`;
8989
throw error;
9090
}
9191
});

test/generator.test.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ describe('generator', () => {
557557
"/users": Object {
558558
"get": Object {
559559
"description": undefined,
560-
"operationId": "query.readUsers",
560+
"operationId": "readUsers",
561561
"parameters": Array [],
562562
"requestBody": undefined,
563563
"responses": Object {
@@ -597,7 +597,7 @@ describe('generator', () => {
597597
},
598598
"post": Object {
599599
"description": undefined,
600-
"operationId": "mutation.createUser",
600+
"operationId": "createUser",
601601
"parameters": Array [],
602602
"requestBody": Object {
603603
"content": Object {
@@ -654,7 +654,7 @@ describe('generator', () => {
654654
"/users/{id}": Object {
655655
"delete": Object {
656656
"description": undefined,
657-
"operationId": "mutation.deleteUser",
657+
"operationId": "deleteUser",
658658
"parameters": Array [
659659
Object {
660660
"description": undefined,
@@ -686,7 +686,7 @@ describe('generator', () => {
686686
},
687687
"get": Object {
688688
"description": undefined,
689-
"operationId": "query.readUser",
689+
"operationId": "readUser",
690690
"parameters": Array [
691691
Object {
692692
"description": undefined,
@@ -733,7 +733,7 @@ describe('generator', () => {
733733
},
734734
"patch": Object {
735735
"description": undefined,
736-
"operationId": "mutation.updateUser",
736+
"operationId": "updateUser",
737737
"parameters": Array [
738738
Object {
739739
"description": undefined,
@@ -905,7 +905,7 @@ describe('generator', () => {
905905
expect(openApiDocument.paths['/user']!.post!).toMatchInlineSnapshot(`
906906
Object {
907907
"description": undefined,
908-
"operationId": "mutation.createUser",
908+
"operationId": "createUser",
909909
"parameters": Array [],
910910
"requestBody": Object {
911911
"content": Object {
@@ -974,7 +974,7 @@ describe('generator', () => {
974974
expect(openApiDocument.paths['/user']!.get!).toMatchInlineSnapshot(`
975975
Object {
976976
"description": undefined,
977-
"operationId": "query.getUser",
977+
"operationId": "getUser",
978978
"parameters": Array [
979979
Object {
980980
"description": "User ID",
@@ -2296,7 +2296,7 @@ describe('generator', () => {
22962296
"/procedure": Object {
22972297
"get": Object {
22982298
"description": undefined,
2299-
"operationId": "query.procedure",
2299+
"operationId": "procedure",
23002300
"parameters": Array [
23012301
Object {
23022302
"description": undefined,
@@ -2341,7 +2341,7 @@ describe('generator', () => {
23412341
"/router/procedure": Object {
23422342
"get": Object {
23432343
"description": undefined,
2344-
"operationId": "query.router.procedure",
2344+
"operationId": "router-procedure",
23452345
"parameters": Array [
23462346
Object {
23472347
"description": undefined,
@@ -2386,7 +2386,7 @@ describe('generator', () => {
23862386
"/router/router/procedure": Object {
23872387
"get": Object {
23882388
"description": undefined,
2389-
"operationId": "query.router.router.procedure",
2389+
"operationId": "router-router-procedure",
23902390
"parameters": Array [
23912391
Object {
23922392
"description": undefined,

0 commit comments

Comments
 (0)