API Parameter Validator

A TypeScript utility that validates API parameter configurations from OpenAPI specifications, ensuring correct serialization settings.

Capabilities

Validates parameter style configurations

• A parameter with style "matrix" and explode true is considered valid @test
• A parameter with style "form" and explode false is considered valid @test
• A parameter with style "deepObject" is considered valid only for query parameters @test

Validates parameter serialization combinations

• A query parameter can use styles: "form", "spaceDelimited", "pipeDelimited", or "deepObject" @test
• A path parameter can use styles: "simple", "label", or "matrix" @test
• A header parameter can only use style "simple" @test

Checks allowReserved flag usage

• A parameter with allowReserved set to true is only valid for query parameters @test
• A path parameter with allowReserved set to true is considered invalid @test

Implementation

@generates

API

/**
 * Validates an OpenAPI parameter object for correct serialization settings.
 *
 * @param parameter - An OpenAPI 3.0 parameter object to validate
 * @returns true if the parameter configuration is valid, false otherwise
 */
export function validateParameterSerialization(parameter: any): boolean;

Dependencies { .dependencies }

openapi-types { .dependency }

Provides TypeScript type definitions for OpenAPI specifications including parameter objects with style, explode, and allowReserved properties.

@satisfied-by