ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-24 07:06:44 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Interfaces/classes/methods with internal in their name are non-public API (#5906)

Browse Source
This commit is contained in:
Joel Dudley 2020-01-29 15:35:00 +00:00 committed by GitHub
parent d16e1126db
commit 5b186b1c65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/api-stability-guarantees.rst
View File

@ -34,10 +34,13 @@ has a stable API.
Non-public API (experimental)
-----------------------------
The following modules are not part of the Corda's public API and no backwards compatibility guarantees are provided. They are further categorized in 2 classes:
The following are not part of the Corda's public API and no backwards compatibility guarantees are provided:
* the incubating modules, for which we will do our best to minimise disruption to developers using them until we are able to graduate them into the public API
* the internal modules, which are not to be used, and will change without notice
* Incubating modules, for which we will do our best to minimise disruption to developers using them until we are able to graduate them into the public API
* Internal modules, which are not to be used, and will change without notice
* Anything defined in a package containing ``.internal`` (for example, ``net.corda.core.internal`` and sub-packages should
not be used)
* Any interfaces, classes or methods whose name contains the word ``internal`` or ``Internal``
The **finance module** was the first CorDapp ever written and is a legacy module. Although it is not a part of our API guarantees, we also
don't anticipate much future change to it. Users should use the tokens SDK instead.
@ -53,8 +56,7 @@ Corda incubating modules
Corda internal modules
~~~~~~~~~~~~~~~~~~~~~~
Everything else is internal and will change without notice, even deleted, and should not be used. This also includes any package that has
``.internal`` in it. So for example, ``net.corda.core.internal`` and sub-packages should not be used.
Every other module is internal and will change without notice, even deleted, and should not be used.
Some of the public modules may depend on internal modules, so be careful to not rely on these transitive dependencies. In particular, the
testing modules depend on the node module and so you may end having the node in your test classpath.