corda/docs/source/api-index.rst

API
===

This section describes the APIs that are available for the development of CorDapps:

.. toctree::
   :maxdepth: 1

   api-states
   api-persistence
   api-contracts
   api-vault-query
   api-transactions
   api-flows
   api-identity
   api-service-hub
   api-rpc
   api-core-types

Before reading this page, you should be familiar with the :doc:`key concepts of Corda <key-concepts>`.

Internal APIs and stability guarantees
--------------------------------------

.. warning:: For Corda 1.0 we do not currently provide a stable wire protocol or support for database upgrades.
   Additionally, the JSON format produced by the client-jackson module may change in future.
   Therefore, you should not expect to be able to migrate persisted data from 1.0 to future versions.

   Additionally, it may be necessary to recompile applications against future versions of the API until we begin offering
   ABI stability as well. We plan to do this soon after the release of Corda 1.0.

   Finally, please note that the 1.0 release has not yet been security audited. You should not run it in situations
   where security is required.

As of Corda 1.0, the following modules export public API that we promise to maintain backwards compatibility for,
unless an incompatible change is required for security reasons:

* core
* client-rpc
* client-jackson

The following modules don't yet have a completely stable API, but we will do our best to minimise disruption to
developers using them until we are able to graduate them into the public API:

* the Gradle plugins (cordformation)
* node-driver
* confidential-identities
* test-utils
* client-jfx, client-mock
* finance
* anything under the experimental directory (sub-components here may never graduate)

We hope to graduate the node-driver, test-utils and confidential-identities modules in the next feature release
after 1.0. The bulk of the Corda API is found in the core module. Other modules should be assumed to be fully internal.

The web server module will be removed in future: you should build web frontends for CorDapps using standard frameworks
like Spring Boot, J2EE, Play, etc.

Code that falls into the following package namespaces are for internal use only and not public. In a future release the
node will not load any CorDapp which uses them.

* Any package in the ``net.corda`` namespace which contains ``.internal``
* ``net.corda.node``
Formatting and typos. Groups API docs in sidebar. Renames Persistence to API: Persistence and fixes some links. 2017-06-21 12:55:48 +00:00			`API`
			`===`
Docsite reorg ahead of beta launch. 2017-06-05 12:37:23 +00:00
			`This section describes the APIs that are available for the development of CorDapps:`

[fix] stop the API pages being orphaned away from the menu 2017-08-01 16:04:16 +00:00			`.. toctree::`
			`:maxdepth: 1`

			`api-states`
			`api-persistence`
			`api-contracts`
			`api-vault-query`
			`api-transactions`
			`api-flows`
Identity documentation (#1620) * Sketch initial identity docs * Restructure confidential identity docs to better fit structure * Split confidential identities into API and concepts * Further expansion on basic identity conceptS * Merge Party type into api-identity.rst * Address feedback on written content * Rework inline code with literalinclude * Start addressing feedback from Richard * Clarify use of "counterparty" * Address comments on key concepts * Correct back to US english * Clarify distribution/publishing of identities * Update changelog around confidential identities 2017-09-27 16:10:38 +00:00			`api-identity`
Tutorial refresh for v1.0 and moving of code into separate files. (#1758) * Moves code sections in tutorials to code files. * Removes wallet references. * Updates repo layout doc. * Removes remaining cordapp-tutorial references, replaced with cordapp-example. * Fixes broken link. * Misc docs fixes. * Refreshes the ServiceHub and rpc ops api pages. * Updates the cheat sheet. * Updates cookbooks. * Refreshes the running-a-notary tutorial. * Updates flow-testing tutorial * Updates tear-offs tutorial. * Refreshes integration-testing tutorial. * Updates to contract tutorial and accompanying code to bring inline with V1 release. * Refreshes contract-upgrade tutorial. * Fixed broken code sample in "writing a contract" and updated contracts dsl. * Added contract ref to java code. Fixed broken rst markup. * Updates transaction-building tutorial. * Updates the client-rpc and flow-state-machines tutorials. * Updates the oracles tutorial. * Amended country in X500 names from "UK" to "GB" * Update FlowCookbook.kt * Amended cheatsheet. Minor update on contract upgrades tutoraial. * Added `extraCordappPackagesToScan` to node driver. * Changes to match new function signature. * Update to reflect change in location of cash contract name. 2017-10-02 09:11:33 +00:00			`api-service-hub`
			`api-rpc`
[fix] stop the API pages being orphaned away from the menu 2017-08-01 16:04:16 +00:00			`api-core-types`
Docsite reorg ahead of beta launch. 2017-06-05 12:37:23 +00:00
Moved the majority of the contents of Utils.kt into either InternalUtils.kt or KotlinUtils.kt. What remains is being dealt with in another PR. 2017-07-24 09:12:27 +00:00			Before reading this page, you should be familiar with the :doc:`key concepts of Corda <key-concepts>`.

Docs: add a note to the api index page about version 1.0 and which modules will have a stable API. 2017-09-21 15:11:47 +00:00			`Internal APIs and stability guarantees`
			`--------------------------------------`

			`.. warning:: For Corda 1.0 we do not currently provide a stable wire protocol or support for database upgrades.`
			`Additionally, the JSON format produced by the client-jackson module may change in future.`
			`Therefore, you should not expect to be able to migrate persisted data from 1.0 to future versions.`

			`Additionally, it may be necessary to recompile applications against future versions of the API until we begin offering`
			`ABI stability as well. We plan to do this soon after the release of Corda 1.0.`

			`Finally, please note that the 1.0 release has not yet been security audited. You should not run it in situations`
			`where security is required.`

			`As of Corda 1.0, the following modules export public API that we promise to maintain backwards compatibility for,`
			`unless an incompatible change is required for security reasons:`

			`* core`
			`* client-rpc`
			`* client-jackson`

			`The following modules don't yet have a completely stable API, but we will do our best to minimise disruption to`
			`developers using them until we are able to graduate them into the public API:`

			`* the Gradle plugins (cordformation)`
			`* node-driver`
			`* confidential-identities`
			`* test-utils`
			`* client-jfx, client-mock`
			`* finance`
			`* anything under the experimental directory (sub-components here may never graduate)`

			`We hope to graduate the node-driver, test-utils and confidential-identities modules in the next feature release`
			`after 1.0. The bulk of the Corda API is found in the core module. Other modules should be assumed to be fully internal.`

			`The web server module will be removed in future: you should build web frontends for CorDapps using standard frameworks`
			`like Spring Boot, J2EE, Play, etc.`
Moved the majority of the contents of Utils.kt into either InternalUtils.kt or KotlinUtils.kt. What remains is being dealt with in another PR. 2017-07-24 09:12:27 +00:00
			`Code that falls into the following package namespaces are for internal use only and not public. In a future release the`
			`node will not load any CorDapp which uses them.`

			* Any package in the ``net.corda`` namespace which contains ``.internal``
Docs: add a note to the api index page about version 1.0 and which modules will have a stable API. 2017-09-21 15:11:47 +00:00			* ``net.corda.node``