Incorrect Example Syntax - Dynamic References via refPath

[chandiwalaaadhar]

"on:" is a reserved keyword which fails on execution, therefore modelId: would be the correct key and works well

Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory.

If you're making a change to documentation, do not modify a .html file directly. Instead find the corresponding .pug file or test case in the test/docs directory.

Summary
This PR will make the documentation example codes bug free as the current syntax gave error Error: `on` may not be used as a schema pathname

Examples

NA

[Uzlopak]

Hmm. I would actually think that 'on' being a "reserved keyword" should be classified as a bug.

[AbdelrahmanHafez]

Reserved keywords should be removed from #10414, if you can't use on, that's something we should fix.

That being said, while we allow usage of keywords that were previously reserved, we recommend against it because it will break plugins that rely on using them, so the example should not mention a case where it might cause issues for the end-user.

[Uzlopak]

I think the problem is, that Schema/Model is an EventEmitter. So while you can set an attribute named "on", it collides with the on property of the EventEmitter.

[AbdelrahmanHafez]

@Uzlopak
That's correct. We've come up with a workaround in #9010, which is giving an alias $on and using that alias internally, so users can use on if they want to.

[Uzlopak]

Should we open a ticket to examine this issue?

[AbdelrahmanHafez]

@Uzlopak Done.
#11580