Merge pull request #4757 from mhsdesign/task/markSerializedCommandsAs…

…Internal TASK: 4305 Mark *Serialized* commands `@internal`
neos · Nov 17, 2023 · 3a37216 · 3a37216
2 parents e304fc6 + 91fe96b
commit 3a37216
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 10 deletions.
diff --git a/...ntentRepository.Core/Classes/Feature/NodeCreation/Command/CreateNodeAggregateWithNode.php b/...ntentRepository.Core/Classes/Feature/NodeCreation/Command/CreateNodeAggregateWithNode.php
@@ -25,10 +25,8 @@
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 
 /**
- * CreateNodeAggregateWithNode
+ * Creates a new node aggregate with a new node.
  *
- * Creates a new node aggregate with a new node in the given `contentStreamId`
- * with the given `nodeAggregateId` and `originDimensionSpacePoint`.
  * The node will be appended as child node of the given `parentNodeId` which must cover the given
  * `originDimensionSpacePoint`.
  *

diff --git a/...asses/Feature/NodeCreation/Command/CreateNodeAggregateWithNodeAndSerializedProperties.php b/...asses/Feature/NodeCreation/Command/CreateNodeAggregateWithNodeAndSerializedProperties.php
@@ -30,7 +30,7 @@
  * The properties of {@see CreateNodeAggregateWithNode} are directly serialized; and then this command
  * is called and triggers the actual processing.
  *
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail, use {@see CreateNodeAggregateWithNode} instead.
  */
 final class CreateNodeAggregateWithNodeAndSerializedProperties implements
     CommandInterface,

diff --git a/...tRepository.Core/Classes/Feature/NodeModification/Command/SetSerializedNodeProperties.php b/...tRepository.Core/Classes/Feature/NodeModification/Command/SetSerializedNodeProperties.php
@@ -24,11 +24,11 @@
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 
 /**
- * Set property values for a given node (internal implementation).
+ * Set property values for a given node.
  *
  * The property values contain the serialized types already, and include type information.
  *
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail, use {@see SetNodeProperties} instead.
  */
 final class SetSerializedNodeProperties implements
     CommandInterface,

diff --git a/...ntRepository.Core/Classes/Feature/NodeReferencing/Command/SetSerializedNodeReferences.php b/...ntRepository.Core/Classes/Feature/NodeReferencing/Command/SetSerializedNodeReferences.php
@@ -25,11 +25,11 @@
 use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
 
 /**
- * Set property values for a given node (internal implementation).
+ * Set property values for a given node.
  *
  * The property values contain the serialized types already, and include type information.
  *
- * @api commands are the write-API of the ContentRepository
+ * @internal implementation detail, use {@see SetNodeReferences} instead.
  */
 final class SetSerializedNodeReferences implements
     CommandInterface,

diff --git a/Neos.ContentRepository.Core/Classes/Feature/NodeReferencing/Dto/SerializedNodeReference.php b/Neos.ContentRepository.Core/Classes/Feature/NodeReferencing/Dto/SerializedNodeReference.php
@@ -20,7 +20,7 @@
 /**
  * "Raw" / Serialized node reference as saved in the event log // in projections.
  *
- * @api used as part of commands/events
+ * @internal
  */
 final class SerializedNodeReference implements \JsonSerializable
 {

diff --git a/Neos.ContentRepository.Core/Classes/Feature/NodeReferencing/Dto/SerializedNodeReferences.php b/Neos.ContentRepository.Core/Classes/Feature/NodeReferencing/Dto/SerializedNodeReferences.php
@@ -21,7 +21,7 @@
  * A collection of SerializedNodeReference objects, to be used when creating reference relations.
  *
  * @implements \IteratorAggregate<SerializedNodeReference>
- * @api used as part of commands/events
+ * @internal
  */
 final readonly class SerializedNodeReferences implements \IteratorAggregate, \Countable, \JsonSerializable
 {