@redocly/openapi-docs 3.24.1 → 3.25.0-next.1

package/lib/services/code-samples/__tests__/convertSampleToString.test.js

@@ -1,116 +0,0 @@
-import { MediaTypes } from '../../../constants';
-import { convertSampleToString } from '../index.js';
-describe('convertSampleToString', () => {
-    describe('EVENT_STREAM', () => {
-        it('should convert objects to SSE format', () => {
-            const obj = {
-                event: 'message',
-                data: 'Hello World',
-                id: '123',
-                retry: 3000,
-            };
-            const result = convertSampleToString(obj, MediaTypes.EVENT_STREAM);
-            expect(result).toBe('event: message\ndata: Hello World\nid: 123\nretry: 3000');
-        });
-        it('should convert object with only data field', () => {
-            const obj = { data: 'test data' };
-            const result = convertSampleToString(obj, MediaTypes.EVENT_STREAM);
-            expect(result).toBe('data: test data');
-        });
-        it('should handle multi-line data', () => {
-            const obj = { data: 'line1\nline2\nline3' };
-            const result = convertSampleToString(obj, MediaTypes.EVENT_STREAM);
-            expect(result).toBe('data: line1\ndata: line2\ndata: line3');
-        });
-        it('should convert object data as JSON', () => {
-            const obj = { data: { key: 'value', number: 123 } };
-            const result = convertSampleToString(obj, MediaTypes.EVENT_STREAM);
-            expect(result).toBe('data: {"key":"value","number":123}');
-        });
-        it('should not convert non-object values', () => {
-            expect(convertSampleToString('string', MediaTypes.EVENT_STREAM)).toBe('string');
-            expect(convertSampleToString(42, MediaTypes.EVENT_STREAM)).toBe(42);
-            expect(convertSampleToString(null, MediaTypes.EVENT_STREAM)).toBe(null);
-        });
-    });
-    describe('JSONL', () => {
-        it('should convert objects to JSON lines', () => {
-            const obj = { name: 'test', value: 123 };
-            const result = convertSampleToString(obj, MediaTypes.JSONL);
-            expect(result).toBe('{"name":"test","value":123}');
-        });
-        it('should not convert non-object values', () => {
-            expect(convertSampleToString('string', MediaTypes.JSONL)).toBe('string');
-            expect(convertSampleToString(42, MediaTypes.JSONL)).toBe(42);
-            expect(convertSampleToString(null, MediaTypes.JSONL)).toBe(null);
-        });
-    });
-    describe('NDJSON', () => {
-        it('should convert objects to JSON lines', () => {
-            const obj = { name: 'test', value: 123 };
-            const result = convertSampleToString(obj, MediaTypes.NDJSON);
-            expect(result).toBe('{"name":"test","value":123}');
-        });
-        it('should not convert non-object values', () => {
-            expect(convertSampleToString('string', MediaTypes.NDJSON)).toBe('string');
-            expect(convertSampleToString(42, MediaTypes.NDJSON)).toBe(42);
-            expect(convertSampleToString(null, MediaTypes.NDJSON)).toBe(null);
-        });
-    });
-    describe('JSON_SEQ', () => {
-        it('should convert objects to JSON-Seq format with record separator', () => {
-            const obj = { name: 'test', value: 123 };
-            const result = convertSampleToString(obj, MediaTypes.JSON_SEQ);
-            expect(result).toBe('0x1E{"name":"test","value":123}0x0A');
-        });
-        it('should convert objects with repeat flag to 3 duplicated items', () => {
-            const obj = { name: 'test', value: 123 };
-            const result = convertSampleToString(obj, MediaTypes.JSON_SEQ, undefined, true);
-            const expected = '0x1E{"name":"test","value":123}0x0A\n0x1E{"name":"test","value":123}0x0A\n0x1E{"name":"test","value":123}0x0A';
-            expect(result).toBe(expected);
-        });
-        it('should not convert non-object values', () => {
-            expect(convertSampleToString('string', MediaTypes.JSON_SEQ)).toBe('string');
-            expect(convertSampleToString(42, MediaTypes.JSON_SEQ)).toBe(42);
-            expect(convertSampleToString(null, MediaTypes.JSON_SEQ)).toBe(null);
-        });
-    });
-    describe('MULTIPART_MIXED', () => {
-        it('should convert objects to multipart format', () => {
-            const obj = { name: 'test' };
-            const result = convertSampleToString(obj, MediaTypes.MULTIPART_MIXED);
-            expect(typeof result).toBe('string');
-            expect(result).toContain('Content-Type: application/json');
-            expect(result).toContain('boundary-separator');
-            expect(result).toContain('"name": "test"');
-        });
-        it('should convert arrays to multipart format', () => {
-            const arr = [{ name: 'test1' }, { name: 'test2' }];
-            const result = convertSampleToString(arr, MediaTypes.MULTIPART_MIXED);
-            expect(typeof result).toBe('string');
-            expect(result).toContain('boundary-separator');
-        });
-        it('should not convert null values', () => {
-            const result = convertSampleToString(null, MediaTypes.MULTIPART_MIXED);
-            expect(result).toBe(null);
-        });
-        it('should handle primitive values', () => {
-            const result = convertSampleToString('test', MediaTypes.MULTIPART_MIXED);
-            expect(typeof result).toBe('string');
-            expect(result).toContain('boundary-separator');
-        });
-    });
-    describe('non-streaming media types', () => {
-        it('should not convert for application/json', () => {
-            const obj = { name: 'test' };
-            const result = convertSampleToString(obj, MediaTypes.JSON);
-            expect(result).toBe(obj);
-        });
-        it('should not convert for text/plain', () => {
-            const value = 'test string';
-            const result = convertSampleToString(value, 'text/plain');
-            expect(result).toBe(value);
-        });
-    });
-});
-//# sourceMappingURL=convertSampleToString.test.js.map

package/lib/services/code-samples/__tests__/generator-data-value.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/services/code-samples/__tests__/generator-data-value.test.js

@@ -1,277 +0,0 @@
-import { getOperation } from '../../../models/index.js';
-import { getCodeSample } from '../generator.js';
-import { OpenAPIParser } from '../../OpenAPIParser.js';
-import { normalizeOptions } from '../../config-options/normalizeOptions.js';
-describe('getDataRequest with dataValue examples from OpenAPI 3.2', () => {
-    const testDataValueSpec = {
-        openapi: '3.2.0',
-        info: { version: '1.1.0', title: 'Redocly Museum API' },
-        servers: [{ url: 'https://api.fake-museum-example.com/v1.1' }],
-        paths: {
-            '/example-tests/data-value': {
-                post: {
-                    summary: 'Test dataValue field (OpenAPI 3.2)',
-                    description: 'Demonstrates the use of dataValue field which contains data in its natural form for validation.',
-                    operationId: 'testDataValue',
-                    requestBody: {
-                        required: true,
-                        content: {
-                            'application/json': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    json_data: {
-                                        summary: 'dataValue with JSON object',
-                                        description: 'Uses dataValue to show data in its natural form for validation',
-                                        value: {},
-                                        dataValue: {
-                                            name: 'Museum Visitor',
-                                            value: 'premium',
-                                            count: 5,
-                                            enabled: true,
-                                        },
-                                    },
-                                },
-                            },
-                            'application/xml': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    xml_data: {
-                                        summary: 'dataValue for XML content',
-                                        description: 'Data structure that will be serialized as XML',
-                                        value: {},
-                                        dataValue: {
-                                            name: 'Museum Visitor',
-                                            value: 'premium',
-                                            count: 5,
-                                        },
-                                    },
-                                },
-                            },
-                            'application/x-www-form-urlencoded': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    url_encoded_data: {
-                                        summary: 'dataValue for URL-encoded content',
-                                        description: 'Data structure that will be serialized as URL-encoded form',
-                                        value: {},
-                                        dataValue: {
-                                            name: 'Museum Visitor',
-                                            value: 'premium',
-                                            count: 5,
-                                            enabled: true,
-                                        },
-                                    },
-                                },
-                            },
-                            'multipart/form-data': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    multipart_data: {
-                                        summary: 'dataValue for multipart/form-data',
-                                        description: 'Data structure that will be serialized as multipart form',
-                                        value: {},
-                                        dataValue: {
-                                            name: 'Museum Visitor',
-                                            value: 'premium',
-                                            count: 5,
-                                            file: 'museum-document.pdf',
-                                        },
-                                    },
-                                },
-                            },
-                            'application/octet-stream': {
-                                schema: {
-                                    type: 'string',
-                                    format: 'binary',
-                                },
-                                examples: {
-                                    octet_stream_data: {
-                                        summary: 'dataValue for application/octet-stream',
-                                        description: 'Binary data represented as base64 string in data form',
-                                        value: '',
-                                        dataValue: 'SGVsbG8gV29ybGQ=',
-                                    },
-                                },
-                            },
-                        },
-                    },
-                    responses: {
-                        '200': {
-                            description: 'Success',
-                            content: {
-                                'application/json': {
-                                    schema: {
-                                        type: 'object',
-                                        properties: {
-                                            success: {
-                                                type: 'boolean',
-                                            },
-                                            message: {
-                                                type: 'string',
-                                            },
-                                        },
-                                    },
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-    };
-    const options = normalizeOptions({});
-    let parser;
-    let operation;
-    const operationStore = {
-        activeServer: {
-            url: 'https://api.fake-museum-example.com/v1.1',
-        },
-        requestValues: {},
-    };
-    beforeEach(() => {
-        parser = new OpenAPIParser(testDataValueSpec, undefined, options);
-        const postOperation = testDataValueSpec.paths['/example-tests/data-value'].post;
-        operation = getOperation(parser, {
-            pointer: '#/paths/~1example-tests~1data-value/post',
-            pathName: '/example-tests/data-value',
-            httpVerb: 'POST',
-            pathParameters: [],
-            pathServers: [],
-            isWebhook: false,
-            isAdditionalOperation: false,
-            operationId: 'testDataValue',
-            defaultSampleName: 'defaultSampleName',
-            ...postOperation,
-            responses: postOperation?.responses,
-        }, undefined, options, '');
-    });
-    const languages = [
-        { name: 'curl', lang: 'curl' },
-        { name: 'JavaScript', lang: 'JavaScript' },
-        { name: 'Node.js', lang: 'Node.js' },
-        { name: 'Python', lang: 'Python' },
-        { name: 'Java8', lang: 'Java8+Apache' },
-        { name: 'Java', lang: 'Java' },
-        { name: 'C#', lang: 'C#' },
-        { name: 'C#+Newtonsoft', lang: 'C#+Newtonsoft' },
-        { name: 'PHP', lang: 'PHP' },
-        { name: 'Go', lang: 'Go' },
-        { name: 'Ruby', lang: 'Ruby' },
-        { name: 'R', lang: 'R' },
-    ];
-    const contentTypes = [
-        {
-            mimeType: 'application/json',
-            exampleName: 'json_data',
-            description: 'application/json',
-        },
-        {
-            mimeType: 'application/xml',
-            exampleName: 'xml_data',
-            description: 'application/xml',
-        },
-        {
-            mimeType: 'application/x-www-form-urlencoded',
-            exampleName: 'url_encoded_data',
-            description: 'application/x-www-form-urlencoded',
-        },
-        {
-            mimeType: 'multipart/form-data',
-            exampleName: 'multipart_data',
-            description: 'multipart/form-data',
-        },
-        {
-            mimeType: 'application/octet-stream',
-            exampleName: 'octet_stream_data',
-            description: 'application/octet-stream',
-        },
-    ];
-    contentTypes.forEach(({ mimeType, exampleName, description }) => {
-        describe(`${description} with dataValue`, () => {
-            languages.forEach(({ name, lang }) => {
-                it(`should generate code sample for ${name}`, () => {
-                    const sample = getCodeSample({
-                        lang: lang,
-                        operation,
-                        exampleName,
-                        options: {
-                            store: operationStore,
-                            activeMimeName: mimeType,
-                            spec: testDataValueSpec,
-                        },
-                        environment: {
-                            server: 'https://api.fake-museum-example.com/v1.1',
-                        },
-                        translate: (_key, defaultValue) => defaultValue,
-                    });
-                    expect(sample).toMatchSnapshot();
-                });
-            });
-        });
-    });
-});
-//# sourceMappingURL=generator-data-value.test.js.map

package/lib/services/code-samples/__tests__/generator-serialized-value.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/services/code-samples/__tests__/generator-serialized-value.test.js

@@ -1,258 +0,0 @@
-import { getOperation } from '../../../models/index.js';
-import { getCodeSample } from '../generator.js';
-import { OpenAPIParser } from '../../OpenAPIParser.js';
-import { normalizeOptions } from '../../config-options/normalizeOptions.js';
-describe('getDataRequest with serializedValue examples from OpenAPI 3.2', () => {
-    const testSerializedValueSpec = {
-        openapi: '3.2.0',
-        info: { version: '1.1.0', title: 'Redocly Museum API' },
-        servers: [{ url: 'https://api.fake-museum-example.com/v1.1' }],
-        paths: {
-            '/example-tests/serialized-value': {
-                post: {
-                    summary: 'Test serializedValue field (OpenAPI 3.2)',
-                    description: 'Demonstrates serializedValue field which contains pre-serialized string representation.',
-                    operationId: 'testSerializedValue',
-                    requestBody: {
-                        required: true,
-                        content: {
-                            'application/json': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    json_data: {
-                                        summary: 'serializedValue with JSON object',
-                                        description: 'Uses serializedValue to show data in its natural form for validation',
-                                        value: {},
-                                        serializedValue: '{"name": "Museum Visitor", "value": "premium", "count": 5, "enabled": true}',
-                                    },
-                                },
-                            },
-                            'application/xml': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    xml_data: {
-                                        summary: 'serializedValue for XML content',
-                                        description: 'Data structure that will be serialized as XML',
-                                        value: {},
-                                        serializedValue: '<request>\n  <name>Museum Visitor</name>\n  <value>premium</value>\n  <count>5</count>\n</request>',
-                                    },
-                                },
-                            },
-                            'application/x-www-form-urlencoded': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    url_encoded_data: {
-                                        summary: 'serializedValue for URL-encoded content',
-                                        description: 'Data structure that will be serialized as URL-encoded form',
-                                        value: {},
-                                        serializedValue: 'name=Museum+Visitor&value=premium&count=5&enabled=true',
-                                    },
-                                },
-                            },
-                            'multipart/form-data': {
-                                schema: {
-                                    type: 'object',
-                                    properties: {
-                                        name: {
-                                            type: 'string',
-                                        },
-                                        value: {
-                                            type: 'string',
-                                        },
-                                        count: {
-                                            type: 'integer',
-                                        },
-                                        enabled: {
-                                            type: 'boolean',
-                                        },
-                                    },
-                                },
-                                examples: {
-                                    multipart_data: {
-                                        summary: 'serializedValue for multipart/form-data',
-                                        description: 'Data structure that will be serialized as multipart form',
-                                        value: {},
-                                        serializedValue: '----formdata\nContent-Disposition: form-data; name=\"name\"\n\nMuseum Visitor\n----formdata\nContent-Disposition: form-data; name=\"value\"\n\npremium\n----formdata\nContent-Disposition: form-data; name=\"count\"\n\n5\n----formdata\nContent-Disposition: form-data; name=\"file\"; filename=\"museum-document.pdf\"\nContent-Type: application/pdf\n\n<binary content of museum-document.pdf>\n----formdata--',
-                                    },
-                                },
-                            },
-                            'application/octet-stream': {
-                                schema: {
-                                    type: 'string',
-                                    format: 'binary',
-                                },
-                                examples: {
-                                    octet_stream_data: {
-                                        summary: 'serializedValue for application/octet-stream',
-                                        description: 'Binary data represented as base64 string in serialized form',
-                                        value: '',
-                                        serializedValue: 'SGVsbG8gV29ybGQ=',
-                                    },
-                                },
-                            },
-                        },
-                    },
-                    responses: {
-                        '200': {
-                            description: 'Success',
-                            content: {
-                                'application/json': {
-                                    schema: {
-                                        type: 'object',
-                                        properties: {
-                                            success: {
-                                                type: 'boolean',
-                                            },
-                                            message: {
-                                                type: 'string',
-                                            },
-                                        },
-                                    },
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-    };
-    const options = normalizeOptions({});
-    let parser;
-    let operation;
-    const operationStore = {
-        activeServer: {
-            url: 'https://api.fake-museum-example.com/v1.1',
-        },
-        requestValues: {},
-    };
-    beforeEach(() => {
-        parser = new OpenAPIParser(testSerializedValueSpec, undefined, options);
-        const postOperation = testSerializedValueSpec.paths['/example-tests/serialized-value'].post;
-        operation = getOperation(parser, {
-            pointer: '#/paths/~1example-tests~1serialized-value/post',
-            pathName: '/example-tests/serialized-value',
-            httpVerb: 'POST',
-            pathParameters: [],
-            pathServers: [],
-            isWebhook: false,
-            isAdditionalOperation: false,
-            operationId: 'testSerializedValue',
-            defaultSampleName: 'defaultSampleName',
-            ...postOperation,
-            responses: postOperation?.responses,
-        }, undefined, options, '');
-    });
-    const languages = [
-        { name: 'curl', lang: 'curl' },
-        { name: 'JavaScript', lang: 'JavaScript' },
-        { name: 'Node.js', lang: 'Node.js' },
-        { name: 'Python', lang: 'Python' },
-        { name: 'Java8', lang: 'Java8+Apache' },
-        { name: 'Java', lang: 'Java' },
-        { name: 'C#', lang: 'C#' },
-        { name: 'C#+Newtonsoft', lang: 'C#+Newtonsoft' },
-        { name: 'PHP', lang: 'PHP' },
-        { name: 'Go', lang: 'Go' },
-        { name: 'Ruby', lang: 'Ruby' },
-        { name: 'R', lang: 'R' },
-    ];
-    const contentTypes = [
-        {
-            mimeType: 'application/json',
-            exampleName: 'json_data',
-            description: 'application/json',
-        },
-        {
-            mimeType: 'application/xml',
-            exampleName: 'xml_data',
-            description: 'application/xml',
-        },
-        {
-            mimeType: 'application/x-www-form-urlencoded',
-            exampleName: 'url_encoded_data',
-            description: 'application/x-www-form-urlencoded',
-        },
-        {
-            mimeType: 'multipart/form-data',
-            exampleName: 'multipart_data',
-            description: 'multipart/form-data',
-        },
-        {
-            mimeType: 'application/octet-stream',
-            exampleName: 'octet_stream_data',
-            description: 'application/octet-stream',
-        },
-    ];
-    contentTypes.forEach(({ mimeType, exampleName, description }) => {
-        describe(`${description} with serializedValue`, () => {
-            languages.forEach(({ name, lang }) => {
-                it(`should generate code sample for ${name}`, () => {
-                    const sample = getCodeSample({
-                        lang: lang,
-                        operation,
-                        exampleName,
-                        options: {
-                            store: operationStore,
-                            activeMimeName: mimeType,
-                            spec: testSerializedValueSpec,
-                        },
-                        environment: {
-                            server: 'https://api.fake-museum-example.com/v1.1',
-                        },
-                        translate: (_key, defaultValue) => defaultValue,
-                    });
-                    expect(sample).toMatchSnapshot();
-                });
-            });
-        });
-    });
-});
-//# sourceMappingURL=generator-serialized-value.test.js.map

package/lib/services/code-samples/__tests__/generator-value.test.d.ts

@@ -1 +0,0 @@
-export {};