khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

NCU unstable namespace

Browse Source 
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
This commit is contained in:
Maxence Lange
2024-11-07 19:22:45 -01:00
parent 2a5c2f947e
commit 7f1ed36eec
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
developer_manual/digging_deeper/api.rst
View File

@@ -7,3 +7,24 @@ PHP public API
The public API is contained in the OCP namespace. See the `OCP API reference
<https://nextcloud-server.netlify.app/>`_ for further details.
PHP unstable API
----------------
To avoid releasing incomplete public API, it is possible to release a
first version of the future API in the `NCU` namespace, following these rules:
- Files are located in ``/lib/unstable/``
- Code quality, comments, tests and psalm check are expected to be identical to the `OCP` namespace.
- Classes must be tag as ``@experimental``, including the current version of Nextcloud.
- Code from the `OCP` namespace must never mention anything coming from the `NCU` namespace. It can not require it as an argument, constant or return something from `NCU`.
- An API can only live in this unstable namespace for one major release.
- During this testing phase, the code and the API can be modified/restructured without limitation.
- API within the testing namespace must have up-to-date documentation.
- If accepted, the API will be copied to the `OCP` public namespace.
- Once tested, the version from the `NCU` namespace will be marked as deprecated.
- Deprecated API from the `NCU` namespace are kept for 2 major releases.
.. note::
- API from `NCU` are included to the ``nextcloud-deps/OCP`` package for easier testing with psalm