TASK: Declare lower level content stream commands as internal

With the content graph / subgraph operating on workspaces, there is no API way of fetching from an arbitrary content stream by id. And by not being able to access it we declare creating content streams or doing any low level work with it as internal.
neos · Jul 12, 2024 · 35155bd · 35155bd
1 parent 4b674d6
commit 35155bd
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/...ontentRepository.Core/Classes/Feature/ContentStreamClosing/Command/CloseContentStream.php b/...ontentRepository.Core/Classes/Feature/ContentStreamClosing/Command/CloseContentStream.php
@@ -18,7 +18,9 @@
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 
 /**
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail. You must not use this command directly.
+ * Direct use may lead to hard to revert senseless state in your content repository.
+ * Please use the higher level workspace commands instead.
  */
 final readonly class CloseContentStream implements CommandInterface
 {

diff --git a/...ntentRepository.Core/Classes/Feature/ContentStreamClosing/Command/ReopenContentStream.php b/...ntentRepository.Core/Classes/Feature/ContentStreamClosing/Command/ReopenContentStream.php
@@ -19,7 +19,9 @@
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamState;
 
 /**
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail. You must not use this command directly.
+ * Direct use may lead to hard to revert senseless state in your content repository.
+ * Please use the higher level workspace commands instead.
  */
 final readonly class ReopenContentStream implements CommandInterface
 {

diff --git a/...tentRepository.Core/Classes/Feature/ContentStreamCreation/Command/CreateContentStream.php b/...tentRepository.Core/Classes/Feature/ContentStreamCreation/Command/CreateContentStream.php
@@ -21,7 +21,9 @@
  * CreateContentStream for creating the FIRST content stream.
  * All other content streams will be FORKED from this FIRST content stream.
  *
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail. You must not use this command directly.
+ * Direct use may lead to hard to revert senseless state in your content repository.
+ * Please use the higher level workspace commands instead.
  */
 final readonly class CreateContentStream implements CommandInterface
 {

diff --git a/...ContentRepository.Core/Classes/Feature/ContentStreamForking/Command/ForkContentStream.php b/...ContentRepository.Core/Classes/Feature/ContentStreamForking/Command/ForkContentStream.php
@@ -20,7 +20,9 @@
 /**
  * ForkContentStream for creating a new fork of a content stream.
  *
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail. You must not use this command directly.
+ * Direct use may lead to hard to revert senseless state in your content repository.
+ * Please use the higher level workspace commands instead.
  */
 final readonly class ForkContentStream implements CommandInterface
 {

diff --git a/...ntentRepository.Core/Classes/Feature/ContentStreamRemoval/Command/RemoveContentStream.php b/...ntentRepository.Core/Classes/Feature/ContentStreamRemoval/Command/RemoveContentStream.php
@@ -20,7 +20,9 @@
 /**
  * Command to remove an existing content stream
  *
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail. You must not use this command directly.
+ * Direct use may lead to hard to revert senseless state in your content repository.
+ * Please use the higher level workspace commands instead.
  */
 final readonly class RemoveContentStream implements CommandInterface
 {