Răsfoiți Sursa

Add scope warning to plugins development doc

Jeremy Stretch 5 ani în urmă
părinte
comite
24e5dd0c78
1 a modificat fișierele cu 3 adăugiri și 0 ștergeri
  1. 3 0
      docs/plugins/development.md

+ 3 - 0
docs/plugins/development.md

@@ -12,6 +12,9 @@ Plugins can do a lot, including:
 
 
 However, keep in mind that each piece of functionality is entirely optional. For example, if your plugin merely adds a piece of middleware or an API endpoint for existing data, there's no need to define any new models.
 However, keep in mind that each piece of functionality is entirely optional. For example, if your plugin merely adds a piece of middleware or an API endpoint for existing data, there's no need to define any new models.
 
 
+!!! warning
+    While very powerful, the NetBox plugins API is necessarily limited in its scope. The plugins API is discussed here in its entirety: Any part of the NetBox code base not documented here is _not_ part of the supported plugins API, and should not be employed by a plugin. Internal elements of NetBox are subject to change at any time and without warning. Plugin authors are **strongly** encouraged to develop plugins using only the officially supported components discussed here and those provided by the underlying Django framework so as to avoid breaking changes in future releases. 
+
 ## Initial Setup
 ## Initial Setup
 
 
 ## Plugin Structure
 ## Plugin Structure