docs: changes Model.md to reflect known issue #3871
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raymondfeng
reviewed
Oct 4, 2019
docs/site/Model.md
Outdated
| @@ -465,6 +465,10 @@ The property decorator leverages LoopBack's | |||
| [metadata package](https://github.com/strongloop/loopback-next/tree/master/packages/metadata) | |||
| to determine the type of a particular property. | |||
|
|
|||
| {% include note.html content=" | |||
| Currently, property types must be specified 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 to a limitation and flaw in the way TypeScript currently generates the metadata that is used to generate the OpenAPI specification for the application. (see [Issue #3863](https://github.com/strongloop/loopback-next/issues/3863)) | |||
| " %} | |||
There was a problem hiding this comment.
Can you provide a code snippet that the design:type is not emitted by TypeScript to make it clear? For example:
@model()
class MyModel {
@property()
p1: string[]; // => design:type: Array
p2: MyType<string>; // => design:type Object
p3: OtherClass['otherProperty']; // => design:type: Object
}There was a problem hiding this comment.
@raymondfeng Thanks - I've added a snippet to the note in an amended commit.
taicho
force-pushed
the
master
branch
2 times, most recently
from
da2bfa3 to
c162ad5
Compare
Changes Model.md to reflect a known issue with property reflection when dealing with type aliases and extracted types. Edit - adds example suggested by @raymondfeng. See loopbackio#3863. No code changes.
raymondfeng
approved these changes
Oct 7, 2019
|
@taicho PR landed. Thank you for the contribution! 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes Model.md to reflect a known issue with property reflection when dealing with type aliases and extracted types. See #3863. No code changes.
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈