Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: add empty value check in getRequestBodyExamples() #904

Merged
merged 6 commits into from
Sep 13, 2024
Merged

fix: add empty value check in getRequestBodyExamples() #904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d3de8ef
fix: add empty `value` check in getRequestBodyExamples()
darrenyong Sep 12, 2024
87d82e4
chore: run prettier
darrenyong Sep 12, 2024
f4f68ed
refactor: update requestBodyExamples empty value check
darrenyong Sep 13, 2024
9d9f7ca
test: update test
darrenyong Sep 13, 2024
279e7c2
chore: run prettier
darrenyong Sep 13, 2024
f59cc66
test: rename test
darrenyong Sep 13, 2024
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
4 changes: 3 additions & 1 deletion packages/oas/src/operation/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,9 @@ export class Operation {
*
*/
getRequestBodyExamples(): RequestBodyExamples {
if (this.requestBodyExamples) {
const isRequestExampleValueDefined = typeof this.requestBodyExamples?.[0]?.examples?.[0].value !== 'undefined';

if (this.requestBodyExamples && isRequestExampleValueDefined) {
return this.requestBodyExamples;
}

Expand Down
34 changes: 34 additions & 0 deletions packages/oas/test/operation/lib/get-requestbody-examples.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,54 @@ import cleanStringify from '../../__fixtures__/json-stringify-clean.js';

let operationExamples: Oas;
let petstore: Oas;
let webhooksOas: Oas;

beforeAll(async () => {
operationExamples = await import('../../__datasets__/operation-examples.json').then(r => r.default).then(Oas.init);
await operationExamples.dereference();

petstore = await import('@readme/oas-examples/3.0/json/petstore.json').then(r => r.default).then(Oas.init);
await petstore.dereference();

webhooksOas = await import('@readme/oas-examples/3.1/json/webhooks.json').then(r => r.default).then(Oas.init);
});

test('should return early if there is no request body', () => {
const operation = operationExamples.operation('/nothing', 'get');
expect(operation.getRequestBodyExamples()).toStrictEqual([]);
});

test('should re-intialize the request examples after the oas is dereferenced', async () => {
const webhookOperation = webhooksOas.operation('newPet', 'post', { isWebhook: true });

expect(webhookOperation.getRequestBodyExamples()).toStrictEqual([
{
mediaType: 'application/json',
examples: [
{
value: undefined,
kanadgupta marked this conversation as resolved.
Show resolved Hide resolved
},
],
},
]);

await webhooksOas.dereference();
expect(webhookOperation.getRequestBodyExamples()).toStrictEqual([
{
mediaType: 'application/json',
examples: [
{
value: {
id: 0,
name: 'string',
tag: 'string',
},
},
],
},
]);
});

test('should support */* media types', () => {
const operation = operationExamples.operation('/wildcard-media-type', 'post');
expect(operation.getRequestBodyExamples()).toStrictEqual([
Expand Down