npm - @loopback/docs - Versions diffs - 8.0.9 → 8.0.10 - Mend

@loopback/docs 8.0.9 → 8.0.10

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 (1102) hide show

package/site/apidocs/openapi-v3.mergesecurityschemetospec.md CHANGED Viewed

@@ -39,47 +39,47 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 spec
-</td><td>
+</td><td markdown="1">
 [OpenApiSpec](./openapi-v3.openapispec.md)
-</td><td>
+</td><td markdown="1">
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 schemeName
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 The name of the security scheme to be added
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 schemeSpec
-</td><td>
+</td><td markdown="1">
 SecuritySchemeObject
-</td><td>
+</td><td markdown="1">
 The security scheme spec body to be added,

package/site/apidocs/openapi-v3.oasenhancer.md CHANGED Viewed

@@ -44,20 +44,20 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [name](./openapi-v3.oasenhancer.name.md)
-</td><td>
+</td><td markdown="1">
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 </td></tr>
@@ -76,12 +76,12 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [modifySpec(spec)](./openapi-v3.oasenhancer.modifyspec.md)
-</td><td>
+</td><td markdown="1">
 </td></tr>

package/site/apidocs/openapi-v3.oasenhancer.modifyspec.md CHANGED Viewed

@@ -37,17 +37,17 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 spec
-</td><td>
+</td><td markdown="1">
 [OpenApiSpec](./openapi-v3.openapispec.md)
-</td><td>
+</td><td markdown="1">
 </td></tr>

package/site/apidocs/openapi-v3.oasenhancerbindings.md CHANGED Viewed

@@ -32,23 +32,23 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [OAS\_ENHANCER\_EXTENSION\_POINT\_NAME](./openapi-v3.oasenhancerbindings.oas_enhancer_extension_point_name.md)
-</td><td>
+</td><td markdown="1">
 Name/id of the OAS enhancer extension point
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [OAS\_ENHANCER\_SERVICE](./openapi-v3.oasenhancerbindings.oas_enhancer_service.md)
-</td><td>
+</td><td markdown="1">
 Strongly-typed binding key for SpecService

package/site/apidocs/openapi-v3.oasenhancerservice._constructor_.md CHANGED Viewed

@@ -41,31 +41,31 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 getEnhancers
-</td><td>
+</td><td markdown="1">
 Getter&lt;[OASEnhancer](./openapi-v3.oasenhancer.md)<!-- -->\[\]&gt;
-</td><td>
+</td><td markdown="1">
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 options
-</td><td>
+</td><td markdown="1">
 [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined
-</td><td>
+</td><td markdown="1">
 _(Optional)_

package/site/apidocs/openapi-v3.oasenhancerservice.applyallenhancers.md CHANGED Viewed

@@ -39,17 +39,17 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 options
-</td><td>
+</td><td markdown="1">
 {}
-</td><td>
+</td><td markdown="1">
 _(Optional)_

package/site/apidocs/openapi-v3.oasenhancerservice.applyenhancerbyname.md CHANGED Viewed

@@ -39,17 +39,17 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 name
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 The name of the enhancer you want to apply

package/site/apidocs/openapi-v3.oasenhancerservice.getenhancerbyname.md CHANGED Viewed

@@ -39,17 +39,17 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 name
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 The name of the enhancer you want to find

package/site/apidocs/openapi-v3.oasenhancerservice.md CHANGED Viewed

@@ -41,15 +41,15 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [(constructor)(getEnhancers, options)](./openapi-v3.oasenhancerservice._constructor_.md)
-</td><td>
+</td><td markdown="1">
-</td><td>
+</td><td markdown="1">
 Constructs a new instance of the `OASEnhancerService` class
@@ -80,41 +80,41 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [options?](./openapi-v3.oasenhancerservice.options.md)
-</td><td>
+</td><td markdown="1">
 `readonly`
-</td><td>
+</td><td markdown="1">
 [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined
-</td><td>
+</td><td markdown="1">
 _(Optional)_ An extension point should be able to receive its options via dependency injection.
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [spec](./openapi-v3.oasenhancerservice.spec.md)
-</td><td>
+</td><td markdown="1">
-</td><td>
+</td><td markdown="1">
 [OpenApiSpec](./openapi-v3.openapispec.md)
-</td><td>
+</td><td markdown="1">
 Getter for `_spec`
@@ -140,43 +140,43 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [applyAllEnhancers(options)](./openapi-v3.oasenhancerservice.applyallenhancers.md)
-</td><td>
+</td><td markdown="1">
-</td><td>
+</td><td markdown="1">
 Generate OpenAPI spec by applying ALL registered enhancers TBD: load enhancers by group names
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [applyEnhancerByName(name)](./openapi-v3.oasenhancerservice.applyenhancerbyname.md)
-</td><td>
+</td><td markdown="1">
-</td><td>
+</td><td markdown="1">
 Apply a given enhancer's merge function. Return the latest \_spec.
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [getEnhancerByName(name)](./openapi-v3.oasenhancerservice.getenhancerbyname.md)
-</td><td>
+</td><td markdown="1">
-</td><td>
+</td><td markdown="1">
 Find an enhancer by its name

package/site/apidocs/openapi-v3.operation.md CHANGED Viewed

@@ -39,49 +39,49 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 verb
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 HTTP verb, e.g. `GET` or `POST`<!-- -->.
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 path
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 The URL path of this operation, e.g. `/product/{id}`
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 spec
-</td><td>
+</td><td markdown="1">
 OperationObject
-</td><td>
+</td><td markdown="1">
 _(Optional)_ The OpenAPI specification describing parameters and responses of this operation.

package/site/apidocs/openapi-v3.operationvisibility.md CHANGED Viewed

@@ -37,31 +37,31 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 DOCUMENTED
-</td><td>
+</td><td markdown="1">
 `"documented"`
-</td><td>
+</td><td markdown="1">
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 UNDOCUMENTED
-</td><td>
+</td><td markdown="1">
 `"undocumented"`
-</td><td>
+</td><td markdown="1">
 </td></tr>

package/site/apidocs/openapi-v3.param.array.md CHANGED Viewed

@@ -39,49 +39,49 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 name
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 Parameter name
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 source
-</td><td>
+</td><td markdown="1">
 ParameterLocation
-</td><td>
+</td><td markdown="1">
 Source of the parameter value
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 itemSpec
-</td><td>
+</td><td markdown="1">
 SchemaObject \| ReferenceObject
-</td><td>
+</td><td markdown="1">
 Item type for the array or the full item object

package/site/apidocs/openapi-v3.param.filter.md CHANGED Viewed

@@ -41,33 +41,33 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 modelCtor
-</td><td>
+</td><td markdown="1">
 typeof Model
-</td><td>
+</td><td markdown="1">
 Model class
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 options
-</td><td>
+</td><td markdown="1">
 string \| ([FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) &amp; { name?: string; })
-</td><td>
+</td><td markdown="1">
 _(Optional)_ Options to customize the parameter name or filter schema

package/site/apidocs/openapi-v3.param.md CHANGED Viewed

@@ -34,34 +34,34 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [array(name, source, itemSpec)](./openapi-v3.param.array.md)
-</td><td>
+</td><td markdown="1">
 Define a parameter of `array` type.
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [filter(modelCtor, options)](./openapi-v3.param.filter.md)
-</td><td>
+</td><td markdown="1">
 Sugar decorator for `filter` query parameter
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [where(modelCtor, name)](./openapi-v3.param.where.md)
-</td><td>
+</td><td markdown="1">
 Sugar decorator for `where` query parameter
@@ -82,34 +82,34 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 [header](./openapi-v3.param.header.md)
-</td><td>
+</td><td markdown="1">
 Header parameter decorator
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [path](./openapi-v3.param.path.md)
-</td><td>
+</td><td markdown="1">
 Path parameter decorator
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 [query](./openapi-v3.param.query.md)
-</td><td>
+</td><td markdown="1">
 Query parameter decorator

package/site/apidocs/openapi-v3.param.where.md CHANGED Viewed

@@ -39,33 +39,33 @@ Description
 </th></tr></thead>
-<tbody><tr><td>
+<tbody><tr><td markdown="1">
 modelCtor
-</td><td>
+</td><td markdown="1">
 typeof Model
-</td><td>
+</td><td markdown="1">
 Model class
 </td></tr>
-<tr><td>
+<tr><td markdown="1">
 name
-</td><td>
+</td><td markdown="1">
 string
-</td><td>
+</td><td markdown="1">
 _(Optional)_ Custom name for the parameter, default to `where`