RFC: Clearly separate APIs for public use RFC2021-05 #1403
Unanswered
iJungleboy
asked this question in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
While documenting I stumbled across an architecture issue which I believe will haunt us in future if we don't address them early.
To explain, I'll demonstrate this on the
ConnectionStringField
class documented here: http://docs.oqtane.me/api/Oqtane.Models.ConnectionStringField.htmlBasically it's purpose (AFAIK) is to help in very specific Oqtane-internal dialogs to configure Database settings. As of now, there is no relevant reason why Module Developers should access this. It's actually important that they don't ever use this, since some day you may make it more generic and have to rename (like to
GenericInputField
) or modify it and not worry about external effects.So my point is there should be a clear distinction between
There are a few ways to do this, including
[PrivateApi]
and hiding these in documentationinternal
and configuring the assembly so internal models are available on the core Oqtane projects, basically makinginternal
a public inside Oqtane onlyYour thoughts.
Beta Was this translation helpful? Give feedback.
All reactions