archive-gh-me/openapi-typescript-codegen
1
0
Fork 0
mirror of https://github.com/ferdikoomen/openapi-typescript-codegen.git synced 2025-12-08 20:16:21 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #452 from raman-savitski/master

Browse Source 
Backquote/backtick symbol (`) is not escaped correctly
This commit is contained in:
Ferdi Koomen 2020-11-28 10:18:31 +01:00 committed by GitHub
commit f582891e96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/openApi/v2/parser/escapeDescription.spec.ts Normal file
View File

@ -0,0 +1,13 @@
import { escapeDescription } from './escapeDescription';
describe('escapeDescription', () => {
it('should escape', () => {
expect(escapeDescription('foo `test` bar')).toEqual('foo \\`test\\` bar');
});
it('should not escape', () => {
expect(escapeDescription('')).toEqual('');
expect(escapeDescription('fooBar')).toEqual('fooBar');
expect(escapeDescription('foo \\`test\\` bar')).toEqual('foo \\`test\\` bar');
});
});

3
src/openApi/v2/parser/escapeDescription.ts Normal file
View File

@ -0,0 +1,3 @@
export function escapeDescription(value: string): string {
return value.replace(/([^\\])`/g, '$1\\`');
}

3
src/openApi/v2/parser/getOperationErrors.ts
View File

@ -1,5 +1,6 @@
import type { OperationError } from '../../../client/interfaces/OperationError';
import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
import { escapeDescription } from './escapeDescription';
export function getOperationErrors(operationResponses: OperationResponse[]): OperationError[] {
return operationResponses
@ -8,6 +9,6 @@ export function getOperationErrors(operationResponses: OperationResponse[]): Ope
})
.map(response => ({
code: response.code,
description: response.description!,
description: escapeDescription(response.description!),
}));
}

13
src/openApi/v3/parser/escapeDescription.spec.ts Normal file
View File

@ -0,0 +1,13 @@
import { escapeDescription } from './escapeDescription';
describe('escapeDescription', () => {
it('should escape', () => {
expect(escapeDescription('foo `test` bar')).toEqual('foo \\`test\\` bar');
});
it('should not escape', () => {
expect(escapeDescription('')).toEqual('');
expect(escapeDescription('fooBar')).toEqual('fooBar');
expect(escapeDescription('foo \\`test\\` bar')).toEqual('foo \\`test\\` bar');
});
});

3
src/openApi/v3/parser/escapeDescription.ts Normal file
View File

@ -0,0 +1,3 @@
export function escapeDescription(value: string): string {
return value.replace(/([^\\])`/g, '$1\\`');
}

3
src/openApi/v3/parser/getOperationErrors.ts
View File

@ -1,5 +1,6 @@
import type { OperationError } from '../../../client/interfaces/OperationError';
import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
import { escapeDescription } from './escapeDescription';
export function getOperationErrors(operationResponses: OperationResponse[]): OperationError[] {
return operationResponses
@ -8,6 +9,6 @@ export function getOperationErrors(operationResponses: OperationResponse[]): Ope
})
.map(response => ({
code: response.code,
description: response.description!,
description: escapeDescription(response.description!),
}));
}