@redocly/openapi-docs 3.24.0-next.9 → 3.24.1

package/lib/services/code-samples/httpsnippet/targets/csharpNewtonsoft/__tests__/httpclient.test.js

@@ -0,0 +1,172 @@
+export { HTTPSnippet } from '../../../index.js'; // we need to reexport it before to prevent circular ref issue
+import httpclient from '../httpclient.js';
+import { originalOptions, serverVariablesOptions, source } from '../../__mocks__/mock.js';
+describe('#code-samples C#+Newtonsoft', () => {
+    describe('handler', () => {
+        it('returns code API PUT /pet', () => {
+            const result = httpclient(source['PUT http://petstore.swagger.io/v2/pet'], originalOptions, {
+                target: 'csharpNewtonsoft',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with path parameters reserved (data) and not (petId) /pet/{petId}/uploadImage/{data}', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage/{data}'], originalOptions, { target: 'csharpNewtonsoft', client: 'httpclient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with one path parameter inside url /pet/{petId}/uploadImage', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage'], originalOptions, { target: 'csharpNewtonsoft', client: 'httpclient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with path parameter and query /pet/findByStatus/{id}?status=...', () => {
+            const result = httpclient(source['GET http://petstore.swagger.io/v2/pet/findByStatus/{id}'], originalOptions, { target: 'csharpNewtonsoft', client: 'httpclient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with server variables', () => {
+            const result = httpclient(source['POST https://{customerId}.saas-app.com:{port}/v2'], serverVariablesOptions, {
+                target: 'csharpNewtonsoft',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with basic auth', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/login'], serverVariablesOptions, {
+                target: 'csharpNewtonsoft',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle URL_ENCODED with text but no params (serializedValue case)', () => {
+            const sourceWithUrlEncodedText = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/pet',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'application/x-www-form-urlencoded' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'application/x-www-form-urlencoded',
+                    text: 'name=Museum+Visitor&value=premium&count=5',
+                    params: [],
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/pet',
+                    path: '/v2/pet',
+                    href: 'http://petstore.swagger.io/v2/pet',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/pet',
+            };
+            const result = httpclient(sourceWithUrlEncodedText, originalOptions, {
+                target: 'csharpNewtonsoft',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle MULTIPART with text but no params (serializedValue case)', () => {
+            const sourceWithMultipartText = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/pet',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'multipart/form-data' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'multipart/form-data',
+                    text: '--boundary123\r\nContent-Disposition: form-data; name="field1"\r\n\r\nvalue1\r\n--boundary123\r\nContent-Disposition: form-data; name="field2"\r\n\r\nvalue2\r\n--boundary123--',
+                    params: [],
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'multipart/form-data' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'multipart/form-data' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/pet',
+                    path: '/v2/pet',
+                    href: 'http://petstore.swagger.io/v2/pet',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/pet',
+            };
+            const result = httpclient(sourceWithMultipartText, originalOptions, {
+                target: 'csharpNewtonsoft',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle OCTET_STREAM with text (binary data case)', () => {
+            const sourceWithOctetStream = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/upload',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'application/octet-stream' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'application/octet-stream',
+                    text: 'SGVsbG8gV29ybGQ=',
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'application/octet-stream' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'application/octet-stream' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/upload',
+                    path: '/v2/upload',
+                    href: 'http://petstore.swagger.io/v2/upload',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/upload',
+            };
+            const result = httpclient(sourceWithOctetStream, originalOptions, {
+                target: 'csharpNewtonsoft',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+    });
+});
+//# sourceMappingURL=httpclient.test.js.map

package/lib/services/code-samples/httpsnippet/targets/go/__tests__/native.test.d.ts

@@ -0,0 +1 @@
+export { HTTPSnippet } from '../../../index.js';

package/lib/services/code-samples/httpsnippet/targets/go/__tests__/native.test.js

@@ -0,0 +1,130 @@
+// TODO: Please Fix linter - (details: https://github.com/Redocly/redocly/pull/16732)
+export { HTTPSnippet } from '../../../index.js'; // we need to reexport it before to prevent circular ref issue
+import native from '../native.js';
+import { originalOptions, serverVariablesOptions, source } from '../../__mocks__/mock.js';
+describe('#code-samples Go lang', () => {
+    describe('handler', () => {
+        it('returns code API POST /pet', () => {
+            const result = native(source['POST http://petstore.swagger.io/v2/pet'], originalOptions, {
+                target: 'go',
+                client: 'http.DefaultClient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with path parameters reserved (data) and not (petId) /pet/{petId}/uploadImage/{data}', () => {
+            const result = native(source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage/{data}'], originalOptions, { target: 'go', client: 'http.DefaultClient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with one path parameter inside url /pet/{petId}/uploadImage', () => {
+            const result = native(source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage'], originalOptions, { target: 'go', client: 'http.DefaultClient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with path parameter and query /pet/findByStatus/{id}?status=...', () => {
+            const result = native(source['GET http://petstore.swagger.io/v2/pet/findByStatus/{id}'], originalOptions, { target: 'go', client: 'http.DefaultClient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with server variables', () => {
+            const result = native(source['POST https://{customerId}.saas-app.com:{port}/v2'], serverVariablesOptions, {
+                target: 'go',
+                client: 'http.DefaultClient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with basic auth', () => {
+            const result = native(source['POST http://petstore.swagger.io/login'], serverVariablesOptions, {
+                target: 'go',
+                client: 'http.DefaultClient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle URL_ENCODED with text but no params (serializedValue case)', () => {
+            const sourceWithUrlEncodedText = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/pet',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'application/x-www-form-urlencoded' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'application/x-www-form-urlencoded',
+                    text: 'name=Museum+Visitor&value=premium&count=5',
+                    params: [],
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/pet',
+                    path: '/v2/pet',
+                    href: 'http://petstore.swagger.io/v2/pet',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/pet',
+            };
+            const result = native(sourceWithUrlEncodedText, originalOptions, {
+                target: 'go',
+                client: 'http.DefaultClient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle MULTIPART with text but no params (serializedValue case)', () => {
+            const sourceWithMultipartText = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/pet',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'multipart/form-data' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'multipart/form-data',
+                    text: '--boundary123\r\nContent-Disposition: form-data; name="field1"\r\n\r\nvalue1\r\n--boundary123\r\nContent-Disposition: form-data; name="field2"\r\n\r\nvalue2\r\n--boundary123--',
+                    params: [],
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'multipart/form-data' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'multipart/form-data' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/pet',
+                    path: '/v2/pet',
+                    href: 'http://petstore.swagger.io/v2/pet',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/pet',
+            };
+            const result = native(sourceWithMultipartText, originalOptions, {
+                target: 'go',
+                client: 'http.DefaultClient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+    });
+});
+//# sourceMappingURL=native.test.js.map

package/lib/services/code-samples/httpsnippet/targets/java/__tests__/httpclient.test.d.ts

@@ -0,0 +1 @@
+export { HTTPSnippet } from '../../../index.js';

package/lib/services/code-samples/httpsnippet/targets/java/__tests__/httpclient.test.js

@@ -0,0 +1,191 @@
+// TODO: Please Fix linter - (details: https://github.com/Redocly/redocly/pull/16732)
+export { HTTPSnippet } from '../../../index.js'; // we need to reexport it before to prevent circular ref issue
+import httpclient from '../httpclient.js';
+import { originalOptions, serverVariablesOptions, source } from '../../__mocks__/mock.js';
+describe('#code-samples Java', () => {
+    describe('handler', () => {
+        it('returns code API POST /pet', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/v2/pet'], originalOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with path parameters reserved (data) and not (petId) /pet/{petId}/uploadImage/{data}', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage/{data}'], originalOptions, { target: 'java', client: 'httpclient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with one path parameter inside url /pet/{petId}/uploadImage', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage'], originalOptions, { target: 'java', client: 'httpclient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('returns code with path parameter and query /pet/findByStatus/{id}?status=...', () => {
+            const result = httpclient(source['GET http://petstore.swagger.io/v2/pet/findByStatus/{id}'], originalOptions, { target: 'java', client: 'httpclient' });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with server variables', () => {
+            const result = httpclient(source['POST https://{customerId}.saas-app.com:{port}/v2'], serverVariablesOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with basic auth', () => {
+            const result = httpclient(source['POST http://petstore.swagger.io/login'], serverVariablesOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should generate code with multipart form data', () => {
+            const multipartSource = {
+                ...source['POST http://petstore.swagger.io/v2/pet/{petId}/uploadImage'],
+                postData: {
+                    mimeType: 'multipart/form-data',
+                    text: '',
+                    params: [
+                        { name: 'file', value: 'fileContent' },
+                        { name: 'metadata', value: 'someMeta' },
+                    ],
+                },
+            };
+            const result = httpclient(multipartSource, originalOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle URL_ENCODED with text but no params (serializedValue case)', () => {
+            const sourceWithUrlEncodedText = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/pet',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'application/x-www-form-urlencoded' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'application/x-www-form-urlencoded',
+                    text: 'name=Museum+Visitor&value=premium&count=5',
+                    params: [],
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/pet',
+                    path: '/v2/pet',
+                    href: 'http://petstore.swagger.io/v2/pet',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/pet',
+            };
+            const result = httpclient(sourceWithUrlEncodedText, originalOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle MULTIPART with text but no params (serializedValue case)', () => {
+            const sourceWithMultipartText = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/pet',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'multipart/form-data' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'multipart/form-data',
+                    text: '--boundary123\r\nContent-Disposition: form-data; name="field1"\r\n\r\nvalue1\r\n--boundary123\r\nContent-Disposition: form-data; name="field2"\r\n\r\nvalue2\r\n--boundary123--',
+                    params: [],
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'multipart/form-data' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'multipart/form-data' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/pet',
+                    path: '/v2/pet',
+                    href: 'http://petstore.swagger.io/v2/pet',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/pet',
+            };
+            const result = httpclient(sourceWithMultipartText, originalOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+        it('should handle OCTET_STREAM with text (binary data case)', () => {
+            const sourceWithOctetStream = {
+                method: 'post',
+                url: 'http://petstore.swagger.io/v2/upload',
+                httpVersion: 'HTTP/1.1',
+                cookies: [],
+                headers: [{ name: 'Content-Type', value: 'application/octet-stream' }],
+                queryString: [],
+                postData: {
+                    mimeType: 'application/octet-stream',
+                    text: 'SGVsbG8gV29ybGQ=',
+                },
+                headersSize: 0,
+                bodySize: 0,
+                securityOAuth2ExtraCalls: [],
+                pathParameters: {},
+                serverVariables: {},
+                queryObj: {},
+                headersObj: { 'Content-Type': 'application/octet-stream' },
+                cookiesObj: {},
+                allHeaders: { 'Content-Type': 'application/octet-stream' },
+                uriObj: {
+                    protocol: 'http:',
+                    slashes: true,
+                    auth: null,
+                    host: 'petstore.swagger.io',
+                    port: null,
+                    hostname: 'petstore.swagger.io',
+                    hash: null,
+                    search: '',
+                    query: {},
+                    pathname: '/v2/upload',
+                    path: '/v2/upload',
+                    href: 'http://petstore.swagger.io/v2/upload',
+                },
+                fullUrl: 'http://petstore.swagger.io/v2/upload',
+            };
+            const result = httpclient(sourceWithOctetStream, originalOptions, {
+                target: 'java',
+                client: 'httpclient',
+            });
+            expect(result).toMatchSnapshot();
+        });
+    });
+});
+//# sourceMappingURL=httpclient.test.js.map

package/lib/services/code-samples/httpsnippet/targets/java8/__tests__/apachehttp.test.d.ts

@@ -0,0 +1 @@
+export { HTTPSnippet } from '../../../index.js';