@redocly/openapi-docs 3.24.0 → 3.24.1

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

@@ -0,0 +1,273 @@
+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 value examples from OpenAPI 3.2', () => {
+    const testValueSpec = {
+        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/value': {
+                post: {
+                    summary: 'Test value field (OpenAPI 3.2)',
+                    description: 'Demonstrates the use of value field which contains data in its natural form for validation.',
+                    operationId: 'testValue',
+                    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: 'value with JSON object',
+                                        description: 'Uses value to show data in its natural form for validation',
+                                        value: {
+                                            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: 'value for XML content',
+                                        description: 'Data structure that will be serialized as XML',
+                                        value: `<item>
+                <name>Museum Visitor</name>
+                <value>premium</value>
+                <count>5</count>
+                <enabled>true</enabled>
+              </item>`,
+                                    },
+                                },
+                            },
+                            '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: 'value for URL-encoded content',
+                                        description: 'Data structure that will be serialized as URL-encoded form',
+                                        value: {
+                                            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: 'value for multipart/form-data',
+                                        description: 'Data structure that will be serialized as multipart form',
+                                        value: {
+                                            name: 'Museum Visitor',
+                                            value: 'premium',
+                                            count: 5,
+                                            file: 'museum-document.pdf',
+                                        },
+                                    },
+                                },
+                            },
+                            'application/octet-stream': {
+                                schema: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                                examples: {
+                                    octet_stream_data: {
+                                        summary: 'value for application/octet-stream',
+                                        description: 'Binary data represented as base64 string in data form',
+                                        value: '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(testValueSpec, undefined, options);
+        const postOperation = testValueSpec.paths['/example-tests/value'].post;
+        operation = getOperation(parser, {
+            pointer: '#/paths/~1example-tests~1value/post',
+            pathName: '/example-tests/value',
+            httpVerb: 'POST',
+            pathParameters: [],
+            pathServers: [],
+            isWebhook: false,
+            isAdditionalOperation: false,
+            operationId: 'testValue',
+            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 Value`, () => {
+            languages.forEach(({ name, lang }) => {
+                it(`should generate code sample for ${name}`, () => {
+                    const sample = getCodeSample({
+                        lang: lang,
+                        operation,
+                        exampleName,
+                        options: {
+                            store: operationStore,
+                            activeMimeName: mimeType,
+                            spec: testValueSpec,
+                        },
+                        environment: {
+                            server: 'https://api.fake-museum-example.com/v1.1',
+                        },
+                        translate: (_key, defaultValue) => defaultValue,
+                    });
+                    expect(sample).toMatchSnapshot();
+                });
+            });
+        });
+    });
+});
+//# sourceMappingURL=generator-value.test.js.map

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

@@ -0,0 +1,249 @@
+export declare const testGetOperation: {
+    summary: string;
+    responses: {
+        '200': {};
+    };
+    parameters: {
+        name: string;
+        in: 'path';
+        schema: {
+            type: string;
+        };
+    }[];
+    requestBody: {
+        content: {
+            'application/json': {
+                schema: {
+                    type: string;
+                    properties: {
+                        a: {
+                            type: string;
+                        };
+                        b: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            'application/x-www-form-urlencoded': {
+                schema: {
+                    type: string;
+                    properties: {
+                        a: {
+                            type: string;
+                        };
+                        b: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            'application/xml': {
+                schema: {
+                    type: string;
+                    properties: {
+                        a: {
+                            type: string;
+                            example: string;
+                        };
+                        b: {
+                            type: string;
+                        };
+                        d: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            'multipart/form-data': {
+                schema: {
+                    type: string;
+                    properties: {
+                        a: {
+                            type: string;
+                        };
+                        b: {
+                            type: string;
+                        };
+                        d: {
+                            type: string;
+                        };
+                        g: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+export declare const testPostOperation: {
+    summary: string;
+    responses: {
+        '200': {};
+    };
+    parameters: {
+        name: string;
+        in: 'cookie';
+        schema: {
+            type: string;
+        };
+    }[];
+    requestBody: {
+        content: {
+            'application/json': {
+                schema: {
+                    type: string;
+                    properties: {
+                        a: {
+                            type: string;
+                        };
+                        b: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+export declare const testDefinition: {
+    openapi: string;
+    info: {
+        version: string;
+        title: string;
+    };
+    security: ({
+        testApiKey: never[];
+        testBasicAuth?: undefined;
+    } | {
+        testBasicAuth: never[];
+        testApiKey: never[];
+    })[];
+    paths: {
+        '/test/{id}': {
+            get: {
+                summary: string;
+                responses: {
+                    '200': {};
+                };
+                parameters: {
+                    name: string;
+                    in: 'path';
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    a: {
+                                        type: string;
+                                    };
+                                    b: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                        'application/x-www-form-urlencoded': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    a: {
+                                        type: string;
+                                    };
+                                    b: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                        'application/xml': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    a: {
+                                        type: string;
+                                        example: string;
+                                    };
+                                    b: {
+                                        type: string;
+                                    };
+                                    d: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                        'multipart/form-data': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    a: {
+                                        type: string;
+                                    };
+                                    b: {
+                                        type: string;
+                                    };
+                                    d: {
+                                        type: string;
+                                    };
+                                    g: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            post: {
+                summary: string;
+                responses: {
+                    '200': {};
+                };
+                parameters: {
+                    name: string;
+                    in: 'cookie';
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    a: {
+                                        type: string;
+                                    };
+                                    b: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        securitySchemes: {
+            testApiKey: {
+                type: string;
+                in: string;
+                name: string;
+            };
+            testBasicAuth: {
+                type: string;
+                scheme: string;
+            };
+        };
+    };
+};