npm - @loopback/docs - Versions diffs - 4.0.4 → 5.1.1 - Mend

@loopback/docs 4.0.4 → 5.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (691) hide show

package/site/apidocs/rest.rawbodyparser._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(options?: RequestBodyParserOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) |  |
+|  options | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | <i>(Optional)</i> |

package/site/apidocs/rest.redirectroute._constructor_.md CHANGED Viewed

@@ -27,6 +27,6 @@ constructor(sourcePath: string, targetLocation: string, statusCode?: number);
 |  --- | --- | --- |
 |  sourcePath | string |  |
 |  targetLocation | string |  |
-|  statusCode | number |  |
+|  statusCode | number | <i>(Optional)</i> |

package/site/apidocs/rest.regexprouter._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(options?: RestRouterOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [RestRouterOptions](./rest.restrouteroptions.md) |  |
+|  options | [RestRouterOptions](./rest.restrouteroptions.md) | <i>(Optional)</i> |

package/site/apidocs/rest.rejectprovider.value.md CHANGED Viewed

@@ -24,7 +24,7 @@ static value(logError: LogError, errorWriterOptions?: ErrorWriterOptions): Rejec
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  logError | [LogError](./rest.logerror.md) |  |
-|  errorWriterOptions | ErrorWriterOptions |  |
+|  errorWriterOptions | ErrorWriterOptions | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.requestbodyparser._constructor_.md CHANGED Viewed

@@ -25,7 +25,7 @@ constructor(parsers?: BodyParser[], ctx?: Context | undefined);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  parsers | [BodyParser](./rest.bodyparser.md)<!-- -->\[\] |  |
-|  ctx | [Context](./context.context.md) \| undefined |  |
+|  parsers | [BodyParser](./rest.bodyparser.md)<!-- -->\[\] | <i>(Optional)</i> |
+|  ctx | [Context](./context.context.md) \| undefined | <i>(Optional)</i> |

package/site/apidocs/rest.requestcontext._constructor_.md CHANGED Viewed

@@ -29,6 +29,6 @@ constructor(request: Request, response: Response, parent: Context, serverConfig:
 |  response | Response |  |
 |  parent | [Context](./context.context.md) |  |
 |  serverConfig | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |

package/site/apidocs/rest.restapplication._constructor__1.md CHANGED Viewed

@@ -25,7 +25,7 @@ constructor(config?: ApplicationConfig, parent?: Context);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  config | [ApplicationConfig](./core.applicationconfig.md) | Application configuration |
-|  parent | [Context](./context.context.md) | Parent context |
+|  config | [ApplicationConfig](./core.applicationconfig.md) | <i>(Optional)</i> Application configuration |
+|  parent | [Context](./context.context.md) | <i>(Optional)</i> Parent context |

package/site/apidocs/rest.restapplication.basepath.md CHANGED Viewed

@@ -25,7 +25,7 @@ basePath(path?: string): void;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  path | string | Base path |
+|  path | string | <i>(Optional)</i> Base path |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.bodyparser.md CHANGED Viewed

@@ -26,7 +26,7 @@ bodyParser(bodyParserClass: Constructor<BodyParser>, address?: BindingAddress<Bo
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  bodyParserClass | [Constructor](./context.constructor.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt; |  |
-|  address | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt; | Optional binding address |
+|  address | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt; | <i>(Optional)</i> Optional binding address |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.exportopenapispec.md CHANGED Viewed

@@ -25,8 +25,8 @@ exportOpenApiSpec(outFile?: string, log?: (message?: any, ...optionalParams: any
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  outFile | string | File name for the spec. The extension of the file determines the format of the file. - <code>yaml</code> or <code>yml</code>: YAML - <code>json</code> or other: JSON If the outFile is not provided or its value is <code>''</code> or <code>'-'</code>, the spec is written to the console using the <code>log</code> function. |
-|  log | (message?: any, ...optionalParams: any\[\]) =&gt; void | Log function, default to <code>console.log</code> |
+|  outFile | string | <i>(Optional)</i> File name for the spec. The extension of the file determines the format of the file. - <code>yaml</code> or <code>yml</code>: YAML - <code>json</code> or other: JSON If the outFile is not provided or its value is <code>''</code> or <code>'-'</code>, the spec is written to the console using the <code>log</code> function. |
+|  log | (message?: any, ...optionalParams: any\[\]) =&gt; void | <i>(Optional)</i> Log function, default to <code>console.log</code> |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.expressmiddleware.md CHANGED Viewed

@@ -27,7 +27,7 @@ expressMiddleware(key: BindingAddress, middleware: ExpressRequestHandler | Expre
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md) | Middleware binding key |
 |  middleware | [ExpressRequestHandler](./express.expressrequesthandler.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] | Express middleware handler function(s) |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) |  |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.expressmiddleware_1.md CHANGED Viewed

@@ -26,8 +26,8 @@ expressMiddleware<CFG>(middlewareFactory: ExpressMiddlewareFactory<CFG>, middlew
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Middleware module name or factory function |
-|  middlewareConfig | CFG | Middleware config |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Options for registration |
+|  middlewareConfig | CFG | <i>(Optional)</i> Middleware config |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Options for registration |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.middleware.md CHANGED Viewed

@@ -26,7 +26,7 @@ middleware(middleware: Middleware | Constructor<Provider<Middleware>>, options?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middleware | [Middleware](./express.middleware.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;&gt; | Middleware function or provider class |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Middleware binding options |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Middleware binding options |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.mountexpressrouter.md CHANGED Viewed

@@ -27,7 +27,7 @@ mountExpressRouter(basePath: string, router: ExpressRequestHandler, spec?: Route
 |  --- | --- | --- |
 |  basePath | string | Path where to mount the router at, e.g. <code>/</code> or <code>/api</code>. |
 |  router | [ExpressRequestHandler](./express.expressrequesthandler.md) | The Express router to handle the requests. |
-|  spec | [RouterSpec](./rest.routerspec.md) | A partial OpenAPI spec describing endpoints provided by the router. LoopBack will prepend <code>basePath</code> to all endpoints automatically. This argument is optional. You can leave it out if you don't want to document the routes. |
+|  spec | [RouterSpec](./rest.routerspec.md) | <i>(Optional)</i> A partial OpenAPI spec describing endpoints provided by the router. LoopBack will prepend <code>basePath</code> to all endpoints automatically. This argument is optional. You can leave it out if you don't want to document the routes. |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.redirect.md CHANGED Viewed

@@ -27,7 +27,7 @@ redirect(fromPath: string, toPathOrUrl: string, statusCode?: number): Binding;
 |  --- | --- | --- |
 |  fromPath | string | URL path of the redirect endpoint |
 |  toPathOrUrl | string | Location (URL path or full URL) where to redirect to. If your server is configured with a custom <code>basePath</code>, then the base path is prepended to the target location. |
-|  statusCode | number | HTTP status code to respond with, defaults to 303 (See Other). |
+|  statusCode | number | <i>(Optional)</i> HTTP status code to respond with, defaults to 303 (See Other). |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.server.md CHANGED Viewed

@@ -24,7 +24,7 @@ server(server: Constructor<Server>, name?: string): Binding;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  server | [Constructor](./context.constructor.md)<!-- -->&lt;[Server](./core.server.md)<!-- -->&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.restapplication.static.md CHANGED Viewed

@@ -27,7 +27,7 @@ static(path: PathParams, rootDir: string, options?: ServeStaticOptions): void;
 |  --- | --- | --- |
 |  path | PathParams | The path(s) to serve the asset. See examples at https://expressjs.com/en/4x/api.html\#path-examples To avoid performance penalty, <code>/</code> is not allowed for now. |
 |  rootDir | string | The root directory from which to serve static assets |
-|  options | ServeStaticOptions | Options for serve-static |
+|  options | ServeStaticOptions | <i>(Optional)</i> Options for serve-static |
 <b>Returns:</b>

package/site/apidocs/rest.restcomponent._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(app: Application, config?: RestComponentConfig);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) |  |
-|  config | [RestComponentConfig](./rest.restcomponentconfig.md) |  |
+|  config | [RestComponentConfig](./rest.restcomponentconfig.md) | <i>(Optional)</i> |

package/site/apidocs/rest.resthttperrors.invaliddata.md CHANGED Viewed

@@ -25,7 +25,7 @@ function invalidData<T, Props extends object = {}>(data: T, name: string, extraP
 |  --- | --- | --- |
 |  data | T |  |
 |  name | string |  |
-|  extraProperties | Props |  |
+|  extraProperties | Props | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.resthttperrors.unsupportedmediatype.md CHANGED Viewed

@@ -28,7 +28,7 @@ function unsupportedMediaType(contentType: string, allowedTypes?: string[]): Htt
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  contentType | string |  |
-|  allowedTypes | string\[\] |  |
+|  allowedTypes | string\[\] | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.restserver._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(app: Application, config?: RestServerConfig);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) | The application instance (injected via CoreBindings.APPLICATION\_INSTANCE). |
-|  config | [RestServerConfig](./rest.restserverconfig.md) | The configuration options (injected via RestBindings.CONFIG). |
+|  config | [RestServerConfig](./rest.restserverconfig.md) | <i>(Optional)</i> The configuration options (injected via RestBindings.CONFIG). |

package/site/apidocs/rest.restserver.addopenapispecendpoint.md CHANGED Viewed

@@ -27,7 +27,7 @@ addOpenApiSpecEndpoint(path: string, form: OpenApiSpecForm, router?: express.Rou
 |  --- | --- | --- |
 |  path | string | Path at which to host the copy of the OpenAPI |
 |  form | [OpenApiSpecForm](./rest.openapispecform.md) | Form that should be rendered from that path |
-|  router | express.Router |  |
+|  router | express.Router | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.basepath.md CHANGED Viewed

@@ -25,7 +25,7 @@ basePath(path?: string): void;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  path | string | Base path |
+|  path | string | <i>(Optional)</i> Base path |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.bodyparser.md CHANGED Viewed

@@ -26,7 +26,7 @@ bodyParser(bodyParserClass: Constructor<BodyParser>, address?: BindingAddress<Bo
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  bodyParserClass | [Constructor](./context.constructor.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt; |  |
-|  address | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt; | Optional binding address |
+|  address | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;[BodyParser](./rest.bodyparser.md)<!-- -->&gt; | <i>(Optional)</i> Optional binding address |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.exportopenapispec.md CHANGED Viewed

@@ -25,8 +25,8 @@ exportOpenApiSpec(outFile?: string, log?: (message?: any, ...optionalParams: any
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  outFile | string | File name for the spec. The extension of the file determines the format of the file. - <code>yaml</code> or <code>yml</code>: YAML - <code>json</code> or other: JSON If the outFile is not provided or its value is <code>''</code> or <code>'-'</code>, the spec is written to the console using the <code>log</code> function. |
-|  log | (message?: any, ...optionalParams: any\[\]) =&gt; void | Log function, default to <code>console.log</code> |
+|  outFile | string | <i>(Optional)</i> File name for the spec. The extension of the file determines the format of the file. - <code>yaml</code> or <code>yml</code>: YAML - <code>json</code> or other: JSON If the outFile is not provided or its value is <code>''</code> or <code>'-'</code>, the spec is written to the console using the <code>log</code> function. |
+|  log | (message?: any, ...optionalParams: any\[\]) =&gt; void | <i>(Optional)</i> Log function, default to <code>console.log</code> |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.getapispec.md CHANGED Viewed

@@ -29,7 +29,7 @@ getApiSpec(requestContext?: RequestContext): Promise<OpenApiSpec>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  requestContext | [RequestContext](./rest.requestcontext.md) | Optional context to update the <code>servers</code> list in the returned spec |
+|  requestContext | [RequestContext](./rest.requestcontext.md) | <i>(Optional)</i> Optional context to update the <code>servers</code> list in the returned spec |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.mountexpressrouter.md CHANGED Viewed

@@ -27,7 +27,7 @@ mountExpressRouter(basePath: string, router: ExpressRequestHandler, spec?: Route
 |  --- | --- | --- |
 |  basePath | string | Path where to mount the router at, e.g. <code>/</code> or <code>/api</code>. |
 |  router | [ExpressRequestHandler](./express.expressrequesthandler.md) | The Express router to handle the requests. |
-|  spec | [RouterSpec](./rest.routerspec.md) | A partial OpenAPI spec describing endpoints provided by the router. LoopBack will prepend <code>basePath</code> to all endpoints automatically. This argument is optional. You can leave it out if you don't want to document the routes. |
+|  spec | [RouterSpec](./rest.routerspec.md) | <i>(Optional)</i> A partial OpenAPI spec describing endpoints provided by the router. LoopBack will prepend <code>basePath</code> to all endpoints automatically. This argument is optional. You can leave it out if you don't want to document the routes. |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.redirect.md CHANGED Viewed

@@ -27,7 +27,7 @@ redirect(fromPath: string, toPathOrUrl: string, statusCode?: number): Binding;
 |  --- | --- | --- |
 |  fromPath | string | URL path of the redirect endpoint |
 |  toPathOrUrl | string | Location (URL path or full URL) where to redirect to. If your server is configured with a custom <code>basePath</code>, then the base path is prepended to the target location. |
-|  statusCode | number | HTTP status code to respond with, defaults to 303 (See Other). |
+|  statusCode | number | <i>(Optional)</i> HTTP status code to respond with, defaults to 303 (See Other). |
 <b>Returns:</b>

package/site/apidocs/rest.restserver.static.md CHANGED Viewed

@@ -27,7 +27,7 @@ static(path: PathParams, rootDir: string, options?: ServeStaticOptions): void;
 |  --- | --- | --- |
 |  path | PathParams | The path(s) to serve the asset. See examples at https://expressjs.com/en/4x/api.html\#path-examples |
 |  rootDir | string | The root directory from which to serve static assets |
-|  options | ServeStaticOptions | Options for serve-static |
+|  options | ServeStaticOptions | <i>(Optional)</i> Options for serve-static |
 <b>Returns:</b>

package/site/apidocs/rest.routesource.md CHANGED Viewed

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.routesource.html
 ```typescript
 export declare class RouteSource implements InvocationSource<RouteEntry>
 ```
-<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- -->&lt;[RouteEntry](./rest.routeentry.md)<!-- -->&gt;
+<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- -->&lt;[RouteEntry](./rest.routeentry.md)
 ## Constructors

package/site/apidocs/rest.routingtable._constructor_.md CHANGED Viewed

@@ -25,7 +25,7 @@ constructor(_router?: RestRouter, _externalRoutes?: ExternalExpressRoutes | unde
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  \_router | [RestRouter](./rest.restrouter.md) |  |
-|  \_externalRoutes | ExternalExpressRoutes \| undefined |  |
+|  \_router | [RestRouter](./rest.restrouter.md) | <i>(Optional)</i> |
+|  \_externalRoutes | ExternalExpressRoutes \| undefined | <i>(Optional)</i> |

package/site/apidocs/rest.routingtable.registercontroller.md CHANGED Viewed

@@ -27,7 +27,7 @@ registerController<T>(spec: ControllerSpec, controllerCtor: ControllerClass<T>,
 |  --- | --- | --- |
 |  spec | [ControllerSpec](./openapi-v3.controllerspec.md) |  |
 |  controllerCtor | [ControllerClass](./rest.controllerclass.md)<!-- -->&lt;T&gt; |  |
-|  controllerFactory | [ControllerFactory](./rest.controllerfactory.md)<!-- -->&lt;T&gt; |  |
+|  controllerFactory | [ControllerFactory](./rest.controllerfactory.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.sanitizejsonparse.md CHANGED Viewed

@@ -25,8 +25,8 @@ export declare function sanitizeJsonParse(reviver?: (key: any, value: any) => an
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  reviver | (key: any, value: any) =&gt; any | Reviver function |
-|  prohibitedKeys | string\[\] | An array of keys to be rejected |
+|  reviver | (key: any, value: any) =&gt; any | <i>(Optional)</i> Reviver function |
+|  prohibitedKeys | string\[\] | <i>(Optional)</i> An array of keys to be rejected |
 <b>Returns:</b>

package/site/apidocs/rest.sendresponsemiddlewareprovider.md CHANGED Viewed

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.sendresponsemiddlewareprovider.html
 ```typescript
 export declare class SendResponseMiddlewareProvider implements Provider<Middleware>
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)
 ## Methods

package/site/apidocs/rest.textbodyparser._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(options?: RequestBodyParserOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) |  |
+|  options | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | <i>(Optional)</i> |

package/site/apidocs/rest.trierouter._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(options?: RestRouterOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [RestRouterOptions](./rest.restrouteroptions.md) |  |
+|  options | [RestRouterOptions](./rest.restrouteroptions.md) | <i>(Optional)</i> |

package/site/apidocs/rest.urlencodedbodyparser._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(options?: RequestBodyParserOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) |  |
+|  options | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | <i>(Optional)</i> |

package/site/apidocs/rest.validateapipath.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function validateApiPath(path?: string): string;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  path | string |  |
+|  path | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/rest.validaterequestbody.md CHANGED Viewed

@@ -26,9 +26,9 @@ export declare function validateRequestBody(body: RequestBody, requestBodySpec?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  body | [RequestBody](./rest.requestbody.md) | The request body parsed from an HTTP request. |
-|  requestBodySpec | RequestBodyObject | The OpenAPI requestBody specification defined in <code>@requestBody()</code>. |
-|  globalSchemas | SchemasObject | The referenced schemas generated from <code>OpenAPISpec.components.schemas</code>. |
-|  options | [ValidationOptions](./rest.validationoptions.md) | Request body validation options for AJV |
+|  requestBodySpec | RequestBodyObject | <i>(Optional)</i> The OpenAPI requestBody specification defined in <code>@requestBody()</code>. |
+|  globalSchemas | SchemasObject | <i>(Optional)</i> The referenced schemas generated from <code>OpenAPISpec.components.schemas</code>. |
+|  options | [ValidationOptions](./rest.validationoptions.md) | <i>(Optional)</i> Request body validation options for AJV |
 <b>Returns:</b>

package/site/apidocs/rest.validatevalueagainstschema.md CHANGED Viewed

@@ -27,8 +27,8 @@ export declare function validateValueAgainstSchema(value: any, schema: SchemaObj
 |  --- | --- | --- |
 |  value | any | The data value. |
 |  schema | SchemaObject \| ReferenceObject | The JSON schema used to perform the validation. |
-|  globalSchemas | SchemasObject | Schema references. |
-|  options | [ValueValidationOptions](./rest.valuevalidationoptions.md) | Value validation options. |
+|  globalSchemas | SchemasObject | <i>(Optional)</i> Schema references. |
+|  options | [ValueValidationOptions](./rest.valuevalidationoptions.md) | <i>(Optional)</i> Value validation options. |
 <b>Returns:</b>

package/site/apidocs/service-proxy.applicationwithservices.component.md CHANGED Viewed

@@ -24,7 +24,7 @@ component(component: Constructor<{}>, name?: string): Binding;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  component | [Constructor](./context.constructor.md)<!-- -->&lt;{}&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/service-proxy.applicationwithservices.serviceprovider.md CHANGED Viewed

@@ -24,7 +24,7 @@ serviceProvider<S>(provider: Constructor<Provider<S>>, name?: string): Binding<S
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  provider | [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;S&gt;&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>