Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NCT testing namespace #12329

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

NCT testing namespace #12329

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3491484
NCT testing namespace
ArtificialOwl Oct 28, 2024
9fb0aa7
better phrasing
ArtificialOwl Oct 29, 2024
50d12d5
adding @experimental to classes
ArtificialOwl Oct 30, 2024
44ea69c
some phrasing
ArtificialOwl Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions developer_manual/digging_deeper/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,21 @@ 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 incomplete public API, it is possible to release a
testing version of the future API in the NCT namespace, following these rules:

- 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.
- An API can only live in this testing namespace for one major release.
- During this testing phase, the code and the API can be modified/restructured without limitation.
- If accepted, the API will be copied to the OCP public namespace.
- Once tested, the version from the NCT namespace will be marked as deprecated.
- Deprecated API from the NCT namespace are kept for 2 major releases.

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