@loopback/docs
Version:
Documentation for LoopBack 4
1,382 lines • 77.1 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.6.2",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/openapi-v3!",
"docComment": "",
"name": "@loopback/openapi-v3",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/openapi-v3!",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!api:function(1)",
"docComment": "/**\n * Decorate the given Controller constructor with metadata describing the HTTP/REST API the Controller implements/provides.\n *\n * `@api` can be applied to controller classes.\n *\n * @param spec - OpenAPI specification describing the endpoints handled by this controller\n *\n * @example\n * ```ts\n * @api({basePath: '/my'})\n * class MyController {\n * // ...\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function api(spec: "
},
{
"kind": "Reference",
"text": "ControllerSpec",
"canonicalReference": "@loopback/openapi-v3!ControllerSpec:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ClassDecorator",
"canonicalReference": "!ClassDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "api"
},
{
"kind": "Interface",
"canonicalReference": "@loopback/openapi-v3!ControllerSpec:interface",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ControllerSpec "
}
],
"releaseTag": "Public",
"name": "ControllerSpec",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/openapi-v3!ControllerSpec#basePath:member",
"docComment": "/**\n * The base path on which the Controller API is served. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/).\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "basePath?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "basePath",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/openapi-v3!ControllerSpec#components:member",
"docComment": "/**\n * OpenAPI components.schemas generated from model metadata\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "components?: "
},
{
"kind": "Reference",
"text": "ComponentsObject",
"canonicalReference": "openapi3-ts!ComponentsObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "components",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/openapi-v3!ControllerSpec#paths:member",
"docComment": "/**\n * The available paths and operations for the API.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "paths: "
},
{
"kind": "Reference",
"text": "PathObject",
"canonicalReference": "openapi3-ts!PathObject:type"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "paths",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!createEmptyApiSpec:function(1)",
"docComment": "/**\n * Create an empty OpenApiSpec object that's still a valid openapi document.\n *\n * @deprecated\n *\n * Use `OpenApiBuilder` from `openapi3-ts` instead.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createEmptyApiSpec(): "
},
{
"kind": "Reference",
"text": "OpenApiSpec",
"canonicalReference": "@loopback/openapi-v3!OpenApiSpec:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "createEmptyApiSpec"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!del:function(1)",
"docComment": "/**\n * Expose a Controller method as a REST API operation mapped to `DELETE` request method.\n *\n * @param path - The URL path of this operation, e.g. `/product/{id}`\n *\n * @param spec - The OpenAPI specification describing parameters and responses of this operation.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function del(path: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", spec?: "
},
{
"kind": "Reference",
"text": "OperationObject",
"canonicalReference": "openapi3-ts!OperationObject:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MethodDecorator",
"canonicalReference": "!MethodDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "path",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "del"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!get:function(1)",
"docComment": "/**\n * Expose a Controller method as a REST API operation mapped to `GET` request method.\n *\n * @param path - The URL path of this operation, e.g. `/product/{id}`\n *\n * @param spec - The OpenAPI specification describing parameters and responses of this operation.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function get(path: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", spec?: "
},
{
"kind": "Reference",
"text": "OperationObject",
"canonicalReference": "openapi3-ts!OperationObject:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MethodDecorator",
"canonicalReference": "!MethodDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "path",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "get"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!getControllerSpec:function(1)",
"docComment": "/**\n * Get the controller spec for the given class\n *\n * @param constructor - Controller class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getControllerSpec(constructor: "
},
{
"kind": "Reference",
"text": "Function",
"canonicalReference": "!Function:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ControllerSpec",
"canonicalReference": "@loopback/openapi-v3!ControllerSpec:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "constructor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "getControllerSpec"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!getFilterSchemaFor:function(1)",
"docComment": "/**\n * Build an OpenAPI schema describing the format of the \"filter\" object used to query model instances.\n *\n * Note we don't take the model properties into account yet and return a generic json schema allowing any \"where\" condition.\n *\n * @param modelCtor - The model constructor to build the filter schema for.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getFilterSchemaFor(modelCtor: "
},
{
"kind": "Content",
"text": "typeof "
},
{
"kind": "Reference",
"text": "Model",
"canonicalReference": "@loopback/repository!Model:class"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SchemaObject",
"canonicalReference": "openapi3-ts!SchemaObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "modelCtor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"name": "getFilterSchemaFor"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!getModelSchemaRef:function(1)",
"docComment": "/**\n * Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema.\n *\n * @param modelCtor - The model constructor (e.g. `Product`)\n *\n * @param options - Additional options\n *\n * @example\n * ```ts\n * const schema = {\n * $ref: '#/components/schemas/Product',\n * definitions: {\n * Product: {\n * title: 'Product',\n * properties: {\n * // etc.\n * }\n * }\n * }\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getModelSchemaRef<T extends "
},
{
"kind": "Content",
"text": "object"
},
{
"kind": "Content",
"text": ">(modelCtor: "
},
{
"kind": "Reference",
"text": "Function",
"canonicalReference": "!Function:interface"
},
{
"kind": "Content",
"text": " & {\n prototype: T;\n}"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "JsonSchemaOptions",
"canonicalReference": "@loopback/repository-json-schema!JsonSchemaOptions:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SchemaRef",
"canonicalReference": "@loopback/openapi-v3!SchemaRef:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "modelCtor",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "getModelSchemaRef"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!getWhereSchemaFor:function(1)",
"docComment": "/**\n * Build a OpenAPI schema describing the format of the \"where\" object used to filter model instances to query, update or delete.\n *\n * Note we don't take the model properties into account yet and return a generic json schema allowing any \"where\" condition.\n *\n * @param modelCtor - The model constructor to build the filter schema for.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getWhereSchemaFor(modelCtor: "
},
{
"kind": "Content",
"text": "typeof "
},
{
"kind": "Reference",
"text": "Model",
"canonicalReference": "@loopback/repository!Model:class"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SchemaObject",
"canonicalReference": "openapi3-ts!SchemaObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "modelCtor",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"name": "getWhereSchemaFor"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!jsonOrBooleanToJSON:function(1)",
"docComment": "/**\n * Helper function used to interpret boolean values as JSON Schemas. See http://json-schema.org/draft-06/json-schema-release-notes.html\n *\n * @param jsonOrBool - converts boolean values into their representative JSON Schemas\n *\n * @returns A JSON Schema document representing the input value.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function jsonOrBooleanToJSON(jsonOrBool: "
},
{
"kind": "Content",
"text": "boolean | "
},
{
"kind": "Reference",
"text": "JsonSchema",
"canonicalReference": "@types/json-schema!JSONSchema6:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "JsonSchema",
"canonicalReference": "@types/json-schema!JSONSchema6:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "jsonOrBool",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"name": "jsonOrBooleanToJSON"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!jsonToSchemaObject:function(1)",
"docComment": "/**\n * Converts JSON Schemas into a SchemaObject\n *\n * @param json - JSON Schema to convert from\n *\n * @param visited - A map to keep track of mapped json schemas to handle circular references\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function jsonToSchemaObject(json: "
},
{
"kind": "Reference",
"text": "JsonSchema",
"canonicalReference": "@types/json-schema!JSONSchema6:interface"
},
{
"kind": "Content",
"text": ", visited?: "
},
{
"kind": "Reference",
"text": "Map",
"canonicalReference": "!Map:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "JsonSchema",
"canonicalReference": "@types/json-schema!JSONSchema6:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "SchemaObject",
"canonicalReference": "openapi3-ts!SchemaObject:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "SchemaRef",
"canonicalReference": "@loopback/openapi-v3!SchemaRef:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "SchemaObject",
"canonicalReference": "openapi3-ts!SchemaObject:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "SchemaRef",
"canonicalReference": "@loopback/openapi-v3!SchemaRef:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "json",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "visited",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 11
}
}
],
"name": "jsonToSchemaObject"
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/openapi-v3!OpenApiSpec:type",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type OpenApiSpec = "
},
{
"kind": "Reference",
"text": "OpenAPIObject",
"canonicalReference": "openapi3-ts!OpenAPIObject:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "OpenApiSpec",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!operation:function(1)",
"docComment": "/**\n * Expose a Controller method as a REST API operation.\n *\n * @param verb - HTTP verb, e.g. `GET` or `POST`.\n *\n * @param path - The URL path of this operation, e.g. `/product/{id}`\n *\n * @param spec - The OpenAPI specification describing parameters and responses of this operation.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function operation(verb: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", path: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", spec?: "
},
{
"kind": "Reference",
"text": "OperationObject",
"canonicalReference": "openapi3-ts!OperationObject:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "MethodDecorator",
"canonicalReference": "!MethodDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "verb",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "path",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "operation"
},
{
"kind": "Function",
"canonicalReference": "@loopback/openapi-v3!param:function(1)",
"docComment": "/**\n * Describe an input parameter of a Controller method.\n *\n * `@param` must be applied to parameters.\n *\n * @param paramSpec - Parameter specification.\n *\n * @example\n * ```ts\n * class MyController {\n * @get('/')\n * list(\n * @param(offsetSpec) offset?: number,\n * @param(pageSizeSpec) pageSize?: number,\n * ) {}\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function param(paramSpec: "
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "(target: object, member: string, index: number) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "paramSpec",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "param"
},
{
"kind": "Namespace",
"canonicalReference": "@loopback/openapi-v3!param:namespace",
"docComment": "/**\n * Namespace for `@param.*` decorators\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace param "
}
],
"releaseTag": "Public",
"name": "param",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/openapi-v3!param.array:var",
"docComment": "/**\n * Define a parameter of `array` type.\n *\n * @param name - Parameter name\n *\n * @param source - Source of the parameter value\n *\n * @param itemSpec - Item type for the array or the full item object\n *\n * @example\n * ```ts\n * export class MyController {\n * @get('/greet')\n * greet(@param.array('names', 'query', {type: 'string'}) names: string[]): string {\n * return `Hello, ${names}`;\n * }\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "array: "
},
{
"kind": "Content",
"text": "(name: string, source: "
},
{
"kind": "Reference",
"text": "ParameterLocation",
"canonicalReference": "openapi3-ts!ParameterLocation:type"
},
{
"kind": "Content",
"text": ", itemSpec: "
},
{
"kind": "Reference",
"text": "SchemaObject",
"canonicalReference": "openapi3-ts!SchemaObject:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "ReferenceObject",
"canonicalReference": "openapi3-ts!ReferenceObject:interface"
},
{
"kind": "Content",
"text": ") => (target: object, member: string, index: number) => void"
}
],
"releaseTag": "Public",
"name": "array",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/openapi-v3!param.header:var",
"docComment": "/**\n * Header parameter decorator\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "header: "
},
{
"kind": "Content",
"text": "{\n string: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n number: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n boolean: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n integer: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n long: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n float: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n double: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n byte: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n binary: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n date: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n dateTime: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n password: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n }"
}
],
"releaseTag": "Public",
"name": "header",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 50
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/openapi-v3!param.path:var",
"docComment": "/**\n * Path parameter decorator\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "path: "
},
{
"kind": "Content",
"text": "{\n string: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n number: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n boolean: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n integer: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n long: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n float: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n double: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n byte: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n binary: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n date: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n dateTime: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n password: (name: string, spec?: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ParameterObject",
"canonicalReference": "openapi3-ts!ParameterObject:interface"
},
{
"kind": "Content",
"text": "> | undefined) => (target: object, member: string, index: number) => void;\n }"
}
],
"releaseTag": "Public",
"name": "path",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 50
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/openapi-v3!param.query:var",
"docComment": "/**\n * Query parameter decorator\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "query: "
},
{
"kind": "Content",
"text": "{\n string: (name: string, spec?: "
},
{
"kind": "Reference",
"te