OS3Parameter

@tsed/openspec

Usage

import { OS3Parameter } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec3/OS3Parameter.ts.

Overview

interface OS3Parameter<Schema = OS3Schema> {
    name: string;
    in: "path" | "query" | "header" | "cookie";
    required: boolean;
    description?: string;
    deprecated?: boolean;
    allowEmptyValue?: boolean;
    schema?: OS3Schema | OpenSpecRef;
    style?: OS3StyleParameter;
    explode?: boolean;
    allowReserved?: boolean;
    example?: any;
    examples?: OpenSpecHash<OS3Example | OpenSpecRef>;
    content?: OpenSpecHash<OS3MediaType>;
}

name

name: string;

The name of the parameter. Parameter names are case sensitive.

• If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object. See Path Templating for further information.
• If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
• For all other cases, the name corresponds to the parameter name used by the in property.

in

in: "path" | "query" | "header" | "cookie";

The location of the parameter. Possible values are "query", "header", "path" or "cookie".

required

required: boolean;

Determines whether this parameter is mandatory. If the [parameter location](Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.) is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.

description

description?: string;

A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

deprecated

deprecated?: boolean;

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

allowEmptyValue

allowEmptyValue?: boolean;

Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.

schema

schema?: OS3Schema | OpenSpecRef;

The schema defining the type used for the parameter.

style

style?: OS3StyleParameter;

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form. See style values.

explode

explode?: boolean;

When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.

allowReserved

allowReserved?: boolean;

Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.

example

example?: any;

Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

examples

examples?: OpenSpecHash<OS3Example | OpenSpecRef>;

Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.

/***

* A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.

content

content?: OpenSpecHash<OS3MediaType>;