Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-07 13:44:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: definition name util

Browse Source
This commit is contained in:
Oprysk 2022-01-19 19:43:23 +02:00
parent 3e47932754
commit 384133f114
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/utils/__tests__/openapi.test.ts
View File

@ -12,6 +12,7 @@ import {
sortByRequired, sortByRequired,
humanizeNumberRange, humanizeNumberRange,
getContentWithLegacyExamples, getContentWithLegacyExamples,
getDefinitionName,
} from '../'; } from '../';
import { FieldModel, OpenAPIParser, RedocNormalizedOptions } from '../../services'; import { FieldModel, OpenAPIParser, RedocNormalizedOptions } from '../../services';
@ -1269,4 +1270,14 @@ describe('Utils', () => {
expect(content['text/plain']).toStrictEqual(info.content['text/plain']); expect(content['text/plain']).toStrictEqual(info.content['text/plain']);
}); });
}); });
describe('getDefinitionName', () => {
test('should return the name if pointer match regex', () => {
expect(getDefinitionName('#/components/schemas/Call')).toEqual('Call');
});
test("should return the `undefined` if pointer not match regex or it's absent", () => {
expect(getDefinitionName('#/test/path/Call')).toBeUndefined();
expect(getDefinitionName()).toBeUndefined();
});
});
}); });

9
src/utils/openapi.ts
View File

@ -384,14 +384,15 @@ export function langFromMime(contentType: string): string {
return 'clike'; return 'clike';
} }
const DEFINITION_NAME_REGEX = /^#\/components\/(schemas|pathItems)\/([^/]+)$/;
export function isNamedDefinition(pointer?: string): boolean { export function isNamedDefinition(pointer?: string): boolean {
return /^#\/components\/(schemas|pathItems)\/[^\/]+$/.test(pointer || ''); return DEFINITION_NAME_REGEX.test(pointer || '');
} }
export function getDefinitionName(pointer?: string): string | undefined { export function getDefinitionName(pointer?: string): string | undefined {
if (!pointer) return undefined; const [name] = pointer?.match(DEFINITION_NAME_REGEX)?.reverse() || [];
const match = pointer.match(/^#\/components\/(schemas|pathItems)\/([^\/]+)$/); return name;
return match === null ? undefined : match[1];
} }
function humanizeMultipleOfConstraint(multipleOf: number | undefined): string | undefined { function humanizeMultipleOfConstraint(multipleOf: number | undefined): string | undefined {