diff --git a/src/lib/openapi/util/request-parameters.test.ts b/src/lib/openapi/util/query-parameters.test.ts similarity index 95% rename from src/lib/openapi/util/request-parameters.test.ts rename to src/lib/openapi/util/query-parameters.test.ts index 1d5be9ab5e..657e9f8505 100644 --- a/src/lib/openapi/util/request-parameters.test.ts +++ b/src/lib/openapi/util/query-parameters.test.ts @@ -3,12 +3,12 @@ import fc, { Arbitrary } from 'fast-check'; import { OpenAPIV3 } from 'openapi-types'; import { urlFriendlyString } from '../../../test/arbitraries.test'; import { - createRequestParameters, + createQueryParameters, ParameterDetails, Parameters, ParameterType, toParamObject, -} from './request-parameters'; +} from './query-parameters'; const paramName = urlFriendlyString; @@ -78,7 +78,7 @@ describe('request parameter utils', () => { it('turns an object of names and descriptions into a an expected parameter list', () => { fc.assert( fc.property(parameterDetails(), fc.context(), (parameters, ctx) => { - const result = createRequestParameters(parameters); + const result = createQueryParameters(parameters); ctx.log(JSON.stringify(result)); diff --git a/src/lib/openapi/util/request-parameters.ts b/src/lib/openapi/util/query-parameters.ts similarity index 94% rename from src/lib/openapi/util/request-parameters.ts rename to src/lib/openapi/util/query-parameters.ts index 2915b17aff..60691d1360 100644 --- a/src/lib/openapi/util/request-parameters.ts +++ b/src/lib/openapi/util/query-parameters.ts @@ -31,7 +31,7 @@ export const toParamObject = ( in: 'query', }); -export const createRequestParameters = (params: { +export const createQueryParameters = (params: { [parameterName: string]: ParameterDetails; }): OpenAPIV3.ParameterObject[] => Object.entries(params).map(([name, deets]) => toParamObject(name, deets)); diff --git a/src/lib/routes/admin-api/state.ts b/src/lib/routes/admin-api/state.ts index 328d5e7f53..e3d6042ba2 100644 --- a/src/lib/routes/admin-api/state.ts +++ b/src/lib/routes/admin-api/state.ts @@ -19,7 +19,7 @@ import { ExportParametersSchema, } from '../../openapi/spec/export-parameters-schema'; import { emptyResponse } from '../../openapi/util/standard-responses'; -import { createRequestParameters } from '../../openapi/util/request-parameters'; +import { createQueryParameters } from '../../openapi/util/query-parameters'; const upload = multer({ limits: { fileSize: 5242880 } }); const paramToBool = (param, def) => { @@ -79,7 +79,7 @@ class StateController extends Controller { responses: { 200: createResponseSchema('stateSchema'), }, - parameters: createRequestParameters(exportParameters), + parameters: createQueryParameters(exportParameters), }), ], });