@autorest/codemodel
Version:
AutoRest code model library
91 lines • 2.72 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.SerializationStyle = void 0;
/**
* The Serialization Style used for the parameter.
*
* Describes how the parameter value will be serialized depending on the type of the parameter value.
* @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#style-examples
*
*/
var SerializationStyle;
(function (SerializationStyle) {
/**
* Path-style parameters defined by RFC6570
*
*
* @type primitive, array, object
* @in path
*/
SerializationStyle["Matrix"] = "matrix";
/**
* Label style parameters defined by RFC6570
*
* @type primitive, array, object
* @in path
*/
SerializationStyle["Label"] = "label";
/**
* Simple style parameters defined by RFC6570. This option replaces collectionFormat with a csv value from OpenAPI 2.0.
*
* @default - path and header
* @type array
* @in path, header
*/
SerializationStyle["Simple"] = "simple";
/**
* Form style parameters defined by RFC6570. This option replaces collectionFormat with a csv (when explode is false) or multi (when explode is true) value from OpenAPI 2.0.
*
* @default - query and cookie
* @type primitive, array, object
* @in query, cookie, body
*/
SerializationStyle["Form"] = "form";
/**
* Space separated array values. This option replaces collectionFormat equal to ssv from OpenAPI 2.0.
*
* @type array
* @in query
*/
SerializationStyle["SpaceDelimited"] = "spaceDelimited";
/**
* Pipe separated array values. This option replaces collectionFormat equal to pipes from OpenAPI 2.0.
*
* @type array
* @in query
*/
SerializationStyle["PipeDelimited"] = "pipeDelimited";
/**
* Provides a simple way of rendering nested objects using form parameters.
*
* @type object
* @in query
*/
SerializationStyle["DeepObject"] = "deepObject";
/**
* Serialize to JSON text
*
* @default - body
* @type primitive, array, object
* @in body
*/
SerializationStyle["Json"] = "json";
/**
* Serialize to XML text
*
* @type primitive, array, object
* @in body
*/
SerializationStyle["Xml"] = "xml";
/**
* The content is a binary (stream)
* @type binary
* @in body
*/
SerializationStyle["Binary"] = "binary";
/**
* Tab delimited array
*/
SerializationStyle["TabDelimited"] = "tabDelimited";
})(SerializationStyle || (exports.SerializationStyle = SerializationStyle = {}));
//# sourceMappingURL=serialization-style.js.map