Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.
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
6 changes: 6 additions & 0 deletions src/parsers/swagger/v2.0/Parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -1252,6 +1252,12 @@ methods.convertParameterObjectIntoParameter = (parameterEntry) => {
applicableContexts
}

if (typeof parameter.example !== 'undefined') {
paramInstance.examples = List([parameter.example])
} else if (typeof parameter['x-example'] !== 'undefined') {
paramInstance.examples = List([parameter['x-example']])
}

if (parameter.type === 'array' && parameter.items) {
const { value } = methods.convertParameterObjectIntoParameter({
key: null,
Expand Down
70 changes: 68 additions & 2 deletions src/parsers/swagger/v2.0/__tests__/Parser.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -2772,7 +2772,8 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
maximum: 321,
minimum: 123,
multipleOf: 5,
default: 100
default: 100,
example: 12345
}
}

Expand All @@ -2787,6 +2788,9 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
required: true,
type: 'integer',
default: 100,
examples: List([
12345
]),
constraints: List([
new Constraint.Maximum(321),
new Constraint.Minimum(123),
Expand Down Expand Up @@ -2816,7 +2820,8 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
maximum: 321,
minimum: 123,
multipleOf: 5,
default: 100
default: 100,
example: 12345
}
}
}
Expand All @@ -2838,6 +2843,7 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
required: true,
type: 'integer',
default: 100,
examples: List([12345]),
constraints: List([
new Constraint.Maximum(321),
new Constraint.Minimum(123),
Expand Down Expand Up @@ -2920,6 +2926,66 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
const actual = inputs.map(input => __internals__.convertParameterObjectIntoParameter(input))
expect(actual).toEqual(expected)
})

it('should respect x-example too', () => {
const inputs = [
{
key: 'UserId',
value: {
name: 'userId',
in: 'query',
type: 'integer',
required: true,
'x-example': 23456
}
},
{
key: 'ShowThing',
value: {
name: 'showThing',
in: 'query',
type: 'boolean',
'x-example': false
}
}
]

const expected = [
{
key: 'UserId',
value: new Parameter({
key: 'userId',
name: 'userId',
in: 'queries',
uuid: 'UserId',
required: true,
type: 'integer',
examples: List([
23456
]),
constraints: List()
})
},
{
key: 'ShowThing',
value: new Parameter({
key: 'showThing',
name: 'showThing',
in: 'queries',
uuid: 'ShowThing',
required: false,
type: 'boolean',
examples: List([
false
]),
constraints: List()
})
}
]

const actual = inputs.map(input => __internals__.convertParameterObjectIntoParameter(input))
expect(actual).toEqual(expected)
})
})

describe('@convertParameterObjectArrayIntoParameterMap', () => {
Expand Down