diff --git a/Development_Apprise_Details.md b/Development_Apprise_Details.md index 3087ac8..d9908fc 100644 --- a/Development_Apprise_Details.md +++ b/Development_Apprise_Details.md @@ -8,7 +8,7 @@ ``` A call to the **Apprise().details()** object returns a list of supported notification services available. It's syntax can be broken down into 3 major categories: -* **Version**: A string representation of the current version of the Apprise library. +* **version**: A string representation of the current version of the Apprise library. * **asset**: Some developers will provide their own [[Apprise Asset Object|Development_API#the-apprise-asset-object]] tailored to their own system. This is merely a view into the current loaded configuration. * **schemas**: This is a identifying all of the supported notification services and a very high level point of reference to them such as their official documentation, the apprise documentation, and the name of the service itself. @@ -29,6 +29,10 @@ print(dumps(a.details(), indent=2) ## Version This is just a simple string that you can use as a reference to help identify what version of Apprise is loaded. The version identified here can have a direct impact on what notification services have been made available to you and additions to this very API. +While there is no intent to change the API at this time, the API IS subject to potentially be structured differently or _could_ include potential breaking changes _IF the major changes_. Hence given a version of **X**.Y.Z, **X** would be identified as _the major_. + +In all other circumstances, content may be added to the API, but NEVER removed or changed in such a way it would break systems referencing it. + ## Asset [[The Apprise Asset Object|Development_API#the-apprise-asset-object]] during the initialization of Apprise can be altered to conform to different products. The Asset object really just defines some static globals that are referenced through-out the entire life of the Apprise object itself.