From c6fa6b6a0f79b2d8633e71f11b650d677ccd40d6 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Fri, 22 Jul 2022 11:32:47 +0200 Subject: [PATCH] Chore: cleanup --- src/lib/openapi/util/query-parameters.test.ts | 62 +++++-------------- src/lib/openapi/util/query-parameters.ts | 2 +- 2 files changed, 18 insertions(+), 46 deletions(-) diff --git a/src/lib/openapi/util/query-parameters.test.ts b/src/lib/openapi/util/query-parameters.test.ts index 657e9f8505..65ca345339 100644 --- a/src/lib/openapi/util/query-parameters.test.ts +++ b/src/lib/openapi/util/query-parameters.test.ts @@ -1,13 +1,11 @@ import { SchemaObject } from 'ajv'; import fc, { Arbitrary } from 'fast-check'; -import { OpenAPIV3 } from 'openapi-types'; import { urlFriendlyString } from '../../../test/arbitraries.test'; import { createQueryParameters, ParameterDetails, Parameters, ParameterType, - toParamObject, } from './query-parameters'; const paramName = urlFriendlyString; @@ -38,43 +36,6 @@ const parameterDetails = (): Arbitrary => fc.dictionary(paramName(), parameterDescription()); describe('request parameter utils', () => { - const parameterDetailsAreMappedCorrectly = ( - parameterDetailsObject: ParameterDetails, - parameterObject: OpenAPIV3.ParameterObject, - ) => { - const schema: SchemaObject = parameterObject.schema; - - return ( - schema.type === parameterDetailsObject.type && - parameterObject.description === - parameterDetailsObject.description && - parameterObject.example === parameterDetailsObject.example && - schema.enum === parameterDetailsObject.enum && - schema.default === parameterDetailsObject.default && - parameterObject.required === parameterDetailsObject.required - ); - }; - - it('turns a name and a parameter details description into a parameter object', () => { - fc.assert( - fc.property( - paramName(), - parameterDescription(), - fc.context(), - (name, details, ctx) => { - const result = toParamObject(name, details); - - ctx.log(JSON.stringify(result)); - - return ( - result.name === name && - parameterDetailsAreMappedCorrectly(details, result) - ); - }, - ), - ); - }); - it('turns an object of names and descriptions into a an expected parameter list', () => { fc.assert( fc.property(parameterDetails(), fc.context(), (parameters, ctx) => { @@ -82,12 +43,23 @@ describe('request parameter utils', () => { ctx.log(JSON.stringify(result)); - return result.every((paramsObject) => - parameterDetailsAreMappedCorrectly( - parameters[paramsObject.name], - paramsObject, - ), - ); + return result.every((paramsObject) => { + const parameterDetailsObject = + parameters[paramsObject.name]; + const schema: SchemaObject = paramsObject.schema; + + return ( + schema.type === parameterDetailsObject.type && + paramsObject.description === + parameterDetailsObject.description && + paramsObject.example === + parameterDetailsObject.example && + schema.enum === parameterDetailsObject.enum && + schema.default === parameterDetailsObject.default && + paramsObject.required === + parameterDetailsObject.required + ); + }); }), ); }); diff --git a/src/lib/openapi/util/query-parameters.ts b/src/lib/openapi/util/query-parameters.ts index eeecd9fb2f..7f4b06f757 100644 --- a/src/lib/openapi/util/query-parameters.ts +++ b/src/lib/openapi/util/query-parameters.ts @@ -15,7 +15,7 @@ export type Parameters = { [parameterName: string]: ParameterDetails; }; -export const toParamObject = ( +const toParamObject = ( name: string, details: ParameterDetails, ): OpenAPIV3.ParameterObject => ({