Skip to content

Commit

Permalink
NCT testing namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
ArtificialOwl committed Oct 28, 2024
1 parent a8041ca commit 3491484
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions developer_manual/digging_deeper/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,19 @@ 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 testing API
---------------

To avoid releasing uncompleted public API, it is possible to release a
testing version of the future API in the NCT namespace, following those rules:

- An API can only be nested in this testing namespace for 1 (one) major release,
- Once tested the API will be removed or copied to the OCP public namespace,
- If the API is not removed, the version from the NCT namespace will be marked as deprecated,
- Deprecated API from the NCT namespace are kept for 2 major releases,
- Code quality, comments, tests and psalm check are expected to be identical than in the OCP namespace.

.. note::
- API within the testing namespace might not have documentation other than in-code comments.

0 comments on commit 3491484

Please sign in to comment.