@loopback/docs 4.0.4 → 5.1.1

package/CHANGELOG.md

@@ -3,6 +3,77 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.1.0...@loopback/docs@5.1.1) (2022-07-14)
+
+
+### Bug Fixes
+
+* **docs:** docs link for discovering models ([1e48456](https://github.com/loopbackio/loopback-next/commit/1e48456fde20e691d85b506f5c8e296c3c64b1fe))
+* **docs:** documentation fix for creater text in polymorphic relation ([3252073](https://github.com/loopbackio/loopback-next/commit/3252073231bfb7af9ed45f12f9ebd68286e313ed))
+* **docs:** documentation fix in deployment docs ([9e9cea2](https://github.com/loopbackio/loopback-next/commit/9e9cea28e6e960c8d5e10e4be246101d8d3ba6df))
+* **docs:** documentation fix in repository ([59de2af](https://github.com/loopbackio/loopback-next/commit/59de2af817b9674a42f243c1de8be6a0b0afdadc))
+* **docs:** documentation fix in req response cycle ([5c1447a](https://github.com/loopbackio/loopback-next/commit/5c1447a6ef46ab381539d4a1d23252f310a5721e))
+* **docs:** documentation fix in req response cycle ([9f5487e](https://github.com/loopbackio/loopback-next/commit/9f5487e7e89d5a1775c6e4b01a64831c56405dd3))
+* **docs:** documentation fix in service static files ([103fe91](https://github.com/loopbackio/loopback-next/commit/103fe91e271967d80ed8cbc0a8211c3d9366f0c4))
+* **docs:** documentation fix of for infered text ([0150199](https://github.com/loopbackio/loopback-next/commit/01501990531acaf5beba786180bb6c63b56de69e))
+* **docs:** documentation fix of for overridden text ([2f45572](https://github.com/loopbackio/loopback-next/commit/2f4557228d4cce50ddff742abe10cc306ffbb1e7))
+* **docs:** documentation fix of for repository generator ([0c5efab](https://github.com/loopbackio/loopback-next/commit/0c5efab81c7a0f79da066574f23ec00448b36195))
+* **docs:** documentation fix typo from sematics ([57e325a](https://github.com/loopbackio/loopback-next/commit/57e325a8b2be674478c0a2c1ba394703c323609e))
+* **docs:** documentation typo fix from extention to extension ([7d16db0](https://github.com/loopbackio/loopback-next/commit/7d16db08f539b477d779428ce0fa1fc920d223db))
+* **docs:** documentation typo fix in context in action ([b02f55b](https://github.com/loopbackio/loopback-next/commit/b02f55bfff45cb856f38c60974c5434015b29785))
+* **docs:** documentation typo fix in filters query and relation ([2521d95](https://github.com/loopbackio/loopback-next/commit/2521d950bba75c197fd1ac5aab437ed8127a5a09))
+* **docs:** documentation typo fix in request response cycle ([19d2bf3](https://github.com/loopbackio/loopback-next/commit/19d2bf364ba8a20eb3a3229fa9677c340878a3ce))
+* **docs:** documentation typo update for recevies ([41ccae8](https://github.com/loopbackio/loopback-next/commit/41ccae8505e9b68e20739c7023b84de98ffe0e8e))
+* **docs:** documentation update for context ([390fa12](https://github.com/loopbackio/loopback-next/commit/390fa124142a489b92f1dbae677ec66ebd915f9d))
+* **docs:** documentation update for non global interceptor ([e6eacff](https://github.com/loopbackio/loopback-next/commit/e6eacffa3b36c1769861ad5a4db71c615c17b1f3))
+* **docs:** documentation updates for datasoure to datasource ([c05a7e6](https://github.com/loopbackio/loopback-next/commit/c05a7e6f8b50c2db51a157f94c2b77fbcc8b7406))
+* **docs:** fix document typo from moreved to removed ([468a014](https://github.com/loopbackio/loopback-next/commit/468a01451d5e802ba87b82c3d9d12ac0703d6920))
+* **docs:** fix in docs for typos in bootind and other docs ([2912fa9](https://github.com/loopbackio/loopback-next/commit/2912fa9216af3f107790672f6fa1331065b2ec9d))
+* **docs:** fix in docs of crafting loopback for extensible typo ([ff023d2](https://github.com/loopbackio/loopback-next/commit/ff023d231c8db16910aa830e783f54b94af843dd))
+* **docs:** fix in docs of crafting loopback for typo ([0329dd0](https://github.com/loopbackio/loopback-next/commit/0329dd0479314225d4634bd0e8fa1c9c765a084b))
+* **docs:** fix in docs of crafting loopback for typo ([610f10a](https://github.com/loopbackio/loopback-next/commit/610f10a105f2f9dab23d4344112e7ad52e5ea31a))
+* **docs:** fix in docs of dynamic models for typo ([71a8ab6](https://github.com/loopbackio/loopback-next/commit/71a8ab6ef9e8ff566298221551373b7672404643))
+* **docs:** fix in docs of dynamic models for typo respositories ([e3f295d](https://github.com/loopbackio/loopback-next/commit/e3f295dabe09ca6510ba067721316989b4e7f60d))
+* **docs:** fix in documentation of belongs to relation ([850c5b8](https://github.com/loopbackio/loopback-next/commit/850c5b83ae78e70f12cd32d37958f803a1694ad7))
+* **docs:** fix typo in documentation from begining to beginning ([ca1bd55](https://github.com/loopbackio/loopback-next/commit/ca1bd55c9781b2e9a3527c4d27ef14282afb9bb2))
+* **docs:** middleware sequence document update ([f0875e2](https://github.com/loopbackio/loopback-next/commit/f0875e27b9499f706bf8cf95fe36a02ce2d3a28b))
+* **docs:** model documentation fix for typo ([e7448c7](https://github.com/loopbackio/loopback-next/commit/e7448c7e6818c0a214a90c03b51d2b7907dce032))
+* **docs:** model generator documentation typo fix ([428b357](https://github.com/loopbackio/loopback-next/commit/428b3573488c8e911e8c73f1355d3b54d51456c9))
+* **docs:** passport documentation fix for typo ([8852b0a](https://github.com/loopbackio/loopback-next/commit/8852b0aeeefc6080628ce95ccd17f1bb6a719c8e))
+
+
+
+
+
+# [5.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.0.0...@loopback/docs@5.1.0) (2022-06-13)
+
+
+### Features
+
+* **cli:** add option to create relations in cli discover command ([37a5f73](https://github.com/loopbackio/loopback-next/commit/37a5f73ada12b64035ef32b01411c28d72058887))
+* **cli:** add option to mark id field as not required in discover command ([497b21d](https://github.com/loopbackio/loopback-next/commit/497b21d84d970a8dcc714d059108cabdf99d46e0))
+* **rest-crud:** add option to create readonly rest-crud apis ([6ae1423](https://github.com/loopbackio/loopback-next/commit/6ae142302ca61363a357559ba42243bdaf4f7256))
+
+
+
+
+
+## [5.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@4.0.4...@loopback/docs@5.0.0) (2022-05-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove node v12 support
+
+### Features
+
+* add polymorphic relations ([f4b8158](https://github.com/loopbackio/loopback-next/commit/f4b8158387222ec64fe7ef6971da8151f2016dda)), closes [#2487](https://github.com/loopbackio/loopback-next/issues/2487)
+* add support for node v18 ([ccb4c61](https://github.com/loopbackio/loopback-next/commit/ccb4c61307d94ab7bb07a19c547dfc4fa7d388a8))
+* remove node v12 support ([5f66e5b](https://github.com/loopbackio/loopback-next/commit/5f66e5bd288ba806b3aa6550fc29c5009de8b60d))
+* **repository:** support `ReferencesMany` relation ([371a6dc](https://github.com/loopbackio/loopback-next/commit/371a6dcdf32d1a9a674f22528160b775f6639364))
+
+
+
 ## [4.0.4](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@4.0.3...@loopback/docs@4.0.4) (2022-03-29)
 
 

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) IBM Corp. 2017,2020.
+Copyright (c) IBM Corp. and LoopBack contributors 2017,2020.
 Node module: @loopback/docs
 This project is licensed under the MIT License, full text below.
 
@@ -6,7 +6,7 @@ This project is licensed under the MIT License, full text below.
 
 MIT License
 
-MIT License Copyright (c) IBM Corp. 2017,2020
+MIT License Copyright (c) IBM Corp. and LoopBack contributors 2017,2020
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@loopback/docs",
   "description": "Documentation files rendered at [https://loopback.io](https://loopback.io)",
-  "version": "4.0.4",
+  "version": "5.1.1",
   "keywords": [
     "LoopBack",
     "docs"
   ],
   "license": "MIT",
-  "author": "IBM Corp.",
-  "copyright.owner": "IBM Corp.",
+  "author": "IBM Corp. and LoopBack contributors",
+  "copyright.owner": "IBM Corp. and LoopBack contributors",
   "homepage": "https://github.com/loopbackio/loopback-next/tree/master/docs",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
     "directory": "docs"
   },
   "engines": {
-    "node": "12 || 14 || 16 || 17"
+    "node": "14 || 16 || 17 || 18"
   },
   "scripts": {
     "version": "node ./bin/copy-readmes.js && node ./bin/copy-changelogs.js && cd .. && npm run tsdocs",
@@ -32,11 +32,11 @@
     "site/"
   ],
   "dependencies": {
-    "fs-extra": "^10.0.1",
-    "tslib": "^2.3.1"
+    "fs-extra": "^10.1.0",
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@loopback/build": "^8.1.2"
+    "@loopback/build": "^9.0.2"
   },
-  "gitHead": "22d993c73a7b4ccdb36f2e26ea52460dc46fbd11"
+  "gitHead": "d2eddfc1319810f4c0126e613c24499b5685f7e4"
 }

package/site/BelongsTo-relation.md

@@ -319,7 +319,7 @@ In LoopBack 3, the REST APIs for relations were exposed using static methods
 with the name following the pattern `__{methodName}__{relationName}__` (e.g.
 `Order.__get__customer`). While we recommend to create a new controller for each
 hasMany relation in LoopBack 4, we also think it's best to use the main CRUD
-controller as the place where to explose `belongsTo` API.
+controller as the place where to expose `belongsTo` API.
 
 ## Handling recursive relations
 

package/site/CHANGELOG.md

@@ -74,6 +74,7 @@ permalink: /doc/en/lb4/changelog.index.html
 - [@loopback/example-metrics-prometheus](changelogs/examples/metrics-prometheus/CHANGELOG.md)
 - [@loopback/example-multi-tenancy](changelogs/examples/multi-tenancy/CHANGELOG.md)
 - [@loopback/example-passport-login](changelogs/examples/passport-login/CHANGELOG.md)
+- [@loopback/example-references-many](changelogs/examples/references-many/CHANGELOG.md)
 - [@loopback/example-rest-crud](changelogs/examples/rest-crud/CHANGELOG.md)
 - [@loopback/example-rpc-server](changelogs/examples/rpc-server/CHANGELOG.md)
 - [@loopback/example-soap-calculator](changelogs/examples/soap-calculator/CHANGELOG.md)

package/site/Context.md

@@ -298,7 +298,7 @@ A context event listener should conform to the following signature:
 
 ```ts
 /**
- * Synchronous event listener for the `Context` as en event emitter
+ * Synchronous event listener for the `Context` as an event emitter
  */
 export type ContextEventListener = (event: ContextEvent) => void;
 ```

package/site/Copyright-generator.md

@@ -22,7 +22,7 @@ lb4 copyright [options]
 The following is an example of such headers.
 
 ```js
-// Copyright IBM Corp. 2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2020. All Rights Reserved.
 // Node module: @loopback/cli
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
@@ -35,7 +35,8 @@ Please note the command expects `git` is installed.
 
 ### Options
 
-`--owner` : _(Optional)_ The owner of the copyright, such as `IBM Corp.`.
+`--owner` : _(Optional)_ The owner of the copyright, such as
+`IBM Corp. and LoopBack contributors`.
 
 `--license` : _(Optional)_ The name of the license, such as `MIT`.
 
@@ -74,15 +75,15 @@ The command prompts you for:
    directory of your package, its content will be read as the license header
    template without prompting.
 
-The default owner is `IBM Corp.` and license is `MIT` with the following
-`package.json`.
+The default owner is `IBM Corp. and LoopBack contributors` and license is `MIT`
+with the following `package.json`.
 
 ```json
 {
   "name": "@loopback/boot",
   "version": "2.0.2",
-  "author": "IBM Corp.",
-  "copyright.owner": "IBM Corp.",
+  "author": "IBM Corp. and LoopBack contributors",
+  "copyright.owner": "IBM Corp. and LoopBack contributors",
   "license": "MIT"
 }
 ```
@@ -93,7 +94,7 @@ The following output is captured when `lb4 copyright` is run against
 [`loopback4-example-shopping`](https://github.com/loopbackio/loopback4-example-shopping).
 
 ```
-? Copyright owner: IBM Corp.
+? Copyright owner: IBM Corp. and LoopBack contributors
 ? License name: (Use arrow keys or type to search)
 ❯ MIT (MIT License)
   ISC (ISC License)

package/site/Crafting-LoopBack-4.md

@@ -50,7 +50,7 @@ LoopBack fits into a typical end-to-end API processing flow.
 ![loopback-overview](./imgs/loopback-overview.png)
 
 LoopBack has grown significantly in features and users with many years of
-development and multiple releases. LoopBack has been well-recieved by the
+development and multiple releases. LoopBack has been well-received by the
 developer community. As an indication, the community has developed
 [many extensions](https://github.com/pasindud/awesome-loopback). The core team
 has also learned a lot from what we have done as well as great feedback from the
@@ -434,8 +434,8 @@ its vast ecosystem.
 Some of the gaps between what Express offers and LoopBack's needs are:
 
 - Lack of extensibility
-  > Express is only extensibile via middleware. It neither exposes a registry
-  > nor provides APIs to manage artifacts such as middleware or routers.
+  > Express is only extensible via middleware. It neither exposes a registry nor
+  > provides APIs to manage artifacts such as middleware or routers.
 - Lack of composability
   > Express is not composable. For example, `app.use()` is the only way to
   > register a middleware. The order of middleware is determined by the order of

package/site/DEVELOPING.md

@@ -679,12 +679,12 @@ to preserve backward compatibility.
 However, we do recognize that often a breaking change is the most sensible thing
 to do. When that time comes:
 
-- Describe incompatibilites for release notes
+- Describe incompatibilities for release notes
 - Look for more breaking changes to include in the release: search for comments
   containing `TODO(semver-major)` and `@deprecated`.
 - Update list of supported versions
 
-### Describe incompatibilites for release notes
+### Describe incompatibilities for release notes
 
 In the pull request introducing the breaking change, provide a descriptive
 [footer](#footer-optional) explaining the breaking change to our users. This

package/site/Discovering-models.md

@@ -39,6 +39,8 @@ Models can be discovered from a supported datasource by running the
 
 `--views`: Choose whether to discover views. Default is true
 
+`--relations`: Choose whether to create relations. Default is false
+
 `--all`: Skips the model prompt and discovers all of them
 
 `--outDir`: Specify the directory into which the `model.model.ts` files will be
@@ -47,6 +49,9 @@ placed. Default is `src/models`
 `--schema`: Specify the schema which the datasource will find the models to
 discover
 
+`--optionalId`: Specify if the Id property of generated models will be marked as
+not required
+
 ### Interactive Prompts
 
 Based on the option, the tool may prompt you for:

package/site/Dynamic-models-repositories-controllers.md

@@ -75,8 +75,8 @@ const bookDef = new ModelDefinition({
 
 A LoopBack model class is created by passing a `ModelDefinition` object to
 `@loopback/repository`'s helper function `defineModelClass()`. It expects a base
-model to extend (typically `Model` or `Entity`), folowed by the model definition
-object. In this case it will be `Entity`.
+model to extend (typically `Model` or `Entity`), followed by the model
+definition object. In this case it will be `Entity`.
 
 ```ts
 const BookModel = defineModelClass<typeof Entity, {id: number; title?: string}>(

package/site/Implementing-features.shelved.md

@@ -7,7 +7,7 @@ permalink: /doc/en/lb4/Implementing-features.html
 ---
 
 {% include previous.html content=" This article continues from \[Defining your
-testing stategy(./Defining-your-testing-strategy.md).
+testing strategy(./Defining-your-testing-strategy.md).
 " %}
 
 ## Incrementally implement features

package/site/Include-filter.md

@@ -286,7 +286,7 @@ await postRepository.findById('123', {
 
 {% include important.html content="The `limit` filter will be applied on a per parent record basis. So each parent record will include a max of `limit` number of records.
 Previously, we had a bug where `limit` will be applied globally, so not all parent's records will include related objects depending on the `limit` value.
-To keep backward compatability with this, in the weird case it is needed, you can use `totalLimit` instead. For more details [see here](https://github.com/loopbackio/loopback-next/issues/6832)
+To keep backward compatibility with this, in the weird case it is needed, you can use `totalLimit` instead. For more details [see here](https://github.com/loopbackio/loopback-next/issues/6832)
 " %}
 
 #### Access included objects

package/site/Interceptor-generator.md

@@ -118,7 +118,7 @@ import {
 } from '@loopback/core';
 
 /**
- * This class will be bound to the application as a global `Interceptor` during
+ * This class will be bound to the application as a non-global `Interceptor` during
  * `boot`
  */
 @injectable({tags: {key: TestInterceptor.BINDING_KEY}})

package/site/LB3-vs-LB4-request-response-cycle.md

@@ -43,7 +43,7 @@ methods.
 [#1293](https://github.com/loopbackio/loopback-next/issues/1293)
 and
 [#2035](https://github.com/loopbackio/loopback-next/issues/2035)
-to track the progress on supporting Express middlweware in LoopBack 4." %}
+to track the progress on supporting Express middleware in LoopBack 4." %}
 
 If you want to mount an Express router in a LoopBack 4 application, you can use
 the
@@ -351,7 +351,7 @@ export class ExampleController {
 ```
 
 Similarly, the request and response objects can be injected into services and
-respositories along with other objects from the [context](./Context.md).
+repositories along with other objects from the [context](./Context.md).
 
 It may be tempting to use an Express router (because of familiarity) instead of
 a controller to add custom endpoints to the application, but bear it in mind
@@ -475,7 +475,7 @@ async create(book: Book, options?: Options): Promise<Book> {
 }
 ```
 
-Similarly, various other repository methods in LoopBack 4 can be overriden to
+Similarly, various other repository methods in LoopBack 4 can be overridden to
 access the model data in the context of their operation.
 
 {% include tip.html content="
@@ -485,6 +485,6 @@ may also be used to access the user submitted data in some cases." %}
 ## Summary
 
 The phase-based middleware chain of LoopBack 3 is replaced by the sequence class
-in LoopBack 4. Controllers, services, and respositories are part of the
+in LoopBack 4. Controllers, services, and repositories are part of the
 request/response cycle in LoopBack 4; they provide interfaces and points of
 access to the request object, the response object, and the model data.

package/site/MONOREPO.md

@@ -40,6 +40,7 @@ one in the monorepo: `npm run update-monorepo-file`
 | [examples/todo-jwt](https://github.com/loopbackio/loopback-next/tree/master/examples/todo-jwt)                                       | @loopback/example-todo-jwt                 | A modified Todo tutorial how to build an application with JWT authentication and LoopBack 4                                                                                                                                                                                                     |
 | [examples/todo-list](https://github.com/loopbackio/loopback-next/tree/master/examples/todo-list)                                     | @loopback/example-todo-list                | Continuation of the todo example using relations in LoopBack 4.                                                                                                                                                                                                                                 |
 | [examples/validation-app](https://github.com/loopbackio/loopback-next/tree/master/examples/validation-app)                           | @loopback/example-validation-app           | An example demonstrating how to add validation in a LoopBack 4 application                                                                                                                                                                                                                      |
+| [examples/references-many](https://github.com/loopbackio/loopback-next/tree/master/examples/references-many)                         | @loopback/example-references-many          | An example of references many relation in a LoopBack 4                                                                                                                                                                                                                                          |
 | [examples/webpack](https://github.com/loopbackio/loopback-next/tree/master/examples/webpack)                                         | @loopback/example-webpack                  | An example to bundle @loopback/core using webpack                                                                                                                                                                                                                                               |
 | [extensions/apiconnect](https://github.com/loopbackio/loopback-next/tree/master/extensions/apiconnect)                               | @loopback/apiconnect                       | An extension for IBM API Connect                                                                                                                                                                                                                                                                |
 | [extensions/authentication-jwt](https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt)               | @loopback/authentication-jwt               | Extension for the prototype of JWT authentication                                                                                                                                                                                                                                               |

package/site/Model-generator.md

@@ -47,7 +47,7 @@ The tool will prompt you for:
   - For more information, see
     [here](https://loopback.io/doc/en/lb4/Model.html#overview).
 
-- **Allow additonal properties.** _(allowAdditionalProperties)_ Defaults to
+- **Allow additional properties.** _(allowAdditionalProperties)_ Defaults to
   **false**. To allow arbitrary properties in addition to well-defined
   properties, disable strict mode.
 

package/site/Model.md

@@ -146,7 +146,7 @@ export class Customer {
 ## Common Tasks
 
 - [Define models at runtime](Creating-model-runtime.md)
-- [Discover models from databases](DIscovering-models.md)
+- [Discover models from databases](Discovering-models.md)
 
 ## Model Metadata
 
@@ -814,7 +814,7 @@ explicitly either on the property itself or via the `type` option of the
 property decorator. Aliased types or types that extracted from a class or
 interface (e.g. `public name: OtherClass['otherProperty']`) will not work
 properly and will result in the property type being resolved as an empty object
-rather than the intended type in the generated OpenAPI specifcation. This is due
+rather than the intended type in the generated OpenAPI specification. This is due
 to a limitation and flaw in the way TypeScript currently generates the metadata
 that is used to generate the OpenAPI specification for the application." %}
 

package/site/Polymorphic-relation.md

@@ -0,0 +1,123 @@
+---
+lang: en
+title: 'Polymorphic Relation'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Model Relation
+sidebar: lb4_sidebar
+permalink: /doc/en/lb4/Polymorphic-relation.html
+---
+
+## Overview
+
+LoopBack supports _polymorphic relations_ in which a model can belong to more
+than one other model, on a single association.
+
+The examples below use the following example models: `Delivery`, `Letter`,
+`Parcel`, where a `Delivery` may contain a `Deliverable` - either a `Letter` or
+a `Parcel`.
+
+## Model definition
+
+We first define `Deliverable`s:
+
+```javascript
+class Deliverable extends Entity {
+}
+
+class Letter extends Deliverable {
+}
+
+class Parcel extends Deliverable {
+}
+...
+```
+
+The relation between the `Delivery` and `Deliverable`s is: `Delivery` `hasOne`
+`Deliverable`; the relation is polymorphic.
+
+```javascript
+class Delivery extends Entity {
+@hasOne(() => Deliverable, {polymorphic: true})
+  deliverable: Deliverable;
+
+deliverableType: string;
+}
+...
+```
+
+A customized discriminator can be specified. The discriminator parameter
+specifies the name of a field in the model indicating the actual type of the
+`Deliverable`.
+
+```javascript
+class Delivery extends Entity {
+@hasOne(() => Deliverable, {polymorphic: {discriminator: "deliverable_type"}})
+  deliverable: Deliverable;
+
+deliverable_type: string;
+}
+...
+```
+
+## Setting up repository
+
+The only difference on the repository class is that instead of having a single
+repository getter, a dictionary of subclass repository getters is passed into
+the repository factory creator.
+
+```javascript
+export class DeliveryRepository extends DefaultCrudRepository {
+  public readonly deliverable: HasOneRepositoryFactory<Deliverable, typeof Delivery.prototype.id>;
+
+  constructor(
+    dataSource: juggler.DataSource,
+    @repository.getter('LetterRepository')
+    protected letterRepositoryGetter: Getter<EntityCrudRepository<Deliverable, typeof Deliverable.prototype.id, DeliverableRelations>>,
+    @repository.getter('ParcelRepository')
+    protected parcelRepositoryGetter: Getter<EntityCrudRepository<Deliverable, typeof Deliverable.prototype.id, DeliverableRelations>>,
+  ) {
+    super(Delivery, dataSource);
+    this.deliverable = this.createHasOneRepositoryFactoryFor(
+      'deliverable',
+      // use a dictionary of repoGetters instead of a single repoGetter instance
+      {Letter: letterRepositoryGetter, Parcel: parcelRepositoryGetter},
+    );
+    this.registerInclusionResolver('deliverable', this.deliverable.inclusionResolver);
+  }
+}
+...
+```
+
+## Operations
+
+The polymorphic relation supports queries with inclusions
+
+```javascript
+const result = await deliveryRepo.findById(delivery1.id, {
+  include: ['deliverable'],
+});
+...
+```
+
+The instances of polymorphic relations can be created through repository
+operations
+
+```javascript
+deliveryRepo
+.deliverable(deliveryId)
+.create(letter1Data, {polymorphicType: "Letter"});
+...
+```
+
+## belongsTo, hasMany, hasManyThrough relations
+
+Polymorphic relation on `belongsTo` is similar to `hasOne`.
+
+Polymorphic relation is not supported on `hasMany` relations. However, there is
+an easy workaround: having a `hasMany` relation on a non-polymorphic concrete
+type which `hasOne` polymorphic relation with an abstract polymorphic type. For
+example, `Delivery` `hasMany` `DeliveryDeliverablePair` and
+`DeliveryDeliverablePair` `hasOne` `Deliverable`.
+
+The polymorphic relation on `hasManyThrough` relation is on the target model,
+not the through model. The discriminator is defined on the through model, and
+the target model is polymorphic.

package/site/REST-middleware-sequence.md

@@ -62,7 +62,7 @@ export class TodoListApplication extends BootMixin(
 }
 ```
 
-The middlware-based sequence itself is basically a named middleware chain. Each
+The middleware-based sequence itself is basically a named middleware chain. Each
 middleware serves as an action within the sequence. The `handle` function
 executes registered middleware in cascading fashion.