diff --git a/_docs_use-cases/use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer.md b/_docs_use-cases/use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer.md deleted file mode 100644 index 81b4255c9..000000000 --- a/_docs_use-cases/use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer -published: true -title: "Delete a third party owned RelationshipAttribute and notify peer" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RA25 - - component: Runtime - - layer: Consumption - - facade: AttributesFacade - - function: deleteThirdPartyOwnedRelationshipAttributeAndNotifyPeer - - description: - - feature category: Cross-Identity Attribute sharing - - tech category: Attributes - - status: DONE - - documentation status: DONE - - comments: deprecated use /use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer instead - - actor: Identity - - trigger: REST API - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: DELETE /api/v2/Attributes/ThirdParty/{id} - - published: default - - link: use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer -require: -required_by: -api_route_regex: ^DELETE /api/v2/Attributes/ThirdParty/{id}$ -# End automatic generation ---- - -{{properties.description}} - -{% include properties_list.html %} - -This use case is deprecated and will be removed in the next major version. Please use the use case [Delete a ThirdPartyRelationshipAttribute and notify peer](use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer) instead. -{: .notice--warning} - -This use case allows you to delete a ThirdPartyRelationshipAttribute, i.e. a [LocalAttribute]({%link _docs_integrate/data-model-overview.md %}#localattribute) that has the property `shareInfo.thirdPartyAddress` set. - -## Parameters - -- The `attributeId` of the ThirdPartyRelationshipAttribute you want to delete. - -## On Success - -- The ThirdPartyRelationshipAttribute will be deleted. -- All predecessors of the ThirdPartyRelationshipAttribute will be deleted. -- If the ThirdPartyRelationshipAttribute was succeeded, the `succeeds` property of the successor will be set to undefined. -- A [Notification]({%link _docs_integrate/data-model-overview.md %}#notification) with a [ThirdPartyRelationshipAttributeDeletedByPeerNotificationItem]({%link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributedeletedbypeernotificationitem) is sent to the peer of the Attribute, informing them that you deleted the Attribute. Technically, the Attribute of the peer and all predecessors will get a `deletionInfo` with `deletionStatus` `"DeletedByPeer"` and the time of receiving the Notification as `deletionDate`. -- The `notificationId` is returned. - -## On Failure - -- No Attribute can be deleted if you don't have a LocalAttribute with given `attributeId`. -- No Attribute can be deleted if the Attribute with given `attributeId` is not a ThirdPartyRelationshipAttribute. diff --git a/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md b/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md index ec82823b4..647109799 100644 --- a/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md +++ b/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md @@ -1,6 +1,8 @@ --- # Start automatic generation permalink: use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer +redirect_from: + - /use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer published: true title: "Delete a ThirdPartyRelationshipAttribute and notify peer" type: use-case @@ -9,7 +11,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RA29 + - id: RA25 - component: Runtime - layer: Consumption - facade: AttributesFacade @@ -19,7 +21,7 @@ properties: - tech category: Attributes - status: DONE - documentation status: DONE - - comments: add redirect from /use-case-consumption-delete-a-third-party-owned-relationshipattribute-and-notify-peer as soon as that use case is deleted + - comments: - actor: Identity - trigger: REST API - precondition: diff --git a/_docs_use-cases/use-case-transport-load-item-from-reference.md b/_docs_use-cases/use-case-transport-load-item-from-reference.md index 4f05bb9a9..b28d3b367 100644 --- a/_docs_use-cases/use-case-transport-load-item-from-reference.md +++ b/_docs_use-cases/use-case-transport-load-item-from-reference.md @@ -1,6 +1,8 @@ --- # Start automatic generation permalink: use-case-transport-load-item-from-reference +redirect_from: + - use-case-transport-load-item-from-truncated-reference published: true title: "Load item from reference" type: use-case @@ -9,7 +11,7 @@ sidebar: - title: "Integrate enmeshed" nav: "docs_integrate" properties: - - id: RU10 + - id: RU9 - component: Runtime - layer: Transport - facade: AccountFacade @@ -19,7 +21,7 @@ properties: - tech category: Account - status: QUESTIONS - documentation status: DONE - - comments: add redirect from /use-case-transport-load-item-from-truncated-reference as soon as that use case is deleted; rather somewhere else? + - comments: rather somewhere else? - actor: Identity - trigger: - precondition: diff --git a/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md b/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md deleted file mode 100644 index 11fd9cb50..000000000 --- a/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -# Start automatic generation -permalink: use-case-transport-load-item-from-truncated-reference -published: true -title: "Load item from truncated reference" -type: use-case -toc: true -sidebar: - - title: "Integrate enmeshed" - nav: "docs_integrate" -properties: - - id: RU9 - - component: Runtime - - layer: Transport - - facade: AccountFacade - - function: loadItemFromTruncatedReference - - description: - - feature category: Share information over side-channel - - tech category: Account - - status: QUESTIONS - - documentation status: DONE - - comments: deprecated use /use-case-transport-load-item-from-reference instead; rather somewhere else? - - actor: Identity - - trigger: - - precondition: - - result: - - priority: n/a - - complexity: n/a - - size: n/a - - created_at: - - changed_at: - - api_route_regex: - - published: default - - link: use-case-transport-load-item-from-truncated-reference -require: -required_by: -# End automatic generation ---- - -{{properties.description}} - -{% include properties_list.html %} - -This use case is deprecated and will be removed in the next major version. Please use the use case [Load item from reference](use-case-transport-load-item-from-reference) instead. -{: .notice--warning} - -This use case intends to load an entity by its `reference` received by a peer. Internally, it uses the specific use cases of each entity: - -- If the `reference` refers to a [Token]({% link _docs_integrate/data-model-overview.md %}#token), it fetches the Token just like the [Load Token created by others]({% link _docs_use-cases/use-case-transport-load-token-created-by-others.md %}) use case. For example, if the `content` of the Token is a TokenContentDeviceSharedSecret, a DeviceOnboardingInfo is returned after the successful execution of the use case. A TokenContentDeviceSharedSecret is created by the [Create Device Onboarding Token]({% link _docs_use-cases/use-case-transport-create-device-onboarding-token.md %}) use case. -- If the `reference` refers to a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate), it fetches the RelationshipTemplate just like the [Load RelationshipTemplate created by others]({% link _docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md %}) use case. -- If the `reference` refers to a [File]({% link _docs_integrate/data-model-overview.md %}#file), it fetches the File just like the [Load File]({% link _docs_use-cases/use-case-transport-load-file.md %}) use case.