Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions packages/bruno-converters/src/openapi/openapi-to-bruno.js
Original file line number Diff line number Diff line change
Expand Up @@ -781,13 +781,41 @@ const getSecurity = (apiSpec) => {

const openAPIRuntimeExpressionToScript = (expression) => {
// see https://swagger.io/docs/specification/links/#runtime-expressions
const prefix = '$response.body#';

if (expression === '$response.body') {
return 'res.body';
} else if (expression.startsWith('$response.body#')) {
let pointer = expression.substring(15);
// could use https://www.npmjs.com/package/json-pointer for better support
return `res.body${pointer.replace('/', '.')}`;
}

if (expression.startsWith(prefix)) {
const pointer = expression.slice(prefix.length);

if (!pointer || pointer === '/') {
return 'res.body';
}

const segments = pointer
.replace(/^\//, '')
.split('/')
.map((segment) =>
segment
.replace(/~1/g, '/')
.replace(/~0/g, '~')
);

return segments.reduce((script, segment) => {
if (/^\d+$/.test(segment)) {
return `${script}[${segment}]`;
}

if (/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(segment)) {
return `${script}.${segment}`;
}

return `${script}[${JSON.stringify(segment)}]`;
}, 'res.body');
}

return expression;
};

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { describe, it, expect } from '@jest/globals';
import openApiToBruno from '../../../src/openapi/openapi-to-bruno';

describe('openapi-to-bruno links', () => {
it('converts response body runtime JSON Pointers into valid response scripts', () => {
const spec = `
openapi: 3.0.3
info:
title: Links API
version: '1.0'
paths:
/orders:
post:
operationId: createOrder
responses:
'201':
description: Created
links:
GetOrder:
operationId: getOrder
parameters:
root: '$response.body'
emptyPointer: '$response.body#'
rootPointer: '$response.body#/'
id: '$response.body#/data/0/id'
hyphenated: '$response.body#/user-name'
escaped: '$response.body#/links/self~1href/meta~0key'
servers:
- url: https://example.com
`;

const collection = openApiToBruno(spec);
const request = collection.items[0];

expect(request.request.script.res).toBe(
[
'if (res.status === 201) {',
' bru.setVar(\'getOrder_root\', res.body);',
' bru.setVar(\'getOrder_emptyPointer\', res.body);',
' bru.setVar(\'getOrder_rootPointer\', res.body);',
' bru.setVar(\'getOrder_id\', res.body.data[0].id);',
' bru.setVar(\'getOrder_hyphenated\', res.body["user-name"]);',
' bru.setVar(\'getOrder_escaped\', res.body.links["self/href"]["meta~key"]);',
'}'
].join('\n')
);
});
});