Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-06-29 16:53:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: use url-template dependency (#1008)

Browse Source 
Fixes #1007
This commit is contained in:
Peter Wessels 2019-09-30 09:12:26 +02:00 committed by Roman Hotsiy
parent aceb3438f2
commit 32a464aaa8
3 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
package.json
View File

@ -156,7 +156,7 @@
"stickyfill": "^1.1.1", "stickyfill": "^1.1.1",
"swagger2openapi": "^5.3.1", "swagger2openapi": "^5.3.1",
"tslib": "^1.10.0", "tslib": "^1.10.0",
"uri-template-lite": "^19.4.0" "url-template": "^2.0.8"
}, },
"bundlesize": [ "bundlesize": [
{ {

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

@ -404,7 +404,7 @@ describe('Utils', () => {
{ style: 'simple', explode: false, expected: 'role,admin,firstName,Alex' }, { style: 'simple', explode: false, expected: 'role,admin,firstName,Alex' },
{ style: 'simple', explode: true, expected: 'role=admin,firstName=Alex' }, { style: 'simple', explode: true, expected: 'role=admin,firstName=Alex' },
{ style: 'label', explode: false, expected: '.role,admin,firstName,Alex' }, { style: 'label', explode: false, expected: '.role,admin,firstName,Alex' },
{ style: 'label', explode: true, expected: '.role=admin,firstName=Alex' }, { style: 'label', explode: true, expected: '.role=admin.firstName=Alex' },
{ style: 'matrix', explode: false, expected: ';id=role,admin,firstName,Alex' }, { style: 'matrix', explode: false, expected: ';id=role,admin,firstName,Alex' },
{ style: 'matrix', explode: true, expected: ';role=admin;firstName=Alex' }, { style: 'matrix', explode: true, expected: ';role=admin;firstName=Alex' },
], ],
@ -516,9 +516,7 @@ describe('Utils', () => {
locationTestGroup.cases.forEach(valueTypeTestGroup => { locationTestGroup.cases.forEach(valueTypeTestGroup => {
describe(valueTypeTestGroup.description, () => { describe(valueTypeTestGroup.description, () => {
valueTypeTestGroup.cases.forEach(testCase => { valueTypeTestGroup.cases.forEach(testCase => {
it(`should serialize correctly when style is ${testCase.style} and explode is ${ it(`should serialize correctly when style is ${testCase.style} and explode is ${testCase.explode}`, () => {
testCase.explode
}`, () => {
const parameter: OpenAPIParameter = { const parameter: OpenAPIParameter = {
name: locationTestGroup.name, name: locationTestGroup.name,
in: locationTestGroup.location, in: locationTestGroup.location,

8
src/utils/openapi.ts
View File

@ -1,5 +1,5 @@
import { dirname } from 'path'; import { dirname } from 'path';
import { URI } from 'uri-template-lite'; const URLtemplate = require('url-template');
import { OpenAPIParser } from '../services/OpenAPIParser'; import { OpenAPIParser } from '../services/OpenAPIParser';
import { import {
@ -168,7 +168,7 @@ function serializeFormValue(name: string, explode: boolean, value: any) {
// e.g. URI.template doesn't parse names with hypen (-) which are valid query param names // e.g. URI.template doesn't parse names with hypen (-) which are valid query param names
const safeName = '__redoc_param_name__'; const safeName = '__redoc_param_name__';
const suffix = explode ? '*' : ''; const suffix = explode ? '*' : '';
const template = new URI.Template(`{?${safeName}${suffix}}`); const template = URLtemplate.parse(`{?${safeName}${suffix}}`);
return template return template
.expand({ [safeName]: value }) .expand({ [safeName]: value })
.substring(1) .substring(1)
@ -227,7 +227,7 @@ function serializePathParameter(
// Use RFC6570 safe name ([a-zA-Z0-9_]) and replace with our name later // Use RFC6570 safe name ([a-zA-Z0-9_]) and replace with our name later
// e.g. URI.template doesn't parse names with hypen (-) which are valid query param names // e.g. URI.template doesn't parse names with hypen (-) which are valid query param names
const safeName = '__redoc_param_name__'; const safeName = '__redoc_param_name__';
const template = new URI.Template(`{${prefix}${safeName}${suffix}}`); const template = URLtemplate.parse(`{${prefix}${safeName}${suffix}}`);
return template.expand({ [safeName]: value }).replace(/__redoc_param_name__/g, name); return template.expand({ [safeName]: value }).replace(/__redoc_param_name__/g, name);
} }
@ -285,7 +285,7 @@ function serializeHeaderParameter(
// name is not important here, so use RFC6570 safe name ([a-zA-Z0-9_]) // name is not important here, so use RFC6570 safe name ([a-zA-Z0-9_])
const name = '__redoc_param_name__'; const name = '__redoc_param_name__';
const template = new URI.Template(`{${name}${suffix}}`); const template = URLtemplate.parse(`{${name}${suffix}}`);
return decodeURIComponent(template.expand({ [name]: value })); return decodeURIComponent(template.expand({ [name]: value }));
default: default:
console.warn('Unexpected style for header: ' + style); console.warn('Unexpected style for header: ' + style);